POST api/Search/Filter
Request Information
URI Parameters
None.
Body Parameters
FilterRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Query | string |
None. |
|
| ItemsPerPage | integer |
None. |
|
| PageNumber | integer |
None. |
|
| FilterType | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Query": "sample string 1",
"ItemsPerPage": 2,
"PageNumber": 3,
"FilterType": "sample string 4"
}
application/xml, text/xml
Sample:
<FilterRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model"> <FilterType>sample string 4</FilterType> <ItemsPerPage>2</ItemsPerPage> <PageNumber>3</PageNumber> <Query>sample string 1</Query> </FilterRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
PaginatedResultsOfSearchResult| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalPages | integer |
None. |
|
| CurrentPage | integer |
None. |
|
| Results | Collection of SearchResult |
None. |
|
| Count | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"TotalPages": 1,
"CurrentPage": 2,
"Results": [
{
"ResourceTypeIdentity": "cb19e4c4-9cf7-4f73-b88f-ff88ff70f94b",
"BookingTypeIdentities": [
"2950149e-5b20-485f-9f64-e2b0295bacf7",
"572f2fc7-5085-4b7a-905e-35e9ac836e8a"
],
"Identity": "67a89d0c-0535-4016-b87c-f4124a1435c4",
"Name": "sample string 3"
},
{
"ResourceTypeIdentity": "cb19e4c4-9cf7-4f73-b88f-ff88ff70f94b",
"BookingTypeIdentities": [
"2950149e-5b20-485f-9f64-e2b0295bacf7",
"572f2fc7-5085-4b7a-905e-35e9ac836e8a"
],
"Identity": "67a89d0c-0535-4016-b87c-f4124a1435c4",
"Name": "sample string 3"
}
],
"Count": 3
}
application/xml, text/xml
Sample:
<PaginatedResultsOfSearchResultjuCGl64F xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
<Count>3</Count>
<CurrentPage>2</CurrentPage>
<Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model.ToDoModels">
<d2p1:SearchResult>
<Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">67a89d0c-0535-4016-b87c-f4124a1435c4</Identity>
<Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 3</Name>
<d2p1:BookingTypeIdentities xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:guid>2950149e-5b20-485f-9f64-e2b0295bacf7</d4p1:guid>
<d4p1:guid>572f2fc7-5085-4b7a-905e-35e9ac836e8a</d4p1:guid>
</d2p1:BookingTypeIdentities>
<d2p1:ResourceTypeIdentity>cb19e4c4-9cf7-4f73-b88f-ff88ff70f94b</d2p1:ResourceTypeIdentity>
</d2p1:SearchResult>
<d2p1:SearchResult>
<Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">67a89d0c-0535-4016-b87c-f4124a1435c4</Identity>
<Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 3</Name>
<d2p1:BookingTypeIdentities xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:guid>2950149e-5b20-485f-9f64-e2b0295bacf7</d4p1:guid>
<d4p1:guid>572f2fc7-5085-4b7a-905e-35e9ac836e8a</d4p1:guid>
</d2p1:BookingTypeIdentities>
<d2p1:ResourceTypeIdentity>cb19e4c4-9cf7-4f73-b88f-ff88ff70f94b</d2p1:ResourceTypeIdentity>
</d2p1:SearchResult>
</Results>
<TotalPages>1</TotalPages>
</PaginatedResultsOfSearchResultjuCGl64F>