© 2018 Capita Business Services Ltd. All rights reserved.

Capita Education Software Solutions is a trading name of Capita Business Services Ltd. Our Registered office is 30 Berners Street, London, W1T 3LR and our registered number is 02299747. Further information about Capita plc can be found in our legal statement.

EducationEstablishment Domain Overview

Warning - Work in Progress

The Education Establishment information domain is used to obtain details of the current school and schools linked to the current school. The obvious example of this is rooms.  Each sub domain effectively requires a separate call.

Rooms (New)

This domain contains details of education establishments via the security domain EducationEstablishment. More detailed information is available along with sample output. This is one of the most important additions to the API list because it provides the data needed for a Staff Browse in a single call.

Sample Call:
<Stem>/EducationEstablishment/V3/Rooms

 

{
  "@odata.context": "https://sepr00apm01.azure-api.net/sspr01/School/V3/$metadata#Rooms",
  "value": [
    {
      "ExternalID": "771ecd29-7994-47f9-a1b5-03552ed5ccb1",
      "ShortName": "HO",
      "Name": "Headteacher's Office",
      "TelephoneNumber": null,
      "MaximumGroupSize": 0,
      "IsActive": false,
      "Area": 0,
      "Notes": [],
      "RoomMainUser": null,
      "RoomLocation": {
        "ExternalID": "af14c097-708c-48db-bcb8-9192df6fa2d3",
        "Type": "EducationalEstablishment.Site"
      }
    },

EducationalEstablishments  (New)

Educational Establishment replaces 'School' in V2 APIs.

This call returns details of all schools linked to the home school and the home school.

Sample Call:
<Stem>/EducationalEstablishment/V3/EducationalEstablishments


  "@odata.context": "https://sepr00apm01.azure-api.net/sspr01/School/V3/$metadata#EducationalEstablishments",
  "value": [
    {
      "ExternalID": "0725da95-6bcc-44b3-95b6-08327f2638e3",
      "Name": "Fairfields Secondary School",
      "PreferredName": null,
      "TelephoneNumber": null,
      "EmailAddress": null,
      "FaxNumber": null,
      "Website": null,
      "Logo": null,
      "OrganisationID": null,
      "Address": {
        "Apartment": null,
        "BuildingNumber": "200",
        "BuildingName": null,
        "Street": "Pool Road",
        "District": null,
        "Town": "Uppercrust",
        "AdministrativeArea": null,
        "Postcode": "SI16 3AH",
        "CoordinateX": null,
        "CoordinateY": null,
        "USRN": null,
        "UPRN": null,
        "AddressIdentifier": null,
        "LastValidated": null,
        "ExternalID": "32016290-ec36-4843-b3d3-ae7cd64db957",
        "Country": {
          "ExternalID": "384d25e0-14a9-4e34-8917-e12b07c602d5",
          "Type": "EducationalEstablishment.Lookup.Country"
        },
        "ResourceProvider": {
          "ExternalID": "2c445c23-d690-4267-909e-592a6e9940fe",
          "Type": "EducationalEstablishment"
        }
      },