Course Offerings

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

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

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this course offering
type	string (Type) Enum: "in person" "virtual" "on-demand"
name required	string (Name) The name of the course offering
course_id required	string (Course) The course being scheduled
enable_capacity	boolean (Enable Capacity) Whether capacity is set
required	object (Capacity Options)
event_id	string (Event) If this offering is tied to a course, list it here
override_credit_assignment	boolean (Override Credit Assignment) If true, the credit assignment rules for this course are overridden for the offering
required	Array of objects non-empty
program_ids	Array of strings (Programs) The programs for which this course is relevant
course_type_id	string (Course Type) The type of course
timezone_mode	string (Timezone Mode) Enum: "local" "specific timezone"
timezone required	string (Timezone) The timezone in which the course offering lives
timezone_offset	number <float> (Timezone Offset) The time zone offset, in minutes, from UTC, based on the event start date
timezone_abbreviation	string (Timezone Abbreviation) The timezone abbreviation, based on the event start date
training_provider_id required	string (Training Provider) The training provider administering the course
instructor_id	string (Instructor) The instructor
training_location_id required	string (Training Location) The training location
start_date required	string <date-time> (Start Date) The date of the course
end_date required	string <date-time> (End Date) The date of the course
fee_id	string (Fee) The course registration fee
enable_webinar_integration	boolean (Enable Webinar Integration) If selecting, registration will be linked to an external webinar service
required	object (Webinar Integration Options)
webinar_url	string (Webinar Url) The URL of the webinar
survey_url	string (Survey Url) A link to the survey to use after the course is complete
publish_to_portal	boolean (Publish To Portal) Whether to sell the offering online
sell_from	string <date-time> (Sell From) Date to sell online from
sell_until	string <date-time> (Sell Until) Date to sell online from
short_description	string (Short Description) Any short descriptive information to display in the directory
description	string (Description) Any information you want to display about this in the portal
additional_instructor_ids	Array of strings (Additional Instructors) Additional instructors
	object (Address) A complete address
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
	Array of objects (Custom Field Values)
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 course offering was saved successfully.

400The course offering you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

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

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

500General server error.

post/courseOfferings/{tenantId}

Request samples

application/json

{"id": "string",
"type": "in person",
"name": "string",
"course_id": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0
},
"event_id": "string",
"override_credit_assignment": true,
"credits_to_assign": [{"credit_type_id": "string",
"quantity": 0,
"automatically_verify": true
}
],
"program_ids": ["string"
],
"course_type_id": "string",
"timezone_mode": "local",
"timezone": "string",
"timezone_offset": 0,
"timezone_abbreviation": "string",
"training_provider_id": "string",
"instructor_id": "string",
"training_location_id": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"fee_id": "string",
"enable_webinar_integration": true,
"webinar_integration_options": {"webinar_service": "integrations-zoom-accounts",
"webinar_account_id": "string",
"webinar_id": "string"
},
"webinar_url": "string",
"survey_url": "string",
"publish_to_portal": true,
"sell_from": "2019-08-24T14:15:22Z",
"sell_until": "2019-08-24T14:15:22Z",
"short_description": "string",
"description": "string",
"additional_instructor_ids": ["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"
},
"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"
},
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_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": "in person",
"name": "string",
"course_id": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0
},
"event_id": "string",
"override_credit_assignment": true,
"credits_to_assign": [{"credit_type_id": "string",
"quantity": 0,
"automatically_verify": true
}
],
"program_ids": ["string"
],
"course_type_id": "string",
"timezone_mode": "local",
"timezone": "string",
"timezone_offset": 0,
"timezone_abbreviation": "string",
"training_provider_id": "string",
"instructor_id": "string",
"training_location_id": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"fee_id": "string",
"enable_webinar_integration": true,
"webinar_integration_options": {"webinar_service": "integrations-zoom-accounts",
"webinar_account_id": "string",
"webinar_id": "string"
},
"webinar_url": "string",
"survey_url": "string",
"publish_to_portal": true,
"sell_from": "2019-08-24T14:15:22Z",
"sell_until": "2019-08-24T14:15:22Z",
"short_description": "string",
"description": "string",
"additional_instructor_ids": ["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"
},
"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"
},
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_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 course offering from the system by its ID.

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

400The request was not valid.

401Unauthorized.

403Forbidden.

404The course offering could not be found.

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

