Training Providers

Training Providers

Creates a new training provider record that does not already exist.

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

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

The unique, string identifier of this training provider, which should match an organization id

contact_id
string (Contact)

The billing contact

name
required
string (Name)

The name of the training provider

Array of objects
billing_exempt
boolean (Billing Exempt)

If set, this training provider is not to be billed for any applications/courses/exams

contract_uri
string <file> (Contract Uri)

A link to the contract

notes
string (Notes)

Notes

is_active
boolean (Is Active)

Whether or not this training provider is active

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 training provider was saved successfully.
400The training provider you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The training provider could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add training provider based on tenant limits.
500General server error.
post/trainingProviders/{tenantId}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "contact_id": "string",
  • "name": "string",
  • "territories": [
    ],
  • "billing_exempt": true,
  • "contract_uri": "string",
  • "notes": "string",
  • "is_active": true,
  • "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",
  • "contact_id": "string",
  • "name": "string",
  • "territories": [
    ],
  • "billing_exempt": true,
  • "contract_uri": "string",
  • "notes": "string",
  • "is_active": true,
  • "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 training providers in the system.

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

Returns a training provider from the system by its ID.

This method will look up a training provider 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 training provider 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 training provider was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The training provider could not be found.
429Limit exceeded... unable to retrieve training provider based on tenant limits.
500General server error.
get/trainingProviders/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/trainingProviders/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "contact_id": "string",
  • "name": "string",
  • "territories": [
    ],
  • "billing_exempt": true,
  • "contract_uri": "string",
  • "notes": "string",
  • "is_active": true,
  • "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 training provider with the specified ID.

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

Request Body schema: application/json

The updated training provider that will be saved.

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

The unique, string identifier of this training provider, which should match an organization id

contact_id
string (Contact)

The billing contact

name
required
string (Name)

The name of the training provider

Array of objects
billing_exempt
boolean (Billing Exempt)

If set, this training provider is not to be billed for any applications/courses/exams

contract_uri
string <file> (Contract Uri)

A link to the contract

notes
string (Notes)

Notes

is_active
boolean (Is Active)

Whether or not this training provider is active

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 training provider was updated successfully.
400The training provider supplied was not valid.
401Unauthorized.
403Forbidden.
404The training provider could not be found.
409The training provider could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve training provider based on tenant limits.
500General server error.
put/trainingProviders/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "contact_id": "string",
  • "name": "string",
  • "territories": [
    ],
  • "billing_exempt": true,
  • "contract_uri": "string",
  • "notes": "string",
  • "is_active": true,
  • "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",
  • "contact_id": "string",
  • "name": "string",
  • "territories": [
    ],
  • "billing_exempt": true,
  • "contract_uri": "string",
  • "notes": "string",
  • "is_active": true,
  • "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 training provider with the specified ID.

This method will patch an existing training provider 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 training provider 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 training provider was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The training provider could not be found.
409The training provider could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve training provider based on tenant limits.
500General server error.
patch/trainingProviders/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "contact_id": "string",
  • "name": "string",
  • "territories": [
    ],
  • "billing_exempt": true,
  • "contract_uri": "string",
  • "notes": "string",
  • "is_active": true,
  • "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 training provider from the system by its ID.

This method will delete a training provider 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 training provider to delete.

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

Create a new Contact

Allows for a portal user to create a new contact

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

Request Body schema: application/json

The contact

object
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
post/trainingProviders/{tenantId}/portal/contact/{trainingProviderId}
Request samples
    1 more
    Python
application/json
{ }
Response samples
application/json
{ }

Get a contact

Allows for a portal user to get a new contact

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

contactId
required
string

The training provider id

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/trainingProviders/{tenantId}/portal/contact/{trainingProviderId}/{contactId}
Request samples
curl -i -X GET \
  https://certifications.api.756794052567.rhythmsoftware.com/trainingProviders/:tenantId/portal/contact/:trainingProviderId/:contactId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{ }

