Skip to content
/
Generates an registration...

Generates an registration for a contact

Request

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed

processIdstringrequired

The process id

contactIdstringrequired

The contact contact

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

Responses

Conflicts were retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
additional_location_infostring(Additional Location Info)

Additional location information

application_idstring(Application)

The certification application to which this registration

cancellation_datestring, (date-time)(Cancellation Date)
citystring(City)

The member city

countrystring(Country)

The member country

course_registration_idstring(Course Registration)

The course registration this exam is tied to

custom_field_valuesArray of objects(Custom Field Values)
datestring(Date)required

The date/time of the registration

email_addressstring(Email Address)

The member's email address

exam_datestring(Exam Date)

The date/time of the registration

exam_idstring(Exam)required

The exam being taken

exam_offering_idstring(Exam Offering)required

The scheduled exam

first_namestring(First Name)

The member's first name

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

The unique, string identifier of this exam registration

job_titlestring(Job Title)

The member job title

last_namestring(Last Name)

The member's last name

locationstring(Location)
Enum:"none""testing facility""training location"
namestring(Name)required

The member's name

notesstring(Notes)

notes

noticesArray of objects
numbernumber, (float)(Number)

The registration number

order_idstring(Order)

The order

order_line_item_idstring(Order Line Item)

The order line item

process_idstring(Process)

The registration process used to create the registration

retestboolean(Retest)

Whether or not this is a retest

scorenumber, (float)(Score)

The score

scoring_report_uristring(Scoring Report Uri)

An image/PDF of the exam scoring report

statestring(State)

The state

statusstring(Status)
Enum:"cancelled""draft""failed""no show""passed""registered"
student_idstring(Student)required

The individual taking the exam

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber, (float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

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

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber, (float)(Sys Snapshot Base Version)

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

sys_versionnumber, (float)(Sys Version)

A number representing the version of this record in the database

testing_facility_idstring(Testing Facility)

The exam testing site

training_location_idstring(Training Location)

The training facility

training_provider_billing_datestring(Training Provider Billing Date)

The date this registration was billing to the training provider

training_provider_billing_invoice_idstring(Training Provider Billing Invoice)

The invoice that was created to bill for this registration

training_provider_billing_invoice_line_item_idstring(Training Provider Billing Invoice Line Item)

The invoice that was created to bill for this registration

training_provider_billing_namestring(Training Provider Billing Name)

The training provider name (for billing)

training_provider_billing_statusstring(Training Provider Billing Status)

The training provider billing status for this registration

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

The training facility

Response
{
  "additional_location_info": "string",
  "application_id": "string",
  "cancellation_date": "2019-08-24T14:15:22Z",
  "city": "string",
  "country": "string",
  "course_registration_id": "string",
  "custom_field_values": [
    { … }
  ],
  "date": "string",
  "email_address": "string",
  "exam_date": "string",
  "exam_id": "string",
  "exam_offering_id": "string",
  "first_name": "string",
  "id": "string",
  "job_title": "string",
  "last_name": "string",
  "location": "none",
  "name": "string",
  "notes": "string",
  "notices": [
    { … }
  ],
  "number": 0.1,
  "order_id": "string",
  "order_line_item_id": "string",
  "process_id": "string",
  "retest": true,
  "score": 0.1,
  "scoring_report_uri": "string",
  "state": "string",
  "status": "cancelled",
  "student_id": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "testing_facility_id": "string",
  "training_location_id": "string",
  "training_provider_billing_date": "string",
  "training_provider_billing_invoice_id": "string",
  "training_provider_billing_invoice_line_item_id": "string",
  "training_provider_billing_name": "string",
  "training_provider_billing_status": "billed",
  "training_provider_id": "string"
}