500General server error.

get/courseOfferings/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

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

Response samples

application/json

{"id": "string",
"type": "in person",
"name": "string",
"course_id": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0
},
"event_id": "string",
"override_credit_assignment": true,
"credits_to_assign": [{"credit_type_id": "string",
"quantity": 0,
"automatically_verify": true
}
],
"program_ids": ["string"
],
"course_type_id": "string",
"timezone_mode": "local",
"timezone": "string",
"timezone_offset": 0,
"timezone_abbreviation": "string",
"training_provider_id": "string",
"instructor_id": "string",
"training_location_id": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"fee_id": "string",
"enable_webinar_integration": true,
"webinar_integration_options": {"webinar_service": "integrations-zoom-accounts",
"webinar_account_id": "string",
"webinar_id": "string"
},
"webinar_url": "string",
"survey_url": "string",
"publish_to_portal": true,
"sell_from": "2019-08-24T14:15:22Z",
"sell_until": "2019-08-24T14:15:22Z",
"short_description": "string",
"description": "string",
"additional_instructor_ids": ["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"
},
"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"
},
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_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 course offering with the specified ID.

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

Request Body schema: application/json

The updated course offering that will be saved.

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this course offering
type	string (Type) Enum: "in person" "virtual" "on-demand"
name required	string (Name) The name of the course offering
course_id required	string (Course) The course being scheduled
enable_capacity	boolean (Enable Capacity) Whether capacity is set
required	object (Capacity Options)
event_id	string (Event) If this offering is tied to a course, list it here
override_credit_assignment	boolean (Override Credit Assignment) If true, the credit assignment rules for this course are overridden for the offering
required	Array of objects non-empty
program_ids	Array of strings (Programs) The programs for which this course is relevant
course_type_id	string (Course Type) The type of course
timezone_mode	string (Timezone Mode) Enum: "local" "specific timezone"
timezone required	string (Timezone) The timezone in which the course offering lives
timezone_offset	number <float> (Timezone Offset) The time zone offset, in minutes, from UTC, based on the event start date
timezone_abbreviation	string (Timezone Abbreviation) The timezone abbreviation, based on the event start date
training_provider_id required	string (Training Provider) The training provider administering the course
instructor_id	string (Instructor) The instructor
training_location_id required	string (Training Location) The training location
start_date required	string <date-time> (Start Date) The date of the course
end_date required	string <date-time> (End Date) The date of the course
fee_id	string (Fee) The course registration fee
enable_webinar_integration	boolean (Enable Webinar Integration) If selecting, registration will be linked to an external webinar service
required	object (Webinar Integration Options)
webinar_url	string (Webinar Url) The URL of the webinar
survey_url	string (Survey Url) A link to the survey to use after the course is complete
publish_to_portal	boolean (Publish To Portal) Whether to sell the offering online
sell_from	string <date-time> (Sell From) Date to sell online from
sell_until	string <date-time> (Sell Until) Date to sell online from
short_description	string (Short Description) Any short descriptive information to display in the directory
description	string (Description) Any information you want to display about this in the portal
additional_instructor_ids	Array of strings (Additional Instructors) Additional instructors
	object (Address) A complete address
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
	Array of objects (Custom Field Values)
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 course offering was updated successfully.

400The course offering supplied was not valid.

401Unauthorized.

403Forbidden.

404The course offering could not be found.

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

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

500General server error.

put/courseOfferings/{tenantId}/{id}

Request samples

application/json

