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

Returns a list of records with the specified program_applicant_id

Request

Returns a list of records with the specified program_applicant_id

Path
tenantIdstringrequired

The tenant

programIdstringrequired

The program id to use to for record lookup

ownerTypestringrequired

The contact or organization type

Enum"contact""organization"
ownerIdstringrequired

The contact or organization type

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/applications/{tenantId}/programApplicant/{programId}/{ownerType}/{ownerId}?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(Application)
LastEvaluatedKeystring
Response
application/json
{ "Count": 0, "Items": [ {} ], "LastEvaluatedKey": "string" }

Searches for applications using predefined parameters

Request

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

contact_idArray of strings(Contact)
dateArray of strings(date-time)(Date)= 2 items
idsArray of strings(Ids)

IDs to search

last_requirements_calculation_dateArray of strings(date-time)(Last Requirements Calculation Date)= 2 items
namestring(Name)
number_of_missing_requirementsArray of numbers(float)(Number Of Missing Requirements)
organization_idArray of strings(Organization)
owner_typeArray of strings(Owner Type)
percentage_completeArray of numbers(float)(Percentage Complete)
process_idArray of strings(Process)
program_idArray of strings(Program)
statusArray of strings(Status)
typeArray of strings(Type)
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/applications/{tenantId}/search?exclusiveStartKey=string&fieldsToReturn=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "contact_id": [
      "string"
    ],
    "date": [
      "2019-08-24T14:15:22Z",
      "2019-08-24T14:15:22Z"
    ],
    "ids": [
      "string"
    ],
    "last_requirements_calculation_date": [
      "2019-08-24T14:15:22Z",
      "2019-08-24T14:15:22Z"
    ],
    "name": "string",
    "number_of_missing_requirements": [
      0.1
    ],
    "organization_id": [
      "string"
    ],
    "owner_type": [
      "string"
    ],
    "percentage_complete": [
      0.1
    ],
    "process_id": [
      "string"
    ],
    "program_id": [
      "string"
    ],
    "status": [
      "string"
    ],
    "type": [
      "string"
    ]
  }'

Responses

The application search was saved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
ItemsArray of objects(ApplicationSearchResults)
LastEvaluatedKeystring
Response
application/json
{ "Items": [ {} ], "LastEvaluatedKey": "string" }

Sends an application notice

Request

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

Path
tenantIdstringrequired

The id of the tenant being accessed

notice_idstringrequired

The application notice

application_idstringrequired

The application

Query
new_status_reason_idstring

The new status reason

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

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