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": "774e83fe-21c2-47f3-b29e-df2432fca0ce",
"BookingTypeIdentities": [
"ccdcb5cf-bc22-4714-b545-b06b4f93e80a",
"f4b6fb1a-b740-4161-adf7-8eea0f2412a7"
],
"Identity": "a66dacdb-6f2e-4708-8a3e-5f8950ce1cca",
"Name": "sample string 3"
},
{
"ResourceTypeIdentity": "774e83fe-21c2-47f3-b29e-df2432fca0ce",
"BookingTypeIdentities": [
"ccdcb5cf-bc22-4714-b545-b06b4f93e80a",
"f4b6fb1a-b740-4161-adf7-8eea0f2412a7"
],
"Identity": "a66dacdb-6f2e-4708-8a3e-5f8950ce1cca",
"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">a66dacdb-6f2e-4708-8a3e-5f8950ce1cca</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>ccdcb5cf-bc22-4714-b545-b06b4f93e80a</d4p1:guid>
<d4p1:guid>f4b6fb1a-b740-4161-adf7-8eea0f2412a7</d4p1:guid>
</d2p1:BookingTypeIdentities>
<d2p1:ResourceTypeIdentity>774e83fe-21c2-47f3-b29e-df2432fca0ce</d2p1:ResourceTypeIdentity>
</d2p1:SearchResult>
<d2p1:SearchResult>
<Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">a66dacdb-6f2e-4708-8a3e-5f8950ce1cca</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>ccdcb5cf-bc22-4714-b545-b06b4f93e80a</d4p1:guid>
<d4p1:guid>f4b6fb1a-b740-4161-adf7-8eea0f2412a7</d4p1:guid>
</d2p1:BookingTypeIdentities>
<d2p1:ResourceTypeIdentity>774e83fe-21c2-47f3-b29e-df2432fca0ce</d2p1:ResourceTypeIdentity>
</d2p1:SearchResult>
</Results>
<TotalPages>1</TotalPages>
</PaginatedResultsOfSearchResultjuCGl64F>