US Transcript API

(0 reviews)
API used for Grade Transcript Application

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 MethodREST EndpointDescriptionConsumers
1.POST/{version}/candidatesStores the candidate personal information in DBGrade Transcript service
2.POST/{version}/qualificationsStores the Exam Details in DBGrade Transcript service
3.POST/{version}/institutionsStores the Institution Details in DBGrade Transcript service
4.POST/{version}/transcriptsStores the transcripts Details in DBGrade Transcript service
5.GET/{version}/transcripts/costsRetrieves the transcripts service costsGrade Transcript service
6.POST/{version}/transcripts/costsCreates new transcripts service costsGrade Transcript service
7.PUT/{version}/transcripts/costsUpdates existing transcripts service costsGrade Transcript service
8.PUT/{version}/transcripts/applicationStatusUpdate the transcripts application payment statusGrade Transcript service
9.GET/{version}/transcripts/orderSummaryRetrieves the transcripts order summaryGrade Transcript service
10.GET/{version}/examseriesRetrieves the exam series data from SNAPI DatabaseGrade Transcript service
11.GET/{version}/institutionsRetrieves the Institutions data from SNAPI DatabaseGrade Transcript service
12.GET/{version}/centresRetrieves the centres data from SNAPI DatabaseGrade Transcript service
13.GET/{version}/candidateResultsRetrieves the candidates results data from SNAPI DatabaseGrade Transcript service
14.POST/{version}/gradeScoresCreates new transcripts grades table in Db to store the values posted by appianGrade Transcript service
15.GET/{version}/candidates/{applicationReferenceNumber}/scoresRetrieves the Candidate Scores data from SNAPI DatabaseGrade Transcript service
16.POST/{version}/candidates/{applicationReferenceNumber}/termsStores Terms and Condition Details in DBGrade Transcript service
17.GET/{version}/creditPolicy/{InstituteId}/termsRetrieves credit details for a particular institute IdGrade Transcript service
18.GET/{version}/termsRetrieves Terms and conditions in HTML formatGrade Transcript service
19.GET/{version}/candidates/gradeChangesRetrieves Grade changesGrade Transcript service
20.GET/{version}/candidates/{uid}/ordersRetrieves the Candidate Order DetailsGrade Transcript service
21.POST/{version}/transcripts/validatePaymentDueValidate if Payment due date breached or notGrade Transcript service

Integration architecture:

resources/Us-transcripts-e77c611f-dbaf-433b-b6ad-f2683f668b28.png

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.

resources/ustran-f3364319-ed04-4cf3-8883-5f7685fda3ac.PNG

Sequence Diagram and Description:

No.StepsDescription
1.Input Request MessageThe 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.
2Validate the user CredentialsDesktop user credentials are validated by the security API mule gateway layer
3.If Validation fails, service returns specific fault responseIf Validation fails, service returns specific fault response
4.Send the request to specific layered APIThe Mule soft experience API secure layer validated users request query parameters will redirect to the specific Process API.
5.Validate the requestThe 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 responseIf 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 UserWhen Experience API layer Fails then it returns error message to the consumers
8.Connect to the databaseSystem API establishes the connection with the database to store the data.
9.Oracle/SQL connection ExceptionIf 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 responseOnce the data is service call successfully, the Mule API prepares the Success response.
12.Return responseReturns the success response.

resources/us-transcript-seq-3d532566-0c57-4e89-9036-8b71c7b52458.png

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

TopicDetails
1.Operation DescriptionCreate the candidate data in SNAPI DB
2.URIPOST: api/v1/candidates
3.Interface SourceGrade Transcript service
4.Interface Targetca-us-transcript-sapi
5.Synchronous/AsynchronousSynchronous
6.ProtocolHTTPs
7.URLhttps://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

TopicDetails
1.Operation DescriptionCreate the Candidate Exam data in SNAPI DB
2.URIPOST: api/v1/qualifications
3.Interface SourceGrade Transcript service
4.Interface Targetca-us-transcript-sapi
5.Synchronous/AsynchronousSynchronous
6.ProtocolHTTPs
7.URLhttps://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

TopicDetails
1.Operation DescriptionCreate the candidates institution data in SNAPI DB
2.URIPOST: api/v1/institutions
3.Interface SourceGrade Transcript service
4.Interface Targetca-us-transcript-sapi
5.Synchronous/AsynchronousSynchronous
6.ProtocolHTTPs
7.URLhttps://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

TopicDetails
1.Operation DescriptionCreate the transcript data in SNAPI DB
2.URIPOST: api/v1/transcripts
3.Interface SourceGrade Transcript service
4.Interface TargetAppian web API
5.Synchronous/AsynchronousSynchronous
6.ProtocolHTTPs
7.URLhttps://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

TopicDetails
1.Operation DescriptionRetrieves the transcript cost details
2.URIGET: api/v1/transcripts/costs
3.Interface SourceGrade Transcript service
4.Interface Targetca-us-transcript-sapi
5.Synchronous/AsynchronousSynchronous
6.ProtocolHTTPs
7.URLhttps://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

TopicDetails
1.Operation DescriptionCreates new transcript cost details
2.URIPOST: api/v1/transcripts/costs
3.Interface SourceGrade Transcript service
4.Interface Targetca-us-transcript-sapi
5.Synchronous/AsynchronousSynchronous
6.ProtocolHTTPs
7.URLhttps://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