Update a contact

Allows for a portal user to update a new contact

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

contactId
required
string

The training provider id

Request Body schema: application/json

The contact

object
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
put/trainingProviders/{tenantId}/portal/contact/{trainingProviderId}/{contactId}
Request samples
    1 more
    Python
application/json
{ }
Response samples
application/json
{ }

Search for contacts

Allows for a portal user to search for contacts

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

Request Body schema: application/json

The contact

object
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
post/trainingProviders/{tenantId}/portal/contactSearch/{trainingProviderId}
Request samples
    1 more
    Python
application/json
{ }
Response samples
application/json
{ }

Create a new Course Registration

Allows for a portal user to create a course registration

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

Request Body schema: application/json

The contact

object
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
post/trainingProviders/{tenantId}/portal/courseRegistration/{trainingProviderId}
Request samples
    1 more
    Python
application/json
{ }
Response samples
application/json
{ }

Get a Course Registration

Allows for a portal user to get a course registration

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

courseRegistrationId
required
string

The course registration id

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/trainingProviders/{tenantId}/portal/courseRegistration/{trainingProviderId}/{courseRegistrationId}
Request samples
curl -i -X GET \
  https://certifications.api.756794052567.rhythmsoftware.com/trainingProviders/:tenantId/portal/courseRegistration/:trainingProviderId/:courseRegistrationId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{ }

Create a new Course Registration

Allows for a portal user to create a course registration

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

Request Body schema: application/json

The contact

object
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
post/trainingProviders/{tenantId}/portal/courseRegistrationOrder/{trainingProviderId}
Request samples
    1 more
    Python
application/json
{ }
Response samples
application/json
{ }

List course registrations by contact

Shows a list of course registration by contact

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

contactId
required
string

The contact

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/trainingProviders/{tenantId}/portal/courseRegistrations/{trainingProviderId}/{contactId}
Request samples
curl -i -X GET \
  https://certifications.api.756794052567.rhythmsoftware.com/trainingProviders/:tenantId/portal/courseRegistrations/:trainingProviderId/:contactId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{ }

Create a new Exam Registration

Allows for a portal user to create a exam registration

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

Request Body schema: application/json

The contact

object
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
post/trainingProviders/{tenantId}/portal/examRegistration/{trainingProviderId}
Request samples
    1 more
    Python
application/json
{ }
Response samples
application/json
{ }

Get an Exam Registration

Allows for a portal user to get an exam registration

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

examRegistrationId
required
string

The exam registration id

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/trainingProviders/{tenantId}/portal/examRegistration/{trainingProviderId}/{examRegistrationId}
Request samples
curl -i -X GET \
  https://certifications.api.756794052567.rhythmsoftware.com/trainingProviders/:tenantId/portal/examRegistration/:trainingProviderId/:examRegistrationId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{ }

Create a new Exam Registration

Allows for a portal user to create a exam registration

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

Request Body schema: application/json

The contact

object
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
post/trainingProviders/{tenantId}/portal/examRegistrationOrder/{trainingProviderId}
Request samples
    1 more
    Python
application/json
{ }
Response samples
application/json
{ }

List exam registrations by contact

Shows a list of exam registration by contact

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

contactId
required
string

The contact

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/trainingProviders/{tenantId}/portal/examRegistrations/{trainingProviderId}/{contactId}
Request samples
curl -i -X GET \
  https://certifications.api.756794052567.rhythmsoftware.com/trainingProviders/:tenantId/portal/examRegistrations/:trainingProviderId/:contactId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{ }

Create a new certification application

Allows for a portal user to create a certification application

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

Request Body schema: application/json

The contact

object
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
post/trainingProviders/{tenantId}/portal/application/{trainingProviderId}
Request samples
    1 more
    Python
application/json
{ }
Response samples
application/json
{ }

Get a certification application

Allows for a portal user to get a certification application

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

applicationId
required
string

