Assessment Entries API

(0 reviews)

Entries - A form of engagement between customers and Cambridge Assessment. Entries will be mainly two types Provisional/Centre Order (An indication of intent) and Final/Candidate Entry (Binding reservation received on or before the closing deadline).

Overview:

Mule Soft API’s are expose to fetch centres, techingGroups, entries, products/entries,candidates/entries, specialConsideration, entries/marks and assessments, assessments entries counts data from EPS using below end points.

	API Method	REST Endpoint	Description	Consumers
1.	GET	/{version}/businessStreams/{businessStreamId}/entries/specialConsiderations	Details of Special Consideration details for the given Business Stream	EMOD
2.	POST	/{version}/businessStreams/{businessStreamId}/entries/marks	Post Entries marks to EPS from EMOD	EMOD
3.	GET	/{version}/businessStreams/{businessStreamId}/entries/marks/errors	Details of errors received while sending entries marks	EMOD
4.	GET	/{version}/businessStreams/{businessStreamId}/sessions/{sessionId}/assessments/{assessmentId}/entries/counts	Get the entries count for the given assessmentCode	EMOD
5.	GET	/{version}/businessStreams/{businessStreamId}/sessions/{sessionId}/teachingGroups	Get Entries Details based on teaching Group	EMOD
6.	GET	/{version}/businessStreams/{businessStreamId}/sessions/{sessionId}/entries/components	Details of Components having at least 95% of Marks submitted from other sources, excluding SfA	EMOD
7.	GET	/{version}/businessStreams/{businessStreamId}/sessions/{sessionId}/entries/counts	Entries count on assessment level for the given sessionId	EMOD
8.	GET	/{version}/businessStreams/{businessStreamId}/sessions/{sessionId}/centres	Get List of centres for which entries modified/updated in a given session	EMOD
9.	GET	/{version}/businessStreams/{businessStreamId}/sessions/{sessionId}/centres/entries/marks	Get details of entries & Marks for the given list of Centres	EMOD
10.	GET	/{version}/businessStreams/{businessStreamId}/sessions/{sessionId}/centres/{centreId}/assessments	Get the list of assessment Code with component details for a particular centre and Session	EMOD
11.	GET	/{version}/businessStreams/{businessStreamId}/sessions/{sessionId}/centres/{centreId}/entries	Details of Entries for the a given Session & Centre	EMOD
12.	GET	/{version}/businessStreams/{businessStreamId}/sessions/{sessionId}/centres/{centreId}/entries/marks	Details of Entries & Marks for the a given Session & Centre	EMOD
13.	GET	/{version}/businessStreams/{businessStreamId}/sessions/{sessionId}/centres/{centreId}/entries/counts	Active Entries Count for a particular Session and Centre	EMOD
14.	GET	/{version}/businessStreams/{businessStreamId}/sessions/{sessionId}/centres/{centreId}/products/entries	Get Entries details based on assessmentcode	OCR Malpractice
15.	GET	/v2/businessStreams/{businessStreamId}/sessions/{sessionId}/centres/{centreId}/products/entries	Get Entries details based on assessmentcode - Version 2	OCR Malpractice
16.	GET	/{version}/businessStreams/{businessStreamId}/sessions/{sessionId}/centres/{centreId}/candidates/entries	Get Centre Candidate Entry details for a given session & Centre	EMOD
17.	GET	/{version}/businessStreams/{businessStreamId}/centres/candidates/nameChangeCount	Get the count of learner name change at centre level	Checkpoint
18.	POST	/{version}/businessStreams/{businessStreamId}/candidates/marks	Get the candidate marks details from EPS for the given batch of Candidate records	OCR malpractice
19.	POST	/{version}/entries/candidates/samplings	Send candidate Sampling status data from eSubmission to Modman	EMOD
20.	PUT	/{version}/candidates/grades	Send candidate grades (Q Grade) to EPS	OCR Malpractice
21.	GET	/{version}/businessStream/{businessStream}/sessionId/{sessionId}/modifiedEntries	Get the latest modified entries	EMOD
22.	GET	/{version}/businessStream/{businessStream}/sessionId/{sessionId}/modifiedMarks	Get the latest modified marks	EMOD

