Exam Registrations

Exam Registrations

Creates a new exam registration record that does not already exist.

This method will auto-generate an ID and create a new exam registration. If an ID is specified for the exam registration, 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 exam registration that you would like to be saved.

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

The unique, string identifier of this exam registration

number
number <float> (Number)

The registration number

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

application_id
string (Application)

The certification application to which this registration

process_id
string (Process)

The registration process used to create the registration

exam_id
required
string (Exam)

The exam being taken

exam_offering_id
required
string (Exam Offering)

The scheduled exam

student_id
required
string (Student)

The individual taking the exam

cancellation_date
string <date-time> (Cancellation Date)
location
string (Location)
Enum: "training location" "testing facility" "none"
testing_facility_id
string (Testing Facility)

The exam testing site

training_provider_id
string (Training Provider)

The training facility

training_location_id
string (Training Location)

The training facility

additional_location_info
string (Additional Location Info)

Additional location information

date
required
string (Date)

The date/time of the registration

exam_date
string (Exam Date)

The date/time of the registration

score
number <float> (Score)

The score

status
string (Status)
Enum: "draft" "registered" "passed" "failed" "no show" "cancelled"
scoring_report_uri
string (Scoring Report Uri)

An image/PDF of the exam scoring report

Array of objects
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 registration

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

The date this registration 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 registration

training_provider_billing_invoice_line_item_id
string (Training Provider Billing Invoice Line Item)

The invoice that was created to bill for this registration

retest
boolean (Retest)

Whether or not this is a retest

course_registration_id
string (Course Registration)

The course registration this exam is tied to

order_id
string (Order)

The order

order_line_item_id
string (Order Line Item)

The order line item

notes
string (Notes)

notes

Array of objects (Custom Field Values)
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 exam registration was saved successfully.
400The exam registration you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The exam registration could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add exam registration based on tenant limits.
500General server error.
post/examRegistrations/{tenantId}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "number": 0,
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "application_id": "string",
  • "process_id": "string",
  • "exam_id": "string",
  • "exam_offering_id": "string",
  • "student_id": "string",
  • "cancellation_date": "2019-08-24T14:15:22Z",
  • "location": "training location",
  • "testing_facility_id": "string",
  • "training_provider_id": "string",
  • "training_location_id": "string",
  • "additional_location_info": "string",
  • "date": "string",
  • "exam_date": "string",
  • "score": 0,
  • "status": "draft",
  • "scoring_report_uri": "string",
  • "notices": [
    ],
  • "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",
  • "retest": true,
  • "course_registration_id": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "notes": "string",
  • "custom_field_values": [
    ],
  • "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",
  • "number": 0,
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "application_id": "string",
  • "process_id": "string",
  • "exam_id": "string",
  • "exam_offering_id": "string",
  • "student_id": "string",
  • "cancellation_date": "2019-08-24T14:15:22Z",
  • "location": "training location",
  • "testing_facility_id": "string",
  • "training_provider_id": "string",
  • "training_location_id": "string",
  • "additional_location_info": "string",
  • "date": "string",
  • "exam_date": "string",
  • "score": 0,
  • "status": "draft",
  • "scoring_report_uri": "string",
  • "notices": [
    ],
  • "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",
  • "retest": true,
  • "course_registration_id": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "notes": "string",
  • "custom_field_values": [
    ],
  • "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 exam registrations in the system.

This method will scan all exam registrations 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 exam registrationswere 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/examRegistrations/{tenantId}
Request samples
curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/examRegistrations/:tenantId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Returns a exam registration from the system by its ID.

This method will look up a exam registration 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 exam registration 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 exam registration was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The exam registration could not be found.
429Limit exceeded... unable to retrieve exam registration based on tenant limits.
500General server error.
get/examRegistrations/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/examRegistrations/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "number": 0,
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "application_id": "string",
  • "process_id": "string",
  • "exam_id": "string",
  • "exam_offering_id": "string",
  • "student_id": "string",
  • "cancellation_date": "2019-08-24T14:15:22Z",
  • "location": "training location",
  • "testing_facility_id": "string",
  • "training_provider_id": "string",
  • "training_location_id": "string",
  • "additional_location_info": "string",
  • "date": "string",
  • "exam_date": "string",
  • "score": 0,
  • "status": "draft",
  • "scoring_report_uri": "string",
  • "notices": [
    ],
  • "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",
  • "retest": true,
  • "course_registration_id": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "notes": "string",
  • "custom_field_values": [
    ],
  • "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 exam registration with the specified ID.