The certification application id

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/trainingProviders/{tenantId}/portal/application/{trainingProviderId}/{applicationId}
Request samples
curl -i -X GET \
  https://certifications.api.756794052567.rhythmsoftware.com/trainingProviders/:tenantId/portal/application/:trainingProviderId/:applicationId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{ }

Get a certification application

Allows for a portal user to update a certification application

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

applicationId
required
string

The certification application id

Request Body schema: application/json

The certification application id

object
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
put/trainingProviders/{tenantId}/portal/application/{trainingProviderId}/{applicationId}
Request samples
    1 more
    Python
application/json
{ }
Response samples
application/json
{ }

Create a new application order

Allows for a portal user to create an order for someone elses certification application

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

Request Body schema: application/json

The contact

object
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
post/trainingProviders/{tenantId}/portal/applicationOrder/{trainingProviderId}
Request samples
    1 more
    Python
application/json
{ }
Response samples
application/json
{ }

List applications by contact

Shows a list of applications by contact

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

contactId
required
string

The contact

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/trainingProviders/{tenantId}/portal/applications/{trainingProviderId}/{contactId}
Request samples
curl -i -X GET \
  https://certifications.api.756794052567.rhythmsoftware.com/trainingProviders/:tenantId/portal/applications/:trainingProviderId/:contactId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{ }

Generate a new certification application

Allows for a portal user to generate a certification application

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

processId
required
string

The contact

contactId
required
string

The contact

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
post/trainingProviders/{tenantId}/portal/generateApplication/{trainingProviderId}/{processId}/{contactId}
Request samples
curl -i -X POST \
  https://certifications.api.756794052567.rhythmsoftware.com/trainingProviders/:tenantId/portal/generateApplication/:trainingProviderId/:processId/:contactId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{ }

Get a Certification

Get a certification

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

certificationId
required
string

The certification id

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/trainingProviders/{tenantId}/portal/certification/{trainingProviderId}/{certificationId}
Request samples
curl -i -X GET \
  https://certifications.api.756794052567.rhythmsoftware.com/trainingProviders/:tenantId/portal/certification/:trainingProviderId/:certificationId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
certification/json
{ }

List certifications by contact

Shows a list of certifications by contact

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

contactId
required
string

The contact

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/trainingProviders/{tenantId}/portal/certifications/{trainingProviderId}/{contactId}
Request samples
curl -i -X GET \
  https://certifications.api.756794052567.rhythmsoftware.com/trainingProviders/:tenantId/portal/certifications/:trainingProviderId/:contactId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
certification/json
{ }

List invoices by contact

Shows a list of invoices by contact

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

contactId
required
string

The contact

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/trainingProviders/{tenantId}/portal/invoices/{trainingProviderId}/{contactId}
Request samples
curl -i -X GET \
  https://certifications.api.756794052567.rhythmsoftware.com/trainingProviders/:tenantId/portal/invoices/:trainingProviderId/:contactId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
invoice/json
{ }

Get eligible application processes

Get the eligible appliation process

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

programId
required
string

The program id

customerType
required
string

The customer type

contactOrOrganizationId
required
string

The contact or organization id

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/trainingProviders/{tenantId}/portal/eligibleApplicationProcess/{trainingProviderId}/{programId}/{customerType}/{contactOrOrganizationId}
Request samples
curl -i -X GET \
  https://certifications.api.756794052567.rhythmsoftware.com/trainingProviders/:tenantId/portal/eligibleApplicationProcess/:trainingProviderId/:programId/:customerType/:contactOrOrganizationId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
invoice/json
{ }

Get eligible course registration process

Get the eligible course registration process

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

contactId
required
string

The contact id

courseId
required
string

The reg course id

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/trainingProviders/{tenantId}/portal/eligibleCourseRegProcess/{trainingProviderId}/{contactId}/{courseId}
Request samples
curl -i -X GET \
  https://certifications.api.756794052567.rhythmsoftware.com/trainingProviders/:tenantId/portal/eligibleCourseRegProcess/:trainingProviderId/:contactId/:courseId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
