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": "93a3f7ec-c49e-4cf0-b9d2-e41355202ec4",
        "BookingTypeIdentities": [
          "9f6fb16c-a34f-44a4-b238-31f97c064487",
          "9bf57bec-5ea4-40fc-8def-85fc2a09b86e"
        ],
        "AdminPermissionsOnly": true,
        "Identity": "aefcdf56-c3d7-4e83-9f08-0f1e0898a7e6",
        "Name": "sample string 4"
      },
      {
        "ResourceTypeIdentity": "93a3f7ec-c49e-4cf0-b9d2-e41355202ec4",
        "BookingTypeIdentities": [
          "9f6fb16c-a34f-44a4-b238-31f97c064487",
          "9bf57bec-5ea4-40fc-8def-85fc2a09b86e"
        ],
        "AdminPermissionsOnly": true,
        "Identity": "aefcdf56-c3d7-4e83-9f08-0f1e0898a7e6",
        "Name": "sample string 4"
      }
    ],
    "Count": 3
  },
  "ResourceGroups": {
    "TotalPages": 1,
    "CurrentPage": 2,
    "Results": [
      {
        "ResourceTypeIdentity": "93a3f7ec-c49e-4cf0-b9d2-e41355202ec4",
        "BookingTypeIdentities": [
          "9f6fb16c-a34f-44a4-b238-31f97c064487",
          "9bf57bec-5ea4-40fc-8def-85fc2a09b86e"
        ],
        "AdminPermissionsOnly": true,
        "Identity": "aefcdf56-c3d7-4e83-9f08-0f1e0898a7e6",
        "Name": "sample string 4"
      },
      {
        "ResourceTypeIdentity": "93a3f7ec-c49e-4cf0-b9d2-e41355202ec4",
        "BookingTypeIdentities": [
          "9f6fb16c-a34f-44a4-b238-31f97c064487",
          "9bf57bec-5ea4-40fc-8def-85fc2a09b86e"
        ],
        "AdminPermissionsOnly": true,
        "Identity": "aefcdf56-c3d7-4e83-9f08-0f1e0898a7e6",
        "Name": "sample string 4"
      }
    ],
    "Count": 3
  },
  "Resources": {
    "TotalPages": 1,
    "CurrentPage": 2,
    "Results": [
      {
        "ResourceTypeIdentity": "93a3f7ec-c49e-4cf0-b9d2-e41355202ec4",
        "BookingTypeIdentities": [
          "9f6fb16c-a34f-44a4-b238-31f97c064487",
          "9bf57bec-5ea4-40fc-8def-85fc2a09b86e"
        ],
        "AdminPermissionsOnly": true,
        "Identity": "aefcdf56-c3d7-4e83-9f08-0f1e0898a7e6",
        "Name": "sample string 4"
      },
      {
        "ResourceTypeIdentity": "93a3f7ec-c49e-4cf0-b9d2-e41355202ec4",
        "BookingTypeIdentities": [
          "9f6fb16c-a34f-44a4-b238-31f97c064487",
          "9bf57bec-5ea4-40fc-8def-85fc2a09b86e"
        ],
        "AdminPermissionsOnly": true,
        "Identity": "aefcdf56-c3d7-4e83-9f08-0f1e0898a7e6",
        "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">aefcdf56-c3d7-4e83-9f08-0f1e0898a7e6</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>9f6fb16c-a34f-44a4-b238-31f97c064487</d5p1:guid>
          <d5p1:guid>9bf57bec-5ea4-40fc-8def-85fc2a09b86e</d5p1:guid>
        </BookingTypeIdentities>
        <ResourceTypeIdentity>93a3f7ec-c49e-4cf0-b9d2-e41355202ec4</ResourceTypeIdentity>
      </SearchResult>
      <SearchResult>
        <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">aefcdf56-c3d7-4e83-9f08-0f1e0898a7e6</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>9f6fb16c-a34f-44a4-b238-31f97c064487</d5p1:guid>
          <d5p1:guid>9bf57bec-5ea4-40fc-8def-85fc2a09b86e</d5p1:guid>
        </BookingTypeIdentities>
        <ResourceTypeIdentity>93a3f7ec-c49e-4cf0-b9d2-e41355202ec4</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">aefcdf56-c3d7-4e83-9f08-0f1e0898a7e6</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>9f6fb16c-a34f-44a4-b238-31f97c064487</d5p1:guid>
          <d5p1:guid>9bf57bec-5ea4-40fc-8def-85fc2a09b86e</d5p1:guid>
        </BookingTypeIdentities>
        <ResourceTypeIdentity>93a3f7ec-c49e-4cf0-b9d2-e41355202ec4</ResourceTypeIdentity>
      </SearchResult>
      <SearchResult>
        <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">aefcdf56-c3d7-4e83-9f08-0f1e0898a7e6</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>9f6fb16c-a34f-44a4-b238-31f97c064487</d5p1:guid>
          <d5p1:guid>9bf57bec-5ea4-40fc-8def-85fc2a09b86e</d5p1:guid>
        </BookingTypeIdentities>
        <ResourceTypeIdentity>93a3f7ec-c49e-4cf0-b9d2-e41355202ec4</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">aefcdf56-c3d7-4e83-9f08-0f1e0898a7e6</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>9f6fb16c-a34f-44a4-b238-31f97c064487</d5p1:guid>
          <d5p1:guid>9bf57bec-5ea4-40fc-8def-85fc2a09b86e</d5p1:guid>
        </BookingTypeIdentities>
        <ResourceTypeIdentity>93a3f7ec-c49e-4cf0-b9d2-e41355202ec4</ResourceTypeIdentity>
      </SearchResult>
      <SearchResult>
        <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">aefcdf56-c3d7-4e83-9f08-0f1e0898a7e6</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>9f6fb16c-a34f-44a4-b238-31f97c064487</d5p1:guid>
          <d5p1:guid>9bf57bec-5ea4-40fc-8def-85fc2a09b86e</d5p1:guid>
        </BookingTypeIdentities>
        <ResourceTypeIdentity>93a3f7ec-c49e-4cf0-b9d2-e41355202ec4</ResourceTypeIdentity>
      </SearchResult>
    </d2p1:Results>
    <d2p1:TotalPages>1</d2p1:TotalPages>
  </Resources>
</GlobalSearchResults>