Updates a certification with the specified ID.

Certifications (v1-2025-04-18)

The Certifications API provides all the capabilities for managing the certification process beginning with your Certification Program. You can also manage Applications, Courses, or Course Offerings from this API.

Like most of the other Rhythm apps, the Certifications API includes endpoints for Query Definitions. These endpoints are commonly used to retrieve saved queries, which can then be executed using the Query endpoints of the System API.

Download OpenAPI description

certifications-v1.json

certifications-v1.yaml

Servers

Mock server

https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/

https://certifications.api.rhythmsoftware.com/

Activities

Operations

Activity Reg Processes

Operations

Activity Types

Operations

App Reference Processes

Operations

App Reference Types

Operations

App Status Reasons

Operations

Application Fees

Operations

Application Notices

Operations

Application Processes

Operations

Application References

Operations

Applications

Operations

Billing Run Actions

Operations

Billing Runs

Operations

Billing Templates

Operations

Certifications

Operations

Gets all of the certifications in the system.

Request

This method will scan all certifications and and return them to the caller.

Path

tenantIdstringrequired

The id of the tenant being accessed.

Query

fieldsstring

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

exclusiveStartKeystring

The start key, if you're making a subsequent request

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/certifications/{tenantId}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The certificationswere retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/jsonArray [

certificate_uristring(Certificate Uri)

A link to an externally created certificate of membership

certification_datestring(Certification Date)

The date of the certification

citystring(City)

The member city

contact_idstring(Contact)required

The contact that owns the certification

countrystring(Country)

The member country

custom_field_valuesArray of objects(Custom Field Values)

customer_idstring(Customer)

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

do_not_dropboolean(Do Not Drop)

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

email_addressstring(Email Address)

The member's email address

expiration_datestring(Expiration Date)

The date the membership expires

first_namestring(First Name)

The member's first name

forecasted_renewal_amountnumber(float)(Forecasted Renewal Amount)

The amount this certification is forecasted to generate upon renewal

grandfatheredboolean(Grandfathered)

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

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

The unique, string identifier of this certification

issuing_training_provider_idstring(Issuing Training Provider)

The provider that issued this certification

job_titlestring(Job Title)

The member job title

lapse_datestring(Lapse Date)

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

last_application_idstring(Last Application)

This is the last application that updated this certification

last_namestring(Last Name)

The member's last name

last_reminder_datestring(Last Reminder Date)

The last time a reminder was sent for this certification

namestring(Name)required

The member's name

name_to_be_printed_on_certificatestring(Name To Be Printed On Certificate)

The name to be displayed on the certificate

notesstring(Notes)

Notes

noticesArray of objects

numbernumber(float)(Number)required

The cert number

organization_idstring(Organization)

The organization that owns the certifications

owner_typestring(Owner Type)

Enum"contact""organization"

program_idstring(Program)required

The certification program

reinstatement_datestring(Reinstatement Date)

The date the member was last reinstated

renewal_datestring(Renewal Date)

The date the member last renewed

renewal_training_provider_idstring(Renewal Training Provider)

The renewal training provider

statestring(State)

The state

statusstring(Status)required

Enum"active""inactive""retired""suspended"

status_reason_idstring(Status Reason)

The configurable reason why the certification is in the specified status

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

term_start_datestring(Term Start Date)

The date the most recently purchased membership type starts

termination_datestring(Termination Date)

The date the member was terminated

transferred_from_idstring(Transferred From)

If this certification was transferred from another, link it here

]

Response

application/json

[
  {
    "certificate_uri": "string",
    "certification_date": "string",
    "city": "string",
    "contact_id": "string",
    "country": "string",
    "custom_field_values": [ … ],
    "customer_id": "string",
    "do_not_drop": true,
    "email_address": "string",
    "expiration_date": "string",
    "first_name": "string",
    "forecasted_renewal_amount": 0.1,
    "grandfathered": true,
    "id": "string",
    "issuing_training_provider_id": "string",
    "job_title": "string",
    "lapse_date": "string",
    "last_application_id": "string",
    "last_name": "string",
    "last_reminder_date": "string",
    "name": "string",
    "name_to_be_printed_on_certificate": "string",
    "notes": "string",
    "notices": [ … ],
    "number": 0.1,
    "organization_id": "string",
    "owner_type": "contact",
    "program_id": "string",
    "reinstatement_date": "string",
    "renewal_date": "string",
    "renewal_training_provider_id": "string",
    "state": "string",
    "status": "active",
    "status_reason_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,
    "term_start_date": "string",
    "termination_date": "string",
    "transferred_from_id": "string"
  }
]

