Skip to content

Certifications (v1-2025-04-18)

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.

Download OpenAPI description
certifications-v1.json
certifications-v1.yaml
Languages
Servers
Mock server
https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1
https://certifications.api.rhythmsoftware.com

Activities

Activities

Operations

Activity Reg Processes

Activity Reg Processes

Operations

Activity Types

Activity Types

Operations

App Reference Processes

App Reference Processes

Operations

App Reference Types

App Reference Types

Operations

App Status Reasons

App Status Reasons

Operations

Application Fees

Application Fees

Operations

Application Notices

Application Notices

Operations

Application Processes

Application Processes

Operations

Application References

Application References

Operations

Applications

Applications

Operations

Gets all of the applications in the system.

Request

This method will scan all applications and and return them to the caller.

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed.

Query
fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned.

exclusiveStartKeystring

The start key, if you're making a subsequent request

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/applications/{tenantId}?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The applicationswere retrieved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/jsonArray [
activation_datestring(Activation Date)

The date the certification was activated

average_scorenumber(float)(Average Score)

The average score for this submission in the most recent round

bucket_idstring(Bucket)required

The review bucket

certification_idstring(Certification)

The certification that this application is tied to

citystring(City)

The member city

contact_idstring(Contact)required

The contact who is applying

countrystring(Country)

The member country

course_offering_idsArray of strings(Course Offerings)
creditsArray of objects
custom_field_valuesArray of objects(Custom Field Values)
datestring(Date)required

The date of the application

email_addressstring(Email Address)

The member's email address

embed_membership_applicationboolean(Embed Membership Application)

Whether or not to embed a whole membership application

exam_fail_letter_sent_datestring(Exam Fail Letter Sent Date)

The date a letter was sent notifying the user that the failed the exam

exam_offering_idsArray of strings(Exam Offerings)
exam_pass_letter_sent_datestring(Exam Pass Letter Sent Date)

The date a letter was sent notifying the user that the passed the exam

expiration_datestring(Expiration Date)

The date this application should no longer be eligible

first_namestring(First Name)

The member's first name

idstring(ID)^[\w:|-]+$required

The unique, string identifier of this application

job_titlestring(Job Title)

The member job title

last_namestring(Last Name)

The member's last name

last_reminder_datestring(Last Reminder Date)

The last time a reminder was sent for this application

last_requirements_calculation_datestring(date-time)(Last Requirements Calculation Date)

The date/time that requirements were last calculated

last_review_status_changestring(date-time)(Last Review Status Change)

The date that the review status was last changed

missing_requirementsArray of objects

A list of missing requirements... this is automatically calculated for reporting only

namestring(Name)required

The member's name

name_to_be_printed_on_certificatestring(Name To Be Printed On Certificate)

The name to be displayed on the certificate

notesstring(Notes)

Notes

noticesArray of objects
numbernumber(float)(Number)

The application number

number_of_missing_requirementsnumber(float)(Number Of Missing Requirements)

The number of missing requirements

order_idstring(Order)

The order that last touched this application

order_line_item_idstring(Order Line Item)

The order line item touched this application

organization_idstring(Organization)required

The organization

override_bucket_assignmentboolean(Override Bucket Assignment)

If set, the bucket is not calculated automatically, and instead manually assigned

owner_typestring(Owner Type)required
Enum"contact""organization"
pending_console_reviewboolean(Pending Console Review)

If true, then this record has been reviewed and now needs action by the staff

percentage_completenumber(float)(Percentage Complete)

The percentage of requirements that have been met

process_idstring(Process)

The application process

program_idstring(Program)required

The certification program

referencesArray of objectsnon-empty
requirementsArray of objects
review_board_approval_datestring(Review Board Approval Date)

The date the application was decided by the board

review_board_submission_datestring(Review Board Submission Date)

The date the application was submitted to the review board

review_statusstring(Review Status)

The review status of this application

Enum"accepted""alternate""declined""pending review"
reviewer_recommendationstring(Reviewer Recommendation)

Aggregate recommendation across all reviewers

round_idstring(Round)

The review round

signature_uristring(Signature Uri)

The signature

statestring(State)

The state

statusstring(Status)
Enum"activated""approved""draft""expired""missing requirements""pending approval""rejected"
status_reason_idstring(Status Reason)

The reason the app is in the status - sub-status

submission_space_idstring(Submission Space)

The submission space to which this object belongs

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

target_program_idstring(Target Program)required

For transfer applications, the target program to transfer

total_scorenumber(float)(Total Score)

The total score for this submission in the most recent round

training_provider_billing_datestring(Training Provider Billing Date)

The date this application was billing to the training provider

training_provider_billing_invoice_idstring(Training Provider Billing Invoice)

The invoice that was created to bill for this application

training_provider_billing_invoice_line_item_idstring(Training Provider Billing Invoice Line Item)

The invoice that was created to bill for this application

training_provider_billing_namestring(Training Provider Billing Name)

The training provider name (for billing)

training_provider_billing_statusstring(Training Provider Billing Status)

The training provider billing status for this application

Enum"billed""billing hold""exempt from billing""not yet billed"
training_provider_idstring(Training Provider)

The training provider with which this application is associated

typestring(Type)required
Enum"certification""reinstatement""renewal""transfer"
]
Response
application/json
[
  {
    "activation_date": "string",
    "average_score": 0.1,
    "bucket_id": "string",
    "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": "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"
  }
]

