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

DeX OData - Data availability for SIMS 7

Read-only data is available to retrieve using the DeX OData API endpoints against a SIMS 7 school running the appropriate Data Transfer SSM package. The data returned is compatible, and can be used interchangeably, with data retrieved from a SIMS Primary school using the v3 API. 

 

Data Domains

DeX for SIMS 7
% availability
(H1 2021)
Proposed availability
(end 2021)
subject to change
  Read Write Read Write
Admissions X X X X
Applicant X X X X
Contacts X X
Agency X X X X
Assessment X X X X
Attendance 75% X X
Conduct 75% X X
Curriculum X X X X
Establishment (school) 50% X 75% X
Learner 80% X 95% X
Meal Management X X X X
Staff 5% X 50% X
School events 70% X 75% X
Pictures/Docs X X X X
UDF X X X X
Other domains X X X X

*Last update Aug 2021

SIMS 7 Domain availability 

School information:

Get basic information about the educational establishment itself, including name address and contact information. Related to this, term dates and other basic useful information about the school.

Learners:

Get basic information about a learner.

Get advanced information about a learner including contact information, medical/cultural/welfare information, SEN and school registration information.

Available Domains:
EducationalEstablishment
SchoolEvents
Available Domains:
Learner


Learners contacts (parents):

Get the learners contacts basic information. Get their relationship and contact information such as address, email and phone numbers.

Conduct:

Get achievement and behaviour events.

Available Domains: 
LearnerContacts
Available Domains: 
ConductBehaviour 
ConductAchievement

Statutory attendance:

Get statutory session attendance records for learners

Staff information :

Get basic staff information such as name

Available Domains: 
Attendance

Available Domains: 
StaffIdentifier

Group memberships:

Get lists of students in each group. See enrolled and historic learners.

Groups such as Primary Class, Year Group, House, NC Year

 

Available Domains:
PastoralGroup
 

Use the Group endpoints on other domains to pull subsets of data i.e. GetByGroup

 

 

Additional Endpoint availability

Use GetChanges to see data areas that have been updated
Applicable Domains : Learner

Make Batch calls to improve performance

 

 

ESS DeX OData Based APIs RESOURCES

Related resources for ESS DeX OData Based APIs

ESS DEX OData Formal Documentation

API manager based formal API documentation for the DEX OData endpoints. This should be used in conjunction with the information that describes data availability from SIMS 7 and SIMS 8

Explore

DeX OData - General Guidance Topics

Links to formal documentation / overviews / throttling

Explore

DeX OData - Learner Service

All information domains linked to a learner

Explore