Creates a new certification record that does not already exist.

Request

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.

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The certification that you would like to be saved.

certificate_uristring(Certificate Uri)

A link to an externally created certificate of membership

certification_datestring(Certification Date)

The date of the certification

citystring(City)

The member city

contact_idstring(Contact)required

The contact that owns the certification

countrystring(Country)

The member country

custom_field_valuesArray of objects(Custom Field Values)

customer_idstring(Customer)

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

do_not_dropboolean(Do Not Drop)

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

email_addressstring(Email Address)

The member's email address

expiration_datestring(Expiration Date)

The date the membership expires

first_namestring(First Name)

The member's first name

forecasted_renewal_amountnumber(float)(Forecasted Renewal Amount)

The amount this certification is forecasted to generate upon renewal

grandfatheredboolean(Grandfathered)

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

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

The unique, string identifier of this certification

issuing_training_provider_idstring(Issuing Training Provider)

The provider that issued this certification

job_titlestring(Job Title)

The member job title

lapse_datestring(Lapse Date)

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

last_application_idstring(Last Application)

This is the last application that updated this certification

last_namestring(Last Name)

The member's last name

last_reminder_datestring(Last Reminder Date)

The last time a reminder was sent for this certification

namestring(Name)required

The member's name

name_to_be_printed_on_certificatestring(Name To Be Printed On Certificate)

The name to be displayed on the certificate

notesstring(Notes)

Notes

noticesArray of objects

numbernumber(float)(Number)required

The cert number

organization_idstring(Organization)

The organization that owns the certifications

owner_typestring(Owner Type)

Enum"contact""organization"

program_idstring(Program)required

The certification program

reinstatement_datestring(Reinstatement Date)

The date the member was last reinstated

renewal_datestring(Renewal Date)

The date the member last renewed

renewal_training_provider_idstring(Renewal Training Provider)

The renewal training provider

statestring(State)

The state

statusstring(Status)required

Enum"active""inactive""retired""suspended"

status_reason_idstring(Status Reason)

The configurable reason why the certification is in the specified status

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

term_start_datestring(Term Start Date)

The date the most recently purchased membership type starts

termination_datestring(Termination Date)

The date the member was terminated

transferred_from_idstring(Transferred From)

If this certification was transferred from another, link it here

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/certifications/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "certificate_uri": "string",
    "certification_date": "string",
    "city": "string",
    "contact_id": "string",
    "country": "string",
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "customer_id": "string",
    "do_not_drop": true,
    "email_address": "string",
    "expiration_date": "string",
    "first_name": "string",
    "forecasted_renewal_amount": 0.1,
    "grandfathered": true,
    "id": "string",
    "issuing_training_provider_id": "string",
    "job_title": "string",
    "lapse_date": "string",
    "last_application_id": "string",
    "last_name": "string",
    "last_reminder_date": "string",
    "name": "string",
    "name_to_be_printed_on_certificate": "string",
    "notes": "string",
    "notices": [
      {
        "date": "2019-08-24T14:15:22Z",
        "notice_id": "string"
      }
    ],
    "number": 0.1,
    "organization_id": "string",
    "owner_type": "contact",
    "program_id": "string",
    "reinstatement_date": "string",
    "renewal_date": "string",
    "renewal_training_provider_id": "string",
    "state": "string",
    "status": "active",
    "status_reason_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": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "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,
    "term_start_date": "string",
    "termination_date": "string",
    "transferred_from_id": "string"
  }'

Responses

The certification was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

certificate_uristring(Certificate Uri)

A link to an externally created certificate of membership

certification_datestring(Certification Date)

The date of the certification

citystring(City)

The member city

contact_idstring(Contact)required

The contact that owns the certification

countrystring(Country)

The member country

custom_field_valuesArray of objects(Custom Field Values)

customer_idstring(Customer)

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

do_not_dropboolean(Do Not Drop)

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

email_addressstring(Email Address)

The member's email address

expiration_datestring(Expiration Date)

The date the membership expires

first_namestring(First Name)

The member's first name

forecasted_renewal_amountnumber(float)(Forecasted Renewal Amount)

The amount this certification is forecasted to generate upon renewal

grandfatheredboolean(Grandfathered)

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

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

The unique, string identifier of this certification

issuing_training_provider_idstring(Issuing Training Provider)

The provider that issued this certification

job_titlestring(Job Title)

The member job title

lapse_datestring(Lapse Date)

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

last_application_idstring(Last Application)

This is the last application that updated this certification

last_namestring(Last Name)

The member's last name

last_reminder_datestring(Last Reminder Date)

The last time a reminder was sent for this certification

namestring(Name)required

The member's name

name_to_be_printed_on_certificatestring(Name To Be Printed On Certificate)

The name to be displayed on the certificate

notesstring(Notes)

Notes

noticesArray of objects

numbernumber(float)(Number)required

The cert number

organization_idstring(Organization)

The organization that owns the certifications

owner_typestring(Owner Type)

Enum"contact""organization"

program_idstring(Program)required

The certification program

reinstatement_datestring(Reinstatement Date)

The date the member was last reinstated

renewal_datestring(Renewal Date)

The date the member last renewed

renewal_training_provider_idstring(Renewal Training Provider)

The renewal training provider

statestring(State)

The state

statusstring(Status)required

Enum"active""inactive""retired""suspended"

status_reason_idstring(Status Reason)

The configurable reason why the certification is in the specified status

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

term_start_datestring(Term Start Date)

The date the most recently purchased membership type starts

termination_datestring(Termination Date)

The date the member was terminated

transferred_from_idstring(Transferred From)

If this certification was transferred from another, link it here

Response

application/json

{
  "certificate_uri": "string",
  "certification_date": "string",
  "city": "string",
  "contact_id": "string",
  "country": "string",
  "custom_field_values": [
    { … }
  ],
  "customer_id": "string",
  "do_not_drop": true,
  "email_address": "string",
  "expiration_date": "string",
  "first_name": "string",
  "forecasted_renewal_amount": 0.1,
  "grandfathered": true,
  "id": "string",
  "issuing_training_provider_id": "string",
  "job_title": "string",
  "lapse_date": "string",
  "last_application_id": "string",
  "last_name": "string",
  "last_reminder_date": "string",
  "name": "string",
  "name_to_be_printed_on_certificate": "string",
  "notes": "string",
  "notices": [
    { … }
  ],
  "number": 0.1,
  "organization_id": "string",
  "owner_type": "contact",
  "program_id": "string",
  "reinstatement_date": "string",
  "renewal_date": "string",
  "renewal_training_provider_id": "string",
  "state": "string",
  "status": "active",
  "status_reason_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,
  "term_start_date": "string",
  "termination_date": "string",
  "transferred_from_id": "string"
}

Execute Batch Operations

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The batch request

operationsArray of objects

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/certifications/{tenantId}/batch' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "operations": [
      {
        "id": null,
        "object": {},
        "operation": "create",
        "patch_directives": {
          "0": {
            "op": "add",
            "path": "string",
            "value": "string"
          }
        }
      }
    ]
  }'

Responses

Request completed successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

error_countnumber(float)(Error Count)

Number of error results

resultsArray of objects

success_countnumber(float)(Success Count)

Number of successful results

Response

application/json

{
  "error_count": 0.1,
  "results": [
    { … }
  ],
  "success_count": 0.1
}

Downloads a Certificate

Request

Returns the HTML for the certificate

Path

tenantIdstringrequired

The id of the tenant being accessed

idstringrequired

The ID of the certifications

Query

downloadAsHtmlboolean

If true, return the receipt as HTML

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/certifications/{tenantId}/certificate/{id}?downloadAsHtml=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The certifications was downloaded successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

string

Response

application/json

"string"

Returns a list of records with the specified contact_id

Request

Returns a list of records with the specified contact_id

Path

tenantIdstringrequired

The tenant

contact_idstringrequired

The contact_id to use to for record lookup

Query

fieldsstring

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

exclusiveStartKeystring

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

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/certifications/{tenantId}/contact/{contact_id}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

Countinteger

ItemsArray of objects(Certification)

LastEvaluatedKeystring

Response

application/json

{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Returns a list of records with the specified organization_id

Request

Returns a list of records with the specified organization_id

Path

tenantIdstringrequired

The tenant

organization_idstringrequired

The organization_id to use to for record lookup

Query

fieldsstring

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

exclusiveStartKeystring

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

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/certifications/{tenantId}/organization/{organization_id}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

Countinteger

ItemsArray of objects(Certification)

LastEvaluatedKeystring

Response

application/json

{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Sends out a preview of the CRC notification certificate

Request

Sends out a preview of the CRC notification certificate

Path

tenantIdstringrequired

The tenant

Bodyapplication/jsonrequired

The domain_name to use to for record lookup

certificate_templatestring(Certificate Template)required

certification_idstring(Certification)required

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/certifications/{tenantId}/previewCertificate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "certificate_template": "string",
    "certification_id": "string"
  }'

Responses

The record was retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Sends out a preview of the CRC notification email

Request

Sends out a preview of the CRC notification email

Path

tenantIdstringrequired

The tenant

Bodyapplication/jsonrequired

The domain_name to use to for record lookup

activity_idstring(Activity)

application_idstring(Application)

certification_idstring(Certification)

destination_email_addressstring(Destination Email Address)required

email_templateobject(Email Template)

reference_idstring(Reference)

registration_idstring(Registration)required

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/certifications/{tenantId}/previewEmail' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "activity_id": "string",
    "application_id": "string",
    "certification_id": "string",
    "destination_email_address": "string",
    "email_template": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "reference_id": "string",
    "registration_id": "string"
  }'

Responses

The record was retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Searches for certifications using predefined parameters

Request

Searches for certifications using predefined parameters

Path

tenantIdstringrequired

The id of the tenant being accessed.

Query

exclusiveStartKeystring

The start key for the search, for paging support

fieldsToReturnstring

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

Bodyapplication/jsonrequired

The certification that you would like to be saved.

certification_dateArray of strings(date-time)(Certification Date)= 2 items

citystring(City)

email_addressstring(Email Address)

expiration_dateArray of strings(date-time)(Expiration Date)= 2 items

idArray of strings(ID)

IDs to search

is_newstring(Is New)

job_titlestring(Job Title)

namestring(Name)

numberArray of numbers(float)(Number)= 2 items

originArray of strings(Origin)

owner_typestring(Owner Type)

program_idArray of strings(Program)

renewal_dateArray of strings(date-time)(Renewal Date)= 2 items

statestring(State)

statusArray of strings(Status)

termination_dateArray of strings(date-time)(Termination Date)= 2 items

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/certifications/{tenantId}/search?exclusiveStartKey=string&fieldsToReturn=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "certification_date": [
      "2019-08-24T14:15:22Z",
      "2019-08-24T14:15:22Z"
    ],
    "city": "string",
    "email_address": "string",
    "expiration_date": [
      "2019-08-24T14:15:22Z",
      "2019-08-24T14:15:22Z"
    ],
    "id": [
      "string"
    ],
    "is_new": "string",
    "job_title": "string",
    "name": "string",
    "number": [
      0.1,
      0.1
    ],
    "origin": [
      "string"
    ],
    "owner_type": "string",
    "program_id": [
      "string"
    ],
    "renewal_date": [
      "2019-08-24T14:15:22Z",
      "2019-08-24T14:15:22Z"
    ],
    "state": "string",
    "status": [
      "string"
    ],
    "termination_date": [
      "2019-08-24T14:15:22Z",
      "2019-08-24T14:15:22Z"
    ]
  }'

Responses

The certification search was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

ItemsArray of objects(CertificationSearchResults)

LastEvaluatedKeystring

Response

application/json

{
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Sends an certification notice

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed

notice_idstringrequired

The certification notice

idstringrequired

The certification

Query

new_status_reason_idstring

The new status reason

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/certifications/{tenantId}/sendNotice/{notice_id}/{id}?new_status_reason_id=string' \
  -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

object

Response

application/json

{}

Returns a certification from the system by its ID.

Request

This method will delete a certification with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the certification to delete.

curl -i -X DELETE \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/certifications/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The certification was deleted successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

string

Response

application/json

"string"

Returns a certification from the system by its ID.

Request

This method will look up a certification by the specified ID and return it back.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the certification to return.

Query

fieldsstring

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

consistentReadstring

Indicates the API should force a consistent read on the data source.

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/certifications/{tenantId}/{id}?consistentRead=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The certification was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

certificate_uristring(Certificate Uri)

A link to an externally created certificate of membership

certification_datestring(Certification Date)

The date of the certification

citystring(City)

The member city

contact_idstring(Contact)required

The contact that owns the certification

countrystring(Country)

The member country

custom_field_valuesArray of objects(Custom Field Values)

customer_idstring(Customer)

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

do_not_dropboolean(Do Not Drop)

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

email_addressstring(Email Address)

The member's email address

expiration_datestring(Expiration Date)

The date the membership expires

first_namestring(First Name)

The member's first name

forecasted_renewal_amountnumber(float)(Forecasted Renewal Amount)

The amount this certification is forecasted to generate upon renewal

grandfatheredboolean(Grandfathered)

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

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

The unique, string identifier of this certification

issuing_training_provider_idstring(Issuing Training Provider)

The provider that issued this certification

job_titlestring(Job Title)

The member job title

lapse_datestring(Lapse Date)

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

last_application_idstring(Last Application)

This is the last application that updated this certification

last_namestring(Last Name)

The member's last name

last_reminder_datestring(Last Reminder Date)

The last time a reminder was sent for this certification

namestring(Name)required

The member's name

name_to_be_printed_on_certificatestring(Name To Be Printed On Certificate)

The name to be displayed on the certificate

notesstring(Notes)

Notes

noticesArray of objects

numbernumber(float)(Number)required

The cert number

organization_idstring(Organization)

The organization that owns the certifications

owner_typestring(Owner Type)

Enum"contact""organization"

program_idstring(Program)required

The certification program

reinstatement_datestring(Reinstatement Date)

The date the member was last reinstated

renewal_datestring(Renewal Date)

The date the member last renewed

renewal_training_provider_idstring(Renewal Training Provider)

The renewal training provider

statestring(State)

The state

statusstring(Status)required

Enum"active""inactive""retired""suspended"

status_reason_idstring(Status Reason)

The configurable reason why the certification is in the specified status

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

term_start_datestring(Term Start Date)

The date the most recently purchased membership type starts

termination_datestring(Termination Date)

The date the member was terminated

transferred_from_idstring(Transferred From)

If this certification was transferred from another, link it here

Response

application/json

{
  "certificate_uri": "string",
  "certification_date": "string",
  "city": "string",
  "contact_id": "string",
  "country": "string",
  "custom_field_values": [
    { … }
  ],
  "customer_id": "string",
  "do_not_drop": true,
  "email_address": "string",
  "expiration_date": "string",
  "first_name": "string",
  "forecasted_renewal_amount": 0.1,
  "grandfathered": true,
  "id": "string",
  "issuing_training_provider_id": "string",
  "job_title": "string",
  "lapse_date": "string",
  "last_application_id": "string",
  "last_name": "string",
  "last_reminder_date": "string",
  "name": "string",
  "name_to_be_printed_on_certificate": "string",
  "notes": "string",
  "notices": [
    { … }
  ],
  "number": 0.1,
  "organization_id": "string",
  "owner_type": "contact",
  "program_id": "string",
  "reinstatement_date": "string",
  "renewal_date": "string",
  "renewal_training_provider_id": "string",
  "state": "string",
  "status": "active",
  "status_reason_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,
  "term_start_date": "string",
  "termination_date": "string",
  "transferred_from_id": "string"
}

Partially updates a certification with the specified ID.

Request

This method will patch an existing certification with the specified ID, using the HTTP PATCH specification.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the certification to patch.

Bodyapplication/jsonrequired

The patch directives conforming to RFC 6902.

Array [

opstring(Op)required

The operation

Enum"add""copy""move""remove""replace""test"

pathstring(Path)required

The JSON path

valuestring(Value)

The updated value

]

curl -i -X PATCH \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/certifications/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The certification was patched successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

certificate_uristring(Certificate Uri)

A link to an externally created certificate of membership

certification_datestring(Certification Date)

The date of the certification

citystring(City)

The member city

contact_idstring(Contact)required

The contact that owns the certification

countrystring(Country)

The member country

custom_field_valuesArray of objects(Custom Field Values)

customer_idstring(Customer)

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

do_not_dropboolean(Do Not Drop)

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

email_addressstring(Email Address)

The member's email address

expiration_datestring(Expiration Date)

The date the membership expires

first_namestring(First Name)

The member's first name

forecasted_renewal_amountnumber(float)(Forecasted Renewal Amount)

The amount this certification is forecasted to generate upon renewal

grandfatheredboolean(Grandfathered)

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

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

The unique, string identifier of this certification

issuing_training_provider_idstring(Issuing Training Provider)

The provider that issued this certification

job_titlestring(Job Title)

The member job title

lapse_datestring(Lapse Date)

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

last_application_idstring(Last Application)

This is the last application that updated this certification

last_namestring(Last Name)

The member's last name

last_reminder_datestring(Last Reminder Date)

The last time a reminder was sent for this certification

namestring(Name)required

The member's name

name_to_be_printed_on_certificatestring(Name To Be Printed On Certificate)

The name to be displayed on the certificate

notesstring(Notes)

Notes

noticesArray of objects

numbernumber(float)(Number)required

The cert number

organization_idstring(Organization)

The organization that owns the certifications

owner_typestring(Owner Type)

Enum"contact""organization"

program_idstring(Program)required

The certification program

reinstatement_datestring(Reinstatement Date)

The date the member was last reinstated

renewal_datestring(Renewal Date)

The date the member last renewed

renewal_training_provider_idstring(Renewal Training Provider)

The renewal training provider

statestring(State)

The state

statusstring(Status)required

Enum"active""inactive""retired""suspended"

status_reason_idstring(Status Reason)

The configurable reason why the certification is in the specified status

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

term_start_datestring(Term Start Date)

The date the most recently purchased membership type starts

termination_datestring(Termination Date)

The date the member was terminated

transferred_from_idstring(Transferred From)

If this certification was transferred from another, link it here

Response

application/json

{
  "certificate_uri": "string",
  "certification_date": "string",
  "city": "string",
  "contact_id": "string",
  "country": "string",
  "custom_field_values": [
    { … }
  ],
  "customer_id": "string",
  "do_not_drop": true,
  "email_address": "string",
  "expiration_date": "string",
  "first_name": "string",
  "forecasted_renewal_amount": 0.1,
  "grandfathered": true,
  "id": "string",
  "issuing_training_provider_id": "string",
  "job_title": "string",
  "lapse_date": "string",
  "last_application_id": "string",
  "last_name": "string",
  "last_reminder_date": "string",
  "name": "string",
  "name_to_be_printed_on_certificate": "string",
  "notes": "string",
  "notices": [
    { … }
  ],
  "number": 0.1,
  "organization_id": "string",
  "owner_type": "contact",
  "program_id": "string",
  "reinstatement_date": "string",
  "renewal_date": "string",
  "renewal_training_provider_id": "string",
  "state": "string",
  "status": "active",
  "status_reason_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,
  "term_start_date": "string",
  "termination_date": "string",
  "transferred_from_id": "string"
}

Updates a certification with the specified ID.

Request

This method will update an existing certification with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the certification to update.

Bodyapplication/jsonrequired

The updated certification that will be saved.

certificate_uristring(Certificate Uri)

A link to an externally created certificate of membership

certification_datestring(Certification Date)

The date of the certification

citystring(City)

The member city

contact_idstring(Contact)required

The contact that owns the certification

countrystring(Country)

The member country

custom_field_valuesArray of objects(Custom Field Values)

customer_idstring(Customer)

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

do_not_dropboolean(Do Not Drop)

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

email_addressstring(Email Address)

The member's email address

expiration_datestring(Expiration Date)

The date the membership expires

first_namestring(First Name)

The member's first name

forecasted_renewal_amountnumber(float)(Forecasted Renewal Amount)

The amount this certification is forecasted to generate upon renewal

grandfatheredboolean(Grandfathered)

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

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

The unique, string identifier of this certification

issuing_training_provider_idstring(Issuing Training Provider)

The provider that issued this certification

job_titlestring(Job Title)

The member job title

lapse_datestring(Lapse Date)

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

last_application_idstring(Last Application)

This is the last application that updated this certification

last_namestring(Last Name)

The member's last name

last_reminder_datestring(Last Reminder Date)

The last time a reminder was sent for this certification

namestring(Name)required

The member's name

name_to_be_printed_on_certificatestring(Name To Be Printed On Certificate)

The name to be displayed on the certificate

notesstring(Notes)

Notes

noticesArray of objects

numbernumber(float)(Number)required

The cert number

organization_idstring(Organization)

The organization that owns the certifications

owner_typestring(Owner Type)

Enum"contact""organization"

program_idstring(Program)required

The certification program

reinstatement_datestring(Reinstatement Date)

The date the member was last reinstated

renewal_datestring(Renewal Date)

The date the member last renewed

renewal_training_provider_idstring(Renewal Training Provider)

The renewal training provider

statestring(State)

The state

statusstring(Status)required

Enum"active""inactive""retired""suspended"

status_reason_idstring(Status Reason)

The configurable reason why the certification is in the specified status

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

term_start_datestring(Term Start Date)

The date the most recently purchased membership type starts

termination_datestring(Termination Date)

The date the member was terminated

transferred_from_idstring(Transferred From)

If this certification was transferred from another, link it here

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/certifications/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "certificate_uri": "string",
    "certification_date": "string",
    "city": "string",
    "contact_id": "string",
    "country": "string",
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "customer_id": "string",
    "do_not_drop": true,
    "email_address": "string",
    "expiration_date": "string",
    "first_name": "string",
    "forecasted_renewal_amount": 0.1,
    "grandfathered": true,
    "id": "string",
    "issuing_training_provider_id": "string",
    "job_title": "string",
    "lapse_date": "string",
    "last_application_id": "string",
    "last_name": "string",
    "last_reminder_date": "string",
    "name": "string",
    "name_to_be_printed_on_certificate": "string",
    "notes": "string",
    "notices": [
      {
        "date": "2019-08-24T14:15:22Z",
        "notice_id": "string"
      }
    ],
    "number": 0.1,
    "organization_id": "string",
    "owner_type": "contact",
    "program_id": "string",
    "reinstatement_date": "string",
    "renewal_date": "string",
    "renewal_training_provider_id": "string",
    "state": "string",
    "status": "active",
    "status_reason_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": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "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,
    "term_start_date": "string",
    "termination_date": "string",
    "transferred_from_id": "string"
  }'

Responses

The certification was updated successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

certificate_uristring(Certificate Uri)

A link to an externally created certificate of membership

certification_datestring(Certification Date)

The date of the certification

citystring(City)

The member city

contact_idstring(Contact)required

The contact that owns the certification

countrystring(Country)

The member country

custom_field_valuesArray of objects(Custom Field Values)

customer_idstring(Customer)

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

do_not_dropboolean(Do Not Drop)

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

email_addressstring(Email Address)

The member's email address

expiration_datestring(Expiration Date)

The date the membership expires

first_namestring(First Name)

The member's first name

forecasted_renewal_amountnumber(float)(Forecasted Renewal Amount)

The amount this certification is forecasted to generate upon renewal

grandfatheredboolean(Grandfathered)

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

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

The unique, string identifier of this certification

issuing_training_provider_idstring(Issuing Training Provider)

The provider that issued this certification

job_titlestring(Job Title)

The member job title

lapse_datestring(Lapse Date)

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

last_application_idstring(Last Application)

This is the last application that updated this certification

last_namestring(Last Name)

The member's last name

last_reminder_datestring(Last Reminder Date)

The last time a reminder was sent for this certification

namestring(Name)required

The member's name

name_to_be_printed_on_certificatestring(Name To Be Printed On Certificate)

The name to be displayed on the certificate

notesstring(Notes)

Notes

noticesArray of objects

numbernumber(float)(Number)required

The cert number

organization_idstring(Organization)

The organization that owns the certifications

owner_typestring(Owner Type)

Enum"contact""organization"

program_idstring(Program)required

The certification program

reinstatement_datestring(Reinstatement Date)

The date the member was last reinstated

renewal_datestring(Renewal Date)

The date the member last renewed

renewal_training_provider_idstring(Renewal Training Provider)

The renewal training provider

statestring(State)

The state

statusstring(Status)required

Enum"active""inactive""retired""suspended"

status_reason_idstring(Status Reason)

The configurable reason why the certification is in the specified status

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

term_start_datestring(Term Start Date)

The date the most recently purchased membership type starts

termination_datestring(Termination Date)

The date the member was terminated

transferred_from_idstring(Transferred From)

If this certification was transferred from another, link it here

Response

application/json

{
  "certificate_uri": "string",
  "certification_date": "string",
  "city": "string",
  "contact_id": "string",
  "country": "string",
  "custom_field_values": [
    { … }
  ],
  "customer_id": "string",
  "do_not_drop": true,
  "email_address": "string",
  "expiration_date": "string",
  "first_name": "string",
  "forecasted_renewal_amount": 0.1,
  "grandfathered": true,
  "id": "string",
  "issuing_training_provider_id": "string",
  "job_title": "string",
  "lapse_date": "string",
  "last_application_id": "string",
  "last_name": "string",
  "last_reminder_date": "string",
  "name": "string",
  "name_to_be_printed_on_certificate": "string",
  "notes": "string",
  "notices": [
    { … }
  ],
  "number": 0.1,
  "organization_id": "string",
  "owner_type": "contact",
  "program_id": "string",
  "reinstatement_date": "string",
  "renewal_date": "string",
  "renewal_training_provider_id": "string",
  "state": "string",
  "status": "active",
  "status_reason_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,
  "term_start_date": "string",
  "termination_date": "string",
  "transferred_from_id": "string"
}

