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

Assessment Information Domain Overview

Warning - Work in Progress

The Assessment information domain is used to obtain exchange assessment data with SIMS.  Each sub domain effectively requires a separate call.

Please ensure that all calls to this information domain are sensibly scoped and is fit for purpose.  For example, use change tracking if you need a complete picture or make use of real time API calls for an individual when needed.

Aspect 

This sub domain contains details of assessment mark definitions via the security domain Assessment. More detailed information is available along with sample output. Supports GET, POST and BATCH.

Sample Call:
<Stem>/Assessment/V3/AssessmentAspects

Grade Set

This sub domain provides the sets and boundaries for Aspect Results.

Sample Call:
<Stem>/Assessment/V3/AssessmentGradeSets

Assessment Period

Assessment period replaces 'Result Set' from SIMS 7 and defines a period of time where marks are collected. Unlike SIMS 7 all results must have an assessment period attached.

Sample Call:
<Stem>/Assessment/V3/AssessmentPeriods

Assessment Result

Assessment result collection within the MIS is one of the key groups of data about a learner's academic progress.

Sample Call:
<Stem>/Assessment/V3/AssessmentResuts

Assessment Lookups

Lookups will be needed to interpret and/or add/update assessment artefacts.  More details are available as is a full export example.

Technical Integrators will need to extract these to get the ID of an AM / PM session in order to be able to write a mark to SIMS.

Sample Call:
<Stem>/Assessment/V3/AssessmentLookups

Marksheets / Progress Grids and Templates

As per SIMS 7 the intention is to share these via standard mechanisms rather than via APIs.  More details will follow when available.

Available Calls

<Whitelist domain="Assessment">
  <Action verb="DELETE" version="V3" endpoint="AssessmentAspects({ExternalID})" />
  <Action verb="DELETE" version="V3" endpoint="AssessmentGradeSets({ExternalID})" />
  <Action verb="DELETE" version="V3" endpoint="AssessmentGradeSets(ExternalID}/GradeSetInstances({ExternalID})" />
  <Action verb="DELETE" version="V3" endpoint="AssessmentGradeSets(ExternalID}/GradeSetInstances({ExternalID})/Grades" />
  <Action verb="DELETE" version="V3" endpoint="AssessmentResults({ExternalID})" />
  <Action verb="GET" version="V3" endpoint="AssessmentAspects" />
  <Action verb="GET" version="V3" endpoint="AssessmentAspects({ExternalID})" />
  <Action verb="GET" version="V3" endpoint="AssessmentAspects/SIMS.Changes(startDate={startDate})" />
  <Action verb="GET" version="V3" endpoint="AssessmentGradeSets" />
  <Action verb="GET" version="V3" endpoint="AssessmentGradeSets({ExternalID})" />
  <Action verb="GET" version="V3" endpoint="AssessmentGradeSets/SIMS.Changes(startDate={startDate})" />
  <Action verb="GET" version="V3" endpoint="AssessmentLookups" />
  <Action verb="GET" version="V3" endpoint="AssessmentLookups(ExternalID={ExternalID},LookupType=SIMS.LookupType'{LookupType}')" />
  <Action verb="GET" version="V3" endpoint="AssessmentResults" />
  <Action verb="GET" version="V3" endpoint="AssessmentResults({ExternalID})" />
  <Action verb="GET" version="V3" endpoint="AssessmentResults/SIMS.Changes(startDate={startDate})" />
  <Action verb="PATCH" version="V3" endpoint="AssessmentAspects({ExternalID})" />
  <Action verb="PATCH" version="V3" endpoint="AssessmentGradeSets({ExternalID})" />
  <Action verb="PATCH" version="V3" endpoint="AssessmentGradeSets(ExternalID}/GradeSetInstances({ExternalID})" />
  <Action verb="PATCH" version="V3" endpoint="AssessmentGradeSets(ExternalID}/GradeSetInstances({ExternalID})/Grades" />
  <Action verb="PATCH" version="V3" endpoint="AssessmentResults({ExternalID})" />
  <Action verb="POST" version="V3" endpoint="AssessmentAspects" />
  <Action verb="POST" version="V3" endpoint="AssessmentGradeSets" />
  <Action verb="POST" version="V3" endpoint="AssessmentGradeSets({ExternalID})/GradeSetInstances" />
  <Action verb="POST" version="V3" endpoint="AssessmentGradeSets({ExternalID})/GradeSetInstances({ExternalID})/Grades" />
  <Action verb="POST" version="V3" endpoint="AssessmentResults" />
</Whitelist>

Information Domains that are not currently available

  •  Information domain will be available shortly.