{"id": "string",
"type": "in person",
"name": "string",
"course_id": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0
},
"event_id": "string",
"override_credit_assignment": true,
"credits_to_assign": [{"credit_type_id": "string",
"quantity": 0,
"automatically_verify": true
}
],
"program_ids": ["string"
],
"course_type_id": "string",
"timezone_mode": "local",
"timezone": "string",
"timezone_offset": 0,
"timezone_abbreviation": "string",
"training_provider_id": "string",
"instructor_id": "string",
"training_location_id": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"fee_id": "string",
"enable_webinar_integration": true,
"webinar_integration_options": {"webinar_service": "integrations-zoom-accounts",
"webinar_account_id": "string",
"webinar_id": "string"
},
"webinar_url": "string",
"survey_url": "string",
"publish_to_portal": true,
"sell_from": "2019-08-24T14:15:22Z",
"sell_until": "2019-08-24T14:15:22Z",
"short_description": "string",
"description": "string",
"additional_instructor_ids": ["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"
},
"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"
},
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_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": "in person",
"name": "string",
"course_id": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0
},
"event_id": "string",
"override_credit_assignment": true,
"credits_to_assign": [{"credit_type_id": "string",
"quantity": 0,
"automatically_verify": true
}
],
"program_ids": ["string"
],
"course_type_id": "string",
"timezone_mode": "local",
"timezone": "string",
"timezone_offset": 0,
"timezone_abbreviation": "string",
"training_provider_id": "string",
"instructor_id": "string",
"training_location_id": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"fee_id": "string",
"enable_webinar_integration": true,
"webinar_integration_options": {"webinar_service": "integrations-zoom-accounts",
"webinar_account_id": "string",
"webinar_id": "string"
},
"webinar_url": "string",
"survey_url": "string",
"publish_to_portal": true,
"sell_from": "2019-08-24T14:15:22Z",
"sell_until": "2019-08-24T14:15:22Z",
"short_description": "string",
"description": "string",
"additional_instructor_ids": ["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"
},
"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"
},
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_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 course offering with the specified ID.

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

400The JSON patch directive you supplied was not valid.

401Unauthorized.

403Forbidden.

404The course offering could not be found.

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

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

500General server error.

patch/courseOfferings/{tenantId}/{id}

Request samples

application/json

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

Response samples

application/json

{"id": "string",
"type": "in person",
"name": "string",
"course_id": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0
},
"event_id": "string",
"override_credit_assignment": true,
"credits_to_assign": [{"credit_type_id": "string",
"quantity": 0,
"automatically_verify": true
}
],
"program_ids": ["string"
],
"course_type_id": "string",
"timezone_mode": "local",
"timezone": "string",
"timezone_offset": 0,
"timezone_abbreviation": "string",
"training_provider_id": "string",
"instructor_id": "string",
"training_location_id": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"fee_id": "string",
"enable_webinar_integration": true,
"webinar_integration_options": {"webinar_service": "integrations-zoom-accounts",
"webinar_account_id": "string",
"webinar_id": "string"
},
"webinar_url": "string",
"survey_url": "string",
"publish_to_portal": true,
"sell_from": "2019-08-24T14:15:22Z",
"sell_until": "2019-08-24T14:15:22Z",
"short_description": "string",
"description": "string",
"additional_instructor_ids": ["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"
},
"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"
},
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_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 course offering from the system by its ID.

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

Responses

200The course offering was deleted successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The course offering could not be found.

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

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

500General server error.

delete/courseOfferings/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

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

Response samples

application/json

"string"

Returns a list of records with the specified course_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
course_id required	string The course_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/courseOfferings/{tenantId}/course/{course_id}

Request samples

curl
JavaScript
C#
PHP
Python

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

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"type": "in person",
"name": "string",
"course_id": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0
},
"event_id": "string",
"override_credit_assignment": true,
"credits_to_assign": [{"credit_type_id": "string",
"quantity": 0,
"automatically_verify": true
}
],
"program_ids": ["string"
],
"course_type_id": "string",
"timezone_mode": "local",
"timezone": "string",
"timezone_offset": 0,
"timezone_abbreviation": "string",
"training_provider_id": "string",
"instructor_id": "string",
"training_location_id": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"fee_id": "string",
"enable_webinar_integration": true,
"webinar_integration_options": {"webinar_service": "integrations-zoom-accounts",
"webinar_account_id": "string",
"webinar_id": "string"
},
"webinar_url": "string",
"survey_url": "string",
"publish_to_portal": true,
"sell_from": "2019-08-24T14:15:22Z",
"sell_until": "2019-08-24T14:15:22Z",
"short_description": "string",
"description": "string",
"additional_instructor_ids": ["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"
},
"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"
},
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_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_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
course_id required	string The course_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/courseOfferings/{tenantId}/portal/{contact_id}/describeForCourse/{course_id}

Request samples

curl
JavaScript
C#
PHP
Python

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

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"type": "in person",
"name": "string",
"course_id": "string",
"sold_out": true,
"enable_capacity": true,
"capacity_options": {"capacity": 0
},
"event_id": "string",
"program_ids": ["string"
],
"course_type_id": "string",
"training_provider_id": "string",
"training_location_id": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"fee_id": "string",
"enable_webinar_integration": true,
"webinar_integration_options": {"webinar_service": "integrations-zoom-accounts",
"webinar_account_id": "string",
"webinar_id": "string"
},
"webinar_url": "string",
"short_description": "string",
"description": "string",
"instructor_id": "string",
"additional_instructor_ids": ["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"
},
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_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 course 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 course offering that you would like to be saved.

