POST api/Search
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. |
|
| 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
GlobalSearchResults| Name | 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": "1ef5ca40-719d-4bbf-b5a1-98dcd0abeb99",
"BookingTypeIdentities": [
"28f5f066-8070-4246-99cb-ee8c0fd423b7",
"ae451861-053c-4339-8437-c04bbc7a226e"
],
"AdminPermissionsOnly": true,
"Identity": "2f39e06f-5b2f-4cce-8921-7b1c8e730b18",
"Name": "sample string 4"
},
{
"ResourceTypeIdentity": "1ef5ca40-719d-4bbf-b5a1-98dcd0abeb99",
"BookingTypeIdentities": [
"28f5f066-8070-4246-99cb-ee8c0fd423b7",
"ae451861-053c-4339-8437-c04bbc7a226e"
],
"AdminPermissionsOnly": true,
"Identity": "2f39e06f-5b2f-4cce-8921-7b1c8e730b18",
"Name": "sample string 4"
}
],
"Count": 3
},
"ResourceGroups": {
"TotalPages": 1,
"CurrentPage": 2,
"Results": [
{
"ResourceTypeIdentity": "1ef5ca40-719d-4bbf-b5a1-98dcd0abeb99",
"BookingTypeIdentities": [
"28f5f066-8070-4246-99cb-ee8c0fd423b7",
"ae451861-053c-4339-8437-c04bbc7a226e"
],
"AdminPermissionsOnly": true,
"Identity": "2f39e06f-5b2f-4cce-8921-7b1c8e730b18",
"Name": "sample string 4"
},
{
"ResourceTypeIdentity": "1ef5ca40-719d-4bbf-b5a1-98dcd0abeb99",
"BookingTypeIdentities": [
"28f5f066-8070-4246-99cb-ee8c0fd423b7",
"ae451861-053c-4339-8437-c04bbc7a226e"
],
"AdminPermissionsOnly": true,
"Identity": "2f39e06f-5b2f-4cce-8921-7b1c8e730b18",
"Name": "sample string 4"
}
],
"Count": 3
},
"Resources": {
"TotalPages": 1,
"CurrentPage": 2,
"Results": [
{
"ResourceTypeIdentity": "1ef5ca40-719d-4bbf-b5a1-98dcd0abeb99",
"BookingTypeIdentities": [
"28f5f066-8070-4246-99cb-ee8c0fd423b7",
"ae451861-053c-4339-8437-c04bbc7a226e"
],
"AdminPermissionsOnly": true,
"Identity": "2f39e06f-5b2f-4cce-8921-7b1c8e730b18",
"Name": "sample string 4"
},
{
"ResourceTypeIdentity": "1ef5ca40-719d-4bbf-b5a1-98dcd0abeb99",
"BookingTypeIdentities": [
"28f5f066-8070-4246-99cb-ee8c0fd423b7",
"ae451861-053c-4339-8437-c04bbc7a226e"
],
"AdminPermissionsOnly": true,
"Identity": "2f39e06f-5b2f-4cce-8921-7b1c8e730b18",
"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">2f39e06f-5b2f-4cce-8921-7b1c8e730b18</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>28f5f066-8070-4246-99cb-ee8c0fd423b7</d5p1:guid>
<d5p1:guid>ae451861-053c-4339-8437-c04bbc7a226e</d5p1:guid>
</BookingTypeIdentities>
<ResourceTypeIdentity>1ef5ca40-719d-4bbf-b5a1-98dcd0abeb99</ResourceTypeIdentity>
</SearchResult>
<SearchResult>
<Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">2f39e06f-5b2f-4cce-8921-7b1c8e730b18</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>28f5f066-8070-4246-99cb-ee8c0fd423b7</d5p1:guid>
<d5p1:guid>ae451861-053c-4339-8437-c04bbc7a226e</d5p1:guid>
</BookingTypeIdentities>
<ResourceTypeIdentity>1ef5ca40-719d-4bbf-b5a1-98dcd0abeb99</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">2f39e06f-5b2f-4cce-8921-7b1c8e730b18</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>28f5f066-8070-4246-99cb-ee8c0fd423b7</d5p1:guid>
<d5p1:guid>ae451861-053c-4339-8437-c04bbc7a226e</d5p1:guid>
</BookingTypeIdentities>
<ResourceTypeIdentity>1ef5ca40-719d-4bbf-b5a1-98dcd0abeb99</ResourceTypeIdentity>
</SearchResult>
<SearchResult>
<Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">2f39e06f-5b2f-4cce-8921-7b1c8e730b18</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>28f5f066-8070-4246-99cb-ee8c0fd423b7</d5p1:guid>
<d5p1:guid>ae451861-053c-4339-8437-c04bbc7a226e</d5p1:guid>
</BookingTypeIdentities>
<ResourceTypeIdentity>1ef5ca40-719d-4bbf-b5a1-98dcd0abeb99</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">2f39e06f-5b2f-4cce-8921-7b1c8e730b18</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>28f5f066-8070-4246-99cb-ee8c0fd423b7</d5p1:guid>
<d5p1:guid>ae451861-053c-4339-8437-c04bbc7a226e</d5p1:guid>
</BookingTypeIdentities>
<ResourceTypeIdentity>1ef5ca40-719d-4bbf-b5a1-98dcd0abeb99</ResourceTypeIdentity>
</SearchResult>
<SearchResult>
<Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">2f39e06f-5b2f-4cce-8921-7b1c8e730b18</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>28f5f066-8070-4246-99cb-ee8c0fd423b7</d5p1:guid>
<d5p1:guid>ae451861-053c-4339-8437-c04bbc7a226e</d5p1:guid>
</BookingTypeIdentities>
<ResourceTypeIdentity>1ef5ca40-719d-4bbf-b5a1-98dcd0abeb99</ResourceTypeIdentity>
</SearchResult>
</d2p1:Results>
<d2p1:TotalPages>1</d2p1:TotalPages>
</Resources>
</GlobalSearchResults>