Certifications

Certifications

Creates a new certification record that does not already exist.

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

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

The unique, string identifier of this certification

contact_id
required
string (Contact)

The contact that owns the certification

organization_id
string (Organization)

The organization that owns the certifications

owner_type
string (Owner Type)
Enum: "contact" "organization"
program_id
required
string (Program)

The certification program

status
required
string (Status)
Enum: "active" "inactive" "suspended" "retired"
certification_date
string (Certification Date)

The date of the certification

number
required
number <float> (Number)

The cert number

customer_id
string (Customer)

For reporting only; the contact ID if this is owned by a contact, the organization if this is owned by an organization

forecasted_renewal_amount
number <float> (Forecasted Renewal Amount)

The amount this certification is forecasted to generate upon renewal

grandfathered
boolean (Grandfathered)

If this is true,this is a grandfathered certification that should be renewed automatically with other certifications

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

issuing_training_provider_id
string (Issuing Training Provider)

The provider that issued this certification

renewal_training_provider_id
string (Renewal Training Provider)

The renewal training provider

Array of objects
last_application_id
string (Last Application)

This is the last application that updated this certification

status_reason_id
string (Status Reason)

The configurable reason why the certification is in the specified status

term_start_date
string (Term Start Date)

The date the most recently purchased membership type starts

expiration_date
string (Expiration Date)

The date the membership expires

renewal_date
string (Renewal Date)

The date the member last renewed

reinstatement_date
string (Reinstatement Date)

The date the member was last reinstated

termination_date
string (Termination Date)

The date the member was terminated

lapse_date
string (Lapse Date)

The last date that this record was terminated. Unlike termination date does not get erased

name_to_be_printed_on_certificate
string (Name To Be Printed On Certificate)

The name to be displayed on the certificate

do_not_drop
boolean (Do Not Drop)

If set, the certification is not dropped on a normal billing cycle

certificate_uri
string (Certificate Uri)

A link to an externally created certificate of membership

last_reminder_date
string (Last Reminder Date)

The last time a reminder was sent for this certification

notes
string (Notes)

Notes

Array of objects (Custom Field Values)
sys_deleted_by_id
string (Sys Deleted By)

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

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

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

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

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

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

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

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

sys_locked
boolean (Sys Locked)

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

sys_bulk_load_pk
string (Sys Bulk Load Pk)

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

sys_bulk_load_at
string (Sys Bulk Load At)

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

