Assessment Products API

(0 reviews)

Product - An entity representing a collection of one or more assessments that a candidate takes as evidence for an endorsement.

Overview:

. This document describes the technical design for the API and aligns with the API Requirements Capture template.

. Mule Soft API’s are exposed to fetch the assessments, options, availabilities and qualification data from EPS view and products data from CAMS view using below end points.

	API Method	REST Endpoint	Description	Consumers
1.	GET	/{version}/businessStreams/{businessStreamId}/qualifications	List of qualifications (only at qualification level) for a given Data Source	EMOD, Teach Cambridge
2.	GET	/{version}/businessStreams/{businessStreamId}/qualifications/{qualificationId}/assessments	List of Assessments WITH or WITHOUT component details for the given Qualification	EMOD, Teach Cambridge
3.	GET	/{version}/businessStreams/{businessStreamId}/assessments/components	List of Assessments with component details for the given Qualification. Full Product hierarchy is available through this endpoint (Qualification > Assessment > Component)	EMOD, Teach Cambridge
4.	GET	/{version}/businessStreams/{businessStreamId}/sessions/{sessionId}/availabilities	Details of products (assessments) available for a given sessionId	EMOD, Access To Scripts, GL CI
5.	GET	/{version}/businessStreams/{businessStreamId}/sessions/{sessionId}/options	Details of available option in a session and which components are associated to it	EMOD
6.	GET	/{version}/businessStreams/{businessStreamId}/sessions/assessments/availabilities	Details of Assessment availability for a given asessmentcode in a session or in a range of years	EMOD
7.	GET	/{version}/businessStreams/{businessStreamId}/sessions/components/availabilities	Details of component availability for a given Session/assessmentCode	EMOD, Teach Cambridge
8.	GET	/{version}/vocational-qualifications	List of Vocational Qualifications	CAMS (Not Used)
9.	GET	/{version}/vocational-qualifications/achievables	Full Product details of one Vocational Qualification	CAMS (Not Used)
10.	GET	/{version}/businessStreams/{businessStreamId}/sessions/{sessionId}/articleNumber	GL CI

resources/image-4a2aac81-4a1b-426f-9464-65f6e4ec8517.png

Products Interaction Diagram:

resources/image-20a58159-4338-4849-83e1-cc161a0d8d0b.png

Products Sequence Diagram:

resources/image-9696f67e-a578-48d9-a4a6-41d9d27bed78.png
)

###

End Point details:

1. Products experience API : Get list of qualification details :

	Topic	Details
1.	Operation Description	Get list of qualification details
2.	URI	Api/v1/businessStreams/(businessStreamId)/qualifications
3.	Interface Source	Products Application
4.	Interface Target	EPS
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-products-xapi-dev/api /businessStreams/{businessStreamId}/qualifications
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [List of Qualification from MEPS (CIE, CE) or OEPS (OCR) ]

2. Get list of Assessments for a qualification : List of Assessments WITH or WITHOUT component details for the given Qualification

	Topic	Details
1.	Operation Description	List of Assessments WITH or WITHOUT component details for the given Qualification
2.	URI	Api/v1/businessStreams/(businessStreamId)/qualifications/(qualificationId)/assessments
3.	Interface Source	Products Application
4.	Interface Target	EMOD, Teach Cambridge
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-products-xapi-dev/api /businessStreams/{businessStreamId}/(qualificationId)/assessments
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [List of Product for a qualification with all versions irrespective of Session. All the details...Qualification Group, Qualification, Assessment, Specification, Unit, Tiers, Subjects and Components ]

3. Get Assessment / Components : List of Assessments with component details for the given Qualification. Full Product hierarchy is available through this endpoint (Qualification > Assessment > Component)

	Topic	Details
