Exam Sites

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

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.

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

Request Body schema: application/json

The exam site that you would like to be saved.

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this exam site
name required	string (Name) The name of the exam site
	object (Address) A complete address
is_active	boolean (Is Active) Whether or not this exam site is active
	Array of objects (Custom Field Values)
sys_version	number <float> (Sys Version) A number representing the version of this record in the database
sys_created_at required	string <date-time> (Sys Created At) The date/time that this record was created, expressed in ISO-8601 date format
sys_last_modified_at required	string <date-time> (Sys Last Modified At) The date/time that this record record was last modified, expressed in ISO-8601 date format
sys_created_by_id required	string (Sys Created By) The ID of the user that created this record
sys_last_modified_by_id required	string (Sys Last Modified By) The ID of the user that last modified this record
sys_external_id	string (Sys External) The ID that a record has from an external system or data import
sys_locked	boolean (Sys Locked) If set, this record is locked and cannot be changed via the API
sys_bulk_load_id	string (Sys Bulk Load) If this record was loaded via bulk, the ID of the bulk load process
sys_bulk_load_record_no	number <float> (Sys Bulk Load Record No) If this record was loaded via bulk, the record number in the source file
sys_bulk_load_source_file	string (Sys Bulk Load Source File) If this record was loaded via bulk, the source file
sys_directive	string (Sys Directive) Means for passing directive information into an object processing logic

Responses

200The exam site was saved successfully.

400The exam site you supplied was invalid.

401Unauthorized.

403Forbidden.

409The exam site could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add exam site based on tenant limits.

500General server error.

post/examSites/{tenantId}

Request samples

application/json

{"id": "string",
"name": "string",
"location": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "AF",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"is_active": true,
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_directive": "string"
}

Response samples

application/json

{"id": "string",
"name": "string",
"location": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "AF",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"is_active": true,
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_directive": "string"
}

Returns a exam site from the system by its ID.

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

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the exam site to return.

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned.
consistentRead	string Indicates the API should force a consistent read on the data source.

Responses

200The exam site was retrieved successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The exam site could not be found.

429Limit exceeded... unable to retrieve exam site based on tenant limits.

500General server error.

get/examSites/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/examSites/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"id": "string",
"name": "string",
"location": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "AF",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"is_active": true,
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_directive": "string"
}

Updates a exam site with the specified ID.

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

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the exam site to update.

Request Body schema: application/json

The updated exam site that will be saved.

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this exam site
name required	string (Name) The name of the exam site
	object (Address) A complete address
is_active	boolean (Is Active) Whether or not this exam site is active
	Array of objects (Custom Field Values)
sys_version	number <float> (Sys Version) A number representing the version of this record in the database
sys_created_at required	string <date-time> (Sys Created At) The date/time that this record was created, expressed in ISO-8601 date format
sys_last_modified_at required	string <date-time> (Sys Last Modified At) The date/time that this record record was last modified, expressed in ISO-8601 date format
sys_created_by_id required	string (Sys Created By) The ID of the user that created this record
sys_last_modified_by_id required	string (Sys Last Modified By) The ID of the user that last modified this record
sys_external_id	string (Sys External) The ID that a record has from an external system or data import
sys_locked	boolean (Sys Locked) If set, this record is locked and cannot be changed via the API
sys_bulk_load_id	string (Sys Bulk Load) If this record was loaded via bulk, the ID of the bulk load process
sys_bulk_load_record_no	number <float> (Sys Bulk Load Record No) If this record was loaded via bulk, the record number in the source file
sys_bulk_load_source_file	string (Sys Bulk Load Source File) If this record was loaded via bulk, the source file
sys_directive	string (Sys Directive) Means for passing directive information into an object processing logic

Responses

200The exam site was updated successfully.

400The exam site supplied was not valid.

401Unauthorized.

403Forbidden.

404The exam site could not be found.

409The exam site could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve exam site based on tenant limits.

500General server error.

put/examSites/{tenantId}/{id}

Request samples

application/json

{"id": "string",
"name": "string",
"location": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "AF",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"is_active": true,
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_directive": "string"
}

Response samples

application/json

{"id": "string",
"name": "string",
"location": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "AF",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"is_active": true,
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_directive": "string"
}

Partially updates a exam site with the specified ID.

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

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the exam site to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array

op required	string (Op) The operation Enum: "add" "remove" "replace" "move" "copy" "test"
path required	string (Path) The JSON path
value	string (Value) The updated value

Responses

200The exam site was patched successfully.

400The JSON patch directive you supplied was not valid.

401Unauthorized.

403Forbidden.

404The exam site could not be found.

409The exam site could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve exam site based on tenant limits.

500General server error.

patch/examSites/{tenantId}/{id}

Request samples

application/json

[{"op": "add",
"path": "string",
"value": "string"
}
]

Response samples

application/json

{"id": "string",
"name": "string",
"location": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "AF",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"is_active": true,
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_directive": "string"
}

Returns a exam site from the system by its ID.

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

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the exam site to delete.

Responses

200The exam site was deleted successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The exam site could not be found.

409The exam site could not be deleted because other objects refers to/depends on this one.

429Limit exceeded... unable to delete exam site based on tenant limits.

500General server error.

delete/examSites/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X DELETE \
  https://certifications.api.756794052567.rhythmsoftware.com/examSites/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

"string"