DSMC Mobile API

(0 reviews)

A Mobile application will be created for CE - examiners to submit the marks for candidates speaking tests without any anomalies

Overview:

• DSMC Mobile API’s are exposed to fetch Sessions, Centres, receipts, Candidates from SAP Odata using below endpoints.

• This API is also used to post Marks from DSMC Mobile Application to SAP via AWS SQS connector.

• Candidates marks are sent from DSMC mobile app to DSMC Mobile Xapi and it is sent to SAP systems to compute final marks.

	API Method	REST Endpoint	Description	Consumers
1.	GET	/{version}/centres	Retrieve the list of centres for provide filters	Mobile APP
2.	GET	/{version}/sessions	Retrieve the list of sessions for provide filters	Mobile APP
3.	GET	/{version}/candidates	Retrieve the list of candidates for provide filters	Mobile APP
4.	GET	/{version}/receipts	Retrieve the receipts details from SAP Receipts Odata	Mobile APP
5.	POST	/{version}/ingestMarks	Retrieve the ingestMarks details from DSMC Mobile Application	Mobile APP
6.	GET	/{version}/examiners	Retrieve the list of examiners	Mobile APP

resources/6-cbb3a0e2-830a-41de-a6d0-d97207feb0db.PNG

1. Flow Diagram and Description:

The mobile application is used to first login from SAP CDC and then retrieve centres, sessions, candidates,receipts data from SAP ECC and post speaking marks to SAP RD HANA.

resources/2-9956eff4-cb7b-4340-a5c6-87695abad238.PNG

2. Flow Diagram and Description:

Marks Ingest service is implemented, using a Post call to Experience API layer which delievers the message to AWS SQS with marks details.
Process API would fetch messages from AWS SQS and post the it to SAP HANA web service . After receiving success message from web service , the message get deleted from AWA SQS.

resources/DSMC%20Marks%20Ingest-7b247065-e32c-4e33-ac5f-4df1a39765ab.PNG

Sequence Diagram and Description:

No.	Steps	Description
1.	Input Request Message	The dsmc 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 query params
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 Led 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 Process Api.
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 SAP	Mule API will invoke SAP and retrieve the Odata response.
9.	SAP connection Exception	On sap connection failure, return error message. If there is any connection failure during the step 5, the sap Exception is thrown by the service.
10.	On successful, retrieve the Odata of centres, document changes, products and sessions from sap.	Once the data is retrieved successfully, the Mule API converts odata to json response.
11.	Return response	Returns the success response.

resources/5-c3cb4b2b-b7f2-4900-ba66-d83bcc6262db.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.
SQS has been enabled with DLQ and zero message loss is ensured.

End Point details:

DSMC Experience API : api/v1/centres

	Topic	Details
1.	Operation Description	Retrieve the OData from SAP
2.	URI	api/v1/centres
3.	Interface Source	DSMC Mobile Application
4.	Interface Target	SAP ECC
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/cupa-dsmc-mobile-xapi-qa1/api/v1/centres?offset=1&limit=1&salesOrg=ESOL&distributionChannel=BB&division=00&partnerFunction=SP&customerOrderBlock=&legacyCentreNumber=MX005&customerGroup=Z001
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

DSMC Experience API : api/v1/sessions

	Topic	Details
1.	Operation Description	Retrieve the OData from SAP
2.	URI	api/v1/sessions
3.	Interface Source	DSMC Mobile Application
4.	Interface Target	SAP ECC
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/cupa-dsmc-mobile-xapi-dev/api/v1/sessions?keyAssessmentStartDate=2020-02-01T00:00:00&keyAssessmentEndDate=2020-03-01T00:00:00&legacyCentreNumber=MX005&documentType=ZNAM&salesOrg=ESOL&distributionChannel=BB&division=00&partnerFunction=PB,CB&reasonForRejection=&limit=1&offset=1
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

DSMC Experience API : api/v1/candidates

	Topic	Details
1.	Operation Description	Retrieve the OData from SAP
2.	URI	api/v1/candidates
3.	Interface Source	DSMC Mobile Application
4.	Interface Target	SAP ECC
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/cupa-dsmc-mobile-xapi-qa1/api/v1/candidates?entryOrdNo=20125772&firstName=Test&lastName=&candidateNo=00&limit=1&offset=1
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

DSMC Experience API : api/v1/receipts

	Topic	Details
1.	Operation Description	Retrieve the OData from SAP
2.	URI	api/v1/receipts
3.	Interface Source	DSMC Mobile Application
4.	Interface Target	SAP ECC
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/cupa-dsmc-mobile-xapi-qa1/api/v1/receipts?type=PORTAL&keyAssessmentStartDate=2019-01-01T00:00:00&keyAssessmentEndDate=2022-12-31T00:00:00&achievable=D435/04
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

DSMC Experience API : api/v1/ingestMarks

	Topic	Details
1.	Operation Description	Post the Candidate Marks to SQS
2.	URI	api/v1/ingestMarks
3.	Interface Source	DSMC Mobile Application
4.	Interface Target	SAP HANA
5.	Synchronous/Asynchronous	Asynchronous
6.	Protocol	HTTPs
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/cupa-dsmc-mobile-xapi-qa1/api/v1/ingestMarks
8.	Mode of Communication	☐ Batch ☒ Message ☐ Real Time
9.	Interface Pattern	☒ Publish / Subscribe ☐ Request / Reply

DSMC Experience API : api/v1/examiners

	Topic	Details
1.	Operation Description	Retrieve the examiners details
2.	URI	api/v1/examiners
3.	Interface Source	DSMC Mobile Application
4.	Interface Target	SAP ECC
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/cupa-dsmc-mobile-xapi-qa1/api/v1/examiners?loadDate=2023-12-13T08%3A33%3A20.060
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

home

Overview:

End Point details:

Reviews