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

General Advice - Interfacing Options for SIMS Products

Partner Options

One of the key task for the partner team is to give best advice to partners and potential partners on how to integrate with our products.  The scope of products available for integration are increasing which increases both opportunities and options for our partners.  This document aims to highlight the options available but does not attempt to explain the detail of the work required which can be found elsewhere.

Key

Code Description
OnPrem On-Premise solution will require the partner to deploy an application to a local server / third party connector (proxy for a local server) and manage that deployment.
Web

Web-based solution which would require no local deployment.  Local configuration may be required. 

Adjustment to the school’s (or their broadband provider’s) web access controls may be needed for example whitelisting your URI’s.

LightData Lightweight Data – May or may not meet a partner’s requirement.  Extensions to data availability would be subject to a Business Case Approval.
RichData Rich Data – Provides access to the widest data available

 

 

 

 

 

 

 

 

 

SIMS ID SSO (Web/LightData)

All future SIMS products will use SIMS ID for identity. For example, our next generation Parental Engagement products use SIMS ID to identify users including parents. The consequence of this is that over time every parent, student and staff member in SIMS will be given a SIMS ID.

SIMS ID SSO Offers partners the opportunity to identify users from SIMS effectively using the same login that SIMS (and other products such as Encyclopaedia Britannica).  Partner products need simply to be registered and use an Open ID Connect flow using a proof key’/ ‘code_verifier’ model for our user present flows.  

SIMS ID - RAP API (Web / LightData)

The next extension of our APIs are those used by SIMS ID to manage the provisioning of people from SIMS in to Active Directory and beyond.  These are also used to provision Office 365 and Google Applications for our customers.

The corollary of this is that these APIs can also be made available to partners and provide lightweight data such as names, email addresses, phones, memberships and supervisions.

These are not intended to provide sensitive personal information or detailed data about individuals.

 

SIMS ID One Roster API (Web / LightData)

These largely use the same data as the RAP APIs but present it in the IMS Global One Roster Standard which is widely supported for integration.  An example of this is a standards-based integration with Microsoft Teams / One Note Classbook but it is also likely to work well for VLEs.

All the APIs are read-only except for a write-back for:

  • Line Items
  • Results

SIMS 7 will use these items as a pair to create and maintain a termly mark sheet for each provider.

 

SIMS 7 APIs (OnPrem / RichData)

Has access to most data within SIMS.  The APIs are .Net APIs contained in the DLLs shipped in an installation of SIMS and will require that a .Net console (or alternative) application is written and deployed to reference local dlls in the SIMS installation.

 

FMS 6 APIs  (OnPrem / RichData)

These APIs are sparse and afford access to key data within FMS.  The APIs are .Net APIs contained in the DLLs shipped in an installation of SIMS and will require that a .Net console (or alternative) application is written and deployed to reference local dlls in the FMS installation.

FMS 6 eProcurement Interface (Web / RichData)

FMS supports eGov 3.09 / BASDA 3.09 exchange for:

  • Content Orders
  • Orders
  • Invoices
  • Credit Notes

Documentation is available for this integration.  Partners are asked to note that this is UK standards-based.

SIMS Finance Integration Toolkits (TBA)

SIMS Finance does not offer formal APIs but does have 5 areas whereby key data can be exported from SIMS Finance to third-party systems and imported from them.  Further information to follow.

SIMS Finance eProcurement Interface ( Web / RichData)

No integration options are currently available.