Coupons

Operations

Course Fees

Operations

Course Instructors

Operations

Course Offerings

Operations

Course Reg Processes

Operations

Course Registrations

Operations

Course Types

Operations

Courses

Operations

Credit Types

Operations

Credits

Operations

Directories

Operations

Exam Fees

Operations

Exam Notices

Operations

Exam Offerings

Operations

Exam Reg Processes

Operations

Exam Registrations

Operations

Exam Sites

Operations

Exams

Operations

Expiration Rule Sets

Operations

Fees

Operations

Instructors

Operations

License Types

Operations

Notices

Operations

Profiles

Operations

Program Groups

Operations

Programs

Operations

Project Types

Operations

Query Definitions

Operations

Recurring Billing Runs

Operations

Settings

Operations

Statistics

Operations

Status Reasons

Operations

Testing Facilities

Operations

Training Locations

Operations

Training Prov Programs

Operations

Training Providers

Operations

Certifications (v1-2025-04-18)

Activities

Activity Reg Processes

Activity Types

App Reference Processes

App Reference Types

App Status Reasons

Application Fees

Application Notices

Application Processes

Application References

Applications

Billing Run Actions

Billing Runs

Billing Templates

Certifications

Gets all of the certifications in the system.

Request

Responses

Was this helpful?

Creates a new certification record that does not already exist.

RequestExpand all

Responses

Was this helpful?

Execute Batch Operations

RequestExpand all

Responses

Was this helpful?

Downloads a Certificate

Request

Responses

Was this helpful?

Returns a list of records with the specified contact_id

Request

Responses

Was this helpful?

Returns a list of records with the specified organization_id

Request

Responses

Was this helpful?

Sends out a preview of the CRC notification certificate

Request

Responses

Was this helpful?

Sends out a preview of the CRC notification email

RequestExpand all

Responses

Was this helpful?

Searches for certifications using predefined parameters

Request

Responses

Was this helpful?

Sends an certification notice

Request

Responses

Was this helpful?

Returns a certification from the system by its ID.

Request

Responses

Was this helpful?

Returns a certification from the system by its ID.

Request

Responses

Was this helpful?

Partially updates a certification with the specified ID.

Request

Responses

Was this helpful?

Updates a certification with the specified ID.

RequestExpand all

Responses

Was this helpful?

Coupons

Course Fees

Course Instructors

Course Offerings

Course Reg Processes

Course Registrations

Course Types

Courses

Request

Request

Request

Request