POST api/Search/Filter

Request Information

URI Parameters

None.

Body Parameters

Name	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

PaginatedResultsOfSearchResult

Name	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": "416fcd7b-a88b-49e0-9524-b862da61f797",
      "BookingTypeIdentities": [
        "577b838f-af48-46b1-b74c-35a0d588e2d5",
        "214dcd37-5026-4854-ab00-b82466f6eca2"
      ],
      "AdminPermissionsOnly": true,
      "Identity": "784c2844-cd83-4c7b-9dbc-a88b39b11326",
      "Name": "sample string 4"
    },
    {
      "ResourceTypeIdentity": "416fcd7b-a88b-49e0-9524-b862da61f797",
      "BookingTypeIdentities": [
        "577b838f-af48-46b1-b74c-35a0d588e2d5",
        "214dcd37-5026-4854-ab00-b82466f6eca2"
      ],
      "AdminPermissionsOnly": true,
      "Identity": "784c2844-cd83-4c7b-9dbc-a88b39b11326",
      "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">784c2844-cd83-4c7b-9dbc-a88b39b11326</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>577b838f-af48-46b1-b74c-35a0d588e2d5</d4p1:guid>
        <d4p1:guid>214dcd37-5026-4854-ab00-b82466f6eca2</d4p1:guid>
      </d2p1:BookingTypeIdentities>
      <d2p1:ResourceTypeIdentity>416fcd7b-a88b-49e0-9524-b862da61f797</d2p1:ResourceTypeIdentity>
    </d2p1:SearchResult>
    <d2p1:SearchResult>
      <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">784c2844-cd83-4c7b-9dbc-a88b39b11326</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>577b838f-af48-46b1-b74c-35a0d588e2d5</d4p1:guid>
        <d4p1:guid>214dcd37-5026-4854-ab00-b82466f6eca2</d4p1:guid>
      </d2p1:BookingTypeIdentities>
      <d2p1:ResourceTypeIdentity>416fcd7b-a88b-49e0-9524-b862da61f797</d2p1:ResourceTypeIdentity>
    </d2p1:SearchResult>
  </Results>
  <TotalPages>1</TotalPages>
</PaginatedResultsOfSearchResultjuCGl64F>