Assessment Centres API
home
Overview:
This document describes the technical design for the API and aligns with the API Requirements Capture template.
Mule Soft APIβs are expose to fetch the panels data from CRM or EPS view using below end points.
API Method | REST Endpoint | Description | Consumers | Source Systems Used | |
---|---|---|---|---|---|
1. | GET | /{version}/centres | List of Centre for a given Data Source | SFA, ATS, GL-CE | SfA uses data from EPS and others use data from EDP DB |
2. | GET | /{version}/centres/{centreId} | Centre Details for a given centreId and Data source | SFA, OCR Malpractice | SfA uses data from EPS and others use data from SAP/SnAPI CRM |
3. | GET | /{version}/sources/{sourceName}/centres?search=βstringβ | Retrieve the center contact details from EPS | SFA | |
4. | GET | /{version}/sources/{sourceName}/centres | Centre Details (By Partial Search on Centre Id and Centre Name) from EPS | SFA, Identity | |
5. | GET | /version}/centres/centreid/comprehensives | Retrieve details from EPS view | SFA | |
6. | GET | /{version}/centres/(centreId)/headCentres | Returns Head Centre to Child Centre Details | SFA | |
7. | POST | /{version}/centres/groups | centre consortia.consortia data in order to provide moderators with the data they need when completing their on-screen tasks in that application | Modman | |
8. | DELETION | /{version}/consortiaDeletion | DeleteConsorita | Modman | |
9. | GET | /{version}/master/centres | This API endpoint will always return the master data from MDM and will support following search criteria | Global listening | |
10 | GET | /{version}/centres/{centreId}/centres | Get the list of child centres for the given parent Centre Id | SFA | |
11 | GET | /{version}/countries | Get the list of countries | Find a School | Salesforce |
12 | GET | /{version}/statesAndCities | Get the list of States and cities | Find a School | Salesforce |
13 | GET | /{version}/findacentre/centres | Get the list of centres in a country and state | Find a School | Salesforce |
Centres API Interaction Diagram:
Centres API Steps and Sequence Diagram:
Source Of Customer / Centre Information
Logic of identifying master data source for each business stream
Exception Handling:
- Custom Error handler is used to handle API Kit errors as well as user defined errors.
- HTTP endpoints have been configured with reconnection strategies with maximum of 2 retry attempts.
End Point details:
1. Centre List : List of Centres.
Centers Experience API : api/v1/centres
Topic | Details | |
---|---|---|
1. | Operation Description | Retrieve panels lists data from C4C |
2. | URI | api/v1/centres |
3. | Interface Source | Centers Application |
4. | Interface Target | EPS, EDP |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-centres-xapi-dev/api/v1/centres?offset=2&limit=6&businessStreamId=01 |
8. | Mode of Communication | β Batch β Message β Real Time |
9. | Interface Pattern | β Publish / Subscribe β Request / Reply |
[List of Centre information will be available from any of the following source as per consumer input about the data source. ( MEPS / OEPS / C4C ) ]
2. Centre - Detailed Information : Details of one Centre .
**Centers Experience API :** api/v1/centers/{centreId}
Topic | Details | |
---|---|---|
1. | Operation Description | Retrieve panels details from EPS and C4C |
2. | URI | Api/v1/centers/{centreId} |
3. | Interface Source | Centers Application |
4. | Interface Target | EPS |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https:https://apis-sandbox.cambridgeassessment.org.uk/ca-centres-xapi-dev/api/v1/centres/00992?dataSource=C4C |
8. | Mode of Communication | β Batch β Message β Real Time |
9. | Interface Pattern | β Publish / Subscribe β Request / Reply |
[Full details of one customer , the detailed view of a given centreId]
3. Centre Relationship : Centre to Parent Centre detail information is available in this API.
**Centers Experience API :** api/v1/centres/centreid/contacts
Topic | Details | |
---|---|---|
1. | Operation Description | Retrieve the list of centers based on search. |
2. | URI | api//v1/centres/centreid/contacts |
3. | Interface Source | Centers Application |
4. | Interface Target | EPS |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | http://apis-sandbox.cambridgeassessment.org.uk/ca-centres-xapi-dev/api/v1/centres/PK550/contacts?centreId=PK550&dataSource=MEPS |
8. | Mode of Communication | β Batch β Message β Real Time |
9. | Interface Pattern | β Publish / Subscribe β Request / Reply |
[ Centre to Parent Centre detail information is available in this API ]
4. Centre Relationship : Head centre to Child centre information is available via this API.
Centers Experience API : api/v1/sources/{sourceName}/centres?search=βstringβ
Topic | Details | |
---|---|---|
1. | Operation Description | Retrieve the center contact details. |
2. | URI | /v1/sources/{sourceName}/centres?search=βstringβ |
3. | Interface Source | Centers Application |
4. | Interface Target | EPS |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | http://apis-sandbox.cambridgeassessment.org.uk/ca-centres-xapi-dev/api/v1/sources/OEPS/centres |
8. | Mode of Communication | β Batch β Message β Real Time |
9. | Interface Pattern | β Publish / Subscribe β Request / Reply |
[ Head centre to Child centre information is available via this API ]
5. Centre Details : C
**Centers Experience API :** api/v1/centres/centreid/comprehensives
Topic | Details | |
---|---|---|
1. | Operation Description | Retrieve details from EPS view. |
2. | URI | Api/v1/centres/{centreId}/comprehensives |
3. | Interface Source | Centers Application |
4. | Interface Target | EPS |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-centres-qa1/v1/centres/10097/compreshensives?offset=2&limit=6&dataSource=MEPS |
8. | Mode of Communication | β Batch β Message β Real Time |
9. | Interface Pattern | β Publish / Subscribe β Request / Reply |
[Search the details of centre using centreId or centreName , this API provides the search functionality ]
6. Centre - Detailed Information : Centre Details (By Partial Search on Centre Id and Centre Name .
**Centers Experience API :** Api/v1/sources/{sourceName}/centres
Topic | Details | |
---|---|---|
1. | Operation Description | Retrieve panels details from EPS and C4C |
2. | URI | Api/v1/sources/{sourceName}/centres |
3. | Interface Source | Centers Application |
4. | Interface Target | EPS |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-centres-xapi-dev/api/v1/sources/OEPS/centres |
8. | Mode of Communication | β Batch β Message β Real Time |
9. | Interface Pattern | β Publish / Subscribe β Request / Reply |
[Full details of one customer , the detailed view of a given centreId]
7. Centre - Detailed Information : Returns Head Centre to Child Centre Details.
**Centers Experience API :** Api/v1/centres/(centreId)/headCentres
Topic | Details | |
---|---|---|
1. | Operation Description | Returns Head Centre to Child Centre Details |
2. | URI | Api/v1/centres/(centreId)/headCentres |
3. | Interface Source | Centers Application |
4. | Interface Target | ca-snapi-crm |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-centres-xapi-dev/ap/v1/centres/{centreId}/headCentres |
8. | Mode of Communication | β Batch β Message β Real Time |
9. | Interface Pattern | β Publish / Subscribe β Request / Reply |
[Returns Head Centre to Child Centre Details]
8. Centre - Detailed Information : centre consortia.consortia data in order to provide moderators with the data they need when completing their on-screen tasks in that application .
**Centers Experience API :** Api/v1/centres/groups
Topic | Details | |
---|---|---|
1. | Operation Description | centre consortia.consortia data in order to provide moderators with the data they need when completing their on-screen tasks in that application |
2. | URI | Api/v1/centres/groups |
3. | Interface Source | Centers Application |
4. | Interface Target | Modman |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-centres-xapi-dev/api/v1/centres/groups |
8. | Mode of Communication | β Batch β Message β Real Time |
9. | Interface Pattern | β Publish / Subscribe β Request / Reply |
[centre consortia.consortia data in order to provide moderators with the data they need when completing their on-screen tasks in that application]
9. Centre - Detailed Information : DeleteConsortia .
**Centers Experience API :** /api/consortiaDeletion
Topic | Details | |
---|---|---|
1. | Operation Description | DeleteConsortia |
2. | URI | Api\v1\consortiaDeletion |
3. | Interface Source | Centers Application |
4. | Interface Target | Modman |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-centres-xapi-dev/api/consortiaDeletion |
8. | Mode of Communication | β Batch β Message β Real Time |
9. | Interface Pattern | β Publish / Subscribe β Request / Reply |
[DeleteConsortia]
10. Centre - Detailed Information : This API endpoint will always return the master data from MDM and will support following search criteria .
**Centers Experience API :** /v1/master/centres
Topic | Details | |
---|---|---|
1. | Operation Description | This API endpoint will always return the master data from MDM and will support following search criteria |
2. | URI | /v1/master/centres |
3. | Interface Source | Centers Application |
4. | Interface Target | Mdm |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-centres-xapi-dev/api/v1/master/centres |
8. | Mode of Communication | β Batch β Message β Real Time |
9. | Interface Pattern | β Publish / Subscribe β Request / Reply |
[This API endpoint will always return the master data from MDM and will support following search criteria]
11. Countries : This API endpoint return the Countries data from Salesforce
**Centers Experience API :** /v1/countries
Topic | Details | |
---|---|---|
1. | Operation Description | This API endpoint return the Countries data from Salesforce |
2. | URI | /v1/countries |
3. | Interface Source | Salesforce |
4. | Interface Target | Find a School |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-centres-xapi-qa1/api/v1/countries |
8. | Mode of Communication | β Batch β Message β Real Time |
9. | Interface Pattern | β Publish / Subscribe β Request / Reply |
12. States and Cities : This API endpoint return the States and Cities data from Salesforce
**Centers Experience API :** /v1/statesAndCities
Topic | Details | |
---|---|---|
1. | Operation Description | This API endpoint return the States and Cities data from Salesforce |
2. | URI | /{version}/statesAndCities |
3. | Interface Source | Salesforce |
4. | Interface Target | Find a School |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-centres-xapi-qa1/api/v1/statesAndCities |
8. | Mode of Communication | β Batch β Message β Real Time |
9. | Interface Pattern | β Publish / Subscribe β Request / Reply |
13. Centres : This API endpoint return the centres in a country/state/City data from Salesforce
**Centers Experience API :** /v1/findacentre/centres
Topic | Details | |
---|---|---|
1. | Operation Description | This API endpoint return the centres in a country/state/City data from Salesforce |
2. | URI | /v1/findacentre/centres |
3. | Interface Source | Salesforce |
4. | Interface Target | Find a School |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-centres-xapi-qa1/api/v1/findacentre/centres |
8. | Mode of Communication | β Batch β Message β Real Time |
9. | Interface Pattern | β Publish / Subscribe β Request / Reply |
```