The Meetings & Shows, or Events, API is used to manage all aspects of events from recurring webinars to annual trade shows. From this API you can access Registrants, Speakers, and Abstracts as well as update the details of your events themselves.
Like most of the other Rhythm apps, the Events 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.
The registrant directory that you would like to be saved.
These are additional fields that should be in the directory query, which will be available in the search results
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
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 set, users are allowed to submit comments in the directory
If set, a custom search results template is displayed
If true, the directory results will be sorted differently that the query
If set, only certain people can access this directory
When true, users are able to contact other users through the directory
If set to true, an expression can be used to further filter the query
If set to true, the directory can display a subset of records based on the provided filter. If false, the default filter is used
If true, the user can search across zip code radius
If true, this is a public directory that can be accessed without security
The page size, used for server side page and to combat scraping attacks
The expression to use to filter the directory
The period of time (in minutes) after which the directory should refresh it self
If true, only those registered for this event can access the directory
The fields in the directory that are displayed as search criteria
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
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/registrantDirectories/{tenantId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"additional_fields": [
"string"
],
"comment_options": {
"comments_header_text": "string",
"comments_instructions": "string",
"comments_placeholder_text": "string",
"enable_ratings": true,
"hide_submitter_name": true,
"leave_comment_button_text": "string",
"max_rating": null,
"no_comments_text": "string",
"rating_label": "string",
"save_comment_button": "string"
},
"custom_directory_entry_template": "string",
"custom_search_results_template": "string",
"custom_sort_fields": [
{
"descending": true,
"name": "string"
}
],
"directory_entry_mode": "custom",
"display_mode": "list",
"eligibility_criteria": {
"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_comments": true,
"enable_custom_search_results_template": true,
"enable_custom_sorting": true,
"enable_eligibility_criteria": true,
"enable_messaging": true,
"enable_query_expression_filter": true,
"enable_query_filter": true,
"enable_radius_search": true,
"event_id": "string",
"id": "string",
"is_active": true,
"is_public": true,
"name": "string",
"page_size": 1,
"query_filter_expression": "string",
"query_filter_rules": {},
"radius_search_options": {
"postal_code_field": "string",
"radius_options": [
0.1
]
},
"refresh_period": 5,
"restrict_to_registrants": true,
"searchable_fields": [
{
"group_name": "string",
"label": "string",
"name": "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
}'The registrant directory was saved successfully.
These are additional fields that should be in the directory query, which will be available in the search results
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
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 set, users are allowed to submit comments in the directory
If set, a custom search results template is displayed
If true, the directory results will be sorted differently that the query
If set, only certain people can access this directory
When true, users are able to contact other users through the directory
If set to true, an expression can be used to further filter the query
If set to true, the directory can display a subset of records based on the provided filter. If false, the default filter is used
If true, the user can search across zip code radius
If true, this is a public directory that can be accessed without security
The page size, used for server side page and to combat scraping attacks
The expression to use to filter the directory
The period of time (in minutes) after which the directory should refresh it self
If true, only those registered for this event can access the directory
The fields in the directory that are displayed as search criteria
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
{ "additional_fields": [ "string" ], "comment_options": { "comments_header_text": "string", "comments_instructions": "string", "comments_placeholder_text": "string", "enable_ratings": true, "hide_submitter_name": true, "leave_comment_button_text": "string", "max_rating": null, "no_comments_text": "string", "rating_label": "string", "save_comment_button": "string" }, "custom_directory_entry_template": "string", "custom_search_results_template": "string", "custom_sort_fields": [ { … } ], "directory_entry_mode": "custom", "display_mode": "list", "eligibility_criteria": { "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_comments": true, "enable_custom_search_results_template": true, "enable_custom_sorting": true, "enable_eligibility_criteria": true, "enable_messaging": true, "enable_query_expression_filter": true, "enable_query_filter": true, "enable_radius_search": true, "event_id": "string", "id": "string", "is_active": true, "is_public": true, "name": "string", "page_size": 1, "query_filter_expression": "string", "query_filter_rules": {}, "radius_search_options": { "postal_code_field": "string", "radius_options": [ … ] }, "refresh_period": 5, "restrict_to_registrants": true, "searchable_fields": [ { … } ], "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 }
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/registrantDirectories/{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"
}
},
"payload": {
"abstract": {
"approval_process_id": "string",
"average_score": 0.1,
"body": "string",
"bucket_id": null,
"city": "string",
"co_author_1": {
"email_address": "string",
"first_name": "string",
"last_name": "string",
"phone_number": "string",
"speaker_type_id": "string"
},
"co_author_2": {
"email_address": "string",
"first_name": "string",
"last_name": "string",
"phone_number": "string",
"speaker_type_id": "string"
},
"co_author_3": {
"email_address": "string",
"first_name": "string",
"last_name": "string",
"phone_number": "string",
"speaker_type_id": "string"
},
"co_author_4": {
"email_address": "string",
"first_name": "string",
"last_name": "string",
"phone_number": "string",
"speaker_type_id": "string"
},
"co_author_5": {
"email_address": "string",
"first_name": "string",
"last_name": "string",
"phone_number": "string",
"speaker_type_id": "string"
},
"co_authors": {
"0": {
"co_author_contact_id": "string",
"co_author_contact_info": {},
"speaker_type_id": "string"
}
},
"country": "string",
"custom_field_values": [
{
"boolean_value": true,
"custom_field_id": "string",
"file_url_value": "string",
"list_value": [
null
],
"numeric_value": 0.1,
"string_value": "string",
"table_value": [
{}
]
}
],
"date": "2019-08-24T14:15:22Z",
"email_address": "string",
"event_id": "string",
"first_name": "string",
"has_co_authors": true,
"id": null,
"job_title": "string",
"last_name": "string",
"last_review_status_change": "2019-08-24T14:15:22Z",
"main_presenter_id": "string",
"max_contact_submissions": 0.1,
"name": "string",
"notes": "string",
"number": 0.1,
"organization_id": "string",
"override_bucket_assignment": true,
"pending_console_review": true,
"presenter_info": {
"contact_info": {},
"email_presenter": true
},
"process_id": "string",
"review_process_id": "string",
"review_round_id": null,
"review_status": "accepted",
"reviewer_recommendation": "string",
"reviews_assigned": true,
"room_ids": [
"string"
],
"round_id": "string",
"round_scores": [
{
"round_id": "string",
"score": 0.1
}
],
"session_has_been_generated": true,
"session_track_ids": [
"string"
],
"state": "string",
"status": "accepted",
"submission_space_id": "string",
"submitter_id": "string",
"submitting_on_behalf_of_presenter": true,
"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": null,
"sys_created_by_id": null,
"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": null,
"sys_last_modified_by_id": null,
"sys_last_security_context": {},
"sys_locked": true,
"sys_snapshot_base_version": 0.1,
"sys_version": 0.1,
"title": "string",
"total_score": 0.1,
"type_id": "string"
},
"allow_duplicates": true,
"main_presenter_speaker_type_id": "string",
"make_co_authors_speakers": true,
"new_status": "accepted",
"suppress_email_notifications": true,
"type_id": "string"
}
}
]
}'{ "error_count": 0.1, "results": [ { … } ], "success_count": 0.1 }
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/registrantDirectories/{tenantId}/event/{event_id}?exclusiveStartKey=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "Count": 0, "Items": [ { … } ], "LastEvaluatedKey": "string" }
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/registrantDirectories/{tenantId}/public/entry/{id}/{entryId}'{}
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/registrantDirectories/{tenantId}/public/search/{id}' \
-H 'Content-Type: application/json' \
-d '{
"criteria": {},
"page": 0.1,
"radius_search": {
"postal_code": "string",
"radius": 1
}
}'{ "fields": [ { … } ], "query": {}, "rows": [ {} ], "sql": "string", "target_service": "string", "totalNumberOfRows": 0.1 }
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/registrantDirectories/{tenantId}/public/sendMessage/{directoryId}/{entryId}' \
-H 'Content-Type: application/json' \
-d '{
"bcc": "string",
"body": "string",
"cc": "string",
"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string"
}'{}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/registrantDirectories/{tenantId}/public/{id}?consistentRead=string&fields=string'The registrant directory was retrieved successfully.
These are additional fields that should be in the directory query, which will be available in the search results
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
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 set, users are allowed to submit comments in the directory
If set, a custom search results template is displayed
If true, the directory results will be sorted differently that the query
If set, only certain people can access this directory
When true, users are able to contact other users through the directory
If set to true, an expression can be used to further filter the query
If set to true, the directory can display a subset of records based on the provided filter. If false, the default filter is used
If true, the user can search across zip code radius
If true, this is a public directory that can be accessed without security
The page size, used for server side page and to combat scraping attacks
The expression to use to filter the directory
The period of time (in minutes) after which the directory should refresh it self
If true, only those registered for this event can access the directory
The fields in the directory that are displayed as search criteria
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
{ "additional_fields": [ "string" ], "comment_options": { "comments_header_text": "string", "comments_instructions": "string", "comments_placeholder_text": "string", "enable_ratings": true, "hide_submitter_name": true, "leave_comment_button_text": "string", "max_rating": null, "no_comments_text": "string", "rating_label": "string", "save_comment_button": "string" }, "custom_directory_entry_template": "string", "custom_search_results_template": "string", "custom_sort_fields": [ { … } ], "directory_entry_mode": "custom", "display_mode": "list", "eligibility_criteria": { "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_comments": true, "enable_custom_search_results_template": true, "enable_custom_sorting": true, "enable_eligibility_criteria": true, "enable_messaging": true, "enable_query_expression_filter": true, "enable_query_filter": true, "enable_radius_search": true, "event_id": "string", "id": "string", "is_active": true, "is_public": true, "name": "string", "page_size": 1, "query_filter_expression": "string", "query_filter_rules": {}, "radius_search_options": { "postal_code_field": "string", "radius_options": [ … ] }, "refresh_period": 5, "restrict_to_registrants": true, "searchable_fields": [ { … } ], "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 }
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/registrantDirectories/{tenantId}/search/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"criteria": {},
"page": 0.1,
"radius_search": {
"postal_code": "string",
"radius": 1
}
}'{ "fields": [ { … } ], "query": {}, "rows": [ {} ], "sql": "string", "target_service": "string", "totalNumberOfRows": 0.1 }
curl -i -X DELETE \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/registrantDirectories/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'"string"
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/registrantDirectories/{tenantId}/{id}?consistentRead=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The registrant directory was retrieved successfully.
These are additional fields that should be in the directory query, which will be available in the search results
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
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 set, users are allowed to submit comments in the directory
If set, a custom search results template is displayed
If true, the directory results will be sorted differently that the query
If set, only certain people can access this directory
When true, users are able to contact other users through the directory
If set to true, an expression can be used to further filter the query
If set to true, the directory can display a subset of records based on the provided filter. If false, the default filter is used
If true, the user can search across zip code radius
If true, this is a public directory that can be accessed without security
The page size, used for server side page and to combat scraping attacks
The expression to use to filter the directory
The period of time (in minutes) after which the directory should refresh it self
If true, only those registered for this event can access the directory
The fields in the directory that are displayed as search criteria
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
{ "additional_fields": [ "string" ], "comment_options": { "comments_header_text": "string", "comments_instructions": "string", "comments_placeholder_text": "string", "enable_ratings": true, "hide_submitter_name": true, "leave_comment_button_text": "string", "max_rating": null, "no_comments_text": "string", "rating_label": "string", "save_comment_button": "string" }, "custom_directory_entry_template": "string", "custom_search_results_template": "string", "custom_sort_fields": [ { … } ], "directory_entry_mode": "custom", "display_mode": "list", "eligibility_criteria": { "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_comments": true, "enable_custom_search_results_template": true, "enable_custom_sorting": true, "enable_eligibility_criteria": true, "enable_messaging": true, "enable_query_expression_filter": true, "enable_query_filter": true, "enable_radius_search": true, "event_id": "string", "id": "string", "is_active": true, "is_public": true, "name": "string", "page_size": 1, "query_filter_expression": "string", "query_filter_rules": {}, "radius_search_options": { "postal_code_field": "string", "radius_options": [ … ] }, "refresh_period": 5, "restrict_to_registrants": true, "searchable_fields": [ { … } ], "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 }
curl -i -X PATCH \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/registrantDirectories/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '[
{
"op": "add",
"path": "string",
"value": "string"
}
]'The registrant directory was patched successfully.
These are additional fields that should be in the directory query, which will be available in the search results
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
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 set, users are allowed to submit comments in the directory
If set, a custom search results template is displayed
If true, the directory results will be sorted differently that the query
If set, only certain people can access this directory
When true, users are able to contact other users through the directory
If set to true, an expression can be used to further filter the query
If set to true, the directory can display a subset of records based on the provided filter. If false, the default filter is used
If true, the user can search across zip code radius
If true, this is a public directory that can be accessed without security
The page size, used for server side page and to combat scraping attacks
The expression to use to filter the directory
The period of time (in minutes) after which the directory should refresh it self
If true, only those registered for this event can access the directory
The fields in the directory that are displayed as search criteria
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
{ "additional_fields": [ "string" ], "comment_options": { "comments_header_text": "string", "comments_instructions": "string", "comments_placeholder_text": "string", "enable_ratings": true, "hide_submitter_name": true, "leave_comment_button_text": "string", "max_rating": null, "no_comments_text": "string", "rating_label": "string", "save_comment_button": "string" }, "custom_directory_entry_template": "string", "custom_search_results_template": "string", "custom_sort_fields": [ { … } ], "directory_entry_mode": "custom", "display_mode": "list", "eligibility_criteria": { "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_comments": true, "enable_custom_search_results_template": true, "enable_custom_sorting": true, "enable_eligibility_criteria": true, "enable_messaging": true, "enable_query_expression_filter": true, "enable_query_filter": true, "enable_radius_search": true, "event_id": "string", "id": "string", "is_active": true, "is_public": true, "name": "string", "page_size": 1, "query_filter_expression": "string", "query_filter_rules": {}, "radius_search_options": { "postal_code_field": "string", "radius_options": [ … ] }, "refresh_period": 5, "restrict_to_registrants": true, "searchable_fields": [ { … } ], "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 }
The updated registrant directory that will be saved.
These are additional fields that should be in the directory query, which will be available in the search results
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
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 set, users are allowed to submit comments in the directory
If set, a custom search results template is displayed
If true, the directory results will be sorted differently that the query
If set, only certain people can access this directory
When true, users are able to contact other users through the directory
If set to true, an expression can be used to further filter the query
If set to true, the directory can display a subset of records based on the provided filter. If false, the default filter is used
If true, the user can search across zip code radius
If true, this is a public directory that can be accessed without security
The page size, used for server side page and to combat scraping attacks
The expression to use to filter the directory
The period of time (in minutes) after which the directory should refresh it self
If true, only those registered for this event can access the directory
The fields in the directory that are displayed as search criteria
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
curl -i -X PUT \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/registrantDirectories/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"additional_fields": [
"string"
],
"comment_options": {
"comments_header_text": "string",
"comments_instructions": "string",
"comments_placeholder_text": "string",
"enable_ratings": true,
"hide_submitter_name": true,
"leave_comment_button_text": "string",
"max_rating": null,
"no_comments_text": "string",
"rating_label": "string",
"save_comment_button": "string"
},
"custom_directory_entry_template": "string",
"custom_search_results_template": "string",
"custom_sort_fields": [
{
"descending": true,
"name": "string"
}
],
"directory_entry_mode": "custom",
"display_mode": "list",
"eligibility_criteria": {
"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_comments": true,
"enable_custom_search_results_template": true,
"enable_custom_sorting": true,
"enable_eligibility_criteria": true,
"enable_messaging": true,
"enable_query_expression_filter": true,
"enable_query_filter": true,
"enable_radius_search": true,
"event_id": "string",
"id": "string",
"is_active": true,
"is_public": true,
"name": "string",
"page_size": 1,
"query_filter_expression": "string",
"query_filter_rules": {},
"radius_search_options": {
"postal_code_field": "string",
"radius_options": [
0.1
]
},
"refresh_period": 5,
"restrict_to_registrants": true,
"searchable_fields": [
{
"group_name": "string",
"label": "string",
"name": "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
}'The registrant directory was updated successfully.
These are additional fields that should be in the directory query, which will be available in the search results
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
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 set, users are allowed to submit comments in the directory
If set, a custom search results template is displayed
If true, the directory results will be sorted differently that the query
If set, only certain people can access this directory
When true, users are able to contact other users through the directory
If set to true, an expression can be used to further filter the query
If set to true, the directory can display a subset of records based on the provided filter. If false, the default filter is used
If true, the user can search across zip code radius
If true, this is a public directory that can be accessed without security
The page size, used for server side page and to combat scraping attacks
The expression to use to filter the directory
The period of time (in minutes) after which the directory should refresh it self
If true, only those registered for this event can access the directory
The fields in the directory that are displayed as search criteria
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
{ "additional_fields": [ "string" ], "comment_options": { "comments_header_text": "string", "comments_instructions": "string", "comments_placeholder_text": "string", "enable_ratings": true, "hide_submitter_name": true, "leave_comment_button_text": "string", "max_rating": null, "no_comments_text": "string", "rating_label": "string", "save_comment_button": "string" }, "custom_directory_entry_template": "string", "custom_search_results_template": "string", "custom_sort_fields": [ { … } ], "directory_entry_mode": "custom", "display_mode": "list", "eligibility_criteria": { "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_comments": true, "enable_custom_search_results_template": true, "enable_custom_sorting": true, "enable_eligibility_criteria": true, "enable_messaging": true, "enable_query_expression_filter": true, "enable_query_filter": true, "enable_radius_search": true, "event_id": "string", "id": "string", "is_active": true, "is_public": true, "name": "string", "page_size": 1, "query_filter_expression": "string", "query_filter_rules": {}, "radius_search_options": { "postal_code_field": "string", "radius_options": [ … ] }, "refresh_period": 5, "restrict_to_registrants": true, "searchable_fields": [ { … } ], "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 }