sys_bulk_load_id
string (Sys Bulk Load)

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

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

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

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_last_bulk_data_operation_id
string (Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_version
string (Sys Last Bulk Data Operation Sys Version)

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

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

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

sys_has_files_in_s3
boolean (Sys Has Files In S3)

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

sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

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

sys_last_security_context
object (Sys Last Security Context)

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

Array of objects
Responses
200The certification was saved successfully.
400The certification you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The certification could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add certification based on tenant limits.
500General server error.
post/certifications/{tenantId}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "contact_id": "string",
  • "organization_id": "string",
  • "owner_type": "contact",
  • "program_id": "string",
  • "status": "active",
  • "certification_date": "string",
  • "number": 0,
  • "customer_id": "string",
  • "forecasted_renewal_amount": 0,
  • "grandfathered": true,
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "issuing_training_provider_id": "string",
  • "renewal_training_provider_id": "string",
  • "notices": [
    ],
  • "last_application_id": "string",
  • "status_reason_id": "string",
  • "term_start_date": "string",
  • "expiration_date": "string",
  • "renewal_date": "string",
  • "reinstatement_date": "string",
  • "termination_date": "string",
  • "lapse_date": "string",
  • "name_to_be_printed_on_certificate": "string",
  • "do_not_drop": true,
  • "certificate_uri": "string",
  • "last_reminder_date": "string",
  • "notes": "string",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "contact_id": "string",
  • "organization_id": "string",
  • "owner_type": "contact",
  • "program_id": "string",
  • "status": "active",
  • "certification_date": "string",
  • "number": 0,
  • "customer_id": "string",
  • "forecasted_renewal_amount": 0,
  • "grandfathered": true,
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "issuing_training_provider_id": "string",
  • "renewal_training_provider_id": "string",
  • "notices": [
    ],
  • "last_application_id": "string",
  • "status_reason_id": "string",
  • "term_start_date": "string",
  • "expiration_date": "string",
  • "renewal_date": "string",
  • "reinstatement_date": "string",
  • "termination_date": "string",
  • "lapse_date": "string",
  • "name_to_be_printed_on_certificate": "string",
  • "do_not_drop": true,
  • "certificate_uri": "string",
  • "last_reminder_date": "string",
  • "notes": "string",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Gets all of the certifications in the system.

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

Returns a certification from the system by its ID.

This method will look up a certification 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 certification 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 certification was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The certification could not be found.
429Limit exceeded... unable to retrieve certification based on tenant limits.
500General server error.
get/certifications/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/certifications/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "contact_id": "string",
  • "organization_id": "string",
  • "owner_type": "contact",
  • "program_id": "string",
  • "status": "active",
  • "certification_date": "string",
  • "number": 0,
  • "customer_id": "string",
  • "forecasted_renewal_amount": 0,
  • "grandfathered": true,
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "issuing_training_provider_id": "string",
  • "renewal_training_provider_id": "string",
  • "notices": [
    ],
  • "last_application_id": "string",
  • "status_reason_id": "string",
  • "term_start_date": "string",
  • "expiration_date": "string",
  • "renewal_date": "string",
  • "reinstatement_date": "string",
  • "termination_date": "string",
  • "lapse_date": "string",
  • "name_to_be_printed_on_certificate": "string",
  • "do_not_drop": true,
  • "certificate_uri": "string",
  • "last_reminder_date": "string",
  • "notes": "string",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Updates a certification with the specified ID.

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

Request Body schema: application/json

The updated certification that will be saved.

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

The unique, string identifier of this certification

contact_id
required
string (Contact)

The contact that owns the certification

organization_id
string (Organization)

The organization that owns the certifications

owner_type
string (Owner Type)
Enum: "contact" "organization"
program_id
required
string (Program)

The certification program

status
required
string (Status)
Enum: "active" "inactive" "suspended" "retired"
certification_date
string (Certification Date)

The date of the certification

number
required
number <float> (Number)

The cert number

customer_id
string (Customer)

For reporting only; the contact ID if this is owned by a contact, the organization if this is owned by an organization

forecasted_renewal_amount
number <float> (Forecasted Renewal Amount)

The amount this certification is forecasted to generate upon renewal

grandfathered
boolean (Grandfathered)

If this is true,this is a grandfathered certification that should be renewed automatically with other certifications

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

issuing_training_provider_id
string (Issuing Training Provider)

The provider that issued this certification

renewal_training_provider_id
string (Renewal Training Provider)

The renewal training provider

Array of objects
last_application_id
string (Last Application)

This is the last application that updated this certification

status_reason_id
string (Status Reason)

The configurable reason why the certification is in the specified status

term_start_date
string (Term Start Date)

The date the most recently purchased membership type starts

expiration_date
string (Expiration Date)

The date the membership expires

renewal_date
string (Renewal Date)

The date the member last renewed

reinstatement_date
string (Reinstatement Date)

The date the member was last reinstated

termination_date
string (Termination Date)

The date the member was terminated

lapse_date
string (Lapse Date)

The last date that this record was terminated. Unlike termination date does not get erased

name_to_be_printed_on_certificate
string (Name To Be Printed On Certificate)

The name to be displayed on the certificate

do_not_drop
boolean (Do Not Drop)

If set, the certification is not dropped on a normal billing cycle

certificate_uri
string (Certificate Uri)

A link to an externally created certificate of membership

last_reminder_date
string (Last Reminder Date)

The last time a reminder was sent for this certification

notes
string (Notes)

Notes

Array of objects (Custom Field Values)
sys_deleted_by_id
string (Sys Deleted By)

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

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

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

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

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

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

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

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

sys_locked
boolean (Sys Locked)

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

sys_bulk_load_pk
string (Sys Bulk Load Pk)

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

sys_bulk_load_at
string (Sys Bulk Load At)

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

sys_bulk_load_id
string (Sys Bulk Load)

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

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

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

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_last_bulk_data_operation_id
string (Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_version
string (Sys Last Bulk Data Operation Sys Version)

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

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

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

sys_has_files_in_s3
boolean (Sys Has Files In S3)

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

sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

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

sys_last_security_context
object (Sys Last Security Context)

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

Array of objects
Responses
200The certification was updated successfully.
400The certification supplied was not valid.
401Unauthorized.
403Forbidden.
404The certification could not be found.
409The certification could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve certification based on tenant limits.
500General server error.
put/certifications/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "contact_id": "string",
  • "organization_id": "string",
  • "owner_type": "contact",
  • "program_id": "string",
  • "status": "active",
  • "certification_date": "string",
  • "number": 0,
  • "customer_id": "string",
  • "forecasted_renewal_amount": 0,
  • "grandfathered": true,
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "issuing_training_provider_id": "string",
  • "renewal_training_provider_id": "string",
  • "notices": [
    ],
  • "last_application_id": "string",
  • "status_reason_id": "string",
  • "term_start_date": "string",
  • "expiration_date": "string",
  • "renewal_date": "string",
  • "reinstatement_date": "string",
  • "termination_date": "string",
  • "lapse_date": "string",
  • "name_to_be_printed_on_certificate": "string",
  • "do_not_drop": true,
  • "certificate_uri": "string",
  • "last_reminder_date": "string",
  • "notes": "string",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "contact_id": "string",
  • "organization_id": "string",
  • "owner_type": "contact",
  • "program_id": "string",
  • "status": "active",
  • "certification_date": "string",
  • "number": 0,
  • "customer_id": "string",
  • "forecasted_renewal_amount": 0,
  • "grandfathered": true,
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "issuing_training_provider_id": "string",
  • "renewal_training_provider_id": "string",
  • "notices": [
    ],
  • "last_application_id": "string",
  • "status_reason_id": "string",
  • "term_start_date": "string",
  • "expiration_date": "string",
  • "renewal_date": "string",
  • "reinstatement_date": "string",
  • "termination_date": "string",
  • "lapse_date": "string",
  • "name_to_be_printed_on_certificate": "string",
  • "do_not_drop": true,
  • "certificate_uri": "string",
  • "last_reminder_date": "string",
  • "notes": "string",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Partially updates a certification with the specified ID.

This method will patch an existing certification 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 certification 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 certification was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The certification could not be found.
409The certification could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve certification based on tenant limits.
500General server error.
patch/certifications/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "contact_id": "string",
  • "organization_id": "string",
  • "owner_type": "contact",
  • "program_id": "string",
  • "status": "active",
  • "certification_date": "string",
  • "number": 0,
  • "customer_id": "string",
  • "forecasted_renewal_amount": 0,
  • "grandfathered": true,
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "issuing_training_provider_id": "string",
  • "renewal_training_provider_id": "string",
  • "notices": [
    ],
  • "last_application_id": "string",
  • "status_reason_id": "string",
  • "term_start_date": "string",
  • "expiration_date": "string",
  • "renewal_date": "string",
  • "reinstatement_date": "string",
  • "termination_date": "string",
  • "lapse_date": "string",
  • "name_to_be_printed_on_certificate": "string",
  • "do_not_drop": true,
  • "certificate_uri": "string",
  • "last_reminder_date": "string",
  • "notes": "string",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Returns a certification from the system by its ID.

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

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

Downloads a Certificate

Returns the HTML for the certificate

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed

id
required
string

The ID of the certifications

query Parameters
downloadAsHtml
boolean

If true, return the receipt as HTML

Responses
200The certifications was downloaded successfully
400The request was not valid.
401Unauthorized
403Forbidden
404The payment could not be found.
429Limit exceeded... unable to retrieve payment based on tenant limits.
500General server error
get/certifications/{tenantId}/certificate/{id}
Request samples
curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/certifications/:tenantId/certificate/:id?downloadAsHtml=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
"string"

Returns a list of records with the specified contact_id

Returns a list of records with the specified contact_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

contact_id
required
string

The contact_id to use to for record lookup

query Parameters
fields
string

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

exclusiveStartKey
string

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

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

Returns a list of records with the specified organization_id

Returns a list of records with the specified organization_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

organization_id
required
string

The organization_id to use to for record lookup

query Parameters
fields
string

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

exclusiveStartKey
string

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

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

Searches for certifications using predefined parameters

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

id
Array of strings (ID)

IDs to search

name
string (Name)
city
string (City)
state
string (State)
email_address
string (Email Address)
job_title
string (Job Title)
owner_type
string (Owner Type)
status
Array of strings (Status)
program_id
Array of strings (Program)
number
Array of numbers <float> (Number) 2 items
certification_date
Array of strings <date-time> (Certification Date) 2 items
expiration_date
Array of strings <date-time> (Expiration Date) 2 items
renewal_date
Array of strings <date-time> (Renewal Date) 2 items
termination_date
Array of strings <date-time> (Termination Date) 2 items
is_new
string (Is New)
origin
Array of strings (Origin)
Responses
200The certification search was saved successfully.
400The certification you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The certification could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add certification based on tenant limits.
500General server error.
post/certifications/{tenantId}/search
Request samples
    1 more
    Python
application/json
{
  • "id": [
    ],
  • "name": "string",
  • "city": "string",
  • "state": "string",
  • "email_address": "string",
  • "job_title": "string",
  • "owner_type": "string",
  • "status": [
    ],
  • "program_id": [
    ],
  • "number": [
    ],
  • "certification_date": [
    ],
  • "expiration_date": [
    ],
  • "renewal_date": [
    ],
  • "termination_date": [
    ],
  • "is_new": "string",
  • "origin": [
    ]
}
Response samples
application/json
{
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Sends out a preview of the CRC notification certificate

Sends out a preview of the CRC notification certificate

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

certification_id
required
string (Certification)
certificate_template
required
string (Certificate Template)
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/certifications/{tenantId}/previewCertificate
Request samples
    1 more
    Python
application/json
{
  • "certification_id": "string",
  • "certificate_template": "string"
}

Sends an certification notice

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed

notice_id
required
string

The certification notice

id
required
string

The certification

query Parameters
new_status_reason_id
string

The new status reason

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

Sends out a preview of the CRC notification email

Sends out a preview of the CRC notification email

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

Request Body schema: application/json

The domain_name to use to for record lookup

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

Execute Batch Operations

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The batch request

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