invoice/json
{ }

Get eligible exam registration processes

Get the eligible exam registration process

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

contactId
required
string

The contact id

examId
required
string

The exam id

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/trainingProviders/{tenantId}/portal/eligibleExamRegProcess/{trainingProviderId}/{contactId}/{examId}
Request samples
curl -i -X GET \
  https://certifications.api.756794052567.rhythmsoftware.com/trainingProviders/:tenantId/portal/eligibleExamRegProcess/:trainingProviderId/:contactId/:examId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
invoice/json
{ }

List Activities By Contact

List the certification activites for the given contact

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

contactId
required
string

The contact id

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/trainingProviders/{tenantId}/portal/activities/{trainingProviderId}/{contactId}
Request samples
curl -i -X GET \
  https://certifications.api.756794052567.rhythmsoftware.com/trainingProviders/:tenantId/portal/activities/:trainingProviderId/:contactId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
invoice/json
{ }

Create Activity

Allows for portal users to create a certification activity

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

Request Body schema: application/json

The contact

object
Responses
200The records were created 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
post/trainingProviders/{tenantId}/portal/activity/{trainingProviderId}
Request samples
    1 more
    Python
application/json
{ }
Response samples
invoice/json
{ }

Update an activity

Allows for a portal user to update an activity

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

Request Body schema: application/json

The activity to be updated

object
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
put/trainingProviders/{tenantId}/portal/activity/{trainingProviderId}
Request samples
    1 more
    Python
application/json
{ }
Response samples
application/json
{ }

Process Activity

Allows for portal users to process a certification activity

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

activityId
required
string

The activity id

Responses
200The records were created 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
put/trainingProviders/{tenantId}/portal/processActivity/{trainingProviderId}/{activityId}
Request samples
curl -i -X PUT \
  https://certifications.api.756794052567.rhythmsoftware.com/trainingProviders/:tenantId/portal/processActivity/:trainingProviderId/:activityId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
invoice/json
{ }

Get eligible activity reg processes

Get the eligible activity reg process

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

contactId
required
string

The contact id

activityTypeId
required
string

The activity type

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/trainingProviders/{tenantId}/portal/eligibleActivityRegProcess/{trainingProviderId}/{contactId}/{activityTypeId}
Request samples
curl -i -X GET \
  https://certifications.api.756794052567.rhythmsoftware.com/trainingProviders/:tenantId/portal/eligibleActivityRegProcess/:trainingProviderId/:contactId/:activityTypeId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
invoice/json
{ }

Runs a saved query on behalf of a training provider

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

Parameters to the query

trainingProviderId
required
string

The trainning provider

savedQueryId
required
string

The saved query ID

outputFormat
required
string

The output format of the query

Request Body schema: application/json

Optional query criteria

object
Responses
200The contact was merged successfully.
400The contact supplied was not valid.
401Unauthorized
403Forbidden
404The contact could not be found.
409The contact could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to merge contact based on tenant limits.
500General server error.
post/trainingProviders/{tenantId}/query/{trainingProviderId}/{savedQueryId}/{outputFormat}
Request samples
    1 more
    Python
application/json
{ }
Response samples
application/json
{ }

Describe Training Provider Queries

Returns a list of queries training providers are able to run

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

trainingProviderId
required
string

The training provider id

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/trainingProviders/{tenantId}/portal/queries/{trainingProviderId}
Request samples
curl -i -X GET \
  https://certifications.api.756794052567.rhythmsoftware.com/trainingProviders/:tenantId/portal/queries/:trainingProviderId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "queries": [
    ]
}

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 training provider could not be found.
429Limit exceeded... unable to retrieve training provider based on tenant limits.
500General server error.
post/trainingProviders/{tenantId}/batch
Request samples
    1 more
    Python
application/json
{
  • "operations": [
    ]
}
Response samples
application/json
{
  • "success_count": 0,
  • "error_count": 0,
  • "results": [
    ]
}