cupa-us-data-transformation-xapi

(0 reviews)

Overview:

US Data transformation API to get passrateReport, syllabusReport, templateDownload, school list, syllabus list etc. from backend API to Frontend.

	API Method	REST Endpoint	Description	Consumers
1.	GET	/{version}/templateDownload	Get template download report for demographics	Web User
2.	GET	/{version}/templateDownload	Get template download report for roster	Web User
3.	POST	/{version}/upload	Post upload file	Web User
4.	GET	/{version}/bulkReports	Download report - School Data (csv file)	Web User
5.	GET	/{version}/bulkReports	Download report - Syllabus (zip file with multiple csv's)	Web User
6.	GET	/{version}/bulkReports/district	Download report - School Data (csv file)	Web User
7.	GET	/{version}/bulkReports/district	Download report - Syllabus (zip file with multiple csv's)	Web User
8.	GET	/{version}/bulkReports/state	Download report - School Data (csv file)	Web User
9.	GET	/{version}/bulkReports/state	Download report - Syllabus (zip file with multiple csv's)	Web User
10.	GET	/{version}/centre	Centre mapping	Web User
11.	GET	/{version}/centre/schools	School list	Web User
12.	GET	/{version}/centre/districts	District list	Web User
13.	GET	/{version}/centre/states	State list	Web User
14.	GET	/{version}/syllabuses	Syllabus list	Web User
15.	GET	/{version}/passRateReport/centre	Passrate Report - Centre	Web User
16.	GET	/{version}/passRateReport/district	Passrate Report - District	Web User
17.	GET	/{version}/passRateReport/district/total	Passrate - District total	Web User
18.	GET	/{version}/passRateReport/state	Passrate Report - State	Web User
19.	GET	/{version}/passRateReport/state/total	Passrate - State total	Web User
20.	GET	/{version}/syllabusReport/centre	Syllabus report - Centre	Web User
21.	GET	/{version}/syllabusReport/district	Syllabus report - District	Web User
22.	POST	/{version}/syllabusReport/teacher	Syllabus report - Teacher	Web User
23.	GET	/{version}/studentReport/centre	Student report - Centre	Web User
24.	GET	/{version}/studentReport/district	Student report - District	Web User
25.	GET	/{version}/studentReport/teacher	Student report - Teacher	Web User
26.	GET	/{version}/teacherReport/centre	Teacher report - Centre	Web User
27.	GET	/{version}/demographicReport/centre/ethnicity	Demographic - Ethinicity Report	Web User
28.	GET	/{version}/demographicReport/centre/gender	Demographic - Gender Report	Web User
29.	GET	/{version}/gradeDistributionReport/teacher	Grade Distribution Report	Web User
30.	GET	/{version}/uploadStatus/centre	Upload status - Centre	Web User
31.	GET	/{version}/uploadStatus/district	Upload status - District	Web User
32.	GET	/{version}/termsAndConditions	Terms and Conditions	Web User
33.	POST	/{version}/termsAndConditions	Terms and Conditions	Web User
34.	GET	/{version}/overview/district	Overview - District	Web User
35.	GET	/{version}/overview/state	Overview - State	Web User
36.	GET	/{version}/filewriter/downloadValidationError	Download Validation Report	Web User
37.	GET	/{version}/studentReport/candidate	Student report - Candidate	Web User

Flow Diagram :

resources/MicrosoftTeams-image-2af07256-953f-4622-80a3-5714ebab63d9.png

Sequence Diagram:

resources/Sequence-28c66351-187f-4611-85cd-f63a130dec61.PNG

Steps In Sequence Diagram

No	Steps	Description
1.	Input Request Message	Script Validation get service invokes the mule services along with credentials via Mule Soft Secure API layer .
2.	Validate the Bearer token credentials	If the token is authorized the request is sent to the endpoint.
3.	If validation fails, service returns specific fault response	If validation fails, service returns specific fault response to the caller.
4.	If the request succeeds after calling the Endpoint	A success response is sent to the xapi which sends the success response to the caller.
5.	If the request fails after calling the backend URL	A failed response or a message is sent to xapi which send the messages to the caller.

End Point details:

Note: All the query parameters are mandatory for below endpoints. Please check below the respective endpoint details for any note as optional query parameters.

US Data Transformation Experience API : /v1/templateDownload

	Topic	Details
1.	Operation Description	Get template download report for type-demographics
2.	URI	/v1/templateDownload
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/templateDownload?centreId=US818&assessmentYear=2023&type=demographic&bpId=2011128&districtId=1201500
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: districtId is optional. Rest all the queryParams are mandatory

US Data Transformation Experience API : /v1/templateDownload

	Topic	Details
1.	Operation Description	Get template download report for type-roster
2.	URI	/v1/templateDownload
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/templateDownload?centreId=US818&assessmentYear=2023&type=roster&bpId=2011128&districtId=1201500
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: districtId is optional. Rest all the queryParams are mandatory

US Data Transformation Experience API : /v1/upload

	Topic	Details
1.	Operation Description	Post upload endpoint will store the file in s3, we are using AWS lambda function to invoke the s3 bucket URL.
2.	URI	/v1/upload
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/upload
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

US Data Transformation Experience API : /v1/bulkReports

	Topic	Details
1.	Operation Description	Getting the presigned URL to Download bulk report school data(zip file with multiple csv's)
2.	URI	/v1/bulkReports
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/bulkReports?centreId=US818&series=June%202023&type=school&bpId=2011128&districtId=1201500&stateId=FL
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: districtId and stateId are optional. Rest all the queryParams are mandatory

US Data Transformation Experience API : /v1/bulkReports

	Topic	Details
1.	Operation Description	Get the presigned Url to download bulk report syllabus details (zip file with multiple csv's)
2.	URI	/v1/bulkReports
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/bulkReports?centreId=US818&series=June%202023&type=syllabus&bpId=2011128&districtId=1201500&stateId=FL
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: districtId and stateId are optional. Rest all the queryParams are mandatory

US Data Transformation Experience API : /v1/bulkReports/district

	Topic	Details
1.	Operation Description	Get the presigned URL to download bulk report based on district- School Data (csv file)
2.	URI	/v1/bulkReports/district
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/bulkReports/district?districtId=1201500&series=June%202023&type=school&userId=uuid®enerate=Y&bpId=1729adc2-7995-4e94-b7fa-e517435f99b5
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: regenerate is an optional parameter. Rest all are mandatory.

US Data Transformation Experience API : /v1/bulkReports/district

	Topic	Details
1.	Operation Description	Get the presigned URL to download bulk report based on district- Syllabus Data (csv file)
2.	URI	/v1/bulkReports/district
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/bulkReports/district?districtId=1201500&series=June%202023&type=syllabus&userId=uuid®enerate=Y&bpId=1729adc2-7995-4e94-b7fa-e517435f99b5
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: regenerate is an optional parameter. Rest all are mandatory

US Data Transformation Experience API : /v1/bulkReports/state

	Topic	Details
1.	Operation Description	Get the presigned URL to download bulk report based on state- school Data (csv file)
2.	URI	/v1/bulkReports/state
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/bulkReports/state?stateId=FL&series=June%202023&type=school&userId=uuid®enerate=Y&bpId=88dbf0de-bccf-4a65-b46e-33514fec8b7e
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: regenerate is an optional parameter. Rest all are mandatory

US Data Transformation Experience API : /v1/bulkReports/state

	Topic	Details
1.	Operation Description	Get the presigned URL to download bulk report based on state- syllabus Data (csv file)
2.	URI	/v1/bulkReports/state
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/bulkReports/state?stateId=FL&series=June%202023&type=syllabus&userId=uuid®enerate=Y&bpId=88dbf0de-bccf-4a65-b46e-33514fec8b7e
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: regenerate is an optional parameter. Rest all are mandatory

US Data Transformation Experience API : /v1/centre

	Topic	Details
1.	Operation Description	Get the centre details
2.	URI	/v1/centre
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/centre?centreId=US818&bpId=2011128&districtId=1201500&stateId=FL
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: bpId is Mandatory. Rest of the queryParameters are optional

US Data Transformation Experience API : /v1/centre/schools

	Topic	Details
1.	Operation Description	Get respective School list details based on specific districtId, centreState, stateCode and centerId
2.	URI	/v1/centre/schools
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/centre/schools?stateCode=FL&districtId=1201500¢reId=US818¢reState=Florida&bpId=88dbf0de-bccf-4a65-b46e-33514fec8b7e
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: bpId is mandatory. Rest all are optional

US Data Transformation Experience API : /v1/centre/districts

	Topic	Details
1.	Operation Description	Get respective district list details based on specific districtId, centreState and stateCode. The response details differ based on data passed for optional queryparams
2.	URI	/v1/centre/districts
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/centre/districts?stateCode=FL¢reState=Florida&districtId=1201500&bpId=88dbf0de-bccf-4a65-b46e-33514fec8b7e
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: bpId is mandatory. Rest all are optional.

US Data Transformation Experience API : /v1/centre/states

	Topic	Details
1.	Operation Description	Get respective State list details based on specific centreState & stateCode, the response details differ based on data passed for optional queryparams
2.	URI	/v1/centre/states
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/centre/states?stateCode=FL¢reState=Florida&bpId=4f563249-8963-439d-b01f-dc8e72ccdfeb
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: bpId is mandatory. Rest all are optional.

US Data Transformation Experience API : /v1/syllabuses

	Topic	Details
1.	Operation Description	Get respective Syllabus list details based on the queryParams
2.	URI	/v1/syllabuses
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/syllabuses?centreId=US699&series=June%202023&qual=A%20Level&bpId=88dbf0de-bccf-4a65-b46e-33514fec8b7e&stateId=FL&districtId=1201500
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: bpId is mandatory. Rest all are optional

US Data Transformation Experience API : /v1/passRateReport/centre

	Topic	Details
1.	Operation Description	Get the passrate report based on center by providing the queryparams
2.	URI	/v1/passRateReport/centre
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/passRateReport/centre?centreId=US818&series=[%22June%202023%22]&quals=[%22A%20Level%22]&bpId=2011128&districtId=1201500&stateId=FL
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: districtId and stateId are optional. Rest all the parameters are mandatory

US Data Transformation Experience API : /v1/passRateReport/district

	Topic	Details
1.	Operation Description	Get passrate Report based on district by providing the queryParams
2.	URI	/v1/passRateReport/district
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/passRateReport/district?districtId=1201500&series=[%22June%202020%22]&quals=[%22A%20Level%22]&bpId=1729adc2-7995-4e94-b7fa-e517435f99b5&stateId=FL
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: stateId is optional. Rest all are mandatory

US Data Transformation Experience API : /v1/passRateReport/district/total

	Topic	Details
1.	Operation Description	Get passrate Report based on district total by providing the queryParams
2.	URI	/v1/passRateReport/district/total
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/passRateReport/district/total?districtId=1200390&series=June%202023&qualId=AS%20Level&bpId=88dbf0de-bccf-4a65-b46e-33514fec8b7e&stateId=FL
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: stateId is optional. Rest all are mandatory.

US Data Transformation Experience API : /v1/passRateReport/state

	Topic	Details
1.	Operation Description	Get passrate Report based on state by providing the queryParams
2.	URI	/v1/passRateReport/state
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/passRateReport/state?stateId=Florida&series=[%22June%202020%22]&quals=[%22A%20Level%22]&bpId=88dbf0de-bccf-4a65-b46e-33514fec8b7e&stateCode=FL
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: stateCode is optional. Rest all are mandatory

US Data Transformation Experience API : /v1/passRateReport/state/total

	Topic	Details
1.	Operation Description	Get passrate Report based on state total by providing the queryParams
2.	URI	/v1/passRateReport/state/total
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/passRateReport/state/total?state=FL&series=June%202023&qualId=AS%20Level&bpId=88dbf0de-bccf-4a65-b46e-33514fec8b7e
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: All Parameters are mandatory

US Data Transformation Experience API : /v1/syllabusReport/centre

	Topic	Details
1.	Operation Description	Get syllabus Report based on centre by providing the queryParams
2.	URI	/v1/syllabusReport/centre
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/syllabusReport/centre?centreId=US818&series=[%22June%202023%22]&syllabusID=9693&bpId=2011128&districtId=1201500
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: districtId is optional. Rest all the queryParams are mandatory

US Data Transformation Experience API : /v1/syllabusReport/district

	Topic	Details
1.	Operation Description	Get syllabus Report based on district by providing the queryParams
2.	URI	/v1/syllabusReport/district
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/syllabusReport/district?districtId=1201500&series=[%22June%202023%22]&syllabusID=9693&bpId=1729adc2-7995-4e94-b7fa-e517435f99b5
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: All parameters are mandatory

US Data Transformation Experience API : /v1/syllabusReport/teacher

	Topic	Details
1.	Operation Description	Get syllabus Report details based on teacher by providing mandatory body fields centreId, series, syllabusID, teacherId, bpId
2.	URI	/v1/syllabusReport/teacher
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/syllabusReport/teacher
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: districtId and stateId are optional body fields. Rest all are mandatory.

US Data Transformation Experience API : /v1/studentReport/centre

	Topic	Details
1.	Operation Description	Get student report based on center by providing the queryParams
2.	URI	/v1/studentReport/centre
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/studentReport/centre?centreId=US818&series=June%202023&qualification=AS%20and%20A%20Level&candidateNumber=2743&bpId=2011128&districtId=1201500&stateId=FL
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: centreId, series and bpId are mandatory. Rest all are optional.

US Data Transformation Experience API : /v1/studentReport/district

	Topic	Details
1.	Operation Description	Get student report based on district by providing districtId, series and bpId
2.	URI	/v1/studentReport/district
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/studentReport/district?districtId=1201500&series=June%202023&bpId=1729adc2-7995-4e94-b7fa-e517435f99b5
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: All queryparameters are mandatory.

US Data Transformation Experience API : /v1/studentReport/teacher

	Topic	Details
1.	Operation Description	Get student report based on teacher by providing centreId, series and bpId
2.	URI	/v1/studentReport/teacher
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/studentReport/teacher?centreId=US818&series=June%202023&bpId=2011128
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: All parameters are mandatory.

US Data Transformation Experience API : /v1/teacherReport/centre

	Topic	Details
1.	Operation Description	Get teacher report based on center by providing the queryParams
2.	URI	/v1/teacherReport/centre
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	'https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/teacherReport/centre?centreId=US818&series=June%202023&syllabusID=8021&quals=AS%20Level&bpId=2011128&districtId=1201500
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: syllabusID, districtId are optional. Rest all are Mandatory.

US Data Transformation Experience API : /v1/demographicReport/centre/ethnicity

	Topic	Details
1.	Operation Description	Get demographics ethnicity report based on centre by providing the queryParams
2.	URI	/v1/demographicReport/centre/ethnicity
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/demographicReport/centre/ethnicity?centreId=US818&series=June%202023&syllabusCode=9693&quals=AS%20Level&bpId=2011128&districtId=1201500&stateId=FL
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: syllabusCode, districtId and stateId are optional. Rest all are mandatory.

US Data Transformation Experience API : /v1/demographicReport/centre/gender

	Topic	Details
1.	Operation Description	Get demographics gender report based on centre by providing the queryParams
2.	URI	/v1/demographicReport/centre/gender
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/demographicReport/centre/gender?centreId=US818&series=June%202023&syllabusCode=9693&quals=AS%20Level&bpId=2011128&districtId=1201500&stateId=FL
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: syllabusCode, districtId and stateId are optional. Rest all are mandatory

US Data Transformation Experience API : /v1/gradeDistributionReport/teacher

	Topic	Details
1.	Operation Description	Get the grade distribution report based on teacher by providing the queryParams
2.	URI	/v1/gradeDistributionReport/teacher
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/gradeDistributionReport/teacher?centreId=US818&series=June%202023&quals=AS%20Level&bpId=2011128
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: quals is an optional parameter. Rest all are mandatory.

US Data Transformation Experience API : /v1/uploadStatus/centre

	Topic	Details
1.	Operation Description	Get upload status based on centre by providing the queryParams
2.	URI	/v1/uploadStatus/centre
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/uploadStatus/centre?centreId=US699&assessmentYear=2023&districtId=1201500&bpId=1729adc2-7995-4e94-b7fa-e517435f99b5
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: districtId is optional. Rest all are mandatory

US Data Transformation Experience API : /v1/uploadStatus/district

	Topic	Details
1.	Operation Description	Get upload status based on district by providing the districtId, assessmentYear and bpId
2.	URI	/v1/uploadStatus/district
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/uploadStatus/district?districtId=1201500&assessmentYear=2023&bpId=1729adc2-7995-4e94-b7fa-e517435f99b5
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: All parameters are mandatory

US Data Transformation Experience API : GET - /v1/termsAndConditions

	Topic	Details
1.	Operation Description	Display Terms and Conditions based on location for new userlogin, if the user already exists do not display the T&C
2.	URI	/v1/termsAndConditions
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/termsAndConditions?country=USA&state=FL&userId=UniqueId
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: All parameters are mandatory

US Data Transformation Experience API : POST - /v1/termsAndConditions

	Topic	Details
1.	Operation Description	Updating the Y(yes) status in the database once the new user accepts T&C's and N(no) if the user hasn't accepted the T&C's while login
2.	URI	/v1/termsAndConditions
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/termsAndConditions
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: userId, agreementStatus fields are mandatory

US Data Transformation Experience API : /v1/overview/district

	Topic	Details
1.	Operation Description	Get the overview of the district based on the queryParams
2.	URI	/v1/overview/district
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/overview/district?districtId=1200030&series=June%202023&bpId=88dbf0de-bccf-4a65-b46e-33514fec8b7e&stateId=FL
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: stateId is optional. Rest all are mandatory.

US Data Transformation Experience API : /v1/overview/state

	Topic	Details
1.	Operation Description	Get the overview of the state based on the queryParams
2.	URI	/v1/overview/state
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/overview/state?stateId=FL&series=June%202023&bpId=88dbf0de-bccf-4a65-b46e-33514fec8b7e
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: All parameters are mandatory

US Data Transformation Experience API : /v1/filewriter/downloadValidationError

	Topic	Details
1.	Operation Description	Get the presigned url to download validation report
2.	URI	/v1/filewriter/downloadValidationError
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/filewriter/downloadValidationError?centreId=US818&assessmentYear=2023&fileType=d&bpId=2011128&districtId=1201500&stateId=FL
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: districtId and stateId are optional. Rest all are mandatory

US Data Transformation Experience API : /v1/studentReport/candidate

	Topic	Details
1.	Operation Description	Get student report - candidate history by providing the queryParams
2.	URI	/v1/studentReport/candidate
3.	Interface Source	Web User
4.	Interface Target	Backend url
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPS
7.	URL	https://apis.sandbox.usdt.cambridge.org/cupa-usdt-xapi-qa1/api/v1/studentReport/candidate?cambridgeId=S-B2660612¢reId=US818&series=June%202023&districtId=1201500&stateCode=FL&bpId=2011128
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Note: cambridgeId and bpId are mandatory. All remaining parameters are optional.

home

Overview:

End Point details:

Reviews