POST api/Search/Filter
Request Information
URI Parameters
None.
Body Parameters
FilterRequestName | Description | Type | Additional information |
---|---|---|---|
Query | string |
None. |
|
ItemsPerPage | integer |
None. |
|
PageNumber | integer |
None. |
|
FilterType | string |
None. |
|
AdminPermissionsOnly | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "Query": "sample string 1", "ItemsPerPage": 2, "PageNumber": 3, "FilterType": "sample string 4", "AdminPermissionsOnly": true }
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"> <AdminPermissionsOnly>true</AdminPermissionsOnly> <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
PaginatedResultsOfSearchResultName | 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": "c7ee4a9d-75a1-41b8-82e6-865d791077c1", "BookingTypeIdentities": [ "e99d72a9-ff00-4de5-a633-034c7252bc72", "3108b38a-8156-482e-96bd-ce4270f97ed5" ], "AdminPermissionsOnly": true, "Identity": "57fa2b80-8428-47c4-96ec-ede3cdfe6c58", "Name": "sample string 4" }, { "ResourceTypeIdentity": "c7ee4a9d-75a1-41b8-82e6-865d791077c1", "BookingTypeIdentities": [ "e99d72a9-ff00-4de5-a633-034c7252bc72", "3108b38a-8156-482e-96bd-ce4270f97ed5" ], "AdminPermissionsOnly": true, "Identity": "57fa2b80-8428-47c4-96ec-ede3cdfe6c58", "Name": "sample string 4" } ], "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">57fa2b80-8428-47c4-96ec-ede3cdfe6c58</Identity> <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 4</Name> <d2p1:AdminPermissionsOnly>true</d2p1:AdminPermissionsOnly> <d2p1:BookingTypeIdentities xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:guid>e99d72a9-ff00-4de5-a633-034c7252bc72</d4p1:guid> <d4p1:guid>3108b38a-8156-482e-96bd-ce4270f97ed5</d4p1:guid> </d2p1:BookingTypeIdentities> <d2p1:ResourceTypeIdentity>c7ee4a9d-75a1-41b8-82e6-865d791077c1</d2p1:ResourceTypeIdentity> </d2p1:SearchResult> <d2p1:SearchResult> <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">57fa2b80-8428-47c4-96ec-ede3cdfe6c58</Identity> <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 4</Name> <d2p1:AdminPermissionsOnly>true</d2p1:AdminPermissionsOnly> <d2p1:BookingTypeIdentities xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:guid>e99d72a9-ff00-4de5-a633-034c7252bc72</d4p1:guid> <d4p1:guid>3108b38a-8156-482e-96bd-ce4270f97ed5</d4p1:guid> </d2p1:BookingTypeIdentities> <d2p1:ResourceTypeIdentity>c7ee4a9d-75a1-41b8-82e6-865d791077c1</d2p1:ResourceTypeIdentity> </d2p1:SearchResult> </Results> <TotalPages>1</TotalPages> </PaginatedResultsOfSearchResultjuCGl64F>