GET restapi/sites/all/organisations/search/v1?searchText={searchText}&PageIndex={PageIndex}&PageSize={PageSize}&sitesFilter={sitesFilter}

Get organisations (sites and schools).

Optional filtering by names containing words starting with specific phrases (separated by space).

This method does not have security checks - it is open.

Optional filtering by site type: Itslearning, Parents.

Request Information

URI Parameters

Name	Description	Type	Additional information
searchText	E.g. searchText=ber gen, will return all sites where title has at least one word starting with 'ber' and one starting with 'gen'(not case sensitive). Rules of search could be changed.	string	Default value is
PageIndex		integer	None.
PageSize		integer	None.
sitesFilter	[All\|Itslearning\|Parents] filter for sites	Itsolutions.Itslearning.Web.RestApi.Public.Unauthenticated.SitesFilter	Default value is All

Body Parameters

None.

Response Information

Resource Description

EntityListOfItslearning.RestApi.Entities.AggregatedOrganisationLite

Name	Type	Additional information
EntityArray	Collection of Itslearning.RestApi.Entities.AggregatedOrganisationLite	None.
Total	integer	None.
CurrentPageIndex	integer	None.
PageSize	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "EntityArray": [
    {
      "CustomerId": 1,
      "SiteName": "sample string 2",
      "SchoolName": "sample string 3",
      "HierarchyId": 4,
      "IsSite": true
    },
    {
      "CustomerId": 1,
      "SiteName": "sample string 2",
      "SchoolName": "sample string 3",
      "HierarchyId": 4,
      "IsSite": true
    }
  ],
  "Total": 1,
  "CurrentPageIndex": 2,
  "PageSize": 3
}

application/xml, text/xml

Sample:

<EntityList xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CurrentPageIndex>2</CurrentPageIndex>
  <EntityArray>
    <AggregatedOrganisationLite>
      <CustomerId>1</CustomerId>
      <HierarchyId>4</HierarchyId>
      <IsSite>true</IsSite>
      <SchoolName>sample string 3</SchoolName>
      <SiteName>sample string 2</SiteName>
    </AggregatedOrganisationLite>
    <AggregatedOrganisationLite>
      <CustomerId>1</CustomerId>
      <HierarchyId>4</HierarchyId>
      <IsSite>true</IsSite>
      <SchoolName>sample string 3</SchoolName>
      <SiteName>sample string 2</SiteName>
    </AggregatedOrganisationLite>
  </EntityArray>
  <PageSize>3</PageSize>
  <Total>1</Total>
</EntityList>