Creates a new application record that does not already exist.

Request

This method will auto-generate an ID and create a new application. If an ID is specified for the application, an error will be thrown.

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The application that you would like to be saved.

activation_datestring(Activation Date)

The date the certification was activated

average_scorenumber(float)(Average Score)

The average score for this submission in the most recent round

bucket_idstring(Bucket)required

The review bucket

certification_idstring(Certification)

The certification that this application is tied to

citystring(City)

The member city

contact_idstring(Contact)required

The contact who is applying

countrystring(Country)

The member country

course_offering_idsArray of strings(Course Offerings)
creditsArray of objects
custom_field_valuesArray of objects(Custom Field Values)
datestring(Date)required

The date of the application

email_addressstring(Email Address)

The member's email address

embed_membership_applicationboolean(Embed Membership Application)

Whether or not to embed a whole membership application

exam_fail_letter_sent_datestring(Exam Fail Letter Sent Date)

The date a letter was sent notifying the user that the failed the exam

exam_offering_idsArray of strings(Exam Offerings)
exam_pass_letter_sent_datestring(Exam Pass Letter Sent Date)

The date a letter was sent notifying the user that the passed the exam

expiration_datestring(Expiration Date)

The date this application should no longer be eligible

first_namestring(First Name)

The member's first name

idstring(ID)^[\w:|-]+$required

The unique, string identifier of this application

job_titlestring(Job Title)

The member job title

last_namestring(Last Name)

The member's last name

last_reminder_datestring(Last Reminder Date)

The last time a reminder was sent for this application

last_requirements_calculation_datestring(date-time)(Last Requirements Calculation Date)

The date/time that requirements were last calculated

last_review_status_changestring(date-time)(Last Review Status Change)

The date that the review status was last changed

missing_requirementsArray of objects

A list of missing requirements... this is automatically calculated for reporting only

namestring(Name)required

The member's name

name_to_be_printed_on_certificatestring(Name To Be Printed On Certificate)

The name to be displayed on the certificate

notesstring(Notes)

Notes

noticesArray of objects
numbernumber(float)(Number)

The application number

number_of_missing_requirementsnumber(float)(Number Of Missing Requirements)

The number of missing requirements

order_idstring(Order)

The order that last touched this application

order_line_item_idstring(Order Line Item)

The order line item touched this application

organization_idstring(Organization)required

The organization

override_bucket_assignmentboolean(Override Bucket Assignment)

If set, the bucket is not calculated automatically, and instead manually assigned

owner_typestring(Owner Type)required
Enum"contact""organization"
pending_console_reviewboolean(Pending Console Review)

If true, then this record has been reviewed and now needs action by the staff

percentage_completenumber(float)(Percentage Complete)

The percentage of requirements that have been met

process_idstring(Process)

The application process

program_idstring(Program)required

The certification program

referencesArray of objectsnon-empty
requirementsArray of objects
review_board_approval_datestring(Review Board Approval Date)

The date the application was decided by the board

review_board_submission_datestring(Review Board Submission Date)

The date the application was submitted to the review board

review_statusstring(Review Status)

The review status of this application

Enum"accepted""alternate""declined""pending review"
reviewer_recommendationstring(Reviewer Recommendation)

Aggregate recommendation across all reviewers

round_idstring(Round)

The review round

signature_uristring(Signature Uri)

The signature

statestring(State)

The state

statusstring(Status)
Enum"activated""approved""draft""expired""missing requirements""pending approval""rejected"
status_reason_idstring(Status Reason)

The reason the app is in the status - sub-status

submission_space_idstring(Submission Space)

The submission space to which this object belongs

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

target_program_idstring(Target Program)required

For transfer applications, the target program to transfer

total_scorenumber(float)(Total Score)

The total score for this submission in the most recent round

training_provider_billing_datestring(Training Provider Billing Date)

The date this application was billing to the training provider

training_provider_billing_invoice_idstring(Training Provider Billing Invoice)

The invoice that was created to bill for this application

training_provider_billing_invoice_line_item_idstring(Training Provider Billing Invoice Line Item)

The invoice that was created to bill for this application

training_provider_billing_namestring(Training Provider Billing Name)

The training provider name (for billing)

training_provider_billing_statusstring(Training Provider Billing Status)

The training provider billing status for this application

Enum"billed""billing hold""exempt from billing""not yet billed"
training_provider_idstring(Training Provider)

The training provider with which this application is associated

typestring(Type)required
Enum"certification""reinstatement""renewal""transfer"
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"
  }'

Responses

The application was saved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
activation_datestring(Activation Date)

The date the certification was activated

average_scorenumber(float)(Average Score)

The average score for this submission in the most recent round

bucket_idstring(Bucket)required

The review bucket

certification_idstring(Certification)

The certification that this application is tied to

citystring(City)

The member city

contact_idstring(Contact)required

The contact who is applying

countrystring(Country)

The member country

course_offering_idsArray of strings(Course Offerings)
creditsArray of objects
custom_field_valuesArray of objects(Custom Field Values)
datestring(Date)required

The date of the application

email_addressstring(Email Address)

The member's email address

embed_membership_applicationboolean(Embed Membership Application)

Whether or not to embed a whole membership application

exam_fail_letter_sent_datestring(Exam Fail Letter Sent Date)

The date a letter was sent notifying the user that the failed the exam

exam_offering_idsArray of strings(Exam Offerings)
exam_pass_letter_sent_datestring(Exam Pass Letter Sent Date)

The date a letter was sent notifying the user that the passed the exam

expiration_datestring(Expiration Date)

The date this application should no longer be eligible

first_namestring(First Name)

The member's first name

idstring(ID)^[\w:|-]+$required

The unique, string identifier of this application

job_titlestring(Job Title)

The member job title

last_namestring(Last Name)

The member's last name

last_reminder_datestring(Last Reminder Date)

The last time a reminder was sent for this application

last_requirements_calculation_datestring(date-time)(Last Requirements Calculation Date)

The date/time that requirements were last calculated

last_review_status_changestring(date-time)(Last Review Status Change)

The date that the review status was last changed

missing_requirementsArray of objects

A list of missing requirements... this is automatically calculated for reporting only

namestring(Name)required

The member's name

name_to_be_printed_on_certificatestring(Name To Be Printed On Certificate)

The name to be displayed on the certificate

notesstring(Notes)

Notes

noticesArray of objects
numbernumber(float)(Number)

The application number

number_of_missing_requirementsnumber(float)(Number Of Missing Requirements)

The number of missing requirements

order_idstring(Order)

The order that last touched this application

order_line_item_idstring(Order Line Item)

The order line item touched this application

organization_idstring(Organization)required

The organization

override_bucket_assignmentboolean(Override Bucket Assignment)

If set, the bucket is not calculated automatically, and instead manually assigned

owner_typestring(Owner Type)required
Enum"contact""organization"
pending_console_reviewboolean(Pending Console Review)

If true, then this record has been reviewed and now needs action by the staff

percentage_completenumber(float)(Percentage Complete)

The percentage of requirements that have been met

process_idstring(Process)

The application process

program_idstring(Program)required

The certification program

referencesArray of objectsnon-empty
requirementsArray of objects
review_board_approval_datestring(Review Board Approval Date)

The date the application was decided by the board

review_board_submission_datestring(Review Board Submission Date)

The date the application was submitted to the review board

review_statusstring(Review Status)

The review status of this application

Enum"accepted""alternate""declined""pending review"
reviewer_recommendationstring(Reviewer Recommendation)

Aggregate recommendation across all reviewers

round_idstring(Round)

The review round

signature_uristring(Signature Uri)

The signature

statestring(State)

The state

statusstring(Status)
Enum"activated""approved""draft""expired""missing requirements""pending approval""rejected"
status_reason_idstring(Status Reason)

The reason the app is in the status - sub-status

submission_space_idstring(Submission Space)

The submission space to which this object belongs

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

target_program_idstring(Target Program)required

For transfer applications, the target program to transfer

total_scorenumber(float)(Total Score)

The total score for this submission in the most recent round

training_provider_billing_datestring(Training Provider Billing Date)

The date this application was billing to the training provider

training_provider_billing_invoice_idstring(Training Provider Billing Invoice)

The invoice that was created to bill for this application

training_provider_billing_invoice_line_item_idstring(Training Provider Billing Invoice Line Item)

The invoice that was created to bill for this application

training_provider_billing_namestring(Training Provider Billing Name)

The training provider name (for billing)

training_provider_billing_statusstring(Training Provider Billing Status)

The training provider billing status for this application

Enum"billed""billing hold""exempt from billing""not yet billed"
training_provider_idstring(Training Provider)

The training provider with which this application is associated

typestring(Type)required
Enum"certification""reinstatement""renewal""transfer"
Response
application/json
{
  "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"
}

Activates a certification

Request

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed

applicationIdstringrequired

The application id

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/applications/{tenantId}/activate/{applicationId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Conflicts were retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
object
Response
application/json
{}

Billing Run Actions

Billing Run Actions

Operations

Billing Runs

Billing Runs

Operations

Billing Templates

Billing Templates

Operations

Certifications

Certifications

Operations

Coupons

Coupons

Operations

Course Fees

Course Fees

Operations

Course Instructors

Course Instructors

Operations

Course Offerings

Course Offerings

Operations

Course Reg Processes

Course Reg Processes

Operations

Course Registrations

Course Registrations

Operations

Course Types

Course Types

Operations

Courses

Courses

Operations

Credit Types

Credit Types

Operations

Credits

Credits

Operations

Directories

Directories

Operations

Exam Fees

Exam Fees

Operations

Exam Notices

Exam Notices

Operations

Exam Offerings

Exam Offerings

Operations

Exam Reg Processes

Exam Reg Processes

Operations

Exam Registrations

Exam Registrations

Operations

Exam Sites

Exam Sites

Operations

Exams

Exams

Operations

Expiration Rule Sets

Expiration Rule Sets

Operations

Fees

Fees

Operations

Instructors

Instructors

Operations

License Types

License Types

Operations

Notices

Notices

Operations

Profiles

Profiles

Operations

Program Groups

Program Groups

Operations

Programs

Programs

Operations

Project Types

Project Types

Operations

Query Definitions

Query Definitions

Operations

Recurring Billing Runs

Recurring Billing Runs

Operations

Settings

Settings

Operations

Statistics

Statistics

Operations

Status Reasons

Status Reasons

Operations

Testing Facilities

Testing Facilities

Operations

Training Locations

Training Locations

Operations

Training Prov Programs

Training Prov Programs

Operations

Training Providers

Training Providers

Operations