ids	Array of strings (Ids) IDs to search
course_type_id	Array of strings (Course Type)
course_id	Array of strings (Course)
publish_to_portal	Array of booleans (Publish To Portal)
type	Array of strings (Type)
state	string (State)
country	string (Country)
program_id	string (Program)
training_provider_id	Array of strings (Training Provider)
training_location_id	Array of strings (Training Location)
start_date	Array of strings (Start Date) <= 2 items
end_date	Array of strings (End Date) <= 2 items
instructor_id	Array of strings (Instructor)
fee_id	Array of strings (Fee)

Responses

200The course offering search was saved successfully.

400The course offering you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

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

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

500General server error.

post/courseOfferings/{tenantId}/search

Request samples

application/json

{"ids": ["string"
],
"course_type_id": ["string"
],
"course_id": ["string"
],
"publish_to_portal": [true
],
"type": ["string"
],
"state": "string",
"country": "string",
"program_id": "string",
"training_provider_id": ["string"
],
"training_location_id": ["string"
],
"start_date": ["string"
],
"end_date": ["string"
],
"instructor_id": ["string"
],
"fee_id": ["string"
]
}

Response samples

application/json

{"Items": [{"id": "string",
"type": "in person",
"name": "string",
"course_id": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0
},
"event_id": "string",
"override_credit_assignment": true,
"credits_to_assign": [{"credit_type_id": "string",
"quantity": 0,
"automatically_verify": true
}
],
"program_ids": ["string"
],
"course_type_id": "string",
"timezone_mode": "local",
"timezone": "string",
"timezone_offset": 0,
"timezone_abbreviation": "string",
"training_provider_id": "string",
"instructor_id": "string",
"training_location_id": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"fee_id": "string",
"enable_webinar_integration": true,
"webinar_integration_options": {"webinar_service": "integrations-zoom-accounts",
"webinar_account_id": "string",
"webinar_id": "string"
},
"webinar_url": "string",
"survey_url": "string",
"publish_to_portal": true,
"sell_from": "2019-08-24T14:15:22Z",
"sell_until": "2019-08-24T14:15:22Z",
"short_description": "string",
"description": "string",
"additional_instructor_ids": ["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"
},
"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"
},
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_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 event_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
event_id required	string The event_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/courseOfferings/{tenantId}/event/{event_id}

Request samples

curl
JavaScript
C#
PHP
Python

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

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"type": "in person",
"name": "string",
"course_id": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0
},
"event_id": "string",
"override_credit_assignment": true,
"credits_to_assign": [{"credit_type_id": "string",
"quantity": 0,
"automatically_verify": true
}
],
"program_ids": ["string"
],
"course_type_id": "string",
"timezone_mode": "local",
"timezone": "string",
"timezone_offset": 0,
"timezone_abbreviation": "string",
"training_provider_id": "string",
"instructor_id": "string",
"training_location_id": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"fee_id": "string",
"enable_webinar_integration": true,
"webinar_integration_options": {"webinar_service": "integrations-zoom-accounts",
"webinar_account_id": "string",
"webinar_id": "string"
},
"webinar_url": "string",
"survey_url": "string",
"publish_to_portal": true,
"sell_from": "2019-08-24T14:15:22Z",
"sell_until": "2019-08-24T14:15:22Z",
"short_description": "string",
"description": "string",
"additional_instructor_ids": ["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"
},
"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"
},
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_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 instructor_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
instructor_id required	string The instructor_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/courseOfferings/{tenantId}/instructor/{instructor_id}

Request samples

