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.

Languages
Servers
Mock server
https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/
https://certifications.api.rhythmsoftware.com/

Activities

Activities

Operations

Activity Reg Processes

Activity Reg Processes

Operations

Activity Types

Activity Types

Operations

App Reference Processes

App Reference Processes

Operations

App Reference Types

App Reference Types

Operations

App Status Reasons

App Status Reasons

Operations

Application Fees

Application Fees

Operations

Application Notices

Application Notices

Operations

Application Processes

Application Processes

Operations

Application References

Application References

Operations

Applications

Applications

Operations

Billing Run Actions

Billing Run Actions

Operations

Billing Runs

Billing Runs

Operations

Billing Templates

Billing Templates

Operations

Certifications

Certifications

Operations

Coupons

Coupons

Operations

Course Fees

Course Fees

Operations

Course Instructors

Course Instructors

Operations

Course Offerings

Course Offerings

Operations

Course Reg Processes

Course Reg Processes

Operations

Course Registrations

Course Registrations

Operations

Course Types

Course Types

Operations

Courses

Courses

Operations

Credit Types

Credit Types

Operations

Credits

Credits

Operations

Directories

Directories

Operations

Exam Fees

Exam Fees

Operations

Exam Notices

Exam Notices

Operations

Exam Offerings

Exam Offerings

Operations

Exam Reg Processes

Exam Reg Processes

Operations

Exam Registrations

Exam Registrations

Operations

Exam Sites

Exam Sites

Operations

Exams

Exams

Operations

Expiration Rule Sets

Expiration Rule Sets

Operations

Fees

Fees

Operations

Instructors

Instructors

Operations

License Types

License Types

Operations

Notices

Notices

Operations

Profiles

Profiles

Operations

Program Groups

Program Groups

Operations

Programs

Programs

Operations

Project Types

Project Types

Operations

Query Definitions

Query Definitions

Operations

Recurring Billing Runs

Recurring Billing Runs

Operations

Settings

Settings

Operations

Statistics

Statistics

Operations

Status Reasons

Status Reasons

Operations

Testing Facilities

Testing Facilities

Operations

Training Locations

Training Locations

Operations

Training Prov Programs

Training Prov Programs

Operations

Training Providers

Training Providers

Operations

Generate a new certification application

Request

Allows for a portal user to generate a certification application

Path
tenantIdstringrequired

The tenant

trainingProviderIdstringrequired

The training provider id

processIdstringrequired

The contact

contactIdstringrequired

The contact

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/trainingProviders/{tenantId}/portal/generateApplication/{trainingProviderId}/{processId}/{contactId}' \
  -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
object
Response
application/json
{}

List invoices by contact

Request

Shows a list of invoices by contact

Path
tenantIdstringrequired

The tenant

trainingProviderIdstringrequired

The training provider id

contactIdstringrequired

The contact

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/trainingProviders/{tenantId}/portal/invoices/{trainingProviderId}/{contactId}' \
  -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
Bodyinvoice/json
object
Response
invoice/json
{}

Process Activity

Request

Allows for portal users to process a certification activity

Path
tenantIdstringrequired

The tenant

trainingProviderIdstringrequired

The training provider id

activityIdstringrequired

The activity id

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/trainingProviders/{tenantId}/portal/processActivity/{trainingProviderId}/{activityId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were created successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyinvoice/json
object
Response
invoice/json
{}