US Transcript API
home
Overview:
- Mule Soft API exposed to either retrieve or store information related to transcript data belonging to US students. Below is the list of end points exposed to store candidate, exam, transcripts and institutions related information.
- Also Transcript costs, payment status, order summary and data related to centers, exam series and candidate results shall be retrieved
API Method | REST Endpoint | Description | Consumers | |
---|---|---|---|---|
1. | POST | /{version}/candidates | Stores the candidate personal information in DB | Grade Transcript service |
2. | POST | /{version}/qualifications | Stores the Exam Details in DB | Grade Transcript service |
3. | POST | /{version}/institutions | Stores the Institution Details in DB | Grade Transcript service |
4. | POST | /{version}/transcripts | Stores the transcripts Details in DB | Grade Transcript service |
5. | GET | /{version}/transcripts/costs | Retrieves the transcripts service costs | Grade Transcript service |
6. | POST | /{version}/transcripts/costs | Creates new transcripts service costs | Grade Transcript service |
7. | PUT | /{version}/transcripts/costs | Updates existing transcripts service costs | Grade Transcript service |
8. | PUT | /{version}/transcripts/applicationStatus | Update the transcripts application payment status | Grade Transcript service |
9. | GET | /{version}/transcripts/orderSummary | Retrieves the transcripts order summary | Grade Transcript service |
10. | GET | /{version}/examseries | Retrieves the exam series data from SNAPI Database | Grade Transcript service |
11. | GET | /{version}/institutions | Retrieves the Institutions data from SNAPI Database | Grade Transcript service |
12. | GET | /{version}/centres | Retrieves the centres data from SNAPI Database | Grade Transcript service |
13. | GET | /{version}/candidateResults | Retrieves the candidates results data from SNAPI Database | Grade Transcript service |
14. | POST | /{version}/gradeScores | Creates new transcripts grades table in Db to store the values posted by appian | Grade Transcript service |
15. | GET | /{version}/candidates/{applicationReferenceNumber}/scores | Retrieves the Candidate Scores data from SNAPI Database | Grade Transcript service |
16. | POST | /{version}/candidates/{applicationReferenceNumber}/terms | Stores Terms and Condition Details in DB | Grade Transcript service |
17. | GET | /{version}/creditPolicy/{InstituteId}/terms | Retrieves credit details for a particular institute Id | Grade Transcript service |
18. | GET | /{version}/terms | Retrieves Terms and conditions in HTML format | Grade Transcript service |
19. | GET | /{version}/candidates/gradeChanges | Retrieves Grade changes | Grade Transcript service |
20. | GET | /{version}/candidates/{uid}/orders | Retrieves the Candidate Order Details | Grade Transcript service |
21. | POST | /{version}/transcripts/validatePaymentDue | Validate if Payment due date breached or not | Grade Transcript service |
Integration architecture:
1. Flow Diagram and Description:
GTS application send the request to Mule API to perform requested operations and data would be stored/retrieved from SNAPI database accordingly.
Sequence Diagram and Description:
No. | Steps | Description |
---|---|---|
1. | Input Request Message | The US grade transcript service invokes the mule services along with credentials (client id and client secret) and X-TRANSACTION-ID(A code to track API calls end to end) via Mule Soft Secure API layer with the proper request. |
2 | Validate the user Credentials | Desktop user credentials are validated by the security API mule gateway layer |
3. | If Validation fails, service returns specific fault response | If Validation fails, service returns specific fault response |
4. | Send the request to specific layered API | The Mule soft experience API secure layer validated users request query parameters will redirect to the specific Process API. |
5. | Validate the request | The request is validated in the Mule System service API and if passed only then it is processed further to step 8 (ca-us-transcript-sapi,ca-mdm-sapi) based on operation. |
6. | If Validation fails, service returns specific fault response | If the request gets failed during the validation the exception is thrown by the Process API to the Experience API secure layer. |
7. | Fault message redirection by the User | When Experience API layer Fails then it returns error message to the consumers |
8. | Connect to the database | System API establishes the connection with the database to store the data. |
9. | Oracle/SQL connection Exception | If there is any connection failure during the step 5, the Oracle/SQL Exception is thrown by the service. |
10. | On successful connection, store the data of candidate info, exam and qualifications data to database. | After establishing successful DB connection, data of specific resource is stored in respective data base it will processed further to step 15. |
11. | Prepare response | Once the data is service call successfully, the Mule API prepares the Success response. |
12. | Return response | Returns the success response. |
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:
US Transcript Experience API : api/v1/candidates
Topic | Details | |
---|---|---|
1. | Operation Description | Create the candidate data in SNAPI DB |
2. | URI | POST: api/v1/candidates |
3. | Interface Source | Grade Transcript service |
4. | Interface Target | ca-us-transcript-sapi |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-us-transcript-xapi-qa1/api/v1/candidates |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
US Transcript Experience API : api/v1/qualifications
Topic | Details | |
---|---|---|
1. | Operation Description | Create the Candidate Exam data in SNAPI DB |
2. | URI | POST: api/v1/qualifications |
3. | Interface Source | Grade Transcript service |
4. | Interface Target | ca-us-transcript-sapi |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-us-transcript-xapi-qa1/api/v1/qualifications |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
US Transcript Experience API : api/v1/institutions
Topic | Details | |
---|---|---|
1. | Operation Description | Create the candidates institution data in SNAPI DB |
2. | URI | POST: api/v1/institutions |
3. | Interface Source | Grade Transcript service |
4. | Interface Target | ca-us-transcript-sapi |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-us-transcript-xapi-qa1/api/v1/institutions |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
US Transcript Experience API : api/v1/transcripts
Topic | Details | |
---|---|---|
1. | Operation Description | Create the transcript data in SNAPI DB |
2. | URI | POST: api/v1/transcripts |
3. | Interface Source | Grade Transcript service |
4. | Interface Target | Appian web API |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-us-transcript-xapi-qa1/api/v1/transcripts |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
US Transcript Experience API : api/v1/transcripts/costs
Topic | Details | |
---|---|---|
1. | Operation Description | Retrieves the transcript cost details |
2. | URI | GET: api/v1/transcripts/costs |
3. | Interface Source | Grade Transcript service |
4. | Interface Target | ca-us-transcript-sapi |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-us-transcript-xapi-qa1/api/v1/transcripts/costs |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
US Transcript Experience API : api/v1/transcripts/costs
Topic | Details | |
---|---|---|
1. | Operation Description | Creates new transcript cost details |
2. | URI | POST: api/v1/transcripts/costs |
3. | Interface Source | Grade Transcript service |
4. | Interface Target | ca-us-transcript-sapi |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-us-transcript-xapi-qa1/api/v1/transcripts/costs |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
US Transcript Experience API : api/v1/transcripts/costs
Topic | Details | |
---|---|---|
1. | Operation Description | Updates existing transcript cost details |
2. | URI | PUT: api/v1/transcripts/costs |
3. | Interface Source | Grade Transcript service |
4. | Interface Target | ca-us-transcript-sapi |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-us-transcript-xapi-qa1/api/v1/transcripts/costs |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
US Transcript Experience API : api/v1/transcripts/applicationStatus
Topic | Details | |
---|---|---|
1. | Operation Description | Updates payment status of Transcript application |
2. | URI | PUT: api/v1/transcripts/applicationStatus |
3. | Interface Source | Grade Transcript service |
4. | Interface Target | ca-us-transcript-sapi |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-us-transcript-xapi-qa1/api/v1/transcripts/applicationStatus |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
US Transcript Experience API : api/v1/transcripts/orderSummary
Topic | Details | |
---|---|---|
1. | Operation Description | Retrieves order summary of transcript application |
2. | URI | GET: api/v1/transcripts/orderSummary |
3. | Interface Source | Grade Transcript service |
4. | Interface Target | ca-us-transcript-sapi |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-us-transcript-xapi-qa1/api/v1/transcripts/orderSummary |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
US Transcript Experience API : api/v1/examseries
Topic | Details | |
---|---|---|
1. | Operation Description | Retrieves the examseries data from SNAPI DB |
2. | URI | GET: api/v1/examseries |
3. | Interface Source | Grade Transcript service |
4. | Interface Target | ca-us-transcript-sapi |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-us-transcript-xapi-qa1/api/v1/examseries |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
US Transcript Experience API : api/v1/institutions
Topic | Details | |
---|---|---|
1. | Operation Description | Retrieves the institutions data from SNAPI DB |
2. | URI | GET: api/v1/institutions |
3. | Interface Source | Grade Transcript service |
4. | Interface Target | ca-us-transcript-sapi |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-us-transcript-xapi-qa1/api/v1/institutions |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
US Transcript Experience API : api/v1/centres
Topic | Details | |
---|---|---|
1. | Operation Description | Retrieves the centres data from SNAPI DB |
2. | URI | GET: api/v1/centres |
3. | Interface Source | Grade Transcript service |
4. | Interface Target | ca-us-transcript-sapi |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-us-transcript-xapi-qa1/api/v1/centres |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
US Transcript Experience API : api/v1/candidateResults
Topic | Details | |
---|---|---|
1. | Operation Description | Retrieves the candidate results data from SNAPI DB |
2. | URI | GET: api/v1/candidateResults |
3. | Interface Source | Grade Transcript service |
4. | Interface Target | ca-us-transcript-sapi |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-us-transcript-xapi-qa1/api/v1/candidateResults |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
US Transcript Experience API : api/v1/gradeScores
Topic | Details | |
---|---|---|
1. | Operation Description | Creates new transcripts grades table in Db to store the values posted by appian |
2. | URI | POST: api/v1/gradeScores |
3. | Interface Source | Grade Transcript service |
4. | Interface Target | ca-us-transcript-sapi |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-us-transcript-xapi-qa1/api/v1/gradeScores |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
US Transcript Experience API : api/v1/candidates/{applicationReferenceNumber}/scores
Topic | Details | |
---|---|---|
1. | Operation Description | Retrieves the Candidate Scores data from SNAPI DB |
2. | URI | POST: api/v1/candidates/{applicationReferenceNumber}/scores |
3. | Interface Source | Grade Transcript service |
4. | Interface Target | ca-us-transcript-sapi |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-us-transcript-xapi-qa1/api/v1/candidates/{applicationReferenceNumber}/scores |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
US Transcript Experience API : api/v1/candidates/{applicationReferenceNumber}/terms
Topic | Details | |
---|---|---|
1. | Operation Description | Stores Terms and Condition Details in DB |
2. | URI | POST: api/v1/candidates/{applicationReferenceNumber}/terms |
3. | Interface Source | Grade Transcript service |
4. | Interface Target | ca-us-transcript-sapi |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-us-transcript-xapi-qa1/api/v1/candidates/{applicationReferenceNumber}/terms |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
US Transcript Experience API : api/v1/candidates/{uid}/orders
Topic | Details | |
---|---|---|
1. | Operation Description | Retrieves the Candidate Order Details |
2. | URI | POST: api/v1/candidates/{uid}/orders |
3. | Interface Source | Grade Transcript service |
4. | Interface Target | ca-us-transcript-sapi |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-us-transcript-xapi-qa1/api/v1/candidates/{uid}/orders |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
US Transcript Experience API : api/v1/creditPolicy/{InstituteId}
Topic | Details | |
---|---|---|
1. | Operation Description | Retrieves credit details for a particular institute Id |
2. | URI | GET: api/v1/creditPolicy/{InstituteId} |
3. | Interface Source | Grade Transcript service |
4. | Interface Target | ca-mdm-sapi |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-us-transcript-xapi-qa1/api/v1/creditPolicy/{InstituteId} |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
US Transcript Experience API : api/v1/terms
Topic | Details | |
---|---|---|
1. | Operation Description | Retrieves Terms and conditions in HTML |
2. | URI | GET: api/v1/terms |
3. | Interface Source | Grade Transcript service |
4. | Interface Target | NA |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-us-transcript-xapi-qa1/api/v1/terms |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
US Transcript Experience API : api/v1/candidates/gradeChanges
Topic | Details | |
---|---|---|
1. | Operation Description | Retrieves Grade changes |
2. | URI | GET: api/v1/candidates/gradeChanges |
3. | Interface Source | Grade Transcript service |
4. | Interface Target | NA |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-us-transcript-xapi-qa1/api/v1/candidates/gradeChanges |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
US Transcript Experience API : api/v1/transcripts/validatePaymentDue
Topic | Details | |
---|---|---|
1. | Operation Description | Validate if Payment due date breached or not |
2. | URI | POST: api/v1/transcripts/validatePaymentDue |
3. | Interface Source | Grade Transcript service |
4. | Interface Target | NA |
5. | Synchronous/Asynchronous | Synchronous |
6. | Protocol | HTTPs |
7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/ca-us-transcript-xapi-qa1/api/v1/transcripts/validatePaymentDue |
8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |