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

Restful APIS

SIMS ID Based APIs

 

The following data (subject to the agreement of the data controller) will be available for sites that are aligned with your product.

User information

  • Name

  • Groups/class/house/year

  • Age range eg <13 / >16

  • Unique ID

Site information

  • Name

  • DFE

  • Unique ID

For a complete list of available information please refer to the SWAGGER endpoint for the relevant API below

API endpoint

A Swagger documented API is available on the SIMS ID Partner Development Platform for Provisioning Integrators to develop against. A corresponding endpoint will be made available to Partners in the live environment.

Provisioning API Swagger endpoint

Swagger endpoint for the SIMS ID Provisioning API

This endpoint matches the available API calls in the live environment but is backed by the Dummy Data.