Course Registrations

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

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

id required	string (ID) /^[\w-\|:]+$/ The unique, string identifier of this course registration
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
order_id	string (Order) The order
order_line_item_id	string (Order Line Item) The order line item
order_number	number <float> (Order Number) The order number
order_balance_due	number <double> (Order Balance Due) The balance due on the order
order_amount_paid	number <double> (Order Amount Paid) The amount paid
order_currency_code	string (Order Currency Code)
order_currency_symbol	string (Order Currency Symbol)
order_status	string (Order Status) Enum: "awaiting payment" "awaiting shipping" "awaiting pickup" "partially shipped" "shipped" "completed" "cancelled" "disputed" "open" "returned" "void"
order_total	number <double> (Order Total) The total of the order
application_id	string (Application) The certification application to which this registration
event_registration_id	string (Event Registration) The event registration to which this is tied
student_id required	string (Student) The person registering for the course
organization_id	string (Organization) Organization
number	number <float> (Number) The registration number
course_id required	string (Course) The course
process_id	string (Process) The registration process used to create the registration
course_offering_id required	string (Course Offering) The scheduled course
webinar_participant_id	string (Webinar Participant) The external ID of this registration in the linked webinar
webinar_join_url	string (Webinar Join Url) The URL used to join the webinar
arrival_date	string <date-time> (Arrival Date) The date the person arrived at the course
departure_date	string <date-time> (Departure Date) The date the person left the course
cancellation_date	string <date-time> (Cancellation Date)
course_date	string <date-time> (Course Date) The date of the course
training_provider_id	string (Training Provider) The training provider
training_location_id	string (Training Location) The location
date	string <date-time> (Date) The date/time of the course registration
completion_percentage	number <double> (Completion Percentage) The completion amount
status	string (Status) Enum: "draft" "registered" "attended" "no show" "cancelled" "in progress" "completed"
exam_offering_ids	Array of strings (Exam Offerings) The exams to register for at the same time as the course
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
notes	string (Notes) Any 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 course registration was saved successfully.

400The course registration you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

409The course registration could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add course registration based on tenant limits.

500General server error.

post/courseRegistrations/{tenantId}

Request samples

application/json

{"id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"application_id": "string",
"event_registration_id": "string",
"student_id": "string",
"organization_id": "string",
"number": 0,
"course_id": "string",
"process_id": "string",
"course_offering_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"arrival_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"course_date": "2019-08-24T14:15:22Z",
"training_provider_id": "string",
"training_location_id": "string",
"date": "2019-08-24T14:15:22Z",
"completion_percentage": 0,
"status": "draft",
"exam_offering_ids": ["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",
"notes": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

{"id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"application_id": "string",
"event_registration_id": "string",
"student_id": "string",
"organization_id": "string",
"number": 0,
"course_id": "string",
"process_id": "string",
"course_offering_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"arrival_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"course_date": "2019-08-24T14:15:22Z",
"training_provider_id": "string",
"training_location_id": "string",
"date": "2019-08-24T14:15:22Z",
"completion_percentage": 0,
"status": "draft",
"exam_offering_ids": ["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",
"notes": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}

Gets all of the course registrations in the system.

This method will scan all course 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 course 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/courseRegistrations/{tenantId}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/courseRegistrations/:tenantId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

[{"id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"application_id": "string",
"event_registration_id": "string",
"student_id": "string",
"organization_id": "string",
"number": 0,
"course_id": "string",
"process_id": "string",
"course_offering_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"arrival_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"course_date": "2019-08-24T14:15:22Z",
"training_provider_id": "string",
"training_location_id": "string",
"date": "2019-08-24T14:15:22Z",
"completion_percentage": 0,
"status": "draft",
"exam_offering_ids": ["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",
"notes": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}
]

Returns a course registration from the system by its ID.

This method will look up a course 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 course 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 course registration was retrieved successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The course registration could not be found.

429Limit exceeded... unable to retrieve course registration based on tenant limits.

500General server error.

get/courseRegistrations/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/courseRegistrations/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"application_id": "string",
"event_registration_id": "string",
"student_id": "string",
"organization_id": "string",
"number": 0,
"course_id": "string",
"process_id": "string",
"course_offering_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"arrival_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"course_date": "2019-08-24T14:15:22Z",
"training_provider_id": "string",
"training_location_id": "string",
"date": "2019-08-24T14:15:22Z",
"completion_percentage": 0,
"status": "draft",
"exam_offering_ids": ["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",
"notes": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}

Updates a course registration with the specified ID.

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

Request Body schema: application/json

The updated course registration that will be saved.

id required	string (ID) /^[\w-\|:]+$/ The unique, string identifier of this course registration
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
order_id	string (Order) The order
order_line_item_id	string (Order Line Item) The order line item
order_number	number <float> (Order Number) The order number
order_balance_due	number <double> (Order Balance Due) The balance due on the order
order_amount_paid	number <double> (Order Amount Paid) The amount paid
order_currency_code	string (Order Currency Code)
order_currency_symbol	string (Order Currency Symbol)
order_status	string (Order Status) Enum: "awaiting payment" "awaiting shipping" "awaiting pickup" "partially shipped" "shipped" "completed" "cancelled" "disputed" "open" "returned" "void"
order_total	number <double> (Order Total) The total of the order
application_id	string (Application) The certification application to which this registration
event_registration_id	string (Event Registration) The event registration to which this is tied
student_id required	string (Student) The person registering for the course
organization_id	string (Organization) Organization
number	number <float> (Number) The registration number
course_id required	string (Course) The course
process_id	string (Process) The registration process used to create the registration
course_offering_id required	string (Course Offering) The scheduled course
webinar_participant_id	string (Webinar Participant) The external ID of this registration in the linked webinar
webinar_join_url	string (Webinar Join Url) The URL used to join the webinar
arrival_date	string <date-time> (Arrival Date) The date the person arrived at the course
departure_date	string <date-time> (Departure Date) The date the person left the course
cancellation_date	string <date-time> (Cancellation Date)
course_date	string <date-time> (Course Date) The date of the course
training_provider_id	string (Training Provider) The training provider
training_location_id	string (Training Location) The location
date	string <date-time> (Date) The date/time of the course registration
completion_percentage	number <double> (Completion Percentage) The completion amount
status	string (Status) Enum: "draft" "registered" "attended" "no show" "cancelled" "in progress" "completed"
exam_offering_ids	Array of strings (Exam Offerings) The exams to register for at the same time as the course
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
notes	string (Notes) Any 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 course registration was updated successfully.

400The course registration supplied was not valid.

401Unauthorized.

403Forbidden.

404The course registration could not be found.

409The course registration could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve course registration based on tenant limits.

500General server error.

put/courseRegistrations/{tenantId}/{id}

Request samples

application/json

{"id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"application_id": "string",
"event_registration_id": "string",
"student_id": "string",
"organization_id": "string",
"number": 0,
"course_id": "string",
"process_id": "string",
"course_offering_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"arrival_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"course_date": "2019-08-24T14:15:22Z",
"training_provider_id": "string",
"training_location_id": "string",
"date": "2019-08-24T14:15:22Z",
"completion_percentage": 0,
"status": "draft",
"exam_offering_ids": ["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",
"notes": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

{"id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"application_id": "string",
"event_registration_id": "string",
"student_id": "string",
"organization_id": "string",
"number": 0,
"course_id": "string",
"process_id": "string",
"course_offering_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"arrival_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"course_date": "2019-08-24T14:15:22Z",
"training_provider_id": "string",
"training_location_id": "string",
"date": "2019-08-24T14:15:22Z",
"completion_percentage": 0,
"status": "draft",
"exam_offering_ids": ["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",
"notes": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}

Partially updates a course registration with the specified ID.

This method will patch an existing course 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 course 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 course registration was patched successfully.

400The JSON patch directive you supplied was not valid.

401Unauthorized.

403Forbidden.

404The course registration could not be found.

409The course registration could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve course registration based on tenant limits.

500General server error.

patch/courseRegistrations/{tenantId}/{id}

Request samples

application/json

[{"op": "add",
"path": "string",
"value": "string"
}
]

Response samples

application/json

{"id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"application_id": "string",
"event_registration_id": "string",
"student_id": "string",
"organization_id": "string",
"number": 0,
"course_id": "string",
"process_id": "string",
"course_offering_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"arrival_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"course_date": "2019-08-24T14:15:22Z",
"training_provider_id": "string",
"training_location_id": "string",
"date": "2019-08-24T14:15:22Z",
"completion_percentage": 0,
"status": "draft",
"exam_offering_ids": ["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",
"notes": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}

Returns a course registration from the system by its ID.

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

Responses

200The course registration was deleted successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The course registration could not be found.

409The course registration could not be deleted because other objects refers to/depends on this one.

429Limit exceeded... unable to delete course registration based on tenant limits.

500General server error.

delete/courseRegistrations/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X DELETE \
  https://certifications.api.756794052567.rhythmsoftware.com/courseRegistrations/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

"string"

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/courseRegistrations/{tenantId}/student/{student_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/courseRegistrations/:tenantId/student/:student_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"application_id": "string",
"event_registration_id": "string",
"student_id": "string",
"organization_id": "string",
"number": 0,
"course_id": "string",
"process_id": "string",
"course_offering_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"arrival_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"course_date": "2019-08-24T14:15:22Z",
"training_provider_id": "string",
"training_location_id": "string",
"date": "2019-08-24T14:15:22Z",
"completion_percentage": 0,
"status": "draft",
"exam_offering_ids": ["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",
"notes": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Returns a list of records with the specified course_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
course_id required	string The course_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/courseRegistrations/{tenantId}/course/{course_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/courseRegistrations/:tenantId/course/:course_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"application_id": "string",
"event_registration_id": "string",
"student_id": "string",
"organization_id": "string",
"number": 0,
"course_id": "string",
"process_id": "string",
"course_offering_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"arrival_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"course_date": "2019-08-24T14:15:22Z",
"training_provider_id": "string",
"training_location_id": "string",
"date": "2019-08-24T14:15:22Z",
"completion_percentage": 0,
"status": "draft",
"exam_offering_ids": ["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",
"notes": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Returns a list of records with the specified course_offering_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
course_offering_id required	string The course_offering_id to use to for record lookup

query Parameters

includeActiveOnly	boolean If true, only active/attended registrations
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/courseRegistrations/{tenantId}/courseOffering/{course_offering_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/courseRegistrations/:tenantId/courseOffering/:course_offering_id?includeActiveOnly=true&fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"application_id": "string",
"event_registration_id": "string",
"student_id": "string",
"organization_id": "string",
"number": 0,
"course_id": "string",
"process_id": "string",
"course_offering_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"arrival_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"course_date": "2019-08-24T14:15:22Z",
"training_provider_id": "string",
"training_location_id": "string",
"date": "2019-08-24T14:15:22Z",
"completion_percentage": 0,
"status": "draft",
"exam_offering_ids": ["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",
"notes": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Generates an order from a membership registration

This method will courseine a cert course 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 course registration
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
order_id	string (Order) The order
order_line_item_id	string (Order Line Item) The order line item
order_number	number <float> (Order Number) The order number
order_balance_due	number <double> (Order Balance Due) The balance due on the order
order_amount_paid	number <double> (Order Amount Paid) The amount paid
order_currency_code	string (Order Currency Code)
order_currency_symbol	string (Order Currency Symbol)
order_status	string (Order Status) Enum: "awaiting payment" "awaiting shipping" "awaiting pickup" "partially shipped" "shipped" "completed" "cancelled" "disputed" "open" "returned" "void"
order_total	number <double> (Order Total) The total of the order
application_id	string (Application) The certification application to which this registration
event_registration_id	string (Event Registration) The event registration to which this is tied
student_id required	string (Student) The person registering for the course
organization_id	string (Organization) Organization
number	number <float> (Number) The registration number
course_id required	string (Course) The course
process_id	string (Process) The registration process used to create the registration
course_offering_id required	string (Course Offering) The scheduled course
webinar_participant_id	string (Webinar Participant) The external ID of this registration in the linked webinar
webinar_join_url	string (Webinar Join Url) The URL used to join the webinar
arrival_date	string <date-time> (Arrival Date) The date the person arrived at the course
departure_date	string <date-time> (Departure Date) The date the person left the course
cancellation_date	string <date-time> (Cancellation Date)
course_date	string <date-time> (Course Date) The date of the course
training_provider_id	string (Training Provider) The training provider
training_location_id	string (Training Location) The location
date	string <date-time> (Date) The date/time of the course registration
completion_percentage	number <double> (Completion Percentage) The completion amount
status	string (Status) Enum: "draft" "registered" "attended" "no show" "cancelled" "in progress" "completed"
exam_offering_ids	Array of strings (Exam Offerings) The exams to register for at the same time as the course
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
notes	string (Notes) Any 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/courseRegistrations/{tenantId}/generateOrder

Request samples

application/json

{"id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"application_id": "string",
"event_registration_id": "string",
"student_id": "string",
"organization_id": "string",
"number": 0,
"course_id": "string",
"process_id": "string",
"course_offering_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"arrival_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"course_date": "2019-08-24T14:15:22Z",
"training_provider_id": "string",
"training_location_id": "string",
"date": "2019-08-24T14:15:22Z",
"completion_percentage": 0,
"status": "draft",
"exam_offering_ids": ["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",
"notes": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}

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/courseRegistrations/{tenantId}/generateRegistration/{processId}/{contactId}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X POST \
  https://certifications.api.756794052567.rhythmsoftware.com/courseRegistrations/:tenantId/generateRegistration/:processId/:contactId \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"application_id": "string",
"event_registration_id": "string",
"student_id": "string",
"organization_id": "string",
"number": 0,
"course_id": "string",
"process_id": "string",
"course_offering_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"arrival_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"course_date": "2019-08-24T14:15:22Z",
"training_provider_id": "string",
"training_location_id": "string",
"date": "2019-08-24T14:15:22Z",
"completion_percentage": 0,
"status": "draft",
"exam_offering_ids": ["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",
"notes": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}

Returns a list of records with the specified student_course_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
student_id required	string The student_course_id to use to for record lookup
course_id required	string The student_course_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/courseRegistrations/{tenantId}/studentCourse/{student_id}/{course_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/courseRegistrations/:tenantId/studentCourse/:student_id/:course_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"application_id": "string",
"event_registration_id": "string",
"student_id": "string",
"organization_id": "string",
"number": 0,
"course_id": "string",
"process_id": "string",
"course_offering_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"arrival_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"course_date": "2019-08-24T14:15:22Z",
"training_provider_id": "string",
"training_location_id": "string",
"date": "2019-08-24T14:15:22Z",
"completion_percentage": 0,
"status": "draft",
"exam_offering_ids": ["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",
"notes": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

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/courseRegistrations/{tenantId}/application/{application_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/courseRegistrations/:tenantId/application/:application_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"application_id": "string",
"event_registration_id": "string",
"student_id": "string",
"organization_id": "string",
"number": 0,
"course_id": "string",
"process_id": "string",
"course_offering_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"arrival_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"course_date": "2019-08-24T14:15:22Z",
"training_provider_id": "string",
"training_location_id": "string",
"date": "2019-08-24T14:15:22Z",
"completion_percentage": 0,
"status": "draft",
"exam_offering_ids": ["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",
"notes": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Returns a list of records with the specified event_registration_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
event_registration_id required	string The event_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/courseRegistrations/{tenantId}/eventRegistration/{event_registration_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/courseRegistrations/:tenantId/eventRegistration/:event_registration_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"application_id": "string",
"event_registration_id": "string",
"student_id": "string",
"organization_id": "string",
"number": 0,
"course_id": "string",
"process_id": "string",
"course_offering_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"arrival_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"course_date": "2019-08-24T14:15:22Z",
"training_provider_id": "string",
"training_location_id": "string",
"date": "2019-08-24T14:15:22Z",
"completion_percentage": 0,
"status": "draft",
"exam_offering_ids": ["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",
"notes": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

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

ids	Array of strings (Ids) IDs to search
name	string (Name)
order_id	Array of strings (Order)
order_number	Array of numbers <float> (Order Number)
order_balance_due	Array of numbers <float> (Order Balance Due) 2 items
order_amount_paid	Array of numbers <float> (Order Amount Paid) 2 items
order_status	Array of strings (Order Status)
order_total	Array of numbers <float> (Order Total) 2 items
course_id	Array of strings (Course)
course_offering_id	Array of strings (Course Offering)
arrival_date	Array of strings <date-time> (Arrival Date) 2 items
departure_date	Array of strings <date-time> (Departure Date) 2 items
training_provider_id	Array of strings (Training Provider)
training_location_id	Array of strings (Training Location)
date	Array of strings <date-time> (Date) 2 items
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 course registration search was saved successfully.

400The course registration you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

409The course registration could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add course registration based on tenant limits.

500General server error.

post/courseRegistrations/{tenantId}/search

Request samples

application/json

{"ids": ["string"
],
"name": "string",
"order_id": ["string"
],
"order_number": [0
],
"order_balance_due": [0,
0
],
"order_amount_paid": [0,
0
],
"order_status": ["string"
],
"order_total": [0,
0
],
"course_id": ["string"
],
"course_offering_id": ["string"
],
"arrival_date": ["2019-08-24T14:15:22Z",
"2019-08-24T14:15:22Z"
],
"departure_date": ["2019-08-24T14:15:22Z",
"2019-08-24T14:15:22Z"
],
"training_provider_id": ["string"
],
"training_location_id": ["string"
],
"date": ["2019-08-24T14:15:22Z",
"2019-08-24T14:15:22Z"
],
"status": ["string"
],
"email_address": "string",
"job_title": "string",
"city": "string",
"state": "string",
"sys_created_at": ["2019-08-24T14:15:22Z",
"2019-08-24T14:15:22Z"
]
}

Response samples

application/json

{"Items": [{"id": "string",
"name": "string",
"course_id": "string",
"course_offering_id": "string",
"arrival_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"training_provider_id": "string",
"training_location_id": "string",
"date": "2019-08-24T14:15:22Z",
"status": "string",
"organization_id": "string",
"email_address": "string",
"job_title": "string",
"city": "string",
"state": "string"
}
],
"LastEvaluatedKey": "string"
}

Returns a list of records with the specified order_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
order_id required	string The order_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/courseRegistrations/{tenantId}/order/{order_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/courseRegistrations/:tenantId/order/:order_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"application_id": "string",
"event_registration_id": "string",
"student_id": "string",
"organization_id": "string",
"number": 0,
"course_id": "string",
"process_id": "string",
"course_offering_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"arrival_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"course_date": "2019-08-24T14:15:22Z",
"training_provider_id": "string",
"training_location_id": "string",
"date": "2019-08-24T14:15:22Z",
"completion_percentage": 0,
"status": "draft",
"exam_offering_ids": ["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",
"notes": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

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/courseRegistrations/{tenantId}/previewEmail

Request samples

application/json

{"activity_id": "string",
"email_template": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
},
"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 course registration could not be found.

429Limit exceeded... unable to retrieve course registration based on tenant limits.

500General server error.

post/courseRegistrations/{tenantId}/batch

Request samples

application/json

{"operations": [{"operation": "create",
"id": "string",
"patch_directives": [{"op": "add",
"path": "string",
"value": "string"
}
],
"object": { }
}
]
}

Response samples

application/json

{"success_count": 0,
"error_count": 0,
"results": [{"operation": "create",
"id": "string",
"outcome": "success",
"error_message": "string",
"object": { }
}
]
}