Exam Sites
/
Partially updates a exam site 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
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

Creates a new exam site record that does not already exist.

Request

This method will auto-generate an ID and create a new exam site. If an ID is specified for the exam site, an error will be thrown.

Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The exam site that you would like to be saved.

custom_field_valuesArray of objects(Custom Field Values)
idstring(ID)/^[\w|-]+$/required

The unique, string identifier of this exam site

is_activeboolean(Is Active)

Whether or not this exam site is active

locationobject(Address)

A complete address

namestring(Name)required

The name of the exam site

sys_bulk_load_idstring(Sys Bulk Load)

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

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_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_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_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_lockedboolean(Sys Locked)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/examSites/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "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": [
          {}
        ]
      }
    ],
    "id": "string",
    "is_active": true,
    "location": {
      "city": "string",
      "country": "AD",
      "country_name": "string",
      "county": "string",
      "latitude": 0.1,
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "longitude": 0.1,
      "postal_code": "string",
      "state": "string",
      "time_zone_id": "string"
    },
    "name": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_locked": true,
    "sys_version": 0.1
  }'

Responses

The exam site was saved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
custom_field_valuesArray of objects(Custom Field Values)
idstring(ID)/^[\w|-]+$/required

The unique, string identifier of this exam site

is_activeboolean(Is Active)

Whether or not this exam site is active

locationobject(Address)

A complete address

namestring(Name)required

The name of the exam site

sys_bulk_load_idstring(Sys Bulk Load)

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

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_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_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_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_lockedboolean(Sys Locked)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

Response
application/json
{
  "custom_field_values": [
    { … }
  ],
  "id": "string",
  "is_active": true,
  "location": {
    "city": "string",
    "country": "AD",
    "country_name": "string",
    "county": "string",
    "latitude": 0.1,
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "longitude": 0.1,
    "postal_code": "string",
    "state": "string",
    "time_zone_id": "string"
  },
  "name": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_locked": true,
  "sys_version": 0.1
}

Returns a exam site from the system by its ID.

Request

This method will delete a exam site with the specified ID.

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the exam site to delete.

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

Responses

The exam site 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 exam site from the system by its ID.

Request

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

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the exam site 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/examSites/{tenantId}/{id}?consistentRead=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The exam site was retrieved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
custom_field_valuesArray of objects(Custom Field Values)
idstring(ID)/^[\w|-]+$/required

The unique, string identifier of this exam site

is_activeboolean(Is Active)

Whether or not this exam site is active

locationobject(Address)

A complete address

namestring(Name)required

The name of the exam site

sys_bulk_load_idstring(Sys Bulk Load)

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

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_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_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_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_lockedboolean(Sys Locked)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

Response
application/json
{
  "custom_field_values": [
    { … }
  ],
  "id": "string",
  "is_active": true,
  "location": {
    "city": "string",
    "country": "AD",
    "country_name": "string",
    "county": "string",
    "latitude": 0.1,
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "longitude": 0.1,
    "postal_code": "string",
    "state": "string",
    "time_zone_id": "string"
  },
  "name": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_locked": true,
  "sys_version": 0.1
}

Partially updates a exam site with the specified ID.

Request

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

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the exam site 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/examSites/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The exam site was patched successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
custom_field_valuesArray of objects(Custom Field Values)
idstring(ID)/^[\w|-]+$/required

The unique, string identifier of this exam site

is_activeboolean(Is Active)

Whether or not this exam site is active

locationobject(Address)

A complete address

namestring(Name)required

The name of the exam site

sys_bulk_load_idstring(Sys Bulk Load)

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

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_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_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_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_lockedboolean(Sys Locked)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

Response
application/json
{
  "custom_field_values": [
    { … }
  ],
  "id": "string",
  "is_active": true,
  "location": {
    "city": "string",
    "country": "AD",
    "country_name": "string",
    "county": "string",
    "latitude": 0.1,
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "longitude": 0.1,
    "postal_code": "string",
    "state": "string",
    "time_zone_id": "string"
  },
  "name": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_locked": true,
  "sys_version": 0.1
}

Updates a exam site with the specified ID.

Request

This method will update an existing exam site with the specified ID.

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the exam site to update.

Bodyapplication/jsonrequired

The updated exam site that will be saved.

custom_field_valuesArray of objects(Custom Field Values)
idstring(ID)/^[\w|-]+$/required

The unique, string identifier of this exam site

is_activeboolean(Is Active)

Whether or not this exam site is active

locationobject(Address)

A complete address

namestring(Name)required

The name of the exam site

sys_bulk_load_idstring(Sys Bulk Load)

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

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_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_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_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_lockedboolean(Sys Locked)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/examSites/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "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": [
          {}
        ]
      }
    ],
    "id": "string",
    "is_active": true,
    "location": {
      "city": "string",
      "country": "AD",
      "country_name": "string",
      "county": "string",
      "latitude": 0.1,
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "longitude": 0.1,
      "postal_code": "string",
      "state": "string",
      "time_zone_id": "string"
    },
    "name": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_locked": true,
    "sys_version": 0.1
  }'

Responses

The exam site was updated successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
custom_field_valuesArray of objects(Custom Field Values)
idstring(ID)/^[\w|-]+$/required

The unique, string identifier of this exam site

is_activeboolean(Is Active)

Whether or not this exam site is active

locationobject(Address)

A complete address

namestring(Name)required

The name of the exam site

sys_bulk_load_idstring(Sys Bulk Load)

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

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_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_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_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_lockedboolean(Sys Locked)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

Response
application/json
{
  "custom_field_values": [
    { … }
  ],
  "id": "string",
  "is_active": true,
  "location": {
    "city": "string",
    "country": "AD",
    "country_name": "string",
    "county": "string",
    "latitude": 0.1,
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "longitude": 0.1,
    "postal_code": "string",
    "state": "string",
    "time_zone_id": "string"
  },
  "name": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_locked": true,
  "sys_version": 0.1
}

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