POST api/Search/Filter

Request Information

URI Parameters

None.

Body Parameters

FilterRequest
NameDescriptionTypeAdditional 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
NameDescriptionTypeAdditional 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": "0dca6110-eaf9-4c63-93d7-6ef65a079f2d",
      "BookingTypeIdentities": [
        "7ec6b205-8dbe-43e0-94b6-6892154e1111",
        "9c4ad4f5-aad9-421a-9f0a-fd26a4319f0d"
      ],
      "Identity": "9d86b9de-2f4a-4cac-a77e-eb99affd3cfc",
      "Name": "sample string 3"
    },
    {
      "ResourceTypeIdentity": "0dca6110-eaf9-4c63-93d7-6ef65a079f2d",
      "BookingTypeIdentities": [
        "7ec6b205-8dbe-43e0-94b6-6892154e1111",
        "9c4ad4f5-aad9-421a-9f0a-fd26a4319f0d"
      ],
      "Identity": "9d86b9de-2f4a-4cac-a77e-eb99affd3cfc",
      "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">9d86b9de-2f4a-4cac-a77e-eb99affd3cfc</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>7ec6b205-8dbe-43e0-94b6-6892154e1111</d4p1:guid>
        <d4p1:guid>9c4ad4f5-aad9-421a-9f0a-fd26a4319f0d</d4p1:guid>
      </d2p1:BookingTypeIdentities>
      <d2p1:ResourceTypeIdentity>0dca6110-eaf9-4c63-93d7-6ef65a079f2d</d2p1:ResourceTypeIdentity>
    </d2p1:SearchResult>
    <d2p1:SearchResult>
      <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">9d86b9de-2f4a-4cac-a77e-eb99affd3cfc</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>7ec6b205-8dbe-43e0-94b6-6892154e1111</d4p1:guid>
        <d4p1:guid>9c4ad4f5-aad9-421a-9f0a-fd26a4319f0d</d4p1:guid>
      </d2p1:BookingTypeIdentities>
      <d2p1:ResourceTypeIdentity>0dca6110-eaf9-4c63-93d7-6ef65a079f2d</d2p1:ResourceTypeIdentity>
    </d2p1:SearchResult>
  </Results>
  <TotalPages>1</TotalPages>
</PaginatedResultsOfSearchResultjuCGl64F>