Exam Offerings

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

This method will auto-generate an ID and create a new exam offering. If an ID is specified for the exam offering, 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 offering that you would like to be saved.

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this exam offering
type required	string (Type) The type of exam Enum: "live" "remote proctor"
name required	string (Name) The name of the offering
exam_id required	string (Exam) The exam
course_offering_id	string (Course Offering) The course offering tied to this exam
fee_id	string (Fee) The fee for initial testing
retest_fee_id	string (Retest Fee) The fee for retake/retest
location required	string (Location) Enum: "training location" "testing facility" "none"
testing_facility_id required	string (Testing Facility) The exam testing site
training_location_id required	string (Training Location) The training facility
additional_location_info	string (Additional Location Info) Additional location information
	object (Address) A complete address
registration_time	string (Registration Time) The registration date/time
date required	string (Date) The date/time of the exam
start_time	string (Start Time) The registration date/time
end_time	string (End Time) The registration date/time
description	string (Description) A description for the portal
pass_letter_id	string (Pass Letter) The exam notice to send when someone has passed this exam; this overrides the letter specified on the exam
fail_letter_id	string (Fail Letter) The exam notice to send when someone has passed this exam; this overrides the letter specified on the exam
is_active	boolean (Is Active) Whether this exam is active and available
enable_eligibility_requirements	boolean (Enable Eligibility Requirements) If true, this offering is only available to certain individuals
required	object (Eligibility Requirements) The criteria to use
notes	string (Notes)
sys_deleted_by_id	string (Sys Deleted By) The ID of the user that deleted (or last tried to delete) this object
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_pk	string (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_at	string (Sys Bulk Load At) If this record was loaded via bulk, the timestamp when the record was processed
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_last_bulk_data_operation_id	string (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_version	string (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_directive	string (Sys Directive) Means for passing directive information into an object processing logic
sys_calculated_field_error	string (Sys Calculated Field Error) The error associated with the calculated field
sys_snapshot_base_version	number <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_has_files_in_s3	boolean (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_configuration_snapshot_id	string (Sys Configuration Snapshot) If a snapshot was restored/applies to this record, the ID of the snapshot
sys_last_security_context	object (Sys Last Security Context) The security context of the last insert, modify, or delete performed on this item
	Array of objects

Responses

200The exam offering was saved successfully.

400The exam offering you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

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

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

500General server error.

post/examOfferings/{tenantId}

Request samples

application/json

{"id": "string",
"type": "live",
"name": "string",
"exam_id": "string",
"course_offering_id": "string",
"fee_id": "string",
"retest_fee_id": "string",
"location": "training location",
"testing_facility_id": "string",
"training_location_id": "string",
"additional_location_info": "string",
"address": {"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"
},
"registration_time": "string",
"date": "string",
"start_time": "string",
"end_time": "string",
"description": "string",
"pass_letter_id": "string",
"fail_letter_id": "string",
"is_active": true,
"enable_eligibility_requirements": true,
"eligibility_requirements": {"logic_operator": "and",
"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"logic_operator": "and",
"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"logic_operator": "and",
"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"logic_operator": "and",
"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"logic_operator": "and",
"program_ids": ["string"
]
},
"enable_status_restriction": true,
"status_restrictions": ["string"
],
"enable_organization_restrictions": true,
"organization_restrictions": {"organization_type_ids": ["string"
],
"contact_role_ids": ["string"
]
},
"enable_age_restrictions": true,
"age_restrictions": {"minimum_age": 0,
"maximum_age": 0
},
"by_location": true,
"location": {"negate_logic": true,
"countries": ["string"
]
},
"award_recipients": true,
"award_options": {"logic_operator": "and",
"award_type_ids": ["string"
],
"award_ids": ["string"
]
},
"event_registrations": true,
"event_registration_options": {"logic_operator": "and",
"registration_category_ids": ["string"
],
"event_ids": ["string"
]
},
"donors": true,
"donor_options": {"logic_operator": "and",
"donor_club_ids": ["string"
]
},
"enable_advanced_rules": true,
"advanced_rules": { },
"advanced_rule_error_message": "string",
"enable_expression": true,
"expression": "string",
"expression_error_message": "string"
},
"notes": "string",
"sys_deleted_by_id": "string",
"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_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

{"id": "string",
"type": "live",
"name": "string",
"exam_id": "string",
"course_offering_id": "string",
"fee_id": "string",
"retest_fee_id": "string",
"location": "training location",
"testing_facility_id": "string",
"training_location_id": "string",
"additional_location_info": "string",
"address": {"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"
},
"registration_time": "string",
"date": "string",
"start_time": "string",
"end_time": "string",
"description": "string",
"pass_letter_id": "string",
"fail_letter_id": "string",
"is_active": true,
"enable_eligibility_requirements": true,
"eligibility_requirements": {"logic_operator": "and",
"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"logic_operator": "and",
"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"logic_operator": "and",
"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"logic_operator": "and",
"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"logic_operator": "and",
"program_ids": ["string"
]
},
"enable_status_restriction": true,
"status_restrictions": ["string"
],
"enable_organization_restrictions": true,
"organization_restrictions": {"organization_type_ids": ["string"
],
"contact_role_ids": ["string"
]
},
"enable_age_restrictions": true,
"age_restrictions": {"minimum_age": 0,
"maximum_age": 0
},
"by_location": true,
"location": {"negate_logic": true,
"countries": ["string"
]
},
"award_recipients": true,
"award_options": {"logic_operator": "and",
"award_type_ids": ["string"
],
"award_ids": ["string"
]
},
"event_registrations": true,
"event_registration_options": {"logic_operator": "and",
"registration_category_ids": ["string"
],
"event_ids": ["string"
]
},
"donors": true,
"donor_options": {"logic_operator": "and",
"donor_club_ids": ["string"
]
},
"enable_advanced_rules": true,
"advanced_rules": { },
"advanced_rule_error_message": "string",
"enable_expression": true,
"expression": "string",
"expression_error_message": "string"
},
"notes": "string",
"sys_deleted_by_id": "string",
"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_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Returns a exam offering from the system by its ID.

This method will look up a exam offering 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 offering 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 offering was retrieved successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The exam offering could not be found.

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

500General server error.

get/examOfferings/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

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

Response samples

application/json

{"id": "string",
"type": "live",
"name": "string",
"exam_id": "string",
"course_offering_id": "string",
"fee_id": "string",
"retest_fee_id": "string",
"location": "training location",
"testing_facility_id": "string",
"training_location_id": "string",
"additional_location_info": "string",
"address": {"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"
},
"registration_time": "string",
"date": "string",
"start_time": "string",
"end_time": "string",
"description": "string",
"pass_letter_id": "string",
"fail_letter_id": "string",
"is_active": true,
"enable_eligibility_requirements": true,
"eligibility_requirements": {"logic_operator": "and",
"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"logic_operator": "and",
"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"logic_operator": "and",
"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"logic_operator": "and",
"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"logic_operator": "and",
"program_ids": ["string"
]
},
"enable_status_restriction": true,
"status_restrictions": ["string"
],
"enable_organization_restrictions": true,
"organization_restrictions": {"organization_type_ids": ["string"
],
"contact_role_ids": ["string"
]
},
"enable_age_restrictions": true,
"age_restrictions": {"minimum_age": 0,
"maximum_age": 0
},
"by_location": true,
"location": {"negate_logic": true,
"countries": ["string"
]
},
"award_recipients": true,
"award_options": {"logic_operator": "and",
"award_type_ids": ["string"
],
"award_ids": ["string"
]
},
"event_registrations": true,
"event_registration_options": {"logic_operator": "and",
"registration_category_ids": ["string"
],
"event_ids": ["string"
]
},
"donors": true,
"donor_options": {"logic_operator": "and",
"donor_club_ids": ["string"
]
},
"enable_advanced_rules": true,
"advanced_rules": { },
"advanced_rule_error_message": "string",
"enable_expression": true,
"expression": "string",
"expression_error_message": "string"
},
"notes": "string",
"sys_deleted_by_id": "string",
"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_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Updates a exam offering with the specified ID.

This method will update an existing exam offering 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 offering to update.

Request Body schema: application/json

The updated exam offering that will be saved.

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this exam offering
type required	string (Type) The type of exam Enum: "live" "remote proctor"
name required	string (Name) The name of the offering
exam_id required	string (Exam) The exam
course_offering_id	string (Course Offering) The course offering tied to this exam
fee_id	string (Fee) The fee for initial testing
retest_fee_id	string (Retest Fee) The fee for retake/retest
location required	string (Location) Enum: "training location" "testing facility" "none"
testing_facility_id required	string (Testing Facility) The exam testing site
training_location_id required	string (Training Location) The training facility
additional_location_info	string (Additional Location Info) Additional location information
	object (Address) A complete address
registration_time	string (Registration Time) The registration date/time
date required	string (Date) The date/time of the exam
start_time	string (Start Time) The registration date/time
end_time	string (End Time) The registration date/time
description	string (Description) A description for the portal
pass_letter_id	string (Pass Letter) The exam notice to send when someone has passed this exam; this overrides the letter specified on the exam
fail_letter_id	string (Fail Letter) The exam notice to send when someone has passed this exam; this overrides the letter specified on the exam
is_active	boolean (Is Active) Whether this exam is active and available
enable_eligibility_requirements	boolean (Enable Eligibility Requirements) If true, this offering is only available to certain individuals
required	object (Eligibility Requirements) The criteria to use
notes	string (Notes)
sys_deleted_by_id	string (Sys Deleted By) The ID of the user that deleted (or last tried to delete) this object
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_pk	string (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_at	string (Sys Bulk Load At) If this record was loaded via bulk, the timestamp when the record was processed
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_last_bulk_data_operation_id	string (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_version	string (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_directive	string (Sys Directive) Means for passing directive information into an object processing logic
sys_calculated_field_error	string (Sys Calculated Field Error) The error associated with the calculated field
sys_snapshot_base_version	number <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_has_files_in_s3	boolean (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_configuration_snapshot_id	string (Sys Configuration Snapshot) If a snapshot was restored/applies to this record, the ID of the snapshot
sys_last_security_context	object (Sys Last Security Context) The security context of the last insert, modify, or delete performed on this item
	Array of objects

Responses

200The exam offering was updated successfully.

400The exam offering supplied was not valid.

401Unauthorized.

403Forbidden.

404The exam offering could not be found.

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

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

500General server error.

put/examOfferings/{tenantId}/{id}

Request samples

application/json

{"id": "string",
"type": "live",
"name": "string",
"exam_id": "string",
"course_offering_id": "string",
"fee_id": "string",
"retest_fee_id": "string",
"location": "training location",
"testing_facility_id": "string",
"training_location_id": "string",
"additional_location_info": "string",
"address": {"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"
},
"registration_time": "string",
"date": "string",
"start_time": "string",
"end_time": "string",
"description": "string",
"pass_letter_id": "string",
"fail_letter_id": "string",
"is_active": true,
"enable_eligibility_requirements": true,
"eligibility_requirements": {"logic_operator": "and",
"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"logic_operator": "and",
"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"logic_operator": "and",
"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"logic_operator": "and",
"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"logic_operator": "and",
"program_ids": ["string"
]
},
"enable_status_restriction": true,
"status_restrictions": ["string"
],
"enable_organization_restrictions": true,
"organization_restrictions": {"organization_type_ids": ["string"
],
"contact_role_ids": ["string"
]
},
"enable_age_restrictions": true,
"age_restrictions": {"minimum_age": 0,
"maximum_age": 0
},
"by_location": true,
"location": {"negate_logic": true,
"countries": ["string"
]
},
"award_recipients": true,
"award_options": {"logic_operator": "and",
"award_type_ids": ["string"
],
"award_ids": ["string"
]
},
"event_registrations": true,
"event_registration_options": {"logic_operator": "and",
"registration_category_ids": ["string"
],
"event_ids": ["string"
]
},
"donors": true,
"donor_options": {"logic_operator": "and",
"donor_club_ids": ["string"
]
},
"enable_advanced_rules": true,
"advanced_rules": { },
"advanced_rule_error_message": "string",
"enable_expression": true,
"expression": "string",
"expression_error_message": "string"
},
"notes": "string",
"sys_deleted_by_id": "string",
"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_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

{"id": "string",
"type": "live",
"name": "string",
"exam_id": "string",
"course_offering_id": "string",
"fee_id": "string",
"retest_fee_id": "string",
"location": "training location",
"testing_facility_id": "string",
"training_location_id": "string",
"additional_location_info": "string",
"address": {"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"
},
"registration_time": "string",
"date": "string",
"start_time": "string",
"end_time": "string",
"description": "string",
"pass_letter_id": "string",
"fail_letter_id": "string",
"is_active": true,
"enable_eligibility_requirements": true,
"eligibility_requirements": {"logic_operator": "and",
"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"logic_operator": "and",
"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"logic_operator": "and",
"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"logic_operator": "and",
"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"logic_operator": "and",
"program_ids": ["string"
]
},
"enable_status_restriction": true,
"status_restrictions": ["string"
],
"enable_organization_restrictions": true,
"organization_restrictions": {"organization_type_ids": ["string"
],
"contact_role_ids": ["string"
]
},
"enable_age_restrictions": true,
"age_restrictions": {"minimum_age": 0,
"maximum_age": 0
},
"by_location": true,
"location": {"negate_logic": true,
"countries": ["string"
]
},
"award_recipients": true,
"award_options": {"logic_operator": "and",
"award_type_ids": ["string"
],
"award_ids": ["string"
]
},
"event_registrations": true,
"event_registration_options": {"logic_operator": "and",
"registration_category_ids": ["string"
],
"event_ids": ["string"
]
},
"donors": true,
"donor_options": {"logic_operator": "and",
"donor_club_ids": ["string"
]
},
"enable_advanced_rules": true,
"advanced_rules": { },
"advanced_rule_error_message": "string",
"enable_expression": true,
"expression": "string",
"expression_error_message": "string"
},
"notes": "string",
"sys_deleted_by_id": "string",
"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_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Partially updates a exam offering with the specified ID.

This method will patch an existing exam offering 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 offering 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 offering was patched successfully.

400The JSON patch directive you supplied was not valid.

401Unauthorized.

403Forbidden.

404The exam offering could not be found.

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

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

500General server error.

patch/examOfferings/{tenantId}/{id}

Request samples

application/json

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

Response samples

application/json

{"id": "string",
"type": "live",
"name": "string",
"exam_id": "string",
"course_offering_id": "string",
"fee_id": "string",
"retest_fee_id": "string",
"location": "training location",
"testing_facility_id": "string",
"training_location_id": "string",
"additional_location_info": "string",
"address": {"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"
},
"registration_time": "string",
"date": "string",
"start_time": "string",
"end_time": "string",
"description": "string",
"pass_letter_id": "string",
"fail_letter_id": "string",
"is_active": true,
"enable_eligibility_requirements": true,
"eligibility_requirements": {"logic_operator": "and",
"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"logic_operator": "and",
"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"logic_operator": "and",
"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"logic_operator": "and",
"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"logic_operator": "and",
"program_ids": ["string"
]
},
"enable_status_restriction": true,
"status_restrictions": ["string"
],
"enable_organization_restrictions": true,
"organization_restrictions": {"organization_type_ids": ["string"
],
"contact_role_ids": ["string"
]
},
"enable_age_restrictions": true,
"age_restrictions": {"minimum_age": 0,
"maximum_age": 0
},
"by_location": true,
"location": {"negate_logic": true,
"countries": ["string"
]
},
"award_recipients": true,
"award_options": {"logic_operator": "and",
"award_type_ids": ["string"
],
"award_ids": ["string"
]
},
"event_registrations": true,
"event_registration_options": {"logic_operator": "and",
"registration_category_ids": ["string"
],
"event_ids": ["string"
]
},
"donors": true,
"donor_options": {"logic_operator": "and",
"donor_club_ids": ["string"
]
},
"enable_advanced_rules": true,
"advanced_rules": { },
"advanced_rule_error_message": "string",
"enable_expression": true,
"expression": "string",
"expression_error_message": "string"
},
"notes": "string",
"sys_deleted_by_id": "string",
"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_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Returns a exam offering from the system by its ID.

This method will delete a exam offering 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 offering to delete.

Responses

200The exam offering was deleted successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The exam offering could not be found.

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

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

500General server error.

delete/examOfferings/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

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

Response samples

application/json

"string"

Returns a list of records with the specified exam_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
exam_id required	string The exam_id to use to for record lookup

query Parameters

includePastOfferings	string If set, past offerings are included in the list
fields	string The fields that you want to retrieve; if omitted, the entire object is returned
exclusiveStartKey	string If paging, this allows you to return the next set of results

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized.

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/examOfferings/{tenantId}/exam/{exam_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/examOfferings/:tenantId/exam/:exam_id?includePastOfferings=string&fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"type": "live",
"name": "string",
"exam_id": "string",
"course_offering_id": "string",
"fee_id": "string",
"retest_fee_id": "string",
"location": "training location",
"testing_facility_id": "string",
"training_location_id": "string",
"additional_location_info": "string",
"address": {"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"
},
"registration_time": "string",
"date": "string",
"start_time": "string",
"end_time": "string",
"description": "string",
"pass_letter_id": "string",
"fail_letter_id": "string",
"is_active": true,
"enable_eligibility_requirements": true,
"eligibility_requirements": {"logic_operator": "and",
"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"logic_operator": "and",
"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"logic_operator": "and",
"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"logic_operator": "and",
"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"logic_operator": "and",
"program_ids": ["string"
]
},
"enable_status_restriction": true,
"status_restrictions": ["string"
],
"enable_organization_restrictions": true,
"organization_restrictions": {"organization_type_ids": ["string"
],
"contact_role_ids": ["string"
]
},
"enable_age_restrictions": true,
"age_restrictions": {"minimum_age": 0,
"maximum_age": 0
},
"by_location": true,
"location": {"negate_logic": true,
"countries": ["string"
]
},
"award_recipients": true,
"award_options": {"logic_operator": "and",
"award_type_ids": ["string"
],
"award_ids": ["string"
]
},
"event_registrations": true,
"event_registration_options": {"logic_operator": "and",
"registration_category_ids": ["string"
],
"event_ids": ["string"
]
},
"donors": true,
"donor_options": {"logic_operator": "and",
"donor_club_ids": ["string"
]
},
"enable_advanced_rules": true,
"advanced_rules": { },
"advanced_rule_error_message": "string",
"enable_expression": true,
"expression": "string",
"expression_error_message": "string"
},
"notes": "string",
"sys_deleted_by_id": "string",
"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_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Returns a list of records with the specified testing_facility_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
testing_facility_id required	string The testing_facility_id to use to for record lookup

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned
exclusiveStartKey	string If paging, this allows you to return the next set of results

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized.

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/examOfferings/{tenantId}/testingFacility/{testing_facility_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/examOfferings/:tenantId/testingFacility/:testing_facility_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"type": "live",
"name": "string",
"exam_id": "string",
"course_offering_id": "string",
"fee_id": "string",
"retest_fee_id": "string",
"location": "training location",
"testing_facility_id": "string",
"training_location_id": "string",
"additional_location_info": "string",
"address": {"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"
},
"registration_time": "string",
"date": "string",
"start_time": "string",
"end_time": "string",
"description": "string",
"pass_letter_id": "string",
"fail_letter_id": "string",
"is_active": true,
"enable_eligibility_requirements": true,
"eligibility_requirements": {"logic_operator": "and",
"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"logic_operator": "and",
"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"logic_operator": "and",
"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"logic_operator": "and",
"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"logic_operator": "and",
"program_ids": ["string"
]
},
"enable_status_restriction": true,
"status_restrictions": ["string"
],
"enable_organization_restrictions": true,
"organization_restrictions": {"organization_type_ids": ["string"
],
"contact_role_ids": ["string"
]
},
"enable_age_restrictions": true,
"age_restrictions": {"minimum_age": 0,
"maximum_age": 0
},
"by_location": true,
"location": {"negate_logic": true,
"countries": ["string"
]
},
"award_recipients": true,
"award_options": {"logic_operator": "and",
"award_type_ids": ["string"
],
"award_ids": ["string"
]
},
"event_registrations": true,
"event_registration_options": {"logic_operator": "and",
"registration_category_ids": ["string"
],
"event_ids": ["string"
]
},
"donors": true,
"donor_options": {"logic_operator": "and",
"donor_club_ids": ["string"
]
},
"enable_advanced_rules": true,
"advanced_rules": { },
"advanced_rule_error_message": "string",
"enable_expression": true,
"expression": "string",
"expression_error_message": "string"
},
"notes": "string",
"sys_deleted_by_id": "string",
"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_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Returns a list of records with the specified course_offering_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
course_offering_id required	string The course_offering_id to use to for record lookup

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned
exclusiveStartKey	string If paging, this allows you to return the next set of results

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized.

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/examOfferings/{tenantId}/courseOffering/{course_offering_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/examOfferings/:tenantId/courseOffering/:course_offering_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"type": "live",
"name": "string",
"exam_id": "string",
"course_offering_id": "string",
"fee_id": "string",
"retest_fee_id": "string",
"location": "training location",
"testing_facility_id": "string",
"training_location_id": "string",
"additional_location_info": "string",
"address": {"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"
},
"registration_time": "string",
"date": "string",
"start_time": "string",
"end_time": "string",
"description": "string",
"pass_letter_id": "string",
"fail_letter_id": "string",
"is_active": true,
"enable_eligibility_requirements": true,
"eligibility_requirements": {"logic_operator": "and",
"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"logic_operator": "and",
"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"logic_operator": "and",
"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"logic_operator": "and",
"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"logic_operator": "and",
"program_ids": ["string"
]
},
"enable_status_restriction": true,
"status_restrictions": ["string"
],
"enable_organization_restrictions": true,
"organization_restrictions": {"organization_type_ids": ["string"
],
"contact_role_ids": ["string"
]
},
"enable_age_restrictions": true,
"age_restrictions": {"minimum_age": 0,
"maximum_age": 0
},
"by_location": true,
"location": {"negate_logic": true,
"countries": ["string"
]
},
"award_recipients": true,
"award_options": {"logic_operator": "and",
"award_type_ids": ["string"
],
"award_ids": ["string"
]
},
"event_registrations": true,
"event_registration_options": {"logic_operator": "and",
"registration_category_ids": ["string"
],
"event_ids": ["string"
]
},
"donors": true,
"donor_options": {"logic_operator": "and",
"donor_club_ids": ["string"
]
},
"enable_advanced_rules": true,
"advanced_rules": { },
"advanced_rule_error_message": "string",
"enable_expression": true,
"expression": "string",
"expression_error_message": "string"
},
"notes": "string",
"sys_deleted_by_id": "string",
"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_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Returns a list of records with the specified exam_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
contact_id required	string The contact_id to use to for record lookup
exam_id required	string The exam_id to use to for record lookup

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned
exclusiveStartKey	string If paging, this allows you to return the next set of results

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized.

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/examOfferings/{tenantId}/portal/{contact_id}/describeForExam/{exam_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/examOfferings/:tenantId/portal/:contact_id/describeForExam/:exam_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"type": "live",
"name": "string",
"exam_id": "string",
"course_offering_id": "string",
"fee_id": "string",
"retest_fee_id": "string",
"location": "training location",
"testing_facility_id": "string",
"training_location_id": "string",
"additional_location_info": "string",
"address": {"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"
},
"registration_time": "string",
"date": "string",
"start_time": "string",
"end_time": "string",
"description": "string",
"pass_letter_id": "string",
"fail_letter_id": "string",
"is_active": true,
"enable_eligibility_requirements": true,
"eligibility_requirements": {"logic_operator": "and",
"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"logic_operator": "and",
"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"logic_operator": "and",
"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"logic_operator": "and",
"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"logic_operator": "and",
"program_ids": ["string"
]
},
"enable_status_restriction": true,
"status_restrictions": ["string"
],
"enable_organization_restrictions": true,
"organization_restrictions": {"organization_type_ids": ["string"
],
"contact_role_ids": ["string"
]
},
"enable_age_restrictions": true,
"age_restrictions": {"minimum_age": 0,
"maximum_age": 0
},
"by_location": true,
"location": {"negate_logic": true,
"countries": ["string"
]
},
"award_recipients": true,
"award_options": {"logic_operator": "and",
"award_type_ids": ["string"
],
"award_ids": ["string"
]
},
"event_registrations": true,
"event_registration_options": {"logic_operator": "and",
"registration_category_ids": ["string"
],
"event_ids": ["string"
]
},
"donors": true,
"donor_options": {"logic_operator": "and",
"donor_club_ids": ["string"
]
},
"enable_advanced_rules": true,
"advanced_rules": { },
"advanced_rule_error_message": "string",
"enable_expression": true,
"expression": "string",
"expression_error_message": "string"
},
"notes": "string",
"sys_deleted_by_id": "string",
"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_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Searches for exam offerings using predefined parameters

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

query Parameters

exclusiveStartKey	string The start key for the search, for paging support
fieldsToReturn	string The fields that you want to retrieve; if omitted, the entire object is returned

Request Body schema: application/json

The exam offering that you would like to be saved.

ids	Array of strings (Ids) IDs to search
exam_id	Array of strings (Exam)
publish_to_portal	Array of booleans (Publish To Portal)
location	Array of strings (Location)
testing_facility_id	Array of strings (Testing Facility)
training_location_id	Array of strings (Training Location)
state	string (State)
country	string (Country)
date	Array of strings (Date)
fee_id	Array of strings (Fee)

Responses

200The exam offering search was saved successfully.

400The exam offering you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

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

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

500General server error.

post/examOfferings/{tenantId}/search

Request samples

application/json

{"ids": ["string"
],
"exam_id": ["string"
],
"publish_to_portal": [true
],
"location": ["string"
],
"testing_facility_id": ["string"
],
"training_location_id": ["string"
],
"state": "string",
"country": "string",
"date": ["string"
],
"fee_id": ["string"
]
}

Response samples

application/json

{"Items": [{"id": "string",
"type": "live",
"name": "string",
"exam_id": "string",
"course_offering_id": "string",
"fee_id": "string",
"retest_fee_id": "string",
"location": "training location",
"testing_facility_id": "string",
"training_location_id": "string",
"additional_location_info": "string",
"address": {"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"
},
"registration_time": "string",
"date": "string",
"start_time": "string",
"end_time": "string",
"description": "string",
"pass_letter_id": "string",
"fail_letter_id": "string",
"is_active": true,
"enable_eligibility_requirements": true,
"eligibility_requirements": {"logic_operator": "and",
"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"logic_operator": "and",
"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"logic_operator": "and",
"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"logic_operator": "and",
"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"logic_operator": "and",
"program_ids": ["string"
]
},
"enable_status_restriction": true,
"status_restrictions": ["string"
],
"enable_organization_restrictions": true,
"organization_restrictions": {"organization_type_ids": ["string"
],
"contact_role_ids": ["string"
]
},
"enable_age_restrictions": true,
"age_restrictions": {"minimum_age": 0,
"maximum_age": 0
},
"by_location": true,
"location": {"negate_logic": true,
"countries": ["string"
]
},
"award_recipients": true,
"award_options": {"logic_operator": "and",
"award_type_ids": ["string"
],
"award_ids": ["string"
]
},
"event_registrations": true,
"event_registration_options": {"logic_operator": "and",
"registration_category_ids": ["string"
],
"event_ids": ["string"
]
},
"donors": true,
"donor_options": {"logic_operator": "and",
"donor_club_ids": ["string"
]
},
"enable_advanced_rules": true,
"advanced_rules": { },
"advanced_rule_error_message": "string",
"enable_expression": true,
"expression": "string",
"expression_error_message": "string"
},
"notes": "string",
"sys_deleted_by_id": "string",
"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_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Execute Batch Operations

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

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

Request Body schema: application/json

The batch request

Array of objects

Responses

200Request completed successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The exam offering could not be found.

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

500General server error.

post/examOfferings/{tenantId}/batch

Request samples

application/json

{"operations": [{"operation": "create",
"id": "string",
"patch_directives": [{"op": "add",
"path": "string",
"value": "string"
}
],
"object": { }
}
]
}

Response samples

application/json

{"success_count": 0,
"error_count": 0,
"results": [{"operation": "create",
"id": "string",
"outcome": "success",
"error_message": "string",
"object": { }
}
]
}