© 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.

Learner Information Domain Overview

The Learner information domain is critical for partners and is split in to a number of sub domains.  Each sub domain effectively requires a separate call.

Learner Indetifiers (New)

This domain contains basic learner identity and is accessed via the securty domain Learner.Indetifier. 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 Learner Browse in a single call. This domain is read only.

Sample Call: <Stem>/V3/LearnerIdentifiers?$filter=OnRollState eq 'Current'

Learner Personal

This domain contains basic personal information and is accessed via the securty domain Learner.Personal. More detailed information on GET is available along with sample output. This domain currently also supports PATCH.

Sample Call: <Stem>/V3/LearnerPersonals

Learner Cultural 

This domain contains information about the cultural background of the learner and is accessed via the securty domain Learner.Cultural. More detailed information is available along with sample output. This information domain contains special category data under GDPR.

Sample Call: <Stem>/V3/LearnerCulturals

Learner Registration

This domain contains basic personal information and is accessed via the securty domain Learner.Cultural. More detailed information is available along with sample output and a sample output with enrolments.

Sample Call: <Stem>/V3/LearnerRegistrations?$expand=Enrolments($expand=EnrolmentStatuses)

NB: Primary Class, House and Year Groups are no longer within this information domain

Learner Groups

This domain contains information about learners and groups and has extened functionality useful to developers. information and is accessed via the securty domain Learner.Groups. More detailed information is available and explains the extended functionality.

Sample Call :  <Stem>/Learner/v3/LearnerGroups

Learner Medical

This domain contains information about the medical background of the learner and is accessed via the securty domain Learner.Medical. More detailed information is available along with sample outputThis information domain contains special category data under GDPR.

Sample Call: <Stem>/V3/LearnerMedicals?$expand=MedicalConditions,MedicalEvents, Disabilities,MedicalProviders,MedicalNotes

Learner Dietary

This domain contains information about the dietary needs and entitlements of the learner and is accessed via the securty domain Learner.Dietary. More detailed information is available along with sample output. This information domain contains special category data under GDPR.

Sample Call: <Stem>/V3LearnerDietarys?$expand=FreeMealEligibilityPeriods, FreeSchoolMilkEligibilityPeriods, MealPatterns, DietaryNeeds

Learner Transport

This domain contains information about how a learner gets to school / who pays for it and is accessed via the securty domain Learner.Transport. More detailed information is available along with sample output.

Sample Call: <Stem>/V3/LearnerTransports

Learner Welfares

This domain contains information about learner welfare and care plans. It is accessed via the securty domain Learner.Welfare. More detailed information is available along with sample outputThis information domain contains special category data under GDPR.

Sample Call: <Stem>/V1/LearnerWelfares?$expand=ChildProtectionPlans,IncareDetails,PersonalEducationPlans

Learner Grants

This domain contains information about learner welfare grants. It is accessed via the securty domain Learner.Grants. More detailed information is available along with sample outputThis information domain contains special category data under GDPR.

Sample Call: <Stem>/V1/LearnerGrants?$expand=ChildProtectionPlans,IncareDetails,PersonalEducationPlans

Learner Contact Details

This domain contains information about the contacts and family of a learner. It is accessed via the securty domain Learner.ContactDetails. More detailed information is available along with sample outputThis information domain contains special category data under GDPR.

Sample Call: <Stem>/V1/LearnerContactDetails?$expand=Addresses,Telephones,Emails,LearnerContactRelationships

Available Calls

<AvailableDomain="Learner">
  <Action verb="GET" version="V3" endpoint="LearnerContactBasics" />
  <Action verb="GET" version="V3" endpoint="LearnerContactBasics({ExternalID})" />
  <Action verb="GET" version="V3" endpoint="LearnerContactBasics/SIMS.Changes(startDate={startDate})" />
  <Action verb="GET" version="V3" endpoint="LearnerContactContactDetails" />
  <Action verb="GET" version="V3" endpoint="LearnerContactContactDetails({ExternalID})" />
  <Action verb="GET" version="V3" endpoint="LearnerContactContactDetails/SIMS.Changes(startDate={startDate})" />
  <Action verb="GET" version="V3" endpoint="LearnerContactDetails" />
  <Action verb="GET" version="V3" endpoint="LearnerContactDetails({ExternalID})" />
  <Action verb="GET" version="V3" endpoint="LearnerContactDetails/SIMS.Changes(startDate={startDate})" />
  <Action verb="GET" version="V3" endpoint="LearnerCulturals" />
  <Action verb="GET" version="V3" endpoint="LearnerCulturals({ExternalID})" />
  <Action verb="GET" version="V3" endpoint="LearnerCulturals/SIMS.Changes(startDate={startDate})" />
  <Action verb="GET" version="V3" endpoint="LearnerDietarys" />
  <Action verb="GET" version="V3" endpoint="LearnerDietarys({ExternalID})" />
  <Action verb="GET" version="V3" endpoint="LearnerDietarys/SIMS.Changes(startDate={startDate})" />
  <Action verb="GET" version="V3" endpoint="LearnerGeneralNotes" />
  <Action verb="GET" version="V3" endpoint="LearnerGeneralNotes({ExternalID})" />
  <Action verb="GET" version="V3" endpoint="LearnerGrants" />
  <Action verb="GET" version="V3" endpoint="LearnerGrants({ExternalID})" />
  <Action verb="GET" version="V3" endpoint="LearnerGrants/SIMS.Changes(startDate={startDate})" />
  <Action verb="GET" version="V3" endpoint="LearnerIdentifiers" />
  <Action verb="GET" version="V3" endpoint="LearnerIdentifiers({ExternalID})" />
  <Action verb="GET" version="V3" endpoint="LearnerIdentifiers/SIMS.Changes(startDate={startDate})" />
  <Action verb="GET" version="V3" endpoint="LearnerLookups" />
  <Action verb="GET" version="V3" endpoint="LearnerLookups(ExternalID={ExternalID},LookupType=SIMS.LookupType'{LookupType}')" />
  <Action verb="GET" version="V3" endpoint="LearnerLookups/SIMS.Changes(startDate={startDate})" />
  <Action verb="GET" version="V3" endpoint="LearnerSENLookups" />
  <Action verb="GET" version="V3" endpoint="LearnerSENLookups(ExternalID={ExternalID},LookupType=SIMS.LookupType'{LookupType}')" />
  <Action verb="GET" version="V3" endpoint="LearnerSENLookups/SIMS.Changes(startDate={startDate})" />
  <Action verb="GET" version="V3" endpoint="LearnerSENs" />
  <Action verb="GET" version="V3" endpoint="LearnerSENs({ExternalID})" />
  <Action verb="GET" version="V3" endpoint="LearnerSENs/SIMS.Changes(startDate={startDate})" />
  <Action verb="PATCH" version="V3" endpoint="LearnerGeneralNotes({ExternalID})/Notes({ExternalID})" />
  <Action verb="POST" version="V3" endpoint="LearnerGeneralNotes({ExternalID})/Notes" />
</AvailableDomain>

Information Domains that are not currently available

  • Learner School Hisitorys
  • LearnerPupilPremiumAwards
  • LearnerContactBasic