SIMS 8 - APIs – V3 - Release Notes

We are delighted to provide the following update to partners about SIMS Primary APIs - V3.

As per our Technical Integrator December 2019 Newsletter, the V3 APIs have been made available from 17th January 2020. 

The whitelist of initial V3 APIs is given below.  Further updates including the addition of 'EducationalEstablishment' will follow typically at 2 week interval.  More detailed documentation can be obtained from the link on the right and the formal API documentation (Swagger equivalent) is provided via API Manager at here.

In order to access the new APIs, Technical Integrators will need to obtain a new OCP_APIM_Key for a new implementation of API Manager.  Please contact partner.support@capita.co.uk on or after 20/1/20 to request a key for development purposes.  When you are ready to go live on V3 calls we will provide a separate key, possibly per application.

We are aware of some minor shortcomings in the AttendanceRecord GET request validations but like the V2s we will restrict the date ranges available on any single call in a later variant.  Most calls to request all attendance marks ever will time out and return too many pages for 'reasonable consumption should the call succeed.  Restricting calls to web manageable payloads should improve technical integrator application performance and usability.

Feedback is essential and is best provided via the partner.support@capita.co.uk email.

<?xml version="1.0" encoding="utf-8" ?>
<Whitelist>
  <Actions Service='Assessment'>
    <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='POST'     version='V3' endpoint='AssessmentAspects'/>
    <Action verb='PATCH'    version='V3' endpoint='AssessmentAspects({ExternalID})'/>
    <Action verb='DELETE'   version='V3' endpoint='AssessmentAspects({ExternalID})'/>

    <Action verb='GET'      version='V3' endpoint='AssessmentGradeSets'>
      <WriteableCollection Field='GradeSetInstances' />
    </Action>
    <Action verb='GET'      version='V3' endpoint='AssessmentGradeSets({ExternalID})'/>
    <Action verb='GET'      version='V3' endpoint='AssessmentGradeSets/SIMS.Changes(startDate={startDate})'/>
    <Action verb='POST'     version='V3' endpoint='AssessmentGradeSets'/>
    <Action verb='PATCH'    version='V3' endpoint='AssessmentGradeSets({ExternalID})'/>
    <Action verb='DELETE'    version='V3' endpoint='AssessmentGradeSets({ExternalID})'/>

    <Action verb='GET'      version='V3' endpoint='AssessmentGradeSetInstances'>
      <WriteableCollection Field='Grades' />
    </Action>
    <Action verb='GET'      version='V3' endpoint='AssessmentGradeSetInstances({ExternalID})'/>
    <Action verb='GET'      version='V3' endpoint='AssessmentGradeSetInstances/SIMS.Changes(startDate={startDate})'/>
    <Action verb='POST'     version='V3' endpoint='AssessmentGradeSetInstances'/>
    <Action verb='PATCH'    version='V3' endpoint='AssessmentGradeSetInstances({ExternalID})'/>
    <Action verb='DELETE'    version='V3' endpoint='AssessmentGradeSetInstances({ExternalID})'/>

    <Action verb='GET'      version='V3' endpoint='AssessmentLookups'/>
    <Action verb='GET'      version='V3' endpoint='AssessmentLookups(ExternalID={ExternalID},LookupType=SIMS.LookupType&apos;{LookupType}&apos;)'/>
    <Action verb='GET'      version='V3' endpoint='AssessmentLookups/SIMS.Changes(startDate={startDate})'/>

    <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='POST'     version='V3' endpoint='AssessmentResults'/>
    <Action verb='PATCH'    version='V3' endpoint='AssessmentResults({ExternalID})'/>
    <Action verb='DELETE'   version='V3' endpoint='AssessmentResults({ExternalID})'/>
  </Actions>

  <Actions Service='Attendance'>
    <Action verb='GET'  version='V3' endpoint='AttendanceRecords'/>
    <Action verb='GET'  version='V3' endpoint='AttendanceRecords({ExternalID})'/>
    <Action verb='GET'  version='V3' endpoint='AttendanceRecords/SIMS.Changes(startDate={startDate})'/>
    <Action verb='POST' version='V3' endpoint='AttendanceRecords'/>
    <Action verb='GET'  version='V3' endpoint='StatutoryAttendanceSessions'/>
    <Action verb='GET'  version='V3' endpoint='StatutoryAttendanceSessions({ExternalID})'/>
    <Action verb='GET'  version='V3' endpoint='StatutoryAttendanceSessions/SIMS.Changes(startDate={startDate})'/>
    <Action verb='GET'  version='V3' endpoint='StatutoryAttendanceRecordHistorys'/>
    <Action verb='GET'  version='V3' endpoint='StatutoryAttendanceRecordHistorys({ExternalID})'/>
    <Action verb='GET'  version='V3' endpoint='StatutoryAttendanceRecordHistorys/SIMS.Changes(startDate={startDate})'/>
    <Action verb='GET'  version='V3' endpoint='AttendanceLookups'/>
    <Action verb='GET'  version='V3' endpoint='AttendanceLookups(ExternalID={ExternalID},LookupType=SIMS.LookupType&apos;{LookupType}&apos;)'/>
    <Action verb='GET'  version='V3' endpoint='AttendanceLookups/SIMS.Changes(startDate={startDate})'/>
  </Actions>

  <Actions Service='CommunicationLog'>
    <Action verb='GET'  version='V3' endpoint='CommunicationLookups'/>
    <Action verb='GET'  version='V3' endpoint='CommunicationLookups(ExternalID={ExternalID},LookupType=SIMS.LookupType&apos;{LookupType}&apos;)'/>
    <Action verb='GET'  version='V3' endpoint='CommunicationLookups/SIMS.Changes(startDate={startDate})'/>
    <Action verb='GET'   version='V3' endpoint='LoggedCommunications'>
      <WriteableCollection Field='Recipients' />
      <WriteableCollection Field='Associations' />
    </Action>
    <Action verb='GET'  version='V3' endpoint='LoggedCommunications({ExternalID})'/>
    <Action verb='GET'  version='V3' endpoint='LoggedCommunications/SIMS.Changes(startDate={startDate})'/>
    <Action verb='POST' version='V3' endpoint='LoggedCommunications'/>
    <Action verb='PATCH'  version='V3' endpoint='LoggedCommunications({ExternalID})'/>
  </Actions>

  <Actions Service='MealManagement'>
    <Action verb='GET' version='V3' endpoint='MealLookups'/>
    <Action verb='GET' version='V3' endpoint='MealLookups(ExternalID={ExternalID},LookupType=SIMS.LookupType&apos;{LookupType}&apos;)'/>
    <Action verb='GET' version='V3' endpoint='MealLookups/SIMS.Changes(startDate={startDate})'/>
    <Action verb='GET' version='V3' endpoint='MealMenus'/>
    <Action verb='GET' version='V3' endpoint='MealMenus({ExternalID})'/>
    <Action verb='GET' version='V3' endpoint='MealMenus/SIMS.Changes(startDate={startDate})'/>
    <Action verb='GET' version='V3' endpoint='MealOrders'/>
    <Action verb='GET' version='V3' endpoint='MealOrders({ExternalID})'/>
    <Action verb='GET' version='V3' endpoint='MealOrders/SIMS.Changes(startDate={startDate})'/>
    <Action verb='GET' version='V3' endpoint='MealSessions'/>
    <Action verb='GET' version='V3' endpoint='MealSessions({ExternalID})'/>
    <Action verb='GET' version='V3' endpoint='MealSessions/SIMS.Changes(startDate={startDate})'/>
  </Actions>

  <Actions Service='Learner'>
    <Action verb='GET'   version='V3' endpoint='LearnerContactDetails'>
      <WriteableCollection Field='Addresses' />
      <WriteableCollection Field='Emails' />
      <WriteableCollection Field='Telephones' />
      <WriteableCollection Field='LearnerContactRelationships' />
    </Action>
    <Action verb='GET'   version='V3' endpoint='LearnerContactDetails({ExternalID})'/>
    <Action verb='PATCH'  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'>
      <WriteableCollection Field='Notes' />
    </Action>
    <Action verb='GET'   version='V3' endpoint='LearnerGeneralNotes({ExternalID})'/>
    <Action verb='GET'   version='V3' endpoint='LearnerGeneralNotes/SIMS.Changes(startDate={startDate})'/>
    <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&apos;{LookupType}&apos;)'/>
    <Action verb='GET'   version='V3' endpoint='LearnerLookups/SIMS.Changes(startDate={startDate})'/>
    <Action verb='GET'   version='V3' endpoint='LearnerPersonals'>
      <WriteableCollection Field='PreviousNames' />
    </Action>
    <Action verb='GET'   version='V3' endpoint='LearnerPersonals({ExternalID})'/>
    <Action verb='PATCH'   version='V3' endpoint='LearnerPersonals({ExternalID})'/>
    <Action verb='GET'   version='V3' endpoint='LearnerPersonals/SIMS.Changes(startDate={startDate})'/>
    <Action verb='GET'   version='V3' endpoint='ContactBasics'>
      <WriteableCollection Field='Notes' />
    </Action>
    <Action verb='GET'   version='V3' endpoint='ContactBasics({ExternalID})'/>
    <Action verb='PATCH'  version='V3' endpoint='ContactBasics({ExternalID})'/>
    <Action verb='GET'   version='V3' endpoint='ContactBasics/SIMS.Changes(startDate={startDate})'/>
    <Action verb='GET'   version='V3' endpoint='ContactContactDetails'>
      <WriteableCollection Field='Addresses' />
      <WriteableCollection Field='Emails' />
      <WriteableCollection Field='Telephones' />
    </Action>
    <Action verb='GET'   version='V3' endpoint='ContactContactDetails({ExternalID})'/>
    <Action verb='PATCH'   version='V3' endpoint='ContactContactDetails({ExternalID})'/>
    <Action verb='GET'   version='V3' endpoint='ContactContactDetails/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='GET'   version='V3' endpoint='LearnerSENLookups'/>
    <Action verb='GET'   version='V3' endpoint='LearnerSENLookups(ExternalID={ExternalID},LookupType=SIMS.LookupType&apos;{LookupType}&apos;)'/>
    <Action verb='GET'   version='V3' endpoint='LearnerSENLookups/SIMS.Changes(startDate={startDate})'/>
  </Actions>

  <Actions Service='School'>
    <Action verb='GET' version='V3' endpoint='Rooms'/>
    <Action verb='GET' version='V3' endpoint='Rooms({ExternalID})'/>
    <Action verb='GET' version='V3' endpoint='Rooms/SIMS.Changes(startDate={startDate})'/>
  </Actions>

  <Actions Service='Staff'>
    <Action verb='GET'   version='V3' endpoint='StaffCulturals'>
      <WriteableCollection Field='Languages' />
    </Action>
    <Action verb='GET'   version='V3' endpoint='StaffCulturals({ExternalID})'/>
    <Action verb='PATCH' 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&apos;{LookupType}&apos;)'/>
    <Action verb='PATCH' version='V3' endpoint='StaffLookups(ExternalID={ExternalID},LookupType=SIMS.LookupType&apos;{LookupType}&apos;)'/>
    <Action verb='GET'   version='V3' endpoint='StaffLookups/SIMS.Changes(startDate={startDate})'/>
    <Action verb='GET'   version='V3' endpoint='StaffMedicals'>
      <WriteableCollection Field='Impairments' />
      <WriteableCollection Field='MedicalNotes' />
    </Action>
    <Action verb='GET'   version='V3' endpoint='StaffMedicals({ExternalID})'/>
    <Action verb='PATCH' 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='PATCH' version='V3' endpoint='StaffPersonalBasics({ExternalID})'/>
    <Action verb='GET'   version='V3' endpoint='StaffPersonalBasics/SIMS.Changes(startDate={startDate})'/>
    <Action verb='GET'   version='V3' endpoint='StaffPersonalExtendeds'>
      <WriteableCollection Field='PreviousNames' />
      <WriteableCollection Field='Notes' />
    </Action>
    <Action verb='GET'   version='V3' endpoint='StaffPersonalExtendeds({ExternalID})'/>
    <Action verb='PATCH' version='V3' endpoint='StaffPersonalExtendeds({ExternalID})'/>
    <Action verb='GET'   version='V3' endpoint='StaffPersonalExtendeds/SIMS.Changes(startDate={startDate})'/>
    <Action verb='GET'   version='V3' endpoint='StaffProfessionals'>
      <WriteableCollection Field='StaffExperiences' />
      <WriteableCollection Field='StaffQualifications' />
      <WriteableCollection Field='ProfessionalAccreditations' />
    </Action>
    <Action verb='GET'   version='V3' endpoint='StaffProfessionals({ExternalID})'/>
    <Action verb='PATCH' version='V3' endpoint='StaffProfessionals({ExternalID})'/>
    <Action verb='GET'   version='V3' endpoint='StaffProfessionals/SIMS.Changes(startDate={startDate})'/>
    <Action verb='GET'   version='V3' endpoint='StaffServices'>
      <WriteableCollection Field='StaffRoleAssignments' />
      <WriteableCollection Field='StaffServiceRecords' />
    </Action>
    <Action verb='GET'   version='V3' endpoint='StaffServices({ExternalID})'/>
    <Action verb='GET'   version='V3' endpoint='StaffServices/SIMS.Changes(startDate={startDate})'/>
    <Action verb='GET'   version='V3' endpoint='StaffServiceExtendeds'>
      <WriteableCollection Field='StaffServiceRecordDetails' />
    </Action>
    <Action verb='GET'   version='V3' endpoint='StaffServiceExtendeds({ExternalID})'/>
    <Action verb='PATCH' version='V3' endpoint='StaffServiceExtendeds({ExternalID})'/>
    <Action verb='GET'   version='V3' endpoint='StaffServiceExtendeds/SIMS.Changes(startDate={startDate})'/>
    <Action verb='GET'   version='V3' endpoint='StaffAbsenceLookups'/>
    <Action verb='GET'   version='V3' endpoint='StaffAbsenceLookups(ExternalID={ExternalID},LookupType=SIMS.LookupType&apos;{LookupType}&apos;)'/>
    <Action verb='GET'   version='V3' endpoint='StaffAbsenceLookups/SIMS.Changes(startDate={startDate})'/>
    <Action verb='GET'   version='V3' endpoint='StaffAbsenceCertificates'/>
    <Action verb='GET'   version='V3' endpoint='StaffAbsenceCertificates({ExternalID})'/>
    <Action verb='GET'   version='V3' endpoint='StaffAbsenceCertificates/SIMS.Changes(startDate={startDate})'/>
    <Action verb='GET'   version='V3' endpoint='StaffAbsenceContractuals'/>
    <Action verb='GET'   version='V3' endpoint='StaffAbsenceContractuals({ExternalID})'/>
    <Action verb='GET'   version='V3' endpoint='StaffAbsenceContractuals/SIMS.Changes(startDate={startDate})'/>
    <Action verb='GET'   version='V3' endpoint='StaffAbsencePeriods'/>
    <Action verb='GET'   version='V3' endpoint='StaffAbsencePeriods({ExternalID})'/>
    <Action verb='GET'   version='V3' endpoint='StaffAbsencePeriods/SIMS.Changes(startDate={startDate})'/>
  </Actions>
</Whitelist>