Integration Architecture

resources/image-1c139c14-02cc-4d2d-83fc-1c974417772c.png

Entries Interaction Diagram

resources/image-c6ff7195-a212-4d05-b632-a8317b8debda.png

Entries Sequence Diagram

resources/image-286a2f6d-d0da-479c-b079-5b134361b0a0.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:

1. Get specialConsiderations : Details of Special Consideration for the given Business Stream :

	Topic	Details
1.	Operation Description	Get Details of Special Consideration for the given Business Stream
2.	URI	Api/v1/businessStreams/(businessStreamId)/qualifications
3.	Interface Source	Entries Application
4.	Interface Target	EMOD
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-Entries-xapi-dev/api businessStreams/{businessStreamId}/entries/specialConsiderations
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply	EntriesEntries

     [Get Details of Special Consideration for the given Business Stream ]

2. Post Entries marks : Post Entries marks to EPS from EMOD

	Topic	Details
1.	Operation Description	Post Entries marks to EPS from EMOD
2.	URI	Api/v1/businessStreams/{businessStreamId}/entries/marks
3.	Interface Source	Entries Application
4.	Interface Target	EMOD
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-entries-xapi-dev/api /businessStreams/{businessStreamId}/entries/marks
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [Post Entries marks   : Post Entries marks to EPS from EMOD ]

3. Get Entries Marks Errors : GET Details of errors received while sending entries marks

	Topic	Details
1.	Operation Description	GET Details of errors received while sending entries marks
2.	URI	Api/v1/businessStreams/{businessStreamId}/entries/marks/errors
3.	Interface Source	Entries Application
4.	Interface Target	EMOD
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-Entries-xapi-dev/api /businessStreams/{businessStreamId}/entries/marks/errors
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [GET Details of errors received while sending entries marks ]

4. Get Assessments Entries Counts : Get the entries count for the given Assessmentcode

	Topic	Details
1.	Operation Description	Get the entries count for the given Assessmentcode
2.	URI	Api/v1/businessStreams/{businessStreamId}/sessions/{sessionId}/assessments/{assessmentId}/entries/counts
3.	Interface Source	Entries Application
4.	Interface Target	EMOD
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-Entries-xapi-dev/api /businessStreams/{businessStreamId}/sessions/{sessionId}/assessments/{assessmentId}/entries/counts
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [Get the entries count for the given Assessmentcode]

5. Get Entries teaching Group : Get Entries Details based on teaching Group

	Topic	Details
1.	Operation Description	Get Entries Details based on teaching Group
2.	URI	Api/v1/businessStreams/{businessStreamId}/sessions/{sessionId}/teachingGroups
3.	Interface Source	entries Application
4.	Interface Target	EMOD
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-Entries-xapi-dev/api /businessStreams/{businessStreamId}/sessions/{sessionId}/teachingGroups
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [Get Entries Details based on teaching Group ]

6. Get Entries Components: Details of Components having at least 95% of Marks

	Topic	Details
1.	Operation Description	Get Details of Components having at least 95% of Marks
2.	URI	Api/v1/businessStreams/{businessStreamId}/sessions/{sessionId}/entries/components
3.	Interface Source	Entriess Application
4.	Interface Target	EMOD
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-Entries-xapi-dev/api/businessStreams/{businessStreamId}/sessions/{sessionId}/entries/components
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [Details of Components having at least 95% of Marks]

7. Get Sessions Entries count : Entries count on assessment level for the given sessionId |

	Topic	Details
1.	Operation Description	Get Entries count on assessment level for the given sessionId
2.	URI	Api/v1/businessStreams/{businessStreamId}/sessions/{sessionId}/entries/counts
3.	Interface Source	Entries Application
4.	Interface Target	EMOD
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-Entries-xapi-dev/api /businessStreams/{businessStreamId}/sessions/{sessionId}/entries/counts
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [ Entries count on assessment level for the given sessionId]

