Applications

Applications

Creates a new application record that does not already exist.

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.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The application that you would like to be saved.

id
required
string (ID) /^[\w:|-]+$/

The unique, string identifier of this application

contact_id
required
string (Contact)

The contact who is applying

owner_type
required
string (Owner Type)
Enum: "contact" "organization"
organization_id
required
string (Organization)

The organization

process_id
string (Process)

The application process

type
required
string (Type)
Enum: "certification" "renewal" "reinstatement" "transfer"
target_program_id
required
string (Target Program)

For transfer applications, the target program to transfer

date
required
string (Date)

The date of the application

program_id
required
string (Program)

The certification program

training_provider_id
string (Training Provider)

The training provider with which this application is associated

review_status
string (Review Status)

The review status of this application

Enum: "pending review" "alternate" "accepted" "declined"
last_review_status_change
string <date-time> (Last Review Status Change)

The date that the review status was last changed

pending_console_review
boolean (Pending Console Review)

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

submission_space_id
string (Submission Space)

The submission space to which this object belongs

override_bucket_assignment
boolean (Override Bucket Assignment)

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

round_id
string (Round)

The review round

bucket_id
required
string (Bucket)

The review bucket

average_score
number <float> (Average Score)

The average score for this submission in the most recent round

total_score
number <float> (Total Score)

The total score for this submission in the most recent round

reviewer_recommendation
string (Reviewer Recommendation)

Aggregate recommendation across all reviewers

training_provider_billing_name
string (Training Provider Billing Name)

The training provider name (for billing)

training_provider_billing_status
string (Training Provider Billing Status)

The training provider billing status for this application

Enum: "exempt from billing" "not yet billed" "billing hold" "billed"
training_provider_billing_date
string (Training Provider Billing Date)

The date this application was billing to the training provider

training_provider_billing_invoice_id
string (Training Provider Billing Invoice)

The invoice that was created to bill for this application

training_provider_billing_invoice_line_item_id
string (Training Provider Billing Invoice Line Item)

The invoice that was created to bill for this application

expiration_date
string (Expiration Date)

The date this application should no longer be eligible

last_reminder_date
string (Last Reminder Date)

The last time a reminder was sent for this application

first_name
string (First Name)

The member's first name

last_name
string (Last Name)

The member's last name

name
required
string (Name)

The member's name

email_address
string (Email Address)

The member's email address

city
string (City)

The member city

state
string (State)

The state

country
string (Country)

The member country

job_title
string (Job Title)

The member job title

Array of objects
number
number <float> (Number)

The application number

status
string (Status)
Enum: "draft" "missing requirements" "pending approval" "rejected" "approved" "activated" "expired"
status_reason_id
string (Status Reason)

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

certification_id
string (Certification)

The certification that this application is tied to

number_of_missing_requirements
number <float> (Number Of Missing Requirements)

The number of missing requirements

percentage_complete
number <float> (Percentage Complete)

The percentage of requirements that have been met

last_requirements_calculation_date
string <date-time> (Last Requirements Calculation Date)

The date/time that requirements were last calculated

Array of objects
Array of objects

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

Array of objects non-empty
course_offering_ids
Array of strings (Course Offerings)
exam_offering_ids
Array of strings (Exam Offerings)
Array of objects
review_board_submission_date
string (Review Board Submission Date)

The date the application was submitted to the review board

review_board_approval_date
string (Review Board Approval Date)

The date the application was decided by the board

exam_pass_letter_sent_date
string (Exam Pass Letter Sent Date)

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

exam_fail_letter_sent_date
string (Exam Fail Letter Sent Date)

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

activation_date
string (Activation Date)

The date the certification was activated

name_to_be_printed_on_certificate
string (Name To Be Printed On Certificate)

The name to be displayed on the certificate

notes
string (Notes)

Notes

order_id
string (Order)

The order that last touched this application

order_line_item_id
string (Order Line Item)

The order line item touched this application

Array of objects (Custom Field Values)
signature_uri
string (Signature Uri)

The signature

sys_deleted_by_id
string (Sys Deleted By)

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

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

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

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

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

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

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

sys_locked
boolean (Sys Locked)

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

sys_bulk_load_pk
string (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_at
string (Sys Bulk Load At)

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

sys_bulk_load_id
string (Sys Bulk Load)

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

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

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

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_last_bulk_data_operation_id
string (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_version
string (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_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

sys_snapshot_base_version
number <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_has_files_in_s3
boolean (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_configuration_snapshot_id
string (Sys Configuration Snapshot)

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

sys_last_security_context
object (Sys Last Security Context)

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

Array of objects
Responses
200The application was saved successfully.
400The application you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The application could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add application based on tenant limits.
500General server error.
post/applications/{tenantId}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "contact_id": "string",
  • "owner_type": "contact",
  • "organization_id": "string",
  • "process_id": "string",
  • "type": "certification",
  • "target_program_id": "string",
  • "date": "string",
  • "program_id": "string",
  • "training_provider_id": "string",
  • "review_status": "pending review",
  • "last_review_status_change": "2019-08-24T14:15:22Z",
  • "pending_console_review": true,
  • "submission_space_id": "string",
  • "override_bucket_assignment": true,
  • "round_id": "string",
  • "bucket_id": "string",
  • "average_score": 0,
  • "total_score": 0,
  • "reviewer_recommendation": "string",
  • "training_provider_billing_name": "string",
  • "training_provider_billing_status": "exempt from billing",
  • "training_provider_billing_date": "string",
  • "training_provider_billing_invoice_id": "string",
  • "training_provider_billing_invoice_line_item_id": "string",
  • "expiration_date": "string",
  • "last_reminder_date": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "notices": [
    ],
  • "number": 0,
  • "status": "draft",
  • "status_reason_id": "string",
  • "certification_id": "string",
  • "number_of_missing_requirements": 0,
  • "percentage_complete": 0,
  • "last_requirements_calculation_date": "2019-08-24T14:15:22Z",
  • "requirements": [
    ],
  • "missing_requirements": [
    ],
  • "references": [
    ],
  • "course_offering_ids": [
    ],
  • "exam_offering_ids": [
    ],
  • "credits": [
    ],
  • "review_board_submission_date": "string",
  • "review_board_approval_date": "string",
  • "exam_pass_letter_sent_date": "string",
  • "exam_fail_letter_sent_date": "string",
  • "activation_date": "string",
  • "name_to_be_printed_on_certificate": "string",
  • "notes": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "custom_field_values": [
    ],
  • "signature_uri": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "contact_id": "string",
  • "owner_type": "contact",
  • "organization_id": "string",
  • "process_id": "string",
  • "type": "certification",
  • "target_program_id": "string",
  • "date": "string",
  • "program_id": "string",
  • "training_provider_id": "string",
  • "review_status": "pending review",
  • "last_review_status_change": "2019-08-24T14:15:22Z",
  • "pending_console_review": true,
  • "submission_space_id": "string",
  • "override_bucket_assignment": true,
  • "round_id": "string",
  • "bucket_id": "string",
  • "average_score": 0,
  • "total_score": 0,
  • "reviewer_recommendation": "string",
  • "training_provider_billing_name": "string",
  • "training_provider_billing_status": "exempt from billing",
  • "training_provider_billing_date": "string",
  • "training_provider_billing_invoice_id": "string",
  • "training_provider_billing_invoice_line_item_id": "string",
  • "expiration_date": "string",
  • "last_reminder_date": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "notices": [
    ],
  • "number": 0,
  • "status": "draft",
  • "status_reason_id": "string",
  • "certification_id": "string",
  • "number_of_missing_requirements": 0,
  • "percentage_complete": 0,
  • "last_requirements_calculation_date": "2019-08-24T14:15:22Z",
  • "requirements": [
    ],
  • "missing_requirements": [
    ],
  • "references": [
    ],
  • "course_offering_ids": [
    ],
  • "exam_offering_ids": [
    ],
  • "credits": [
    ],
  • "review_board_submission_date": "string",
  • "review_board_approval_date": "string",
  • "exam_pass_letter_sent_date": "string",
  • "exam_fail_letter_sent_date": "string",
  • "activation_date": "string",
  • "name_to_be_printed_on_certificate": "string",
  • "notes": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "custom_field_values": [
    ],
  • "signature_uri": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Gets all of the applications in the system.

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

query Parameters
fields
string

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

exclusiveStartKey
string

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

Responses
200The applicationswere retrieved successfully.
400The request was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
429Limit exceeded... unable to add contact role based on tenant limits.
500General server error.
get/applications/{tenantId}
Request samples
curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/applications/:tenantId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Returns a application from the system by its ID.

This method will look up a application by the specified ID and return it back.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the application to return.

query Parameters
fields
string

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

consistentRead
string

Indicates the API should force a consistent read on the data source.

Responses
200The application was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The application could not be found.
429Limit exceeded... unable to retrieve application based on tenant limits.
500General server error.
get/applications/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/applications/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "contact_id": "string",
  • "owner_type": "contact",
  • "organization_id": "string",
  • "process_id": "string",
  • "type": "certification",
  • "target_program_id": "string",
  • "date": "string",
  • "program_id": "string",
  • "training_provider_id": "string",
  • "review_status": "pending review",
  • "last_review_status_change": "2019-08-24T14:15:22Z",
  • "pending_console_review": true,
  • "submission_space_id": "string",
  • "override_bucket_assignment": true,
  • "round_id": "string",
  • "bucket_id": "string",
  • "average_score": 0,
  • "total_score": 0,
  • "reviewer_recommendation": "string",
  • "training_provider_billing_name": "string",
  • "training_provider_billing_status": "exempt from billing",
  • "training_provider_billing_date": "string",
  • "training_provider_billing_invoice_id": "string",
  • "training_provider_billing_invoice_line_item_id": "string",
  • "expiration_date": "string",
  • "last_reminder_date": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "notices": [
    ],
  • "number": 0,
  • "status": "draft",
  • "status_reason_id": "string",
  • "certification_id": "string",
  • "number_of_missing_requirements": 0,
  • "percentage_complete": 0,
  • "last_requirements_calculation_date": "2019-08-24T14:15:22Z",
  • "requirements": [
    ],
  • "missing_requirements": [
    ],
  • "references": [
    ],
  • "course_offering_ids": [
    ],
  • "exam_offering_ids": [
    ],
  • "credits": [
    ],
  • "review_board_submission_date": "string",
  • "review_board_approval_date": "string",
  • "exam_pass_letter_sent_date": "string",
  • "exam_fail_letter_sent_date": "string",
  • "activation_date": "string",
  • "name_to_be_printed_on_certificate": "string",
  • "notes": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "custom_field_values": [
    ],
  • "signature_uri": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Updates a application with the specified ID.

This method will update an existing application with the specified ID.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the application to update.

Request Body schema: application/json

The updated application that will be saved.

id
required
string (ID) /^[\w:|-]+$/

The unique, string identifier of this application

contact_id
required
string (Contact)

The contact who is applying

owner_type
required
string (Owner Type)
Enum: "contact" "organization"
organization_id
required
string (Organization)

The organization

process_id
string (Process)

The application process

type
required
string (Type)
Enum: "certification" "renewal" "reinstatement" "transfer"
target_program_id
required
string (Target Program)

For transfer applications, the target program to transfer

date
required
string (Date)

The date of the application

program_id
required
string (Program)

The certification program

training_provider_id
string (Training Provider)

The training provider with which this application is associated

review_status
string (Review Status)

The review status of this application

Enum: "pending review" "alternate" "accepted" "declined"
last_review_status_change
string <date-time> (Last Review Status Change)

The date that the review status was last changed

pending_console_review
boolean (Pending Console Review)

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

submission_space_id
string (Submission Space)

The submission space to which this object belongs

override_bucket_assignment
boolean (Override Bucket Assignment)

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

round_id
string (Round)

The review round

bucket_id
required
string (Bucket)

The review bucket

average_score
number <float> (Average Score)

The average score for this submission in the most recent round

total_score
number <float> (Total Score)

The total score for this submission in the most recent round

reviewer_recommendation
string (Reviewer Recommendation)

Aggregate recommendation across all reviewers

training_provider_billing_name
string (Training Provider Billing Name)

The training provider name (for billing)

training_provider_billing_status
string (Training Provider Billing Status)

The training provider billing status for this application

Enum: "exempt from billing" "not yet billed" "billing hold" "billed"
training_provider_billing_date
string (Training Provider Billing Date)

The date this application was billing to the training provider

training_provider_billing_invoice_id
string (Training Provider Billing Invoice)

The invoice that was created to bill for this application

training_provider_billing_invoice_line_item_id
string (Training Provider Billing Invoice Line Item)

The invoice that was created to bill for this application

expiration_date
string (Expiration Date)

The date this application should no longer be eligible

last_reminder_date
string (Last Reminder Date)

The last time a reminder was sent for this application

first_name
string (First Name)

The member's first name

last_name
string (Last Name)

The member's last name

name
required
string (Name)

The member's name

email_address
string (Email Address)

The member's email address

city
string (City)

The member city

state
string (State)

The state

country
string (Country)

The member country

job_title
string (Job Title)

The member job title

Array of objects
number
number <float> (Number)

The application number

status
string (Status)
Enum: "draft" "missing requirements" "pending approval" "rejected" "approved" "activated" "expired"
status_reason_id
string (Status Reason)

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

certification_id
string (Certification)

The certification that this application is tied to

number_of_missing_requirements
number <float> (Number Of Missing Requirements)

The number of missing requirements

percentage_complete
number <float> (Percentage Complete)

The percentage of requirements that have been met

last_requirements_calculation_date
string <date-time> (Last Requirements Calculation Date)

The date/time that requirements were last calculated

Array of objects
Array of objects

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

Array of objects non-empty
course_offering_ids
Array of strings (Course Offerings)
exam_offering_ids
Array of strings (Exam Offerings)
Array of objects
review_board_submission_date
string (Review Board Submission Date)

The date the application was submitted to the review board

review_board_approval_date
string (Review Board Approval Date)

The date the application was decided by the board

exam_pass_letter_sent_date
string (Exam Pass Letter Sent Date)

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

exam_fail_letter_sent_date
string (Exam Fail Letter Sent Date)

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

activation_date
string (Activation Date)

The date the certification was activated

name_to_be_printed_on_certificate
string (Name To Be Printed On Certificate)

The name to be displayed on the certificate

notes
string (Notes)

Notes

order_id
string (Order)

The order that last touched this application

order_line_item_id
string (Order Line Item)

The order line item touched this application

Array of objects (Custom Field Values)
signature_uri
string (Signature Uri)

The signature

sys_deleted_by_id
string (Sys Deleted By)

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

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

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

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

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

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

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

sys_locked
boolean (Sys Locked)

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

sys_bulk_load_pk
string (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_at
string (Sys Bulk Load At)

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

sys_bulk_load_id
string (Sys Bulk Load)

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

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

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

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_last_bulk_data_operation_id
string (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_version
string (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_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

sys_snapshot_base_version
number <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_has_files_in_s3
boolean (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_configuration_snapshot_id
string (Sys Configuration Snapshot)

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

sys_last_security_context
object (Sys Last Security Context)

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

Array of objects
Responses
200The application was updated successfully.
400The application supplied was not valid.
401Unauthorized.
403Forbidden.
404The application could not be found.
409The application could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve application based on tenant limits.
500General server error.
put/applications/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "contact_id": "string",
  • "owner_type": "contact",
  • "organization_id": "string",
  • "process_id": "string",
  • "type": "certification",
  • "target_program_id": "string",
  • "date": "string",
  • "program_id": "string",
  • "training_provider_id": "string",
  • "review_status": "pending review",
  • "last_review_status_change": "2019-08-24T14:15:22Z",
  • "pending_console_review": true,
  • "submission_space_id": "string",
  • "override_bucket_assignment": true,
  • "round_id": "string",
  • "bucket_id": "string",
  • "average_score": 0,
  • "total_score": 0,
  • "reviewer_recommendation": "string",
  • "training_provider_billing_name": "string",
  • "training_provider_billing_status": "exempt from billing",
  • "training_provider_billing_date": "string",
  • "training_provider_billing_invoice_id": "string",
  • "training_provider_billing_invoice_line_item_id": "string",
  • "expiration_date": "string",
  • "last_reminder_date": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "notices": [
    ],
  • "number": 0,
  • "status": "draft",
  • "status_reason_id": "string",
  • "certification_id": "string",
  • "number_of_missing_requirements": 0,
  • "percentage_complete": 0,
  • "last_requirements_calculation_date": "2019-08-24T14:15:22Z",
  • "requirements": [
    ],
  • "missing_requirements": [
    ],
  • "references": [
    ],
  • "course_offering_ids": [
    ],
  • "exam_offering_ids": [
    ],
  • "credits": [
    ],
  • "review_board_submission_date": "string",
  • "review_board_approval_date": "string",
  • "exam_pass_letter_sent_date": "string",
  • "exam_fail_letter_sent_date": "string",
  • "activation_date": "string",
  • "name_to_be_printed_on_certificate": "string",
  • "notes": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "custom_field_values": [
    ],
  • "signature_uri": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "contact_id": "string",
  • "owner_type": "contact",
  • "organization_id": "string",
  • "process_id": "string",
  • "type": "certification",
  • "target_program_id": "string",
  • "date": "string",
  • "program_id": "string",
  • "training_provider_id": "string",
  • "review_status": "pending review",
  • "last_review_status_change": "2019-08-24T14:15:22Z",
  • "pending_console_review": true,
  • "submission_space_id": "string",
  • "override_bucket_assignment": true,
  • "round_id": "string",
  • "bucket_id": "string",
  • "average_score": 0,
  • "total_score": 0,
  • "reviewer_recommendation": "string",
  • "training_provider_billing_name": "string",
  • "training_provider_billing_status": "exempt from billing",
  • "training_provider_billing_date": "string",
  • "training_provider_billing_invoice_id": "string",
  • "training_provider_billing_invoice_line_item_id": "string",
  • "expiration_date": "string",
  • "last_reminder_date": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "notices": [
    ],
  • "number": 0,
  • "status": "draft",
  • "status_reason_id": "string",
  • "certification_id": "string",
  • "number_of_missing_requirements": 0,
  • "percentage_complete": 0,
  • "last_requirements_calculation_date": "2019-08-24T14:15:22Z",
  • "requirements": [
    ],
  • "missing_requirements": [
    ],
  • "references": [
    ],
  • "course_offering_ids": [
    ],
  • "exam_offering_ids": [
    ],
  • "credits": [
    ],
  • "review_board_submission_date": "string",
  • "review_board_approval_date": "string",
  • "exam_pass_letter_sent_date": "string",
  • "exam_fail_letter_sent_date": "string",
  • "activation_date": "string",
  • "name_to_be_printed_on_certificate": "string",
  • "notes": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "custom_field_values": [
    ],
  • "signature_uri": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Partially updates a application with the specified ID.

This method will patch an existing application with the specified ID, using the HTTP PATCH specification.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the application to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array
op
required
string (Op)

The operation

Enum: "add" "remove" "replace" "move" "copy" "test"
path
required
string (Path)

The JSON path

value
string (Value)

The updated value

Responses
200The application was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The application could not be found.
409The application could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve application based on tenant limits.
500General server error.
patch/applications/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "contact_id": "string",
  • "owner_type": "contact",
  • "organization_id": "string",
  • "process_id": "string",
  • "type": "certification",
  • "target_program_id": "string",
  • "date": "string",
  • "program_id": "string",
  • "training_provider_id": "string",
  • "review_status": "pending review",
  • "last_review_status_change": "2019-08-24T14:15:22Z",
  • "pending_console_review": true,
  • "submission_space_id": "string",
  • "override_bucket_assignment": true,
  • "round_id": "string",
  • "bucket_id": "string",
  • "average_score": 0,
  • "total_score": 0,
  • "reviewer_recommendation": "string",
  • "training_provider_billing_name": "string",
  • "training_provider_billing_status": "exempt from billing",
  • "training_provider_billing_date": "string",
  • "training_provider_billing_invoice_id": "string",
  • "training_provider_billing_invoice_line_item_id": "string",
  • "expiration_date": "string",
  • "last_reminder_date": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "notices": [
    ],
  • "number": 0,
  • "status": "draft",
  • "status_reason_id": "string",
  • "certification_id": "string",
  • "number_of_missing_requirements": 0,
  • "percentage_complete": 0,
  • "last_requirements_calculation_date": "2019-08-24T14:15:22Z",
  • "requirements": [
    ],
  • "missing_requirements": [
    ],
  • "references": [
    ],
  • "course_offering_ids": [
    ],
  • "exam_offering_ids": [
    ],
  • "credits": [
    ],
  • "review_board_submission_date": "string",
  • "review_board_approval_date": "string",
  • "exam_pass_letter_sent_date": "string",
  • "exam_fail_letter_sent_date": "string",
  • "activation_date": "string",
  • "name_to_be_printed_on_certificate": "string",
  • "notes": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "custom_field_values": [
    ],
  • "signature_uri": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Returns a application from the system by its ID.

This method will delete a application with the specified ID.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the application to delete.

Responses
200The application was deleted successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The application could not be found.
409The application could not be deleted because other objects refers to/depends on this one.
429Limit exceeded... unable to delete application based on tenant limits.
500General server error.
delete/applications/{tenantId}/{id}
Request samples
curl -i -X DELETE \
  https://certifications.api.756794052567.rhythmsoftware.com/applications/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
"string"

Generates an order from a certification application

This method will examine a certification application and generate an appropriate order

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed

Request Body schema: application/json

The application to generate an order

id
required
string (ID) /^[\w:|-]+$/

The unique, string identifier of this application

contact_id
required
string (Contact)

The contact who is applying

owner_type
required
string (Owner Type)
Enum: "contact" "organization"
organization_id
required
string (Organization)

The organization

process_id
string (Process)

The application process

type
required
string (Type)
Enum: "certification" "renewal" "reinstatement" "transfer"
target_program_id
required
string (Target Program)

For transfer applications, the target program to transfer

date
required
string (Date)

The date of the application

program_id
required
string (Program)

The certification program

training_provider_id
string (Training Provider)

The training provider with which this application is associated

review_status
string (Review Status)

The review status of this application

Enum: "pending review" "alternate" "accepted" "declined"
last_review_status_change
string <date-time> (Last Review Status Change)

The date that the review status was last changed

pending_console_review
boolean (Pending Console Review)

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

submission_space_id
string (Submission Space)

The submission space to which this object belongs

override_bucket_assignment
boolean (Override Bucket Assignment)

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

round_id
string (Round)

The review round

bucket_id
required
string (Bucket)

The review bucket

average_score
number <float> (Average Score)

The average score for this submission in the most recent round

total_score
number <float> (Total Score)

The total score for this submission in the most recent round

reviewer_recommendation
string (Reviewer Recommendation)

Aggregate recommendation across all reviewers

training_provider_billing_name
string (Training Provider Billing Name)

The training provider name (for billing)

training_provider_billing_status
string (Training Provider Billing Status)

The training provider billing status for this application

Enum: "exempt from billing" "not yet billed" "billing hold" "billed"
training_provider_billing_date
string (Training Provider Billing Date)

The date this application was billing to the training provider

training_provider_billing_invoice_id
string (Training Provider Billing Invoice)

The invoice that was created to bill for this application

training_provider_billing_invoice_line_item_id
string (Training Provider Billing Invoice Line Item)

The invoice that was created to bill for this application

expiration_date
string (Expiration Date)

The date this application should no longer be eligible

last_reminder_date
string (Last Reminder Date)

The last time a reminder was sent for this application

first_name
string (First Name)

The member's first name

last_name
string (Last Name)

The member's last name

name
required
string (Name)

The member's name

email_address
string (Email Address)

The member's email address

city
string (City)

The member city

state
string (State)

The state

country
string (Country)

The member country

job_title
string (Job Title)

The member job title

Array of objects
number
number <float> (Number)

The application number

status
string (Status)
Enum: "draft" "missing requirements" "pending approval" "rejected" "approved" "activated" "expired"
status_reason_id
string (Status Reason)

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

certification_id
string (Certification)

The certification that this application is tied to

number_of_missing_requirements
number <float> (Number Of Missing Requirements)

The number of missing requirements

percentage_complete
number <float> (Percentage Complete)

The percentage of requirements that have been met

last_requirements_calculation_date
string <date-time> (Last Requirements Calculation Date)

The date/time that requirements were last calculated

Array of objects
Array of objects

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

Array of objects non-empty
course_offering_ids
Array of strings (Course Offerings)
exam_offering_ids
Array of strings (Exam Offerings)
Array of objects
review_board_submission_date
string (Review Board Submission Date)

The date the application was submitted to the review board

review_board_approval_date
string (Review Board Approval Date)

The date the application was decided by the board

exam_pass_letter_sent_date
string (Exam Pass Letter Sent Date)

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

exam_fail_letter_sent_date
string (Exam Fail Letter Sent Date)

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

activation_date
string (Activation Date)

The date the certification was activated

name_to_be_printed_on_certificate
string (Name To Be Printed On Certificate)

The name to be displayed on the certificate

notes
string (Notes)

Notes

order_id
string (Order)

The order that last touched this application

order_line_item_id
string (Order Line Item)

The order line item touched this application

Array of objects (Custom Field Values)
signature_uri
string (Signature Uri)

The signature

sys_deleted_by_id
string (Sys Deleted By)

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

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

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

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

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

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

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

sys_locked
boolean (Sys Locked)

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

sys_bulk_load_pk
string (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_at
string (Sys Bulk Load At)

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

sys_bulk_load_id
string (Sys Bulk Load)

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

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

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

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_last_bulk_data_operation_id
string (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_version
string (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_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

sys_snapshot_base_version
number <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_has_files_in_s3
boolean (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_configuration_snapshot_id
string (Sys Configuration Snapshot)

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

sys_last_security_context
object (Sys Last Security Context)

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

Array of objects
Responses
200Conflicts were retrieved successfully
400The search you supplied was invalid.
401Unauthorized
403Forbidden
404The resource could not be found
429Limit exceeded... unable to add order based on tenant limits.
500General server error
post/applications/{tenantId}/generateOrder
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "contact_id": "string",
  • "owner_type": "contact",
  • "organization_id": "string",
  • "process_id": "string",
  • "type": "certification",
  • "target_program_id": "string",
  • "date": "string",
  • "program_id": "string",
  • "training_provider_id": "string",
  • "review_status": "pending review",
  • "last_review_status_change": "2019-08-24T14:15:22Z",
  • "pending_console_review": true,
  • "submission_space_id": "string",
  • "override_bucket_assignment": true,
  • "round_id": "string",
  • "bucket_id": "string",
  • "average_score": 0,
  • "total_score": 0,
  • "reviewer_recommendation": "string",
  • "training_provider_billing_name": "string",
  • "training_provider_billing_status": "exempt from billing",
  • "training_provider_billing_date": "string",
  • "training_provider_billing_invoice_id": "string",
  • "training_provider_billing_invoice_line_item_id": "string",
  • "expiration_date": "string",
  • "last_reminder_date": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "notices": [
    ],
  • "number": 0,
  • "status": "draft",
  • "status_reason_id": "string",
  • "certification_id": "string",
  • "number_of_missing_requirements": 0,
  • "percentage_complete": 0,
  • "last_requirements_calculation_date": "2019-08-24T14:15:22Z",
  • "requirements": [
    ],
  • "missing_requirements": [
    ],
  • "references": [
    ],
  • "course_offering_ids": [
    ],
  • "exam_offering_ids": [
    ],
  • "credits": [
    ],
  • "review_board_submission_date": "string",
  • "review_board_approval_date": "string",
  • "exam_pass_letter_sent_date": "string",
  • "exam_fail_letter_sent_date": "string",
  • "activation_date": "string",
  • "name_to_be_printed_on_certificate": "string",
  • "notes": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "custom_field_values": [
    ],
  • "signature_uri": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}
Response samples
application/json
{ }

Sends an application notice

This method will examine a certification application and generate an appropriate order

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed

notice_id
required
string

The application notice

application_id
required
string

The application

query Parameters
new_status_reason_id
string

The new status reason

Responses
200Conflicts were retrieved successfully
400The search you supplied was invalid.
401Unauthorized
403Forbidden
404The resource could not be found
429Limit exceeded... unable to add order based on tenant limits.
500General server error
post/applications/{tenantId}/sendNotice/{notice_id}/{application_id}
Request samples
curl -i -X POST \
  'https://certifications.api.756794052567.rhythmsoftware.com/applications/:tenantId/sendNotice/:notice_id/:application_id?new_status_reason_id=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{ }

Applies credits to an application

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed

id
required
string

The id of the application

Request Body schema: application/json

Credit application request

required
Array of objects non-empty
Responses
200Conflicts were retrieved successfully
400The search you supplied was invalid.
401Unauthorized
403Forbidden
404The resource could not be found
429Limit exceeded... unable to add order based on tenant limits.
500General server error
post/applications/{tenantId}/credits/apply/{id}
Request samples
    1 more
    Python
application/json
{
  • "credits": [
    ]
}

Test credit requirement formula

Use this to test the formula for certification credit requirements

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed

applicationId
required
string

The id of the application

Request Body schema: application/json

Credit application request

credit_type_id
required
string (Credit Type)

The type of credits required

type
string (Type)

Whether or not the number of credits is fixed or calculated

Enum: "fixed" "calculated"
number_of_credits
required
number <float> (Number Of Credits)

The number of credits required

formula
required
string (Formula)

A formula to determine the number of credits

Responses
200Conflicts were retrieved successfully
400The search you supplied was invalid.
401Unauthorized
403Forbidden
404The resource could not be found
429Limit exceeded... unable to add order based on tenant limits.
500General server error
post/applications/{tenantId}/creditRequirementFormulaTest/{applicationId}
Request samples
    1 more
    Python
application/json
{
  • "credit_type_id": "string",
  • "type": "fixed",
  • "number_of_credits": 0,
  • "formula": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "status": "fulfilled",
  • "date_requirement_fulfilled": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "internal_notes": "string",
  • "portal_explanation": "string",
  • "not_applicable": true,
  • "type": "string",
  • "weight": 0
}

Unapplies credits to an application

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed

id
required
string

The id of the application

Request Body schema: application/json

Credit application request

required
Array of objects non-empty
Responses
200Conflicts were retrieved successfully
400The search you supplied was invalid.
401Unauthorized
403Forbidden
404The resource could not be found
429Limit exceeded... unable to add order based on tenant limits.
500General server error
post/applications/{tenantId}/credits/unapply/{id}
Request samples
    1 more
    Python
application/json
{
  • "credits": [
    ]
}

Generates an generation for a contact or organization

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed

processId
required
string

The process id

ownerType
required
string

The contact or organization type

Enum: "contact" "organization"
ownerId
required
string

The contact or organization type

Responses
200Conflicts were retrieved successfully
400The search you supplied was invalid.
401Unauthorized
403Forbidden
404The resource could not be found
429Limit exceeded... unable to add order based on tenant limits.
500General server error
post/applications/{tenantId}/generateApplication/{processId}/{ownerType}/{ownerId}
Request samples
curl -i -X POST \
  https://certifications.api.756794052567.rhythmsoftware.com/applications/:tenantId/generateApplication/:processId/:ownerType/:ownerId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "application": {
    },
  • "courses": [
    ],
  • "exams": [
    ],
  • "available_credits": [
    ],
  • "credit_requirements": [
    ],
  • "activities": [
    ]
}

Activates a certification

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed

applicationId
required
string

The application id

Responses
200Conflicts were retrieved successfully
400The search you supplied was invalid.
401Unauthorized
403Forbidden
404The resource could not be found
429Limit exceeded... unable to add order based on tenant limits.
500General server error
post/applications/{tenantId}/activate/{applicationId}
Request samples
curl -i -X POST \
  https://certifications.api.756794052567.rhythmsoftware.com/applications/:tenantId/activate/:applicationId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{ }

Returns a list of records with the specified contact_id

Returns a list of records with the specified contact_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

contact_id
required
string

The contact_id to use to for record lookup

query Parameters
fields
string

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

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/applications/{tenantId}/contact/{contact_id}
Request samples
curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/applications/:tenantId/contact/:contact_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Searches for applications using predefined parameters

Searches for applications using predefined parameters

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

query Parameters
exclusiveStartKey
string

The start key for the search, for paging support

fieldsToReturn
string

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

Request Body schema: application/json

The application that you would like to be saved.

ids
Array of strings (Ids)

IDs to search

name
string (Name)
contact_id
Array of strings (Contact)
organization_id
Array of strings (Organization)
owner_type
Array of strings (Owner Type)
date
Array of strings <date-time> (Date) 2 items
program_id
Array of strings (Program)
process_id
Array of strings (Process)
status
Array of strings (Status)
percentage_complete
Array of numbers <float> (Percentage Complete)
last_requirements_calculation_date
Array of strings <date-time> (Last Requirements Calculation Date) 2 items
number_of_missing_requirements
Array of numbers <float> (Number Of Missing Requirements)
type
Array of strings (Type)
Responses
200The application search was saved successfully.
400The application you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The application could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add application based on tenant limits.
500General server error.
post/applications/{tenantId}/search
Request samples
    1 more
    Python
application/json
{
  • "ids": [
    ],
  • "name": "string",
  • "contact_id": [
    ],
  • "organization_id": [
    ],
  • "owner_type": [
    ],
  • "date": [
    ],
  • "program_id": [
    ],
  • "process_id": [
    ],
  • "status": [
    ],
  • "percentage_complete": [
    ],
  • "last_requirements_calculation_date": [
    ],
  • "number_of_missing_requirements": [
    ],
  • "type": [
    ]
}
Response samples
application/json
{
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified program_applicant_id

Returns a list of records with the specified program_applicant_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

programId
required
string

The program id to use to for record lookup

ownerType
required
string

The contact or organization type

Enum: "contact" "organization"
ownerId
required
string

The contact or organization type

query Parameters
fields
string

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

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/applications/{tenantId}/programApplicant/{programId}/{ownerType}/{ownerId}
Request samples
curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/applications/:tenantId/programApplicant/:programId/:ownerType/:ownerId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Sends out a preview of the CRC notification email

Sends out a preview of the CRC notification email

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

Request Body schema: application/json

The domain_name to use to for record lookup

activity_id
string (Activity)
object (Email Template)
destination_email_address
required
string (Destination Email Address)
reference_id
string (Reference)
application_id
string (Application)
certification_id
string (Certification)
registration_id
required
string (Registration)
Responses
200The record was retrieved successfully
400The request was not valid.
401Unauthorized
403Forbidden
404Unable to locate any organizations with the specified domain
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
post/applications/{tenantId}/previewEmail
Request samples
    1 more
    Python
application/json
{
  • "activity_id": "string",
  • "email_template": {
    },
  • "destination_email_address": "string",
  • "reference_id": "string",
  • "application_id": "string",
  • "certification_id": "string",
  • "registration_id": "string"
}

Execute Batch Operations

TAllows you to perform up to 100 parallel patch/delete operations

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The batch request

Array of objects
Responses
200Request completed successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The application could not be found.
429Limit exceeded... unable to retrieve application based on tenant limits.
500General server error.
post/applications/{tenantId}/batch
Request samples
    1 more
    Python
application/json
{
  • "operations": [
    ]
}
Response samples
application/json
{
  • "success_count": 0,
  • "error_count": 0,
  • "results": [
    ]
}

Returns a list of records with the specified organization_id

Returns a list of records with the specified organization_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

organization_id
required
string

The organization_id to use to for record lookup

query Parameters
fields
string

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

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/applications/{tenantId}/organization/{organization_id}
Request samples
curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/applications/:tenantId/organization/:organization_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}