POST api/Search
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
GlobalSearchResultsName | Description | Type | Additional information |
---|---|---|---|
BookingTypes | PaginatedResultsOfSearchResult |
None. |
|
ResourceGroups | PaginatedResultsOfSearchResult |
None. |
|
Resources | PaginatedResultsOfSearchResult |
None. |
Response Formats
application/json, text/json
Sample:
{ "BookingTypes": { "TotalPages": 1, "CurrentPage": 2, "Results": [ { "ResourceTypeIdentity": "c41f2bdb-8831-443a-8279-46b7f37edb8b", "BookingTypeIdentities": [ "d7074418-ec9b-4244-b7ee-f525d7352575", "259aea2c-df8c-43e9-b13a-f9844f25e3ea" ], "AdminPermissionsOnly": true, "Identity": "868fa33e-a830-4867-96dd-0029fae26ba9", "Name": "sample string 4" }, { "ResourceTypeIdentity": "c41f2bdb-8831-443a-8279-46b7f37edb8b", "BookingTypeIdentities": [ "d7074418-ec9b-4244-b7ee-f525d7352575", "259aea2c-df8c-43e9-b13a-f9844f25e3ea" ], "AdminPermissionsOnly": true, "Identity": "868fa33e-a830-4867-96dd-0029fae26ba9", "Name": "sample string 4" } ], "Count": 3 }, "ResourceGroups": { "TotalPages": 1, "CurrentPage": 2, "Results": [ { "ResourceTypeIdentity": "c41f2bdb-8831-443a-8279-46b7f37edb8b", "BookingTypeIdentities": [ "d7074418-ec9b-4244-b7ee-f525d7352575", "259aea2c-df8c-43e9-b13a-f9844f25e3ea" ], "AdminPermissionsOnly": true, "Identity": "868fa33e-a830-4867-96dd-0029fae26ba9", "Name": "sample string 4" }, { "ResourceTypeIdentity": "c41f2bdb-8831-443a-8279-46b7f37edb8b", "BookingTypeIdentities": [ "d7074418-ec9b-4244-b7ee-f525d7352575", "259aea2c-df8c-43e9-b13a-f9844f25e3ea" ], "AdminPermissionsOnly": true, "Identity": "868fa33e-a830-4867-96dd-0029fae26ba9", "Name": "sample string 4" } ], "Count": 3 }, "Resources": { "TotalPages": 1, "CurrentPage": 2, "Results": [ { "ResourceTypeIdentity": "c41f2bdb-8831-443a-8279-46b7f37edb8b", "BookingTypeIdentities": [ "d7074418-ec9b-4244-b7ee-f525d7352575", "259aea2c-df8c-43e9-b13a-f9844f25e3ea" ], "AdminPermissionsOnly": true, "Identity": "868fa33e-a830-4867-96dd-0029fae26ba9", "Name": "sample string 4" }, { "ResourceTypeIdentity": "c41f2bdb-8831-443a-8279-46b7f37edb8b", "BookingTypeIdentities": [ "d7074418-ec9b-4244-b7ee-f525d7352575", "259aea2c-df8c-43e9-b13a-f9844f25e3ea" ], "AdminPermissionsOnly": true, "Identity": "868fa33e-a830-4867-96dd-0029fae26ba9", "Name": "sample string 4" } ], "Count": 3 } }
application/xml, text/xml
Sample:
<GlobalSearchResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model.ToDoModels"> <BookingTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model"> <d2p1:Count>3</d2p1:Count> <d2p1:CurrentPage>2</d2p1:CurrentPage> <d2p1:Results> <SearchResult> <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">868fa33e-a830-4867-96dd-0029fae26ba9</Identity> <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 4</Name> <AdminPermissionsOnly>true</AdminPermissionsOnly> <BookingTypeIdentities xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:guid>d7074418-ec9b-4244-b7ee-f525d7352575</d5p1:guid> <d5p1:guid>259aea2c-df8c-43e9-b13a-f9844f25e3ea</d5p1:guid> </BookingTypeIdentities> <ResourceTypeIdentity>c41f2bdb-8831-443a-8279-46b7f37edb8b</ResourceTypeIdentity> </SearchResult> <SearchResult> <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">868fa33e-a830-4867-96dd-0029fae26ba9</Identity> <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 4</Name> <AdminPermissionsOnly>true</AdminPermissionsOnly> <BookingTypeIdentities xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:guid>d7074418-ec9b-4244-b7ee-f525d7352575</d5p1:guid> <d5p1:guid>259aea2c-df8c-43e9-b13a-f9844f25e3ea</d5p1:guid> </BookingTypeIdentities> <ResourceTypeIdentity>c41f2bdb-8831-443a-8279-46b7f37edb8b</ResourceTypeIdentity> </SearchResult> </d2p1:Results> <d2p1:TotalPages>1</d2p1:TotalPages> </BookingTypes> <ResourceGroups xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model"> <d2p1:Count>3</d2p1:Count> <d2p1:CurrentPage>2</d2p1:CurrentPage> <d2p1:Results> <SearchResult> <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">868fa33e-a830-4867-96dd-0029fae26ba9</Identity> <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 4</Name> <AdminPermissionsOnly>true</AdminPermissionsOnly> <BookingTypeIdentities xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:guid>d7074418-ec9b-4244-b7ee-f525d7352575</d5p1:guid> <d5p1:guid>259aea2c-df8c-43e9-b13a-f9844f25e3ea</d5p1:guid> </BookingTypeIdentities> <ResourceTypeIdentity>c41f2bdb-8831-443a-8279-46b7f37edb8b</ResourceTypeIdentity> </SearchResult> <SearchResult> <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">868fa33e-a830-4867-96dd-0029fae26ba9</Identity> <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 4</Name> <AdminPermissionsOnly>true</AdminPermissionsOnly> <BookingTypeIdentities xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:guid>d7074418-ec9b-4244-b7ee-f525d7352575</d5p1:guid> <d5p1:guid>259aea2c-df8c-43e9-b13a-f9844f25e3ea</d5p1:guid> </BookingTypeIdentities> <ResourceTypeIdentity>c41f2bdb-8831-443a-8279-46b7f37edb8b</ResourceTypeIdentity> </SearchResult> </d2p1:Results> <d2p1:TotalPages>1</d2p1:TotalPages> </ResourceGroups> <Resources xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model"> <d2p1:Count>3</d2p1:Count> <d2p1:CurrentPage>2</d2p1:CurrentPage> <d2p1:Results> <SearchResult> <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">868fa33e-a830-4867-96dd-0029fae26ba9</Identity> <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 4</Name> <AdminPermissionsOnly>true</AdminPermissionsOnly> <BookingTypeIdentities xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:guid>d7074418-ec9b-4244-b7ee-f525d7352575</d5p1:guid> <d5p1:guid>259aea2c-df8c-43e9-b13a-f9844f25e3ea</d5p1:guid> </BookingTypeIdentities> <ResourceTypeIdentity>c41f2bdb-8831-443a-8279-46b7f37edb8b</ResourceTypeIdentity> </SearchResult> <SearchResult> <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">868fa33e-a830-4867-96dd-0029fae26ba9</Identity> <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 4</Name> <AdminPermissionsOnly>true</AdminPermissionsOnly> <BookingTypeIdentities xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:guid>d7074418-ec9b-4244-b7ee-f525d7352575</d5p1:guid> <d5p1:guid>259aea2c-df8c-43e9-b13a-f9844f25e3ea</d5p1:guid> </BookingTypeIdentities> <ResourceTypeIdentity>c41f2bdb-8831-443a-8279-46b7f37edb8b</ResourceTypeIdentity> </SearchResult> </d2p1:Results> <d2p1:TotalPages>1</d2p1:TotalPages> </Resources> </GlobalSearchResults>