POST api/Search

Request Information

URI Parameters

None.

Body Parameters

FilterRequest
NameDescriptionTypeAdditional 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
NameDescriptionTypeAdditional information
BookingTypes

PaginatedResultsOfSearchResult

None.

ResourceGroups

PaginatedResultsOfSearchResult

None.

Resources

PaginatedResultsOfSearchResult

None.

Response Formats

application/json, text/json

Sample:
{
  "BookingTypes": {
    "TotalPages": 1,
    "CurrentPage": 2,
    "Results": [
      {
        "ResourceTypeIdentity": "a6a2bfb7-19f0-48e4-8f6a-8fa98d91231b",
        "BookingTypeIdentities": [
          "e1fb1530-b23c-4222-93d0-2d028f2a5b41",
          "1ce95b88-a98e-42a9-a219-583519c6c942"
        ],
        "AdminPermissionsOnly": true,
        "Identity": "f3297155-c3d7-43de-bc18-8d5cd77c4b5f",
        "Name": "sample string 4"
      },
      {
        "ResourceTypeIdentity": "a6a2bfb7-19f0-48e4-8f6a-8fa98d91231b",
        "BookingTypeIdentities": [
          "e1fb1530-b23c-4222-93d0-2d028f2a5b41",
          "1ce95b88-a98e-42a9-a219-583519c6c942"
        ],
        "AdminPermissionsOnly": true,
        "Identity": "f3297155-c3d7-43de-bc18-8d5cd77c4b5f",
        "Name": "sample string 4"
      }
    ],
    "Count": 3
  },
  "ResourceGroups": {
    "TotalPages": 1,
    "CurrentPage": 2,
    "Results": [
      {
        "ResourceTypeIdentity": "a6a2bfb7-19f0-48e4-8f6a-8fa98d91231b",
        "BookingTypeIdentities": [
          "e1fb1530-b23c-4222-93d0-2d028f2a5b41",
          "1ce95b88-a98e-42a9-a219-583519c6c942"
        ],
        "AdminPermissionsOnly": true,
        "Identity": "f3297155-c3d7-43de-bc18-8d5cd77c4b5f",
        "Name": "sample string 4"
      },
      {
        "ResourceTypeIdentity": "a6a2bfb7-19f0-48e4-8f6a-8fa98d91231b",
        "BookingTypeIdentities": [
          "e1fb1530-b23c-4222-93d0-2d028f2a5b41",
          "1ce95b88-a98e-42a9-a219-583519c6c942"
        ],
        "AdminPermissionsOnly": true,
        "Identity": "f3297155-c3d7-43de-bc18-8d5cd77c4b5f",
        "Name": "sample string 4"
      }
    ],
    "Count": 3
  },
  "Resources": {
    "TotalPages": 1,
    "CurrentPage": 2,
    "Results": [
      {
        "ResourceTypeIdentity": "a6a2bfb7-19f0-48e4-8f6a-8fa98d91231b",
        "BookingTypeIdentities": [
          "e1fb1530-b23c-4222-93d0-2d028f2a5b41",
          "1ce95b88-a98e-42a9-a219-583519c6c942"
        ],
        "AdminPermissionsOnly": true,
        "Identity": "f3297155-c3d7-43de-bc18-8d5cd77c4b5f",
        "Name": "sample string 4"
      },
      {
        "ResourceTypeIdentity": "a6a2bfb7-19f0-48e4-8f6a-8fa98d91231b",
        "BookingTypeIdentities": [
          "e1fb1530-b23c-4222-93d0-2d028f2a5b41",
          "1ce95b88-a98e-42a9-a219-583519c6c942"
        ],
        "AdminPermissionsOnly": true,
        "Identity": "f3297155-c3d7-43de-bc18-8d5cd77c4b5f",
        "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">f3297155-c3d7-43de-bc18-8d5cd77c4b5f</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>e1fb1530-b23c-4222-93d0-2d028f2a5b41</d5p1:guid>
          <d5p1:guid>1ce95b88-a98e-42a9-a219-583519c6c942</d5p1:guid>
        </BookingTypeIdentities>
        <ResourceTypeIdentity>a6a2bfb7-19f0-48e4-8f6a-8fa98d91231b</ResourceTypeIdentity>
      </SearchResult>
      <SearchResult>
        <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">f3297155-c3d7-43de-bc18-8d5cd77c4b5f</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>e1fb1530-b23c-4222-93d0-2d028f2a5b41</d5p1:guid>
          <d5p1:guid>1ce95b88-a98e-42a9-a219-583519c6c942</d5p1:guid>
        </BookingTypeIdentities>
        <ResourceTypeIdentity>a6a2bfb7-19f0-48e4-8f6a-8fa98d91231b</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">f3297155-c3d7-43de-bc18-8d5cd77c4b5f</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>e1fb1530-b23c-4222-93d0-2d028f2a5b41</d5p1:guid>
          <d5p1:guid>1ce95b88-a98e-42a9-a219-583519c6c942</d5p1:guid>
        </BookingTypeIdentities>
        <ResourceTypeIdentity>a6a2bfb7-19f0-48e4-8f6a-8fa98d91231b</ResourceTypeIdentity>
      </SearchResult>
      <SearchResult>
        <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">f3297155-c3d7-43de-bc18-8d5cd77c4b5f</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>e1fb1530-b23c-4222-93d0-2d028f2a5b41</d5p1:guid>
          <d5p1:guid>1ce95b88-a98e-42a9-a219-583519c6c942</d5p1:guid>
        </BookingTypeIdentities>
        <ResourceTypeIdentity>a6a2bfb7-19f0-48e4-8f6a-8fa98d91231b</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">f3297155-c3d7-43de-bc18-8d5cd77c4b5f</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>e1fb1530-b23c-4222-93d0-2d028f2a5b41</d5p1:guid>
          <d5p1:guid>1ce95b88-a98e-42a9-a219-583519c6c942</d5p1:guid>
        </BookingTypeIdentities>
        <ResourceTypeIdentity>a6a2bfb7-19f0-48e4-8f6a-8fa98d91231b</ResourceTypeIdentity>
      </SearchResult>
      <SearchResult>
        <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">f3297155-c3d7-43de-bc18-8d5cd77c4b5f</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>e1fb1530-b23c-4222-93d0-2d028f2a5b41</d5p1:guid>
          <d5p1:guid>1ce95b88-a98e-42a9-a219-583519c6c942</d5p1:guid>
        </BookingTypeIdentities>
        <ResourceTypeIdentity>a6a2bfb7-19f0-48e4-8f6a-8fa98d91231b</ResourceTypeIdentity>
      </SearchResult>
    </d2p1:Results>
    <d2p1:TotalPages>1</d2p1:TotalPages>
  </Resources>
</GlobalSearchResults>