Metrica Test API

(0 reviews)

This API is used for taking test on Metrica, Evolve and JetPack player. Also used to publish results and feedback related to candidate

Overview:

• Metrica Test application exposes endpoints for taking test on Metrica, Evolve and JetPack player and publishing results and feedback for candidate.

• Result and Feedback endpoints are used only for JetPack Player.

	API Method	REST Endpoint	Description	Consumers
1.	POST	/metrica/v1/tests/event	Metrica Admin notifies availability of a test	Metrica
2.	GET	/metrica/{version}/publishedtests	Returns published test content between a date range for a product	Jetpack, Evolve, Cambridge Portal
3.	GET	/metrica/{version}/publishedtests/{testId}	Returns published test content based on test id	Jetpack, Evolve
4.	GET	/metrica/v1/test-player/testresponse/{testId}	Returns test response for a particular test	Jetpack, Evolve
5.	POST	/metrica/v1/test-player/saveResponse	Save candidate response per interaction in metrica	Jetpack, Evolve
6.	POST	/metrica/v1/results/event	Metrica notify that results are available	Metrica
7.	GET	/metrica/v1/results/{testInstanceId}	Returns results from Metrica	Evolve, Jetpack
8.	GET	/metrica/v1/results/{tinId}/qti	Returns results from Metrica	DFE
9.	GET	/metrica/v1/results/event	Check the event notification	DFE
10.	DELETE	/metrica/v1/results/event/{messageId}/{locktoken}	Delete event notification	DFE
11.	POST	/metrica/v1/feedback/event	Publishes and event to notify that feedback is available	DFE

Flow Diagram:

resources/one%20test%20arch%20diageam-010d41b3-ef3b-4604-b8fc-10a16f25b8ca.png

Sequence Diagram:

resources/image-f55f9bb9-746a-472f-8686-a4ab562a86ca.png

Sequence Diagram and Description

No.	Steps	Description
1.	Test Published in Metrica	Metrica system calls Mule's end point to notify a test is published. Mule in turn notifies this to Jetpack and Evo test player
2.	Getting contents of published Test	C1 platform call Mule's endpoint to fetch the test published in Metrica system.
3.	Saving/ Submitting candidate response/ test in Metrica	Evo /Jet player call Mule's endpoint to save response or submit test in Metrica
4.	Retrieving response for a test	Evolve/ Jetpack player call Mule's endpoint to fetch the test response to resume a test
5.	Metrica make result ready	Metrica calls mule's endpoint to notify test result are out for a candidate
6.	DFE admin fetch result for a candidate	Results api are used to fetch the result for a candidate

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.

Error Codes :

HTTP Code	Error Code	Error Message
500	60006	Message Not Processed. There is some technical error while processing request. Please report this to Support team.
400	70416	Message Not Processed:Mandatory Query Parameter is missing.
401	70401	Message Not Processed:Invalid Access token. Please provide valid access token.
401	70402	Message Not Processed:Missing Access token. Please provide valid access token.
401	70405	Message Not Processed: Accesstoken expired. Please try again with valid token.
403	70403	Message Not Processed:Not allowed to access requested resource. Please contact support for the access.
404	70404	Message Not Processed:Requested resource is not found.
503	70503	Message Not Processed:One or more back-end is down. Please try again later.
504	70504	Message Not Processed:Back-end timed out. Please try again later

End Point details:

Metrica Test Experience API : /metrica/v1/tests/event

	Topic	Details
1.	Operation Description	Metrica Admin notifies availability of a test
2.	URI	/metrica/v1/tests/event
3.	Interface Source	Metrica Test Application
4.	Interface Target	Metrica
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/metrica/v1/tests/event
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Metrica Test Experience API : /metrica/{version}/publishedtests

	Topic	Details
1.	Operation Description	Returns published test content between a date range for a product
2.	URI	/metrica/{version}/publishedtests
3.	Interface Source	Metrica Test Application
4.	Interface Target	Jetpack, Evolve, Cambridge Portal
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/metrica/{version}/publishedtests
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Metrica Test Experience API : /metrica/{version}/publishedtests/{testId}

	Topic	Details
1.	Operation Description	Returns published test content based on test id
2.	URI	/metrica/{version}/publishedtests/{testId}
3.	Interface Source	Metrica Test Application
4.	Interface Target	Jetpack, Evolve
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/metrica/{version}/publishedtests/{testId}
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Metrica Test Experience API : /metrica/v1/test-player/testresponse/{testId}

	Topic	Details
1.	Operation Description	Returns test response for a particular test
2.	URI	/metrica/v1/test-player/testresponse/{testId}
3.	Interface Source	Metrica Test Application
4.	Interface Target	Jetpack, Evolve
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/metrica/v1/test-player/testresponse/{testId}
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Metrica Test Experience API : /metrica/v1/test-player/saveResponse

	Topic	Details
1.	Operation Description	Save candidate response per interaction in metrica
2.	URI	/metrica/v1/test-player/saveResponse
3.	Interface Source	Metrica Test Application
4.	Interface Target	Jetpack, Evolve
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/metrica/v1/test-player/saveResponse
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Metrica Test Experience API : /metrica/v1/results/event

	Topic	Details
1.	Operation Description	Metrica notify that results are available
2.	URI	/metrica/v1/results/event
3.	Interface Source	Metrica Test Application
4.	Interface Target	Metrica
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk//metrica/v1/results/event
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Metrica Test Experience API : /metrica/v1/results/{testInstanceId}

	Topic	Details
1.	Operation Description	Returns results from Metrica
2.	URI	/metrica/v1/results/{testInstanceId}
3.	Interface Source	Metrica Test Application
4.	Interface Target	JetPack, Evolve
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/metrica/v1/results/{testInstanceId}
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Metrica Test Experience API : /metrica/v1/results/{tinId}/qti

	Topic	Details
1.	Operation Description	Returns results from Metrica
2.	URI	/metrica/v1/results/{tinId}/qti
3.	Interface Source	Metrica Test Application
4.	Interface Target	DFE
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/metrica/v1/results/{tinId}/qti
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Metrica Test Experience API : /metrica/v1/results/event

	Topic	Details
1.	Operation Description	Check the event notification
2.	URI	/metrica/v1/results/event/{messageId}/{locktoken}
3.	Interface Source	Metrica Test Application
4.	Interface Target	DFE
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/metrica/v1/results/event
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Metrica Test Experience API : /metrica/v1/results/event/{messageId}/{locktoken}

	Topic	Details
1.	Operation Description	Delete event notification
2.	URI	/metrica/v1/results/event/{messageId}/{locktoken}
3.	Interface Source	Metrica Test Application
4.	Interface Target	DFE
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/metrica/v1/results/event/{messageId}/{locktoken}
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Metrica Test Experience API : /metrica/v1/feedback/event

	Topic	Details
1.	Operation Description	Publishes and event to notify that feedback is available
2.	URI	/metrica/v1/feedback/event
3.	Interface Source	Metrica Test Application
4.	Interface Target	DFE
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/metrica/v1/feedback/event
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply