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

Staff Information Domain Overview

The Staff information domain is critical for many partners and is split into a number of sub domains.  Each sub domain effectively requires a separate call.

Staff Identifiers 

Not currently available - due for publication by 1/5/2020

This domain contains basic learner identity and is accessed via the security domain Staff.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 Staff Browse in a single call.

Sample Call: <Stem>/Staff/V3/StaffIdentifiers?$filter=CurrentStatus eq 'Current'

Staff Personal Basics

This domain contains basic personal information and is accessed via the security domain Staff.Personal.Basic. More detailed information is available along with sample output.

Sample Call: <Stem>Staff/V3/StaffPersonalBasics

Staff Personal Extended

This domain contains basic personal information and is accessed via the security domain Staff.Personal.Extended. More detailed information is available along with sample output.

Sample Call: <Stem>Staff/V3/StaffPersonalExtendeds

Staff Cultural 

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

Sample Call: <Stem>Staff/V3/StaffCulturals

Staff Lookups

This domain contains information about the cultural background of the learner and is accessed via the security domain Staff.Lookups. More detailed information is available along with sample output. Please note that lookups are held together in a generic model.  Technical integrators (TI) are recommended to look at the sample output above to identify which ones are of importance.  Filters can be applied to get specific lookups which may or may not be applicable to the TI's needs.

Sample Call: <Stem>Staff/V3/StaffLookups

Staff Medical

This domain contains information about the medical records of the staff member and is accessed via the security domain Staff.Medical. More detailed information is available along with sample output. This information domain contains special category data under GDPR.

Sample Call: <Stem>Staff/V3/StaffMedicals

Available Calls

<Domain domain="Staff">
  <Action verb="GET" version="V3" endpoint="StaffCulturals" />
  <Action verb="GET" version="V3" endpoint="StaffCulturals({ExternalID})" />
  <Action verb="GET" version="V3" endpoint="StaffCulturals/SIMS.Changes(startDate={startDate})" />
  <Action verb="GET" version="V3" endpoint="StaffLookups" />
  <Action verb="GET" version="V3" endpoint="StaffLookups(ExternalID={ExternalID},LookupType=SIMS.LookupType'{LookupType}')" />
  <Action verb="GET" version="V3" endpoint="StaffLookups/SIMS.Changes(startDate={startDate})" />
  <Action verb="GET" version="V3" endpoint="StaffMedicals" />
  <Action verb="GET" version="V3" endpoint="StaffMedicals({ExternalID})" />
  <Action verb="GET" version="V3" endpoint="StaffMedicals/SIMS.Changes(startDate={startDate})" />
  <Action verb="GET" version="V3" endpoint="StaffPersonalBasics" />
  <Action verb="GET" version="V3" endpoint="StaffPersonalBasics({ExternalID})" />
  <Action verb="GET" version="V3" endpoint="StaffPersonalBasics/SIMS.Changes(startDate={startDate})" />
  <Action verb="GET" version="V3" endpoint="StaffPersonalExtendeds" />
  <Action verb="GET" version="V3" endpoint="StaffPersonalExtendeds({ExternalID})" />
  <Action verb="GET" version="V3" endpoint="StaffPersonalExtendeds/SIMS.Changes(startDate={startDate})" />
  <Action verb="GET" version="V3" endpoint="StaffProfessionals" />
  <Action verb="GET" version="V3" endpoint="StaffProfessionals({ExternalID})" />
  <Action verb="GET" version="V3" endpoint="StaffProfessionals/SIMS.Changes(startDate={startDate})" />
  <Action verb="GET" version="V3" endpoint="StaffServiceExtendeds" />
  <Action verb="GET" version="V3" endpoint="StaffServiceExtendeds({ExternalID})" />
  <Action verb="GET" version="V3" endpoint="StaffServiceExtendeds/SIMS.Changes(startDate={startDate})" />
  <Action verb="GET" version="V3" endpoint="StaffServices" />
  <Action verb="GET" version="V3" endpoint="StaffServices({ExternalID})" />
  <Action verb="GET" version="V3" endpoint="StaffServices/SIMS.Changes(startDate={startDate})" />
  <Action verb="PATCH" version="V3" endpoint="StaffCulturals({ExternalID})" />
  <Action verb="PATCH" version="V3" endpoint="StaffLookups(ExternalID={ExternalID},LookupType=SIMS.LookupType'{LookupType}')" />
  <Action verb="PATCH" version="V3" endpoint="StaffMedicals({ExternalID})" />
  <Action verb="PATCH" version="V3" endpoint="StaffPersonalBasics({ExternalID})" />
  <Action verb="PATCH" version="V3" endpoint="StaffPersonalExtendeds({ExternalID})" />
  <Action verb="PATCH" version="V3" endpoint="StaffProfessionals({ExternalID})" />
  <Action verb="PATCH" version="V3" endpoint="StaffServiceExtendeds({ExternalID})" />
  <Action verb="PATCH" version="V3" endpoint="StaffServices({ExternalID})" />
</Domain>

Information Domains that are not currently available

  • <TBA>