Cambridge Tech XAPI
home
Overview:
• Cambridge Tech API used to Get candidates, centers, results, qualifications, last updated date, registered candidates details from RDS Database and we post and retrieve checkpoint status, date details.
API Method | REST Endpoint | Description | Consumers | |
---|---|---|---|---|
1. | GET | /{version}/candidatesByCentre | GET candidates details from RDS DB | Cambridge Technical Portal |
2. | GET | /{version}/centres | GET centres details from RDS DB | Cambridge Technical Portal |
3. | GET | /{version}/subjectLevelAndQualification | GET qualifications details from RDS DB | Cambridge Technical Portal |
4. | GET | /{version}/lastUpdateDate | GET last update date details from RDS DB | Cambridge Technical Portal |
5. | GET | /{version}/candidatesSummary | GET registered candidate details from RDS DB | Cambridge Technical Portal |
6. | GET | /{version}/candidatesResults | GET results details from RDS DB | Cambridge Technical Portal |
7. | GET | /{version}/checkPointStatusForCentres | GET checkpoint status details from RDS DB | Cambridge Technical Portal |
8. | POST | /{version}/checkPointStatusForCentres | POST checkpoint status details to RDS DB | Cambridge Technical Portal |
9. | GET | /{version}/checkpointDateForCentres | GET checkpoint date details from RDS DB | Cambridge Technical Portal |
10. | POST | /{version}/checkpointDateForCentres | POST checkpoint status details to RDS DB | Cambridge Technical Portal |
11. | GET | /{version}/estimatedCompletionDateHistory | GET estimated Completion Date History from RDS DB | Cambridge Technical Portal |
12. | POST | /{version}/estimatedCompletionDate | POST estimated Completion Date details to RDS DB | Cambridge Technical Portal |
13. | GET | /{version}/checkPointStatusForCentresHistory | GET checkpoint date details for centers history from RDS DB | Cambridge Technical Portal |
14. | GET | /{version}/certificationStatusForCentres | GET certification status for centers from RDS DB | Cambridge Technical Portal |
15. | GET | /{version}/eligibilityHistory | GET eligibility History from RDS DB | Cambridge Technical Portal |
Flow Diagram and Description:
- This API can be utilized to get candidates, centers, results, qualifications, last updated date, registered candidates details from RDS database using cupa-cambridgetech-rds-sapi.
Sequence Diagram:
Steps In Sequence Diagram
No | Steps | Description |
---|---|---|
1. | Input Request Message | Script Validation get service invokes the mule services along with credentials via Mule Soft Secure API layer . |
2. | Validate the Bearer token credentials | If the token is authorized the request is sent to the endpoint. |
3. | If validation fails, service returns specific fault response | If validation fails, service returns specific fault response to the caller. |
4. | If the request succeeds after calling the Endpoint | A success response is sent to the Xapi which sends the success response to the caller. |
5. | If the request fails after calling the System layer | A failed response or a message is sent to Xapi which send the messages to the caller. |
End Point details:
Cambridge Tech Experience API : /v1/candidatesByCentre
Topic | Details | |
---|---|---|
1. | Operation Description | get candidate details from RDS |
2. | URI | /v1/candidates |
3. | Interface Source | Cambridge Technical Portal |
4. | Interface Target | RDS Database |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-cambridgetech-xapi-dev/api/v1/candidatesByCentre |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
Cambridge Tech Experience API : /v1/centers
Topic | Details | |
---|---|---|
1. | Operation Description | get centers details from RDS |
2. | URI | /v1/centers |
3. | Interface Source | Cambridge Technical Portal |
4. | Interface Target | RDS Database |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-cambridgetech-xapi-dev/api/v1/centres |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
Cambridge Tech Experience API : /v1/candidatesResults
Topic | Details | |
---|---|---|
1. | Operation Description | get results details from RDS |
2. | URI | /v1/results |
3. | Interface Source | Cambridge Technical Portal |
4. | Interface Target | RDS Database |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-cambridgetech-xapi-dev/api/v1/candidatesResults |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
Cambridge Tech Experience API : /v1/subjectLevelAndQualification
Topic | Details | |
---|---|---|
1. | Operation Description | get qualifications details from RDS |
2. | URI | /v1/qualifications |
3. | Interface Source | Cambridge Technical Portal |
4. | Interface Target | RDS Database |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-cambridgetech-xapi-dev/api/v1/subjectLevelAndQualification |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
Cambridge Tech Experience API : /v1/lastUpdateDate
Topic | Details | |
---|---|---|
1. | Operation Description | get last update date details from RDS |
2. | URI | /v1/lastUpdateDate |
3. | Interface Source | Cambridge Technical Portal |
4. | Interface Target | RDS Database |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-cambridgetech-xapi-dev/api/v1/lastUpdateDate |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
Cambridge Tech Experience API : /v1/candidatesSummary
Topic | Details | |
---|---|---|
1. | Operation Description | get registered candidates details from RDS |
2. | URI | /v1/registeredCandidates |
3. | Interface Source | Cambridge Technical Portal |
4. | Interface Target | RDS Database |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-cambridgetech-xapi-dev/api/v1/candidatesSummary |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
Cambridge Tech Experience API : /v1/checkPointStatusForCentres
Topic | Details | |
---|---|---|
1. | Operation Description | get checkpoint Status For Centers details from RDS |
2. | URI | /v1/checkPointStatusForCentres |
3. | Interface Source | Cambridge Technical Portal |
4. | Interface Target | RDS Database |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-cambridgetech-xapi-dev/api/v1/checkPointStatusForCentres |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
Cambridge Tech Experience API : /v1/checkPointStatusForCentres
Topic | Details | |
---|---|---|
1. | Operation Description | Post checkpoint Status For Centers details to RDS DB |
2. | URI | /v1/checkPointStatusForCentres |
3. | Interface Source | Cambridge Technical Portal |
4. | Interface Target | RDS Database |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-cambridgetech-xapi-dev/api/v1/checkPointStatusForCentres |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
Cambridge Tech Experience API : /v1/checkpointDateForCentres
Topic | Details | |
---|---|---|
1. | Operation Description | get checkpoint Date For Centers details from RDS |
2. | URI | /v1/checkpointDateForCentres |
3. | Interface Source | Cambridge Technical Portal |
4. | Interface Target | RDS Database |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-cambridgetech-xapi-dev/api/v1/checkpointDateForCentres |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
Cambridge Tech Experience API : /v1/checkpointDateForCentres
Topic | Details | |
---|---|---|
1. | Operation Description | Post checkpoint Date For Centers details to RDS DB |
2. | URI | /v1/checkpointDateForCentres |
3. | Interface Source | Cambridge Technical Portal |
4. | Interface Target | RDS Database |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-cambridgetech-xapi-dev/api/v1/checkpointDateForCentres |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
Cambridge Tech Experience API : /v1/estimatedCompletionDateHistory
Topic | Details | |
---|---|---|
1. | Operation Description | Get estimated completion date history from RDS DB |
2. | URI | /v1/estimatedCompletionDateHistory |
3. | Interface Source | Cambridge Technical Portal |
4. | Interface Target | RDS Database |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-cambridgetech-xapi-dev/api/v1/estimatedCompletionDateHistory |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
Cambridge Tech Experience API : /v1/estimatedCompletionDate
Topic | Details | |
---|---|---|
1. | Operation Description | Post estimated Completion Date details to RDS DB |
2. | URI | /v1/estimatedCompletionDate |
3. | Interface Source | Cambridge Technical Portal |
4. | Interface Target | RDS Database |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-cambridgetech-xapi-dev/api/v1/estimatedCompletionDate |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
Cambridge Tech Experience API : /v1/checkPointStatusForCentresHistory
Topic | Details | |
---|---|---|
1. | Operation Description | get checkPoint status for centers history details from RDS DB |
2. | URI | /v1/checkPointStatusForCentresHistory |
3. | Interface Source | Cambridge Technical Portal |
4. | Interface Target | RDS Database |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-cambridgetech-xapi-dev/api/v1/checkPointStatusForCentresHistory |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
Cambridge Tech Experience API : /v1/certificationStatusForCentres
Topic | Details | |
---|---|---|
1. | Operation Description | get certification for centers details from RDS DB |
2. | URI | /v1/certificationStatusForCentres |
3. | Interface Source | Cambridge Technical Portal |
4. | Interface Target | RDS Database |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-cambridgetech-xapi-dev/api/v1/certificationStatusForCentres |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
Cambridge Tech Experience API : /v1/eligibilityHistory
Topic | Details | |
---|---|---|
1. | Operation Description | get eligibility history details from RDS DB |
2. | URI | /v1/certificationStatusForCentres |
3. | Interface Source | Cambridge Technical Portal |
4. | Interface Target | RDS Database |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-cambridgetech-xapi-dev/api/v1/eligibilityHistory |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |