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/
The application that you would like to be saved.
The average score for this submission in the most recent round
Whether or not to embed a whole membership application
The date a letter was sent notifying the user that the failed the exam
The date a letter was sent notifying the user that the passed the exam
The date/time that requirements were last calculated
The date that the review status was last changed
A list of missing requirements... this is automatically calculated for reporting only
The name to be displayed on the certificate
The number of missing requirements
If set, the bucket is not calculated automatically, and instead manually assigned
If true, then this record has been reviewed and now needs action by the staff
The percentage of requirements that have been met
The date the application was decided by the board
The date the application was submitted to the review board
The review status of this application
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
For transfer applications, the target program to transfer
The date this application was billing to the training provider
The invoice that was created to bill for this application
The invoice that was created to bill for this application
The training provider name (for billing)
The training provider billing status for this application
The training provider with which this application is associated
https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/applications/{tenantId}
https://certifications.api.rhythmsoftware.com/applications/{tenantId}
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/applications/{tenantId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"activation_date": "string",
"average_score": 0.1,
"bucket_id": "string",
"certification_id": "string",
"city": "string",
"contact_id": "string",
"country": "string",
"course_offering_ids": [
"string"
],
"credits": [
{
"credit_id": "string",
"credit_type_id": "string",
"exclusive": true,
"quantity": 0.1
}
],
"custom_field_values": [
{
"boolean_value": true,
"custom_field_id": "string",
"file_url_value": "string",
"list_value": [
"string"
],
"numeric_value": 0.1,
"string_value": "string",
"table_value": [
{}
]
}
],
"date": "string",
"email_address": "string",
"embed_membership_application": true,
"exam_fail_letter_sent_date": "string",
"exam_offering_ids": [
"string"
],
"exam_pass_letter_sent_date": "string",
"expiration_date": "string",
"first_name": "string",
"id": "string",
"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": [
{
"id": "string",
"internal_notes": "string",
"name": "string",
"notes": "string",
"portal_explanation": "string",
"type": "string",
"weight": 0.1
}
],
"name": "string",
"name_to_be_printed_on_certificate": "string",
"notes": "string",
"notices": [
{
"date": "2019-08-24T14:15:22Z",
"notice_id": "string"
}
],
"number": 0.1,
"number_of_missing_requirements": 0.1,
"order_id": "string",
"order_line_item_id": "string",
"organization_id": "string",
"override_bucket_assignment": true,
"owner_type": "contact",
"pending_console_review": true,
"percentage_complete": 0.1,
"process_id": "string",
"program_id": "string",
"references": [
{
"id": "string",
"reference_contact_info": {},
"reference_type_id": "string"
}
],
"requirements": [
{
"date_requirement_fulfilled": "2019-08-24T14:15:22Z",
"id": "string",
"internal_notes": "string",
"name": "string",
"not_applicable": true,
"notes": "string",
"portal_explanation": "string",
"status": "fulfilled",
"type": "string",
"weight": 0.1
}
],
"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": [
{
"error": "string",
"field": "string"
}
],
"sys_configuration_snapshot_id": "string",
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"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": "2019-08-24T14:15:22Z",
"sys_last_modified_by_id": "string",
"sys_last_security_context": {},
"sys_locked": true,
"sys_snapshot_base_version": 0.1,
"sys_version": 0.1,
"target_program_id": "string",
"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"
}'The application was saved successfully.
The average score for this submission in the most recent round
Whether or not to embed a whole membership application
The date a letter was sent notifying the user that the failed the exam
The date a letter was sent notifying the user that the passed the exam
The date/time that requirements were last calculated
The date that the review status was last changed
A list of missing requirements... this is automatically calculated for reporting only
The name to be displayed on the certificate
The number of missing requirements
If set, the bucket is not calculated automatically, and instead manually assigned
If true, then this record has been reviewed and now needs action by the staff
The percentage of requirements that have been met
The date the application was decided by the board
The date the application was submitted to the review board
The review status of this application
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
For transfer applications, the target program to transfer
The date this application was billing to the training provider
The invoice that was created to bill for this application
The invoice that was created to bill for this application
The training provider name (for billing)
The training provider billing status for this application
The training provider with which this application is associated
{ "activation_date": "string", "average_score": 0.1, "bucket_id": "string", "certification_id": "string", "city": "string", "contact_id": "string", "country": "string", "course_offering_ids": [ "string" ], "credits": [ { … } ], "custom_field_values": [ { … } ], "date": "string", "email_address": "string", "embed_membership_application": true, "exam_fail_letter_sent_date": "string", "exam_offering_ids": [ "string" ], "exam_pass_letter_sent_date": "string", "expiration_date": "string", "first_name": "string", "id": "string", "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": "string", "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": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "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": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "target_program_id": "string", "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" }
https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/applications/{tenantId}/activate/{applicationId}
https://certifications.api.rhythmsoftware.com/applications/{tenantId}/activate/{applicationId}
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/applications/{tenantId}/activate/{applicationId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{}
https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/applications/{tenantId}/batch
https://certifications.api.rhythmsoftware.com/applications/{tenantId}/batch
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/applications/{tenantId}/batch' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"operations": [
{
"id": null,
"object": {},
"operation": "create",
"patch_directives": {
"0": {
"op": "add",
"path": "string",
"value": "string"
}
}
}
]
}'{ "error_count": 0.1, "results": [ { … } ], "success_count": 0.1 }