8. [Get centres : Get List of centres for which entries modified/updated in a given session

	Topic	Details
1.	Operation Description	Get List of centres for which entries modified/updated in a given session
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-Entries-xapi-dev/api /businessStreams/{businessStreamId}/sessions/{sessionId}/centres
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [Get List of centers for which entries modified/updated  in a given session ]

9. [Get Centers Entries Marks : Get details of entries & Marks for the given list of Centers

	Topic	Details
1.	Operation Description	Get details of entries & Marks for the given list of Centres
2.	URI	Api/v1/businessStreams/{businessStreamId}/sessions/{sessionId}/centres/entries/marks
3.	Interface Source	Entries Application
4.	Interface Target	EMOD
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-Entries-xapi-dev/api/businessStreams/{businessStreamId}/sessions/{sessionId}/centres/entries/marks
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [Get details of entries & Marks for the given list of Centres]

10. [Get Article Number : Get the list of assessment Code with component details for a particular centre and Session

	Topic	Details
1.	Operation Description	Get the list of assessment Code with component details for a particular centre and Session
2.	URI	Api/v1/businessStreams/{businessStreamId}/sessions/{sessionId}/centres/{centreId}/assessments
3.	Interface Source	Entries Application
4.	Interface Target	EMOD
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-Entries-xapi-dev/api/businessStreams/{businessStreamId}/sessions/{sessionId}/centres/{centreId}/assessments
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [Get the list of assessment Code with component details  for a particular centre and Session ]

11. Get Sessions Centres Entries : Details of Entries for the a given Session & Centre :

	Topic	Details
1.	Operation Description	Details of Entries for the a given Session & Centre
2.	URI	Api/v1/businessStreams/{businessStreamId}/sessions/{sessionId}/centres/{centreId}/entries
3.	Interface Source	Entries Application
4.	Interface Target	EPS
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-Entries-xapi-dev/api /businessStreams/{businessStreamId}/sessions/{sessionId}/centres/{centreId}/entries
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [Details of Entries for the a given Session & Centre ]

12. Get list of Assessments for a qualification : Details of Entries & Marks for the a given Session & Centre

	Topic	Details
1.	Operation Description	Details of Entries & Marks for the a given Session & Centre
2.	URI	Api/v1/businessStreams/{businessStreamId}/sessions/{sessionId}/centres/{centreId}/entries/marks
3.	Interface Source	Entries Application
4.	Interface Target	EMOD
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-entries-xapi-dev/api /businessStreams/{businessStreamId}/sessions/{sessionId}/centres/{centreId}/entries/marks
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [ Details of Entries  & Marks for the a given Session & Centre  ]

13. Get Assessment / Components : Active Entries Count for a particular Session and Centre

	Topic	Details
1.	Operation Description	Active Entries Count for a particular Session and Centre
2.	URI	Api/v1/businessStreams/{businessStreamId}/sessions/{sessionId}/centres/{centreId}/entries/counts
3.	Interface Source	Entries Application
4.	Interface Target	EMOD
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-Entries-xapi-dev/api /businessStreams/{businessStreamId}/sessions/{sessionId}/centres/{centreId}/entries/counts
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [Active Entries Count for a particular Session and Centre ]

14. Get Product Entries : Get Entries details based on assessmentcode

	Topic	Details
1.	Operation Description	Get Entries details based on assessmentcode
2.	URI	Api/v1/businessStreams/{businessStreamId}/sessions/{sessionId}/centres/{centreId}/products/entries
3.	Interface Source	Entries Application
4.	Interface Target	OCR Malpractice
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-entries-xapi-dev/api /businessStreams/{businessStreamId}/sessions/{sessionId}/centres/{centreId}/products/entries
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [Get Entries details based on assessmentcode]

15. Get Product Option Details : Get Entries details based on assessmentcode - Version 2

	Topic	Details
1.	Operation Description	Get Entries details based on assessmentcode - Version 2
2.	URI	Api/v2/businessStreams/{businessStreamId}/sessions/{sessionId}/centres/{centreId}/products/entries
3.	Interface Source	Products Application
4.	Interface Target	OCR Malpractice
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-entries-xapi-dev/api /businessStreams/{businessStreamId}/sessions/{sessionId}/centres/{centreId}/products/entries
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [Get Entries details based on assessmentcode - Version 2]

16. Get candidate entry Details : Get Centre Candidate Entry details for a given session & Centre

	Topic	Details
1.	Operation Description	Get Centre Candidate Entry details for a given session & Centre
2.	URI	Api/v1/businessStreams/{businessStreamId}/sessions/{sessionId}/centres/{centreId}/candidates/entries
3.	Interface Source	entries Application
4.	Interface Target	EMOD
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-entriess-xapi-dev/api/businessStreams/{businessStreamId}/sessions/{sessionId}/centres/{centreId}/candidates/entries
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [Get Centre Candidate Entry details for a given session & Centre]

17. Get Product Component Availability Details : Get the count of learner name change at centre level |

	Topic	Details
1.	Operation Description	Get the count of learner name change at centre leve
2.	URI	Api/v1/businessStreams/{businessStreamId}/centres/candidates/nameChangeCount
3.	Interface Source	entries Application
4.	Interface Target	Checkpoint
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-entries-xapi-dev/api /businessStreams/{businessStreamId}/centres/candidates/nameChangeCount
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [Get the count of learner name change at centre level]

18. [Get Marks Details : Get the candidate marks details from EPS for the given batch of Candidate records

	Topic	Details
1.	Operation Description	Get the candidate marks details from EPS for the given batch of Candidate records
2.	URI	Api/v1/businessStreams/{businessStreamId}/candidates/marks
3.	Interface Source	Entries Application
4.	Interface Target	OCR malpractice
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-entries-xapi-dev/api/businessStreams/{businessStreamId}/candidates/marks
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [Get the candidate marks details from EPS for the given batch of Candidate records ]

19. [Post Candidate Samplings : Send candidate Sampling status data from eSubmission to Modman

	Topic	Details
1.	Operation Description	Send candidate Sampling status data from eSubmission to Modman
2.	URI	Api/v1/entries/candidates/samplings
3.	Interface Source	Entriess Application
4.	Interface Target	EMOD
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-Entriess-xapi-dev/api/entries/candidates/samplings
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [Send candidate Sampling status data  from eSubmission to Modman]

20. [Put Candidate Grades: Send candidate grades (Q Grade) to EPS

	Topic	Details
1.	Operation Description	Send candidate grades (Q Grade) to EPS
2.	URI	Api/v1/businessStreams/{businessStreamId}/sessions/{sessionId}/articleNumber
3.	Interface Source	Entries Application
4.	Interface Target	OCR Malpractice
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-Entries-xapi-dev/api/businessStreams/{businessStreamId}/sessions/{sessionId}/articleNumber
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [Send candidate grades (Q Grade) to EPS ]

21. Products experience API : Get the latest modified entries :

	Topic	Details
1.	Operation Description	Get the latest modified entries
2.	URI	Api/v1/businessStream/{businessStream}/sessionId/{sessionId}/modifiedTime
3.	Interface Source	Entries Application
4.	Interface Target	EMOD
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-Entries-xapi-dev/api /businessStream/{businessStream}/sessionId/{sessionId}/modifiedTime
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [Get the latest modified entries ]

22. Get Modified Marks : Get the latest modified marks Qualification

	Topic	Details
1.	Operation Description	Get the latest modified marks
2.	URI	Api/v1/businessStream/{businessStream}/sessionId/{sessionId}/modifiedMarks
3.	Interface Source	Entriess Application
4.	Interface Target	EMOD
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https:// apis-sandbox.cambridgeassessment.org.uk/ca-Entries-xapi-dev/api /businessStream/{businessStream}/sessionId/{sessionId}/modifiedMarks
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

     [Get the latest modified marks ]

home

Reviews