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.
https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/
https://certifications.api.rhythmsoftware.com/
https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/applications/{tenantId}/credits/apply/{id}
https://certifications.api.rhythmsoftware.com/applications/{tenantId}/credits/apply/{id}
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/applications/{tenantId}/credits/apply/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"credits": [
{
"credit_id": "string"
}
]
}'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/applications/{tenantId}/credits/unapply/{id}
https://certifications.api.rhythmsoftware.com/applications/{tenantId}/credits/unapply/{id}
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/applications/{tenantId}/credits/unapply/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"credits": [
{
"credit_id": "string"
}
]
}'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/applications/{tenantId}/generateApplication/{processId}/{ownerType}/{ownerId}
https://certifications.api.rhythmsoftware.com/applications/{tenantId}/generateApplication/{processId}/{ownerType}/{ownerId}
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/applications/{tenantId}/generateApplication/{processId}/{ownerType}/{ownerId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "activities": [ { … } ], "application": { "activation_date": "string", "average_score": 0.1, "bucket_id": null, "certification_id": "string", "city": "string", "contact_id": "string", "country": "string", "course_offering_ids": [ … ], "credits": [ … ], "custom_field_values": [ … ], "date": "string", "email_address": "string", "embed_membership_application": true, "exam_fail_letter_sent_date": "string", "exam_offering_ids": [ … ], "exam_pass_letter_sent_date": "string", "expiration_date": "string", "first_name": "string", "id": null, "job_title": "string", "last_name": "string", "last_reminder_date": "string", "last_requirements_calculation_date": "2019-08-24T14:15:22Z", "last_review_status_change": "2019-08-24T14:15:22Z", "missing_requirements": [ … ], "name": "string", "name_to_be_printed_on_certificate": "string", "notes": "string", "notices": [ … ], "number": 0.1, "number_of_missing_requirements": 0.1, "order_id": "string", "order_line_item_id": "string", "organization_id": null, "override_bucket_assignment": true, "owner_type": "contact", "pending_console_review": true, "percentage_complete": 0.1, "process_id": "string", "program_id": "string", "references": [ … ], "requirements": [ … ], "review_board_approval_date": "string", "review_board_submission_date": "string", "review_status": "accepted", "reviewer_recommendation": "string", "round_id": "string", "signature_uri": "string", "state": "string", "status": "activated", "status_reason_id": "string", "submission_space_id": "string", "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ … ], "sys_configuration_snapshot_id": "string", "sys_created_at": null, "sys_created_by_id": null, "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": null, "sys_last_modified_by_id": null, "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "target_program_id": null, "total_score": 0.1, "training_provider_billing_date": "string", "training_provider_billing_invoice_id": "string", "training_provider_billing_invoice_line_item_id": "string", "training_provider_billing_name": "string", "training_provider_billing_status": "billed", "training_provider_id": "string", "type": "certification" }, "available_credits": [ { … } ], "courses": [ { … } ], "credit_requirements": [ { … } ], "exams": [ { … } ] }