GET restapi/sites/countries/{countryCode}/organisations/v1

Get organisations (sites and schools) for a specific country by country code (case insensitive).

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

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

Optional filtering by site type: Itslearning, Parents.

Request Information

URI Parameters

Name	Description	Type	Additional information
countryCode	Country code.	string	Required

Body Parameters

None.

Response Information

Resource Description

List of organisations (sites and schools) for the specified country.

EntityListOfItslearning.RestApi.Entities.AggregatedOrganisation

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

Response Formats

application/json, text/json

Sample:

{
  "EntityArray": [
    {
      "IsFronterUpgradedSite": true,
      "IsParentAppEnabled": true,
      "CustomerId": 3,
      "SiteName": "sample string 4",
      "SchoolName": "sample string 5",
      "HierarchyId": 6,
      "IsSite": true
    },
    {
      "IsFronterUpgradedSite": true,
      "IsParentAppEnabled": true,
      "CustomerId": 3,
      "SiteName": "sample string 4",
      "SchoolName": "sample string 5",
      "HierarchyId": 6,
      "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>
    <AggregatedOrganisation>
      <CustomerId>3</CustomerId>
      <HierarchyId>6</HierarchyId>
      <IsSite>true</IsSite>
      <SchoolName>sample string 5</SchoolName>
      <SiteName>sample string 4</SiteName>
      <IsFronterUpgradedSite>true</IsFronterUpgradedSite>
      <IsParentAppEnabled>true</IsParentAppEnabled>
    </AggregatedOrganisation>
    <AggregatedOrganisation>
      <CustomerId>3</CustomerId>
      <HierarchyId>6</HierarchyId>
      <IsSite>true</IsSite>
      <SchoolName>sample string 5</SchoolName>
      <SiteName>sample string 4</SiteName>
      <IsFronterUpgradedSite>true</IsFronterUpgradedSite>
      <IsParentAppEnabled>true</IsParentAppEnabled>
    </AggregatedOrganisation>
  </EntityArray>
  <PageSize>3</PageSize>
  <Total>1</Total>
</EntityList>