ESS SIMS 8 INTERFACING This presentation is initially

ESS – SIMS 8 INTERFACING This presentation is initially based on SIMS 8 but the intention is that any code will be transferable to the De. X service once we have identical SIMS 7 and SIMS 8 APIs available in H 1 2021. Coverage may vary between systems.

WEB APIS ESS SIMS 8 / De. X APIs are: Web based Implement Odata Secured by SIMS ID via OAuth 2 Managed by API Manager Documented via API Manager What are the SIMS 8 / De. X APIs

Security Obtain an Access Token URL https: //sts. sims. co. uk/connect/token? Content-Type Body Data grant_type: client_credentials client_id: {{client_id}} client_secret: {{client_secret}} scope: partnerserverapplication partner acr_values: orgselected: {{organisation_id}} POST: Returns a bearer token BASICS OF SIMS 8 INTERFACING Bearer Tokens can be obtained via Postman or a variety of coding libraries. Examples and more help are available at SIMS Partners. com 8 - Access Token | Capita Portal (sims-partners. com)

Get Some Data Formulate the call <Base URL>/<Service>/<Version>/<Sub Domain> <Base URL> https: //seli 00 apm 01. azure-api. net/ssli 01/ <Service> Learner|Staff|Atttendance|… <Version> V 3 <Sub Domain> Learner. Indentifiers | Staff. Indentifiers | Attendance. Record | … Headers Authorization : Bearer {{token}} Ocp-Apim-Subscription-Key: {{subsciption_key. V 3}} WEB API CALLS Whilst there are many additional options for Odata, see OData - the Best Way to REST, the key goal is to make the task simple.

Example https: //seli 00 apm 01. azureapi. net/ssli 01/Learner/V 3/Learner. Identifiers { "External. ID": "8 baf 79 e 2 -cd 33 -43 a 0 -832 d-00951 f 7 b 5 f 79", "Forename": "Dwayne", "Surname": "Johnson", "Gender. Category": "Male", WEB API CALLS The call will return a set of JSON records and classes are provided to assist with deserialization with a link on the next page… public class TLearner. Identifier { "On. Roll. State": "Future", public Guid External. ID; "Date. Of. Application": "2020 -05 -14 T 00: 00 Z", "Photograph": null, public string Forename; "Current. Year. Group": { public string Surname; "Description": "Year 2", public string Gender. Category; "External. ID": "7 d 59 c 220 -a 68 a-41 a 6 -a 19 c-93 de 70616046", public int? Age. Months; "Type": "Pastoral. Group. Definition. Year. Group" public bool? Do. Not. Communicate; }, "Current. Primary. Class": { public TLearner. Group Current. Year. Group; "Description": "My Class DUS", public TLearner. Group Current. Primary. Class; "External. ID": "0 d 77113 d-6 a 7 f-44 f 5 -acfe-c 5 b 89 c 8 bc 49 b", public TLearner. Group Current. House; "Type": "Pastoral. Group. Definition. Primary. Class" public string On. Roll. State; }, "Current. House": null public Date. Time? Date. Of. Application; }, } "Age. Months": 33, "Do. Not. Communicate": false,

Resources Getting Started: https: //www. sims- partners. com/Product/SIMS 8/API/Start-Point Formal Documentation: Products: Details - Microsoft Azure API Management - developer portal (azureapi. net) API Overviews: https: //www. simspartners. com/Product/SIMS 8/APIs/V 3/Index Data Models: SIMS 8 - Models 28012021 | Capita Portal (sims-partners. com) WEB API CALL RESOURCES There are many resources on the SIMS-Partners. Com site but the 4 links on the left are probably the most important ones to get a Technical Integrator started.