GET api/globalsearch/properties
Search for Properties across the system. Processes this global search API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Term |
The term value. |
string |
None. |
| PageSize |
The page size value. |
integer |
None. |
| PageNumber |
The page number value. |
integer |
None. |
| BranchId |
The unique identifier of the related branch resource. |
integer |
None. |
| GroupTypes |
The collection of group types. |
Collection of GroupSearchType |
None. |
| ExcludeDeleted |
Indicates whether exclude deleted is true. |
boolean |
None. |
| ExcludeArchived |
Indicates whether exclude archived is true. |
boolean |
None. |
| LastUpdated |
The last updated, expressed as a date and time. |
date |
None. |
| ServiceType |
The service type value. |
string |
None. |
| PaginationLastDocumentId |
The unique identifier of the related pagination last document resource. |
integer |
None. |
Body Parameters
None.
Response Information
Resource Description
The response returned after the operation completes.
PagedCollectionDataContractOfGlobalSearchPropertyResultDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalCount |
The total count value. |
integer |
None. |
| CurrentCount |
The current count value. |
integer |
None. |
| PageSize |
The page size value. |
integer |
None. |
| PageNumber |
The page number value. |
integer |
None. |
| Collection |
The collection of collection. |
Collection of GlobalSearchPropertyResultDataContract |
None. |
Response Formats
application/json
Sample not available.
text/json
Sample not available.