curl
JavaScript
C#
PHP
Python

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

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"type": "in person",
"name": "string",
"course_id": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0
},
"event_id": "string",
"override_credit_assignment": true,
"credits_to_assign": [{"credit_type_id": "string",
"quantity": 0,
"automatically_verify": true
}
],
"program_ids": ["string"
],
"course_type_id": "string",
"timezone_mode": "local",
"timezone": "string",
"timezone_offset": 0,
"timezone_abbreviation": "string",
"training_provider_id": "string",
"instructor_id": "string",
"training_location_id": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"fee_id": "string",
"enable_webinar_integration": true,
"webinar_integration_options": {"webinar_service": "integrations-zoom-accounts",
"webinar_account_id": "string",
"webinar_id": "string"
},
"webinar_url": "string",
"survey_url": "string",
"publish_to_portal": true,
"sell_from": "2019-08-24T14:15:22Z",
"sell_until": "2019-08-24T14:15:22Z",
"short_description": "string",
"description": "string",
"additional_instructor_ids": ["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"
},
"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"
},
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_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 course offering could not be found.

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

500General server error.

post/courseOfferings/{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": { }
}
]
}

Searches for course offerings using predefined parameters

Request

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 course offering that you would like to be saved.

ids	Array of strings (Ids) IDs to search
course_type_id	Array of strings (Course Type)
course_id	Array of strings (Course)
publish_to_portal	Array of booleans (Publish To Portal)
type	Array of strings (Type)
state	string (State)
country	string (Country)
program_id	string (Program)
training_provider_id	Array of strings (Training Provider)
training_location_id	Array of strings (Training Location)
start_date	Array of strings (Start Date) <= 2 items
end_date	Array of strings (End Date) <= 2 items
instructor_id	Array of strings (Instructor)
fee_id	Array of strings (Fee)

Responses

200The course offering search was saved successfully.

400The course offering you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

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

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

500General server error.

post/courseOfferings/{tenantId}/search/public

Request samples

application/json

{"ids": ["string"
],
"course_type_id": ["string"
],
"course_id": ["string"
],
"publish_to_portal": [true
],
"type": ["string"
],
"state": "string",
"country": "string",
"program_id": "string",
"training_provider_id": ["string"
],
"training_location_id": ["string"
],
"start_date": ["string"
],
"end_date": ["string"
],
"instructor_id": ["string"
],
"fee_id": ["string"
]
}

Response samples

application/json

{"Items": [{"id": "string",
"type": "in person",
"name": "string",
"course_id": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0
},
"event_id": "string",
"override_credit_assignment": true,
"credits_to_assign": [{"credit_type_id": "string",
"quantity": 0,
"automatically_verify": true
}
],
"program_ids": ["string"
],
"course_type_id": "string",
"timezone_mode": "local",
"timezone": "string",
"timezone_offset": 0,
"timezone_abbreviation": "string",
"training_provider_id": "string",
"instructor_id": "string",
"training_location_id": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"fee_id": "string",
"enable_webinar_integration": true,
"webinar_integration_options": {"webinar_service": "integrations-zoom-accounts",
"webinar_account_id": "string",
"webinar_id": "string"
},
"webinar_url": "string",
"survey_url": "string",
"publish_to_portal": true,
"sell_from": "2019-08-24T14:15:22Z",
"sell_until": "2019-08-24T14:15:22Z",
"short_description": "string",
"description": "string",
"additional_instructor_ids": ["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"
},
"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"
},
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_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 course offering from the system by its ID.

This method will look up a course offering by the specified ID and return it back.

Request

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the course 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 course offering was retrieved successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The course offering could not be found.

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

500General server error.

get/courseOfferings/{tenantId}/public/{id}

Request samples

curl
JavaScript
C#
PHP
Python

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

Response samples

application/json

{"id": "string",
"type": "in person",
"name": "string",
"course_id": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0
},
"event_id": "string",
"override_credit_assignment": true,
"credits_to_assign": [{"credit_type_id": "string",
"quantity": 0,
"automatically_verify": true
}
],
"program_ids": ["string"
],
"course_type_id": "string",
"timezone_mode": "local",
"timezone": "string",
"timezone_offset": 0,
"timezone_abbreviation": "string",
"training_provider_id": "string",
"instructor_id": "string",
"training_location_id": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"fee_id": "string",
"enable_webinar_integration": true,
"webinar_integration_options": {"webinar_service": "integrations-zoom-accounts",
"webinar_account_id": "string",
"webinar_id": "string"
},
"webinar_url": "string",
"survey_url": "string",
"publish_to_portal": true,
"sell_from": "2019-08-24T14:15:22Z",
"sell_until": "2019-08-24T14:15:22Z",
"short_description": "string",
"description": "string",
"additional_instructor_ids": ["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"
},
"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"
},
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_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"
}
]
}