Assessment Panels API

(0 reviews)

API retrieve the Panel details from the EPS.

Mule Soft API’s are exposed to fetch the panels, their contact details , examiner and creditor data from EPS/CAMS Databases systems
Its being used by EMOD, CASS, and SFA consumers to get the panels data.

	API Method	This REST Endpoint	Description	Consumers
1.	GET	/{version}/businessStreams/{businessStreamId}/panels/{panelId}/creditors/{creditorNumber}/examiners	Get Examiner details associated to a panel	EMOD
2.	GET	/{version}/businessStreams/{businessStreamId}/sessions/{sessionId}/creditors/{creditorNumber}/lists	Get Panels and details for a given creditor and session	EMOD, CASS
3.	GET	/{version}/businessStreams/{businessStreamId}/panelContacts	Get Panel contact details for given session, centre ,assessment & component	EMOD
4.	GET	/{version}/businessStreams/{businessStreamId}/sessions/{sessionId}/panels/apportionCentres	Get centre details (centres apportioned to a panel) associated to the given list of panels	CASS
5.	GET	/{version}/businessStreams/{businessStreamId}/sessions/{sessionId}/panels	Get distinct Panels ID list for a given session	SFA
6.	GET	/{version}/businessStreams/{businessStreamId}/sessions/{sessionId}/panels/{panelId}/creditors	Get distinct Creditors list for a given session and panel	SFA
7.	GET	/{version}/vocational-qualifications/panels	Get Vocational qualifications panels list	EMOD

API architecture:

resources/API_led-e2c7d468-fb6a-45d0-9e52-8a7c63d19b98.png

1. Flow Diagram and Description:

Consumers would call Panels API to get Panels, contact details, examiners and creditors information as per the session and Panel ID.
Panels API would fetch data from EPS or CAMS system API and provide the response.

resources/Panels-Interaction-e0647479-45b2-48e6-8c1d-86df9674ce76.png

Sequence Diagram and Description:

resources/Sequence%20Diagram-2c1b331a-7498-4141-b027-e2f927c372d1.png

No.	Steps	Description
1.	Input Request Message	The panels 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 parameters.
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 system 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 ca-eps-sapi
6.	Connect to the Database	Eps Service System API establishes the connection with the database to retrieve the data from the database.
7.	Oracle connection Exception	If there is any connection failure during the step 5, the Oracle Exception is thrown by the service.
8.	On successful connection, retrieve the data of examiners, lists ,panel Contacts and apportion Centers from database.	After establishing successful DB connection, data of specific resource is retrieved from respective views.
9.	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.

Panels Experience API : /businessStreams/{businessStreamId}/panels/{panelId}/creditors/{creditorNumber}/examiners

	Topic	Details
1.	Operation Description	Retrieve panels Examiner details from EPS
2.	URI	GET: /{version}/businessStreams/{businessStreamId}/panels/{panelId}/creditors/{creditorNumber}/examiners
3.	Interface Source	Panels Application
4.	Interface Target	ca-eps-sapi
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/ca-panels-qa1/v1/businessStreams/01/panels/1307663/creditors/70295/examiners
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Panels Experience API : api/v1/businessStreams/{businessStreamId}/sessions/{sessionId}/creditors/{creditorNumber}/lists

	Topic	Details
1.	Operation Description	Retrieve panels list data from EPS
2.	URI	GET: /{version}/businessStreams/{businessStreamId}/sessions/{sessionId}/creditors/{creditorNumber}/lists
3.	Interface Source	Panels Application
4.	Interface Target	ca-eps-sapi
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/ca-panels-qa1/v1/businessStreams/01/sessions/8/creditors/278130/lists
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Panels Experience API : api/v1/businessStreams/{businessStreamId}/panelContacts

	Topic	Details
1.	Operation Description	Retrieves contact details of panel
2.	URI	GET: /{version}/businessStreams/{businessStreamId}/panelContacts
3.	Interface Source	Panels Application
4.	Interface Target	ca-eps-sapi
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/ca-panels-qa1/v1/businessStreams/01/panelContacts?sessionId=3269¢reId=66619&assessmentCode=J410&componentId=01
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Panels Experience API : api/v1/businessStreams/{businessStreamId}/sessions/{sessionId}/panels/apportionCentres

	Topic	Details
1.	Operation Description	Get Panels Apportion centres list
2.	URI	GET: /{version}/businessStreams/{businessStreamId}/sessions/{sessionId}/panels/apportionCentres
3.	Interface Source	Panels Application
4.	Interface Target	ca-eps-sapi
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/ca-panels-qa1/v1/businessStreams/01/sessions/16844/panels/apportionCentres
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Panels Experience API : api/v1/businessStreams/{businessStreamId}/sessions/{sessionId}/panels

	Topic	Details
1.	Operation Description	Get Panel ID's from EPS
2.	URI	GET: /{version}/businessStreams/{businessStreamId}/sessions/{sessionId}/panels
3.	Interface Source	Panels Application
4.	Interface Target	ca-eps-sapi
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/ca-panels-qa1/v1/businessStreams/01/sessions/16844/panels
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Panels Experience API : api/v1/businessStreams/{businessStreamId}/sessions/{sessionId}/panels/{panelId}/creditors

	Topic	Details
1.	Operation Description	Get creditor number list from EPS
2.	URI	GET: /{version}/businessStreams/{businessStreamId}/sessions/{sessionId}/panels/{panelId}/creditors
3.	Interface Source	Panels Application
4.	Interface Target	ca-eps-sapi
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/ca-panels-qa1/v1/businessStreams/01/sessions/16844/panels/3086116/creditors
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Panels Experience API : api/v1/vocational-qualifications/panels

	Topic	Details
1.	Operation Description	Get Vocational qualifications panels list
2.	URI	GET: /{version}/vocational-qualifications/panels
3.	Interface Source	Panels Application
4.	Interface Target	ca-cams-sapi
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/ca-panels-qa1/v1/vocational-qualifications/panels?name=Annual&qualificationId=D/505/3095&unitType=M&offset=2&limit=100
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

home