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.
https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/
https://certifications.api.rhythmsoftware.com/
The course offering that you would like to be saved.
The criteria to use
The error message to show when the advanced rule fails
If set, only people who have received awards
If set, only people with specific certifications
If set, active members who belong to a committee can purchase
Enable advanced JSON rules
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, then you must have certain entitlements
Whether or not to enable an expression for evaluation
If set, you can restrict organizations
If set, you can restrict by status
If set, only people who have registered for events
The error message to show when the expression fails
If true, this offering is only available to certain individuals
If selecting, registration will be linked to an external webinar service
If true, the credit assignment rules for this course are overridden for the offering
Any short descriptive information to display in the directory
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The timezone abbreviation, based on the event start date
The time zone offset, in minutes, from UTC, based on the event start date
The meeting id
The meeting id
The meeting id
The webinar id
The webinar id
The webinar id
https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseOfferings/{tenantId}
https://certifications.api.rhythmsoftware.com/courseOfferings/{tenantId}
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseOfferings/{tenantId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"additional_instructor_ids": [
"string"
],
"address": {
"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"
},
"capacity_options": {
"capacity": 0.1
},
"course_id": "string",
"course_type_id": "string",
"credits_to_assign": [
{
"automatically_verify": true,
"credit_type_id": "string",
"quantity": 0.1
}
],
"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": [
{}
]
}
],
"description": "string",
"eligibility_requirements": {
"advanced_rule_error_message": "string",
"advanced_rules": {},
"age_restrictions": {
"maximum_age": 0.1,
"minimum_age": 0.1
},
"award_options": {
"award_ids": [
"string"
],
"award_type_ids": [
"string"
],
"logic_operator": "and"
},
"award_recipients": true,
"by_location": true,
"certificants": true,
"certification_options": {
"logic_operator": "and",
"program_ids": [
"string"
]
},
"committee_member_options": {
"committee_ids": [
"string"
],
"committee_position_ids": [
"string"
],
"committee_type_ids": [
"string"
],
"logic_operator": "and"
},
"committee_members": true,
"custom_logic_options": {
"lambda_function_id": "string"
},
"customer_type": "contact",
"donor_options": {
"donor_club_ids": [
"string"
],
"logic_operator": "and"
},
"donors": true,
"enable_advanced_rules": true,
"enable_age_restrictions": true,
"enable_custom_logic": true,
"enable_entitlement_restrictions": true,
"enable_expression": true,
"enable_organization_restrictions": true,
"enable_status_restriction": true,
"entitlement_restrictions": [
{
"quantity": 0.1,
"type_id": "string"
}
],
"event_registration_options": {
"event_ids": [
"string"
],
"logic_operator": "and",
"registration_category_ids": [
"string"
]
},
"event_registrations": true,
"expression": "string",
"expression_error_message": "string",
"location": {
"countries": [
"string"
],
"negate_logic": true
},
"logic_operator": "and",
"member_options": {
"chapter_member_options": {
"chapter_ids": [
"string"
],
"chapter_type_ids": [
"string"
],
"logic_operator": "and"
},
"chapter_members": true,
"member_package_ids": [
"string"
],
"member_status_reason_ids": [
"string"
],
"member_statuses": [
"active"
],
"member_type_ids": [
"string"
],
"section_member_options": {
"logic_operator": "and",
"section_ids": [
"string"
],
"section_type_ids": [
"string"
]
},
"section_members": true
},
"members": true,
"non_members": true,
"organization_restrictions": {
"contact_role_ids": [
"string"
],
"organization_type_ids": [
"string"
]
},
"status_restrictions": {
"0": "string"
},
"use_organization_for_eligibility": true
},
"enable_capacity": true,
"enable_eligibility_requirements": true,
"enable_webinar_integration": true,
"end_date": "2019-08-24T14:15:22Z",
"event_id": "string",
"fee_id": "string",
"id": "string",
"instructor_id": "string",
"instructor_names": [
"string"
],
"meeting_url": "string",
"name": "string",
"override_credit_assignment": true,
"program_ids": [
"string"
],
"publish_to_portal": true,
"sell_from": "2019-08-24T14:15:22Z",
"sell_until": "2019-08-24T14:15:22Z",
"short_description": "string",
"start_date": "2019-08-24T14:15:22Z",
"survey_url": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_pk": "string",
"sys_bulk_load_record_no": 0.1,
"sys_bulk_load_source_file": "string",
"sys_calculated_field_error": "string",
"sys_calculated_field_errors": [
{
"error": "string",
"field": "string"
}
],
"sys_configuration_snapshot_id": "string",
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_deleted_by_id": "string",
"sys_directive": "string",
"sys_external_id": "string",
"sys_has_files_in_s3": true,
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_last_modified_by_id": "string",
"sys_last_security_context": {},
"sys_locked": true,
"sys_snapshot_base_version": 0.1,
"sys_version": 0.1,
"timezone": "string",
"timezone_abbreviation": "string",
"timezone_mode": "local",
"timezone_offset": 0.1,
"training_location_id": "string",
"training_provider_id": "string",
"type": "in person",
"webinar_integration_options": {
"meeting_id": null,
"type": "meeting",
"webinar_account_id": "string",
"webinar_id": null,
"webinar_service": "integrations-zoom-accounts"
},
"webinar_url": "string"
}'The course offering was saved successfully.
The criteria to use
The error message to show when the advanced rule fails
If set, only people who have received awards
If set, only people with specific certifications
If set, active members who belong to a committee can purchase
Enable advanced JSON rules
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, then you must have certain entitlements
Whether or not to enable an expression for evaluation
If set, you can restrict organizations
If set, you can restrict by status
If set, only people who have registered for events
The error message to show when the expression fails
If true, this offering is only available to certain individuals
If selecting, registration will be linked to an external webinar service
If true, the credit assignment rules for this course are overridden for the offering
Any short descriptive information to display in the directory
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The timezone abbreviation, based on the event start date
The time zone offset, in minutes, from UTC, based on the event start date
The meeting id
The meeting id
The meeting id
The webinar id
The webinar id
The webinar id
{ "additional_instructor_ids": [ "string" ], "address": { "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" }, "capacity_options": { "capacity": 0.1 }, "course_id": "string", "course_type_id": "string", "credits_to_assign": [ { … } ], "custom_field_values": [ { … } ], "description": "string", "eligibility_requirements": { "advanced_rule_error_message": "string", "advanced_rules": {}, "age_restrictions": { … }, "award_options": { … }, "award_recipients": true, "by_location": true, "certificants": true, "certification_options": { … }, "committee_member_options": { … }, "committee_members": true, "custom_logic_options": { … }, "customer_type": "contact", "donor_options": { … }, "donors": true, "enable_advanced_rules": true, "enable_age_restrictions": true, "enable_custom_logic": true, "enable_entitlement_restrictions": true, "enable_expression": true, "enable_organization_restrictions": true, "enable_status_restriction": true, "entitlement_restrictions": [ … ], "event_registration_options": { … }, "event_registrations": true, "expression": "string", "expression_error_message": "string", "location": { … }, "logic_operator": "and", "member_options": { … }, "members": true, "non_members": true, "organization_restrictions": { … }, "status_restrictions": { … }, "use_organization_for_eligibility": true }, "enable_capacity": true, "enable_eligibility_requirements": true, "enable_webinar_integration": true, "end_date": "2019-08-24T14:15:22Z", "event_id": "string", "fee_id": "string", "id": "string", "instructor_id": "string", "instructor_names": [ "string" ], "meeting_url": "string", "name": "string", "override_credit_assignment": true, "program_ids": [ "string" ], "publish_to_portal": true, "sell_from": "2019-08-24T14:15:22Z", "sell_until": "2019-08-24T14:15:22Z", "short_description": "string", "start_date": "2019-08-24T14:15:22Z", "survey_url": "string", "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ { … } ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "timezone": "string", "timezone_abbreviation": "string", "timezone_mode": "local", "timezone_offset": 0.1, "training_location_id": "string", "training_provider_id": "string", "type": "in person", "webinar_integration_options": { "meeting_id": null, "type": "meeting", "webinar_account_id": "string", "webinar_id": null, "webinar_service": "integrations-zoom-accounts" }, "webinar_url": "string" }
https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseOfferings/{tenantId}/batch
https://certifications.api.rhythmsoftware.com/courseOfferings/{tenantId}/batch
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseOfferings/{tenantId}/batch' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"operations": [
{
"id": null,
"object": {},
"operation": "create",
"patch_directives": {
"0": {
"op": "add",
"path": "string",
"value": "string"
}
}
}
]
}'{ "error_count": 0.1, "results": [ { … } ], "success_count": 0.1 }
https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseOfferings/{tenantId}/course/{course_id}
https://certifications.api.rhythmsoftware.com/courseOfferings/{tenantId}/course/{course_id}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseOfferings/{tenantId}/course/{course_id}?exclusiveStartKey=string&fields=string&includePastOfferings=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "Count": 0, "Items": [ { … } ], "LastEvaluatedKey": "string" }
https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseOfferings/{tenantId}/event/{event_id}
https://certifications.api.rhythmsoftware.com/courseOfferings/{tenantId}/event/{event_id}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseOfferings/{tenantId}/event/{event_id}?exclusiveStartKey=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "Count": 0, "Items": [ { … } ], "LastEvaluatedKey": "string" }
https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseOfferings/{tenantId}/event/{event_id}/public
https://certifications.api.rhythmsoftware.com/courseOfferings/{tenantId}/event/{event_id}/public
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseOfferings/{tenantId}/event/{event_id}/public?exclusiveStartKey=string&fields=string'{ "Count": 0, "Items": [ { … } ], "LastEvaluatedKey": "string" }
https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseOfferings/{tenantId}/instructor/{instructor_id}
https://certifications.api.rhythmsoftware.com/courseOfferings/{tenantId}/instructor/{instructor_id}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseOfferings/{tenantId}/instructor/{instructor_id}?exclusiveStartKey=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "Count": 0, "Items": [ { … } ], "LastEvaluatedKey": "string" }
https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseOfferings/{tenantId}/portal/{contact_id}/describeForCourse/{course_id}
https://certifications.api.rhythmsoftware.com/courseOfferings/{tenantId}/portal/{contact_id}/describeForCourse/{course_id}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseOfferings/{tenantId}/portal/{contact_id}/describeForCourse/{course_id}?exclusiveStartKey=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "Count": 0, "Items": [ { … } ], "LastEvaluatedKey": "string" }
https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseOfferings/{tenantId}/public/{id}
https://certifications.api.rhythmsoftware.com/courseOfferings/{tenantId}/public/{id}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseOfferings/{tenantId}/public/{id}?consistentRead=string&fields=string'The course offering was retrieved successfully.
The criteria to use
The error message to show when the advanced rule fails
If set, only people who have received awards
If set, only people with specific certifications
If set, active members who belong to a committee can purchase
Enable advanced JSON rules
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, then you must have certain entitlements
Whether or not to enable an expression for evaluation
If set, you can restrict organizations
If set, you can restrict by status
If set, only people who have registered for events
The error message to show when the expression fails
If true, this offering is only available to certain individuals
If selecting, registration will be linked to an external webinar service
If true, the credit assignment rules for this course are overridden for the offering
Any short descriptive information to display in the directory
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The timezone abbreviation, based on the event start date
The time zone offset, in minutes, from UTC, based on the event start date
The meeting id
The meeting id
The meeting id
The webinar id
The webinar id
The webinar id
{ "additional_instructor_ids": [ "string" ], "address": { "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" }, "capacity_options": { "capacity": 0.1 }, "course_id": "string", "course_type_id": "string", "credits_to_assign": [ { … } ], "custom_field_values": [ { … } ], "description": "string", "eligibility_requirements": { "advanced_rule_error_message": "string", "advanced_rules": {}, "age_restrictions": { … }, "award_options": { … }, "award_recipients": true, "by_location": true, "certificants": true, "certification_options": { … }, "committee_member_options": { … }, "committee_members": true, "custom_logic_options": { … }, "customer_type": "contact", "donor_options": { … }, "donors": true, "enable_advanced_rules": true, "enable_age_restrictions": true, "enable_custom_logic": true, "enable_entitlement_restrictions": true, "enable_expression": true, "enable_organization_restrictions": true, "enable_status_restriction": true, "entitlement_restrictions": [ … ], "event_registration_options": { … }, "event_registrations": true, "expression": "string", "expression_error_message": "string", "location": { … }, "logic_operator": "and", "member_options": { … }, "members": true, "non_members": true, "organization_restrictions": { … }, "status_restrictions": { … }, "use_organization_for_eligibility": true }, "enable_capacity": true, "enable_eligibility_requirements": true, "enable_webinar_integration": true, "end_date": "2019-08-24T14:15:22Z", "event_id": "string", "fee_id": "string", "id": "string", "instructor_id": "string", "instructor_names": [ "string" ], "meeting_url": "string", "name": "string", "override_credit_assignment": true, "program_ids": [ "string" ], "publish_to_portal": true, "sell_from": "2019-08-24T14:15:22Z", "sell_until": "2019-08-24T14:15:22Z", "short_description": "string", "start_date": "2019-08-24T14:15:22Z", "survey_url": "string", "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ { … } ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "timezone": "string", "timezone_abbreviation": "string", "timezone_mode": "local", "timezone_offset": 0.1, "training_location_id": "string", "training_provider_id": "string", "type": "in person", "webinar_integration_options": { "meeting_id": null, "type": "meeting", "webinar_account_id": "string", "webinar_id": null, "webinar_service": "integrations-zoom-accounts" }, "webinar_url": "string" }
https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseOfferings/{tenantId}/search
https://certifications.api.rhythmsoftware.com/courseOfferings/{tenantId}/search
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseOfferings/{tenantId}/search?exclusiveStartKey=string&fieldsToReturn=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"country": "string",
"course_id": [
"string"
],
"course_type_id": [
"string"
],
"end_date": [
"string"
],
"fee_id": [
"string"
],
"ids": [
"string"
],
"instructor_id": [
"string"
],
"program_id": "string",
"publish_to_portal": [
true
],
"start_date": [
"string"
],
"state": "string",
"training_location_id": [
"string"
],
"training_provider_id": [
"string"
],
"type": [
"string"
]
}'{ "Items": [ { … } ], "LastEvaluatedKey": "string" }
https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseOfferings/{tenantId}/search/public
https://certifications.api.rhythmsoftware.com/courseOfferings/{tenantId}/search/public
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseOfferings/{tenantId}/search/public?exclusiveStartKey=string&fieldsToReturn=string' \
-H 'Content-Type: application/json' \
-d '{
"country": "string",
"course_id": [
"string"
],
"course_type_id": [
"string"
],
"end_date": [
"string"
],
"fee_id": [
"string"
],
"ids": [
"string"
],
"instructor_id": [
"string"
],
"program_id": "string",
"publish_to_portal": [
true
],
"start_date": [
"string"
],
"state": "string",
"training_location_id": [
"string"
],
"training_provider_id": [
"string"
],
"type": [
"string"
]
}'{ "Items": [ { … } ], "LastEvaluatedKey": "string" }
https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseOfferings/{tenantId}/{id}
https://certifications.api.rhythmsoftware.com/courseOfferings/{tenantId}/{id}
curl -i -X DELETE \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseOfferings/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'"string"
https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseOfferings/{tenantId}/{id}
https://certifications.api.rhythmsoftware.com/courseOfferings/{tenantId}/{id}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseOfferings/{tenantId}/{id}?consistentRead=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The course offering was retrieved successfully.
The criteria to use
The error message to show when the advanced rule fails
If set, only people who have received awards
If set, only people with specific certifications
If set, active members who belong to a committee can purchase
Enable advanced JSON rules
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, then you must have certain entitlements
Whether or not to enable an expression for evaluation
If set, you can restrict organizations
If set, you can restrict by status
If set, only people who have registered for events
The error message to show when the expression fails
If true, this offering is only available to certain individuals
If selecting, registration will be linked to an external webinar service
If true, the credit assignment rules for this course are overridden for the offering
Any short descriptive information to display in the directory
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The timezone abbreviation, based on the event start date
The time zone offset, in minutes, from UTC, based on the event start date
The meeting id
The meeting id
The meeting id
The webinar id
The webinar id
The webinar id
{ "additional_instructor_ids": [ "string" ], "address": { "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" }, "capacity_options": { "capacity": 0.1 }, "course_id": "string", "course_type_id": "string", "credits_to_assign": [ { … } ], "custom_field_values": [ { … } ], "description": "string", "eligibility_requirements": { "advanced_rule_error_message": "string", "advanced_rules": {}, "age_restrictions": { … }, "award_options": { … }, "award_recipients": true, "by_location": true, "certificants": true, "certification_options": { … }, "committee_member_options": { … }, "committee_members": true, "custom_logic_options": { … }, "customer_type": "contact", "donor_options": { … }, "donors": true, "enable_advanced_rules": true, "enable_age_restrictions": true, "enable_custom_logic": true, "enable_entitlement_restrictions": true, "enable_expression": true, "enable_organization_restrictions": true, "enable_status_restriction": true, "entitlement_restrictions": [ … ], "event_registration_options": { … }, "event_registrations": true, "expression": "string", "expression_error_message": "string", "location": { … }, "logic_operator": "and", "member_options": { … }, "members": true, "non_members": true, "organization_restrictions": { … }, "status_restrictions": { … }, "use_organization_for_eligibility": true }, "enable_capacity": true, "enable_eligibility_requirements": true, "enable_webinar_integration": true, "end_date": "2019-08-24T14:15:22Z", "event_id": "string", "fee_id": "string", "id": "string", "instructor_id": "string", "instructor_names": [ "string" ], "meeting_url": "string", "name": "string", "override_credit_assignment": true, "program_ids": [ "string" ], "publish_to_portal": true, "sell_from": "2019-08-24T14:15:22Z", "sell_until": "2019-08-24T14:15:22Z", "short_description": "string", "start_date": "2019-08-24T14:15:22Z", "survey_url": "string", "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ { … } ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "timezone": "string", "timezone_abbreviation": "string", "timezone_mode": "local", "timezone_offset": 0.1, "training_location_id": "string", "training_provider_id": "string", "type": "in person", "webinar_integration_options": { "meeting_id": null, "type": "meeting", "webinar_account_id": "string", "webinar_id": null, "webinar_service": "integrations-zoom-accounts" }, "webinar_url": "string" }
https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseOfferings/{tenantId}/{id}
https://certifications.api.rhythmsoftware.com/courseOfferings/{tenantId}/{id}
curl -i -X PATCH \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseOfferings/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '[
{
"op": "add",
"path": "string",
"value": "string"
}
]'The course offering was patched successfully.
The criteria to use
The error message to show when the advanced rule fails
If set, only people who have received awards
If set, only people with specific certifications
If set, active members who belong to a committee can purchase
Enable advanced JSON rules
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, then you must have certain entitlements
Whether or not to enable an expression for evaluation
If set, you can restrict organizations
If set, you can restrict by status
If set, only people who have registered for events
The error message to show when the expression fails
If true, this offering is only available to certain individuals
If selecting, registration will be linked to an external webinar service
If true, the credit assignment rules for this course are overridden for the offering
Any short descriptive information to display in the directory
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The timezone abbreviation, based on the event start date
The time zone offset, in minutes, from UTC, based on the event start date
The meeting id
The meeting id
The meeting id
The webinar id
The webinar id
The webinar id
{ "additional_instructor_ids": [ "string" ], "address": { "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" }, "capacity_options": { "capacity": 0.1 }, "course_id": "string", "course_type_id": "string", "credits_to_assign": [ { … } ], "custom_field_values": [ { … } ], "description": "string", "eligibility_requirements": { "advanced_rule_error_message": "string", "advanced_rules": {}, "age_restrictions": { … }, "award_options": { … }, "award_recipients": true, "by_location": true, "certificants": true, "certification_options": { … }, "committee_member_options": { … }, "committee_members": true, "custom_logic_options": { … }, "customer_type": "contact", "donor_options": { … }, "donors": true, "enable_advanced_rules": true, "enable_age_restrictions": true, "enable_custom_logic": true, "enable_entitlement_restrictions": true, "enable_expression": true, "enable_organization_restrictions": true, "enable_status_restriction": true, "entitlement_restrictions": [ … ], "event_registration_options": { … }, "event_registrations": true, "expression": "string", "expression_error_message": "string", "location": { … }, "logic_operator": "and", "member_options": { … }, "members": true, "non_members": true, "organization_restrictions": { … }, "status_restrictions": { … }, "use_organization_for_eligibility": true }, "enable_capacity": true, "enable_eligibility_requirements": true, "enable_webinar_integration": true, "end_date": "2019-08-24T14:15:22Z", "event_id": "string", "fee_id": "string", "id": "string", "instructor_id": "string", "instructor_names": [ "string" ], "meeting_url": "string", "name": "string", "override_credit_assignment": true, "program_ids": [ "string" ], "publish_to_portal": true, "sell_from": "2019-08-24T14:15:22Z", "sell_until": "2019-08-24T14:15:22Z", "short_description": "string", "start_date": "2019-08-24T14:15:22Z", "survey_url": "string", "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ { … } ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "timezone": "string", "timezone_abbreviation": "string", "timezone_mode": "local", "timezone_offset": 0.1, "training_location_id": "string", "training_provider_id": "string", "type": "in person", "webinar_integration_options": { "meeting_id": null, "type": "meeting", "webinar_account_id": "string", "webinar_id": null, "webinar_service": "integrations-zoom-accounts" }, "webinar_url": "string" }
The updated course offering that will be saved.
The criteria to use
The error message to show when the advanced rule fails
If set, only people who have received awards
If set, only people with specific certifications
If set, active members who belong to a committee can purchase
Enable advanced JSON rules
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, then you must have certain entitlements
Whether or not to enable an expression for evaluation
If set, you can restrict organizations
If set, you can restrict by status
If set, only people who have registered for events
The error message to show when the expression fails
If true, this offering is only available to certain individuals
If selecting, registration will be linked to an external webinar service
If true, the credit assignment rules for this course are overridden for the offering
Any short descriptive information to display in the directory
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The timezone abbreviation, based on the event start date
The time zone offset, in minutes, from UTC, based on the event start date
The meeting id
The meeting id
The meeting id
The webinar id
The webinar id
The webinar id
https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseOfferings/{tenantId}/{id}
https://certifications.api.rhythmsoftware.com/courseOfferings/{tenantId}/{id}
curl -i -X PUT \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseOfferings/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"additional_instructor_ids": [
"string"
],
"address": {
"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"
},
"capacity_options": {
"capacity": 0.1
},
"course_id": "string",
"course_type_id": "string",
"credits_to_assign": [
{
"automatically_verify": true,
"credit_type_id": "string",
"quantity": 0.1
}
],
"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": [
{}
]
}
],
"description": "string",
"eligibility_requirements": {
"advanced_rule_error_message": "string",
"advanced_rules": {},
"age_restrictions": {
"maximum_age": 0.1,
"minimum_age": 0.1
},
"award_options": {
"award_ids": [
"string"
],
"award_type_ids": [
"string"
],
"logic_operator": "and"
},
"award_recipients": true,
"by_location": true,
"certificants": true,
"certification_options": {
"logic_operator": "and",
"program_ids": [
"string"
]
},
"committee_member_options": {
"committee_ids": [
"string"
],
"committee_position_ids": [
"string"
],
"committee_type_ids": [
"string"
],
"logic_operator": "and"
},
"committee_members": true,
"custom_logic_options": {
"lambda_function_id": "string"
},
"customer_type": "contact",
"donor_options": {
"donor_club_ids": [
"string"
],
"logic_operator": "and"
},
"donors": true,
"enable_advanced_rules": true,
"enable_age_restrictions": true,
"enable_custom_logic": true,
"enable_entitlement_restrictions": true,
"enable_expression": true,
"enable_organization_restrictions": true,
"enable_status_restriction": true,
"entitlement_restrictions": [
{
"quantity": 0.1,
"type_id": "string"
}
],
"event_registration_options": {
"event_ids": [
"string"
],
"logic_operator": "and",
"registration_category_ids": [
"string"
]
},
"event_registrations": true,
"expression": "string",
"expression_error_message": "string",
"location": {
"countries": [
"string"
],
"negate_logic": true
},
"logic_operator": "and",
"member_options": {
"chapter_member_options": {
"chapter_ids": [
"string"
],
"chapter_type_ids": [
"string"
],
"logic_operator": "and"
},
"chapter_members": true,
"member_package_ids": [
"string"
],
"member_status_reason_ids": [
"string"
],
"member_statuses": [
"active"
],
"member_type_ids": [
"string"
],
"section_member_options": {
"logic_operator": "and",
"section_ids": [
"string"
],
"section_type_ids": [
"string"
]
},
"section_members": true
},
"members": true,
"non_members": true,
"organization_restrictions": {
"contact_role_ids": [
"string"
],
"organization_type_ids": [
"string"
]
},
"status_restrictions": {
"0": "string"
},
"use_organization_for_eligibility": true
},
"enable_capacity": true,
"enable_eligibility_requirements": true,
"enable_webinar_integration": true,
"end_date": "2019-08-24T14:15:22Z",
"event_id": "string",
"fee_id": "string",
"id": "string",
"instructor_id": "string",
"instructor_names": [
"string"
],
"meeting_url": "string",
"name": "string",
"override_credit_assignment": true,
"program_ids": [
"string"
],
"publish_to_portal": true,
"sell_from": "2019-08-24T14:15:22Z",
"sell_until": "2019-08-24T14:15:22Z",
"short_description": "string",
"start_date": "2019-08-24T14:15:22Z",
"survey_url": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_pk": "string",
"sys_bulk_load_record_no": 0.1,
"sys_bulk_load_source_file": "string",
"sys_calculated_field_error": "string",
"sys_calculated_field_errors": [
{
"error": "string",
"field": "string"
}
],
"sys_configuration_snapshot_id": "string",
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_deleted_by_id": "string",
"sys_directive": "string",
"sys_external_id": "string",
"sys_has_files_in_s3": true,
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_last_modified_by_id": "string",
"sys_last_security_context": {},
"sys_locked": true,
"sys_snapshot_base_version": 0.1,
"sys_version": 0.1,
"timezone": "string",
"timezone_abbreviation": "string",
"timezone_mode": "local",
"timezone_offset": 0.1,
"training_location_id": "string",
"training_provider_id": "string",
"type": "in person",
"webinar_integration_options": {
"meeting_id": null,
"type": "meeting",
"webinar_account_id": "string",
"webinar_id": null,
"webinar_service": "integrations-zoom-accounts"
},
"webinar_url": "string"
}'The course offering was updated successfully.
The criteria to use
The error message to show when the advanced rule fails
If set, only people who have received awards
If set, only people with specific certifications
If set, active members who belong to a committee can purchase
Enable advanced JSON rules
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, then you must have certain entitlements
Whether or not to enable an expression for evaluation
If set, you can restrict organizations
If set, you can restrict by status
If set, only people who have registered for events
The error message to show when the expression fails
If true, this offering is only available to certain individuals
If selecting, registration will be linked to an external webinar service
If true, the credit assignment rules for this course are overridden for the offering
Any short descriptive information to display in the directory
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The timezone abbreviation, based on the event start date
The time zone offset, in minutes, from UTC, based on the event start date
The meeting id
The meeting id
The meeting id
The webinar id
The webinar id
The webinar id
{ "additional_instructor_ids": [ "string" ], "address": { "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" }, "capacity_options": { "capacity": 0.1 }, "course_id": "string", "course_type_id": "string", "credits_to_assign": [ { … } ], "custom_field_values": [ { … } ], "description": "string", "eligibility_requirements": { "advanced_rule_error_message": "string", "advanced_rules": {}, "age_restrictions": { … }, "award_options": { … }, "award_recipients": true, "by_location": true, "certificants": true, "certification_options": { … }, "committee_member_options": { … }, "committee_members": true, "custom_logic_options": { … }, "customer_type": "contact", "donor_options": { … }, "donors": true, "enable_advanced_rules": true, "enable_age_restrictions": true, "enable_custom_logic": true, "enable_entitlement_restrictions": true, "enable_expression": true, "enable_organization_restrictions": true, "enable_status_restriction": true, "entitlement_restrictions": [ … ], "event_registration_options": { … }, "event_registrations": true, "expression": "string", "expression_error_message": "string", "location": { … }, "logic_operator": "and", "member_options": { … }, "members": true, "non_members": true, "organization_restrictions": { … }, "status_restrictions": { … }, "use_organization_for_eligibility": true }, "enable_capacity": true, "enable_eligibility_requirements": true, "enable_webinar_integration": true, "end_date": "2019-08-24T14:15:22Z", "event_id": "string", "fee_id": "string", "id": "string", "instructor_id": "string", "instructor_names": [ "string" ], "meeting_url": "string", "name": "string", "override_credit_assignment": true, "program_ids": [ "string" ], "publish_to_portal": true, "sell_from": "2019-08-24T14:15:22Z", "sell_until": "2019-08-24T14:15:22Z", "short_description": "string", "start_date": "2019-08-24T14:15:22Z", "survey_url": "string", "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ { … } ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "timezone": "string", "timezone_abbreviation": "string", "timezone_mode": "local", "timezone_offset": 0.1, "training_location_id": "string", "training_provider_id": "string", "type": "in person", "webinar_integration_options": { "meeting_id": null, "type": "meeting", "webinar_account_id": "string", "webinar_id": null, "webinar_service": "integrations-zoom-accounts" }, "webinar_url": "string" }