This method will update an existing exam registration 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 exam registration to update.

Request Body schema: application/json

The updated exam registration that will be saved.

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

The unique, string identifier of this exam registration

number
number <float> (Number)

The registration number

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

application_id
string (Application)

The certification application to which this registration

process_id
string (Process)

The registration process used to create the registration

exam_id
required
string (Exam)

The exam being taken

exam_offering_id
required
string (Exam Offering)

The scheduled exam

student_id
required
string (Student)

The individual taking the exam

cancellation_date
string <date-time> (Cancellation Date)
location
string (Location)
Enum: "training location" "testing facility" "none"
testing_facility_id
string (Testing Facility)

The exam testing site

training_provider_id
string (Training Provider)

The training facility

training_location_id
string (Training Location)

The training facility

additional_location_info
string (Additional Location Info)

Additional location information

date
required
string (Date)

The date/time of the registration

exam_date
string (Exam Date)

The date/time of the registration

score
number <float> (Score)

The score

status
string (Status)
Enum: "draft" "registered" "passed" "failed" "no show" "cancelled"
scoring_report_uri
string (Scoring Report Uri)

An image/PDF of the exam scoring report

Array of objects
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 registration

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

The date this registration 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 registration

training_provider_billing_invoice_line_item_id
string (Training Provider Billing Invoice Line Item)

The invoice that was created to bill for this registration

retest
boolean (Retest)

Whether or not this is a retest

course_registration_id
string (Course Registration)

The course registration this exam is tied to

order_id
string (Order)

The order

order_line_item_id
string (Order Line Item)

The order line item

notes
string (Notes)

notes

Array of objects (Custom Field Values)
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 exam registration was updated successfully.
400The exam registration supplied was not valid.
401Unauthorized.
403Forbidden.
404The exam registration could not be found.
409The exam registration could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve exam registration based on tenant limits.
500General server error.
put/examRegistrations/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "number": 0,
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "application_id": "string",
  • "process_id": "string",
  • "exam_id": "string",
  • "exam_offering_id": "string",
  • "student_id": "string",
  • "cancellation_date": "2019-08-24T14:15:22Z",
  • "location": "training location",
  • "testing_facility_id": "string",
  • "training_provider_id": "string",
  • "training_location_id": "string",
  • "additional_location_info": "string",
  • "date": "string",
  • "exam_date": "string",
  • "score": 0,
  • "status": "draft",
  • "scoring_report_uri": "string",
  • "notices": [
    ],
  • "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",
  • "retest": true,
  • "course_registration_id": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "notes": "string",
  • "custom_field_values": [
    ],
  • "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",
  • "number": 0,
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "application_id": "string",
  • "process_id": "string",
  • "exam_id": "string",
  • "exam_offering_id": "string",
  • "student_id": "string",
  • "cancellation_date": "2019-08-24T14:15:22Z",
  • "location": "training location",
  • "testing_facility_id": "string",
  • "training_provider_id": "string",
  • "training_location_id": "string",
  • "additional_location_info": "string",
  • "date": "string",
  • "exam_date": "string",
  • "score": 0,
  • "status": "draft",
  • "scoring_report_uri": "string",
  • "notices": [
    ],
  • "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",
  • "retest": true,
  • "course_registration_id": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "notes": "string",
  • "custom_field_values": [
    ],
  • "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 exam registration with the specified ID.

This method will patch an existing exam registration 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 exam registration 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 exam registration was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The exam registration could not be found.
409The exam registration could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve exam registration based on tenant limits.
500General server error.
patch/examRegistrations/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "number": 0,
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "application_id": "string",
  • "process_id": "string",
  • "exam_id": "string",
  • "exam_offering_id": "string",
  • "student_id": "string",
  • "cancellation_date": "2019-08-24T14:15:22Z",
  • "location": "training location",
  • "testing_facility_id": "string",
  • "training_provider_id": "string",
  • "training_location_id": "string",
  • "additional_location_info": "string",
  • "date": "string",
  • "exam_date": "string",
  • "score": 0,
  • "status": "draft",
  • "scoring_report_uri": "string",
  • "notices": [
    ],
  • "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",
  • "retest": true,
  • "course_registration_id": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "notes": "string",
  • "custom_field_values": [
    ],
  • "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 exam registration from the system by its ID.

This method will delete a exam registration 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 exam registration to delete.

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

Generates an order from a membership registration

This method will examine a cert exam reg 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 registration to generate an order

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

The unique, string identifier of this exam registration

number
number <float> (Number)

The registration number

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

application_id
string (Application)

The certification application to which this registration

process_id
string (Process)

The registration process used to create the registration

exam_id
required
string (Exam)

The exam being taken

exam_offering_id
required
string (Exam Offering)

The scheduled exam

student_id
required
string (Student)

The individual taking the exam

cancellation_date
string <date-time> (Cancellation Date)
location
string (Location)
Enum: "training location" "testing facility" "none"
testing_facility_id
string (Testing Facility)

The exam testing site

training_provider_id
string (Training Provider)

The training facility

training_location_id
string (Training Location)

The training facility

additional_location_info
string (Additional Location Info)

Additional location information

date
required
string (Date)

The date/time of the registration

exam_date
string (Exam Date)

The date/time of the registration

score
number <float> (Score)

The score

status
string (Status)
Enum: "draft" "registered" "passed" "failed" "no show" "cancelled"
scoring_report_uri
string (Scoring Report Uri)

An image/PDF of the exam scoring report

Array of objects
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 registration

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

The date this registration 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 registration

training_provider_billing_invoice_line_item_id
string (Training Provider Billing Invoice Line Item)

The invoice that was created to bill for this registration

retest
boolean (Retest)

Whether or not this is a retest

course_registration_id
string (Course Registration)

The course registration this exam is tied to

order_id
string (Order)

The order

order_line_item_id
string (Order Line Item)

The order line item

notes
string (Notes)

notes

Array of objects (Custom Field Values)
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/examRegistrations/{tenantId}/generateOrder
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "number": 0,
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "application_id": "string",
  • "process_id": "string",
  • "exam_id": "string",
  • "exam_offering_id": "string",
  • "student_id": "string",
  • "cancellation_date": "2019-08-24T14:15:22Z",
  • "location": "training location",
  • "testing_facility_id": "string",
  • "training_provider_id": "string",
  • "training_location_id": "string",
  • "additional_location_info": "string",
  • "date": "string",
  • "exam_date": "string",
  • "score": 0,
  • "status": "draft",
  • "scoring_report_uri": "string",
  • "notices": [
    ],
  • "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",
  • "retest": true,
  • "course_registration_id": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "notes": "string",
  • "custom_field_values": [
    ],
  • "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
{ }

Generates an registration for a contact

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed

processId
required
string

The process id

contactId
required
string

The contact contact

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/examRegistrations/{tenantId}/generateRegistration/{processId}/{contactId}
Request samples
curl -i -X POST \
  https://certifications.api.756794052567.rhythmsoftware.com/examRegistrations/:tenantId/generateRegistration/:processId/:contactId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "number": 0,
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "application_id": "string",
  • "process_id": "string",
  • "exam_id": "string",
  • "exam_offering_id": "string",
  • "student_id": "string",
  • "cancellation_date": "2019-08-24T14:15:22Z",
  • "location": "training location",
  • "testing_facility_id": "string",
  • "training_provider_id": "string",
  • "training_location_id": "string",
  • "additional_location_info": "string",
  • "date": "string",
  • "exam_date": "string",
  • "score": 0,
  • "status": "draft",
  • "scoring_report_uri": "string",
  • "notices": [
    ],
  • "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",
  • "retest": true,
  • "course_registration_id": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "notes": "string",
  • "custom_field_values": [
    ],
  • "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 list of records with the specified student_id

Returns a list of records with the specified student_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

student_id
required
string

The student_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/examRegistrations/{tenantId}/student/{student_id}
Request samples
curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/examRegistrations/:tenantId/student/:student_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified exam_id

Returns a list of records with the specified exam_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

exam_id
required
string

The exam_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/examRegistrations/{tenantId}/exam/{exam_id}
Request samples
curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/examRegistrations/:tenantId/exam/:exam_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified exam_offering_id

Returns a list of records with the specified exam_offering_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

exam_offering_id
required
string

The exam_offering_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/examRegistrations/{tenantId}/examOffering/{exam_offering_id}
Request samples
curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/examRegistrations/:tenantId/examOffering/:exam_offering_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified student_exam_id

Returns a list of records with the specified student_exam_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

student_id
required
string

The student_exam_id to use to for record lookup

exam_id
required
string

The student_exam_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/examRegistrations/{tenantId}/studentExam/{student_id}/{exam_id}
Request samples
curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/examRegistrations/:tenantId/studentExam/:student_id/:exam_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified course_registration_id

Returns a list of records with the specified course_registration_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

course_registration_id
required
string

The course_registration_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/examRegistrations/{tenantId}/courseRegistration/{course_registration_id}
Request samples
curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/examRegistrations/:tenantId/courseRegistration/:course_registration_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified application_id

Returns a list of records with the specified application_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

application_id
required
string

The application_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/examRegistrations/{tenantId}/application/{application_id}
Request samples
curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/examRegistrations/:tenantId/application/:application_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Send an exam notice

This will send an exam notice

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed

id
required
string

The exam registration

noticeId
required
string

The exam notice

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/examRegistrations/{tenantId}/sendNotice/{id}/{noticeId}
Request samples
curl -i -X POST \
  https://certifications.api.756794052567.rhythmsoftware.com/examRegistrations/:tenantId/sendNotice/:id/:noticeId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{ }

Searches for exam registrations using predefined parameters

Searches for exam registrations 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 exam registration that you would like to be saved.

ids
Array of strings (Ids)

IDs to search

name
string (Name)
exam_id
Array of strings (Exam)
exam_offering_id
Array of strings (Exam Offering)
date
Array of strings <date-time> (Date) 2 items
location
Array of strings (Location)
testing_facility_id
Array of strings (Testing Facility)
training_provider_id
Array of strings (Training Provider)
training_location_id
Array of strings (Training Location)
score
Array of numbers <float> (Score)
status
Array of strings (Status)
email_address
string (Email Address)
job_title
string (Job Title)
city
string (City)

City to search

state
string (State)

The state

sys_created_at
Array of strings <date-time> (Sys Created At) 2 items
Responses
200The exam registration search was saved successfully.
400The exam registration you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The exam registration could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add exam registration based on tenant limits.
500General server error.
post/examRegistrations/{tenantId}/search
Request samples
    1 more
    Python
application/json
{
  • "ids": [
    ],
  • "name": "string",
  • "exam_id": [
    ],
  • "exam_offering_id": [
    ],
  • "date": [
    ],
  • "location": [
    ],
  • "testing_facility_id": [
    ],
  • "training_provider_id": [
    ],
  • "training_location_id": [
    ],
  • "score": [
    ],
  • "status": [
    ],
  • "email_address": "string",
  • "job_title": "string",
  • "city": "string",
  • "state": "string",
  • "sys_created_at": [
    ]
}
Response samples
application/json
{
  • "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/examRegistrations/{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 exam registration could not be found.
429Limit exceeded... unable to retrieve exam registration based on tenant limits.
500General server error.
post/examRegistrations/{tenantId}/batch
Request samples
    1 more
    Python
application/json
{
  • "operations": [
    ]
}
Response samples
application/json
{
  • "success_count": 0,
  • "error_count": 0,
  • "results": [
    ]
}