1.	Operation Description	List of Assessments with component details for the given Qualification. Full Product hierarchy is available through this endpoint (Qualification > Assessment > Component)
2.	URI	Api/v1/businessStreams/(businessStreamId)/assessments/components
3.	Interface Source	Products Application
4.	Interface Target	EPS
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-products-xapi-dev/api /businessStreams/{businessStreamId}/assessments/components
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [Get Product details...Qualification Group, Qualification, Assessment, Specification, Unit, Tiers, Subjects and Components ]

4. Get Product Availability Details : Details of products (assessments) available for a given sessionId

	Topic	Details
1.	Operation Description	Get Details of products (assessments) available for a given sessionId
2.	URI	Api/v1/businessStreams/(businessStreamId)/sessions/(sessionId)/availabilities
3.	Interface Source	Products Application
4.	Interface Target	EMOD, Access To Scripts, GL CI
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-products-xapi-dev/api /businessStreams/(businessStreamId)/sessions/(sessionId)/availabilities
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [Get the information about which qualification, assessment version and component available in a given session]

5. Get Product Option Details : Details of available option in a session and which components are associated to it

	Topic	Details
1.	Operation Description	Get Details of available option in a session and which components are associated to it
2.	URI	Api/v1/businessStreams/(businessStreamId)/sessions/(sessionId)/options
3.	Interface Source	Products Application
4.	Interface Target	EMOD
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-products-xapi-dev/api /businessStreams/(businessStreamId)/sessions/(sessionId)/options
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [Get the options available for an assessment in a session.  Group of components is known as option which is used for entries ]

6. Get Product Assessment Availability Details : Details of Assessment availability for a given asessmentcode in a session or in a range of years

	Topic	Details
1.	Operation Description	Get Details of Assessment availability for a given asessmentcode in a session or in a range of years
2.	URI	Api/v1/businessStreams/(businessStreamId)/sessions/assessments/availabilities
3.	Interface Source	Products Application
4.	Interface Target	EMOD
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-products-xapi-dev/api/businessStreams/(businessStreamId)/sessions/assessments/availabilities
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [Get the information about which qualification, assessment version available in a given session]

7. Get Product Component Availability Details : Details of component availability for a given Session/assessmentCode |

	Topic	Details
1.	Operation Description	Get Details of component availability for a given Session/assessmentCode
2.	URI	Api/v1/businessStreams/(businessStreamId)/sessions/assessments/availabilities
3.	Interface Source	Products Application
4.	Interface Target	EMOD, Teach Cambridge
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-products-xapi-dev/api /businessStreams/(businessStreamId)/sessions/assessments/availabilities
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [Get the information about which qualification, assessment & component  available in a given session]

8. [Get vocational qualifications List : List of Vocational Qualifications

	Topic	Details
1.	Operation Description	Get List of Vocational Qualifications
2.	URI	Api/v1/vocational-qualifications
3.	Interface Source	Products Application
4.	Interface Target	cams
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-products-xapi-dev/api /vocational-qualifications
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [List of Vocational Product Qualifications (Scheme) ]

9. [Get vocational Product List : Full Product details of one Vocational Qualification

	Topic	Details
1.	Operation Description	Get Full Product details of one Vocational Qualification
2.	URI	Api/v1/vocational-qualifications/achievables
3.	Interface Source	Products Application
4.	Interface Target	CAMS
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-products-xapi-dev/api/vocational-qualifications/achievables
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [Details of Vocational Product for a Qualification (Scheme). Vocational Product has two level hierarchy Scheme and Units]

10. [Get Article Number : This resource gets the article number of product assessments with session details

	Topic	Details
1.	Operation Description	This resource gets the article number of product assessments with session details
2.	URI	Api/v1/businessStreams/{businessStreamId}/sessions/{sessionId}/articleNumber
3.	Interface Source	Products Application
4.	Interface Target	EPS
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-products-xapi-dev/api/businessStreams/{businessStreamId}/sessions/{sessionId}/articleNumber
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [This resource gets the article number of product assessments with session details]

home

Overview:

End Point details:

Reviews