TopicDetails
1.Operation DescriptionUpdates existing transcript cost details
2.URIPUT: api/v1/transcripts/costs
3.Interface SourceGrade Transcript service
4.Interface Targetca-us-transcript-sapi
5.Synchronous/AsynchronousSynchronous
6.ProtocolHTTPs
7.URLhttps://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

TopicDetails
1.Operation DescriptionUpdates payment status of Transcript application
2.URIPUT: api/v1/transcripts/applicationStatus
3.Interface SourceGrade Transcript service
4.Interface Targetca-us-transcript-sapi
5.Synchronous/AsynchronousSynchronous
6.ProtocolHTTPs
7.URLhttps://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

TopicDetails
1.Operation DescriptionRetrieves order summary of transcript application
2.URIGET: api/v1/transcripts/orderSummary
3.Interface SourceGrade Transcript service
4.Interface Targetca-us-transcript-sapi
5.Synchronous/AsynchronousSynchronous
6.ProtocolHTTPs
7.URLhttps://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

TopicDetails
1.Operation DescriptionRetrieves the examseries data from SNAPI DB
2.URIGET: api/v1/examseries
3.Interface SourceGrade Transcript service
4.Interface Targetca-us-transcript-sapi
5.Synchronous/AsynchronousSynchronous
6.ProtocolHTTPs
7.URLhttps://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

TopicDetails
1.Operation DescriptionRetrieves the institutions data from SNAPI DB
2.URIGET: api/v1/institutions
3.Interface SourceGrade Transcript service
4.Interface Targetca-us-transcript-sapi
5.Synchronous/AsynchronousSynchronous
6.ProtocolHTTPs
7.URLhttps://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

TopicDetails
1.Operation DescriptionRetrieves the centres data from SNAPI DB
2.URIGET: api/v1/centres
3.Interface SourceGrade Transcript service
4.Interface Targetca-us-transcript-sapi
5.Synchronous/AsynchronousSynchronous
6.ProtocolHTTPs
7.URLhttps://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

TopicDetails
1.Operation DescriptionRetrieves the candidate results data from SNAPI DB
2.URIGET: api/v1/candidateResults
3.Interface SourceGrade Transcript service
4.Interface Targetca-us-transcript-sapi
5.Synchronous/AsynchronousSynchronous
6.ProtocolHTTPs
7.URLhttps://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

TopicDetails
1.Operation DescriptionCreates new transcripts grades table in Db to store the values posted by appian
2.URIPOST: api/v1/gradeScores
3.Interface SourceGrade Transcript service
4.Interface Targetca-us-transcript-sapi
5.Synchronous/AsynchronousSynchronous
6.ProtocolHTTPs
7.URLhttps://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

TopicDetails
1.Operation DescriptionRetrieves the Candidate Scores data from SNAPI DB
2.URIPOST: api/v1/candidates/{applicationReferenceNumber}/scores
3.Interface SourceGrade Transcript service
4.Interface Targetca-us-transcript-sapi
5.Synchronous/AsynchronousSynchronous
6.ProtocolHTTPs
7.URLhttps://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

TopicDetails
1.Operation DescriptionStores Terms and Condition Details in DB
2.URIPOST: api/v1/candidates/{applicationReferenceNumber}/terms
3.Interface SourceGrade Transcript service
4.Interface Targetca-us-transcript-sapi
5.Synchronous/AsynchronousSynchronous
6.ProtocolHTTPs
7.URLhttps://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

TopicDetails
1.Operation DescriptionRetrieves the Candidate Order Details
2.URIPOST: api/v1/candidates/{uid}/orders
3.Interface SourceGrade Transcript service
4.Interface Targetca-us-transcript-sapi
5.Synchronous/AsynchronousSynchronous
6.ProtocolHTTPs
7.URLhttps://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}

TopicDetails
1.Operation DescriptionRetrieves credit details for a particular institute Id
2.URIGET: api/v1/creditPolicy/{InstituteId}
3.Interface SourceGrade Transcript service
4.Interface Targetca-mdm-sapi
5.Synchronous/AsynchronousSynchronous
6.ProtocolHTTPs
7.URLhttps://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

TopicDetails
1.Operation DescriptionRetrieves Terms and conditions in HTML
2.URIGET: api/v1/terms
3.Interface SourceGrade Transcript service
4.Interface TargetNA
5.Synchronous/AsynchronousSynchronous
6.ProtocolHTTPs
7.URLhttps://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

TopicDetails
1.Operation DescriptionRetrieves Grade changes
2.URIGET: api/v1/candidates/gradeChanges
3.Interface SourceGrade Transcript service
4.Interface TargetNA
5.Synchronous/AsynchronousSynchronous
6.ProtocolHTTPs
7.URLhttps://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

TopicDetails
1.Operation DescriptionValidate if Payment due date breached or not
2.URIPOST: api/v1/transcripts/validatePaymentDue
3.Interface SourceGrade Transcript service
4.Interface TargetNA
5.Synchronous/AsynchronousSynchronous
6.ProtocolHTTPs
7.URLhttps://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

Reviews