The Certifications API provides all the capabilities for managing the certification process beginning with your Certification Program. You can also manage Applications, Courses, or Course Offerings from this API.
Like most of the other Rhythm apps, the Certifications API includes endpoints for Query Definitions. These endpoints are commonly used to retrieve saved queries, which can then be executed using the Query endpoints of the System API.
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseRegistrations/{tenantId}/search?exclusiveStartKey=string&fieldsToReturn=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"arrival_date": [
"2019-08-24T14:15:22Z",
"2019-08-24T14:15:22Z"
],
"city": "string",
"course_id": [
"string"
],
"course_offering_id": [
"string"
],
"date": [
"2019-08-24T14:15:22Z",
"2019-08-24T14:15:22Z"
],
"departure_date": [
"2019-08-24T14:15:22Z",
"2019-08-24T14:15:22Z"
],
"email_address": "string",
"ids": [
"string"
],
"job_title": "string",
"name": "string",
"order_amount_paid": [
0.1,
0.1
],
"order_balance_due": [
0.1,
0.1
],
"order_id": [
"string"
],
"order_number": [
0.1
],
"order_status": [
"string"
],
"order_total": [
0.1,
0.1
],
"state": "string",
"status": [
"string"
],
"sys_created_at": [
"2019-08-24T14:15:22Z",
"2019-08-24T14:15:22Z"
],
"training_location_id": [
"string"
],
"training_provider_id": [
"string"
]
}'{ "Items": [ { … } ], "LastEvaluatedKey": "string" }
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseRegistrations/{tenantId}/student/{student_id}?exclusiveStartKey=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "Count": 0, "Items": [ { … } ], "LastEvaluatedKey": "string" }
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseRegistrations/{tenantId}/studentCourse/{student_id}/{course_id}?exclusiveStartKey=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "Count": 0, "Items": [ { … } ], "LastEvaluatedKey": "string" }