Registrations

Creates a new registration record that does not already exist.

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

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this registration group
event_id required	string (Event) The event
first_name	string (First Name) The member's first name
last_name	string (Last Name) The member's last name
name required	string (Name) The member's name
email_address	string (Email Address) The member's email address
city	string (City) The member city
state	string (State) The state
country	string (Country) The member country
job_title	string (Job Title) The member job title
number	number <float> (Number) The registration number
date	string <date-time> (Date) The date of registration
event_start_date	string <date-time> (Event Start Date) The date of the event
event_end_date	string <date-time> (Event End Date) The date of the event
coupon_code_id	string (Coupon Code) If a coupon code was used with this registration, it is linked here
modified_registration_id	string (Modified Registration) If this registration is modifying another registration, that ID is here
process_id	string (Process) The registration process
contact_id required	string (Contact) The contact ID of the registrant
organization_id	string (Organization) The organization associated with this registration
status	string (Status) Enum: "draft" "pending approval" "active" "cancelled"
is_guest_registration	boolean (Is Guest Registration) Guest registration
is_transient_guest	boolean (Is Transient Guest) If set, the guest has no contact record
type_id required	string (Type) The registration type
package_id required	string (Package) The registration package
webinar_participant_id	string (Webinar Participant) The external ID of this registration in the linked webinar
webinar_join_url	string (Webinar Join Url) The URL used to join the webinar
last_modification_date	string <date-time> (Last Modification Date) The last time that the registration was modified
order_id	string (Order) The order
order_line_item_id	string (Order Line Item) The order line item
order_number	number <float> (Order Number) The order number
order_balance_due	number <double> (Order Balance Due) The balance due on the order
order_amount_paid	number <double> (Order Amount Paid) The amount paid
order_currency_code	string (Order Currency Code)
order_currency_symbol	string (Order Currency Symbol)
order_status	string (Order Status) Enum: "awaiting payment" "awaiting shipping" "awaiting pickup" "partially shipped" "shipped" "completed" "cancelled" "disputed" "open" "returned" "void"
order_total	number <double> (Order Total) The total of the order
group_id	string (Group) The group this registration belongs to
group_order	number <float> (Group Order) The order of the registration within the group
deadline_id	string (Deadline) The registration deadline
add_membership_package	boolean (Add Membership Package) Whether or not we add a membership package to this registration
required	object (Membership Information)
	object (Badge)
	Array of objects
	Array of objects
registrant_acknowledges_scheduling_conflicts	boolean (Registrant Acknowledges Scheduling Conflicts) True if the registrant was presented with scheduling conflicts and acknowledged them
	Array of objects
	Array of objects
checkin_date	string <date-time> (Checkin Date) The date/time of checkin
departure_date	string <date-time> (Departure Date) The date the person left the event
cancellation_date required	string <date-time> (Cancellation Date)
	Array of objects
parent_registration_id	string (Parent Registration) For guest registrations, the parent id
ribbon_ids	Array of strings (Ribbons) The ribbons on this registration
internal_notes	string (Internal Notes) Any applicable notes
notes	string (Notes) Notes
	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 registration was saved successfully.

400The registration you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

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

429Limit exceeded... unable to add registration based on tenant limits.

500General server error.

post/registrations/{tenantId}

Request samples

application/json

{"id": "string",
"event_id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"number": 0,
"date": "2019-08-24T14:15:22Z",
"event_start_date": "2019-08-24T14:15:22Z",
"event_end_date": "2019-08-24T14:15:22Z",
"coupon_code_id": "string",
"modified_registration_id": "string",
"process_id": "string",
"contact_id": "string",
"organization_id": "string",
"status": "draft",
"is_guest_registration": true,
"is_transient_guest": true,
"type_id": "string",
"package_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"last_modification_date": "2019-08-24T14:15:22Z",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"group_id": "string",
"group_order": 0,
"deadline_id": "string",
"add_membership_package": true,
"membership_information": {"membership_package_id": "string"
},
"badge": {"first_name": "string",
"full_name": "string",
"organization_name": "string",
"job_title": "string",
"location": "string"
},
"sessions": [{"session_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": [{ }
]
}
]
}
],
"courses": [{"course_offering_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": [{ }
]
}
]
}
],
"registrant_acknowledges_scheduling_conflicts": true,
"functions": [{"function_id": "string",
"fee_id": "string",
"number_of_tickets": 0,
"ticket_options": [{"meal_option_id": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": [null
],
"table_value": [{ }
]
}
]
}
]
}
],
"add_ons": [{"add_on_product_id": "string",
"quantity": 1
}
],
"checkin_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"guests": [{"guest_registration_package_id": "string",
"guest_contact_info": { }
}
],
"parent_registration_id": "string",
"ribbon_ids": ["string"
],
"internal_notes": "string",
"notes": "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",
"event_id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"number": 0,
"date": "2019-08-24T14:15:22Z",
"event_start_date": "2019-08-24T14:15:22Z",
"event_end_date": "2019-08-24T14:15:22Z",
"coupon_code_id": "string",
"modified_registration_id": "string",
"process_id": "string",
"contact_id": "string",
"organization_id": "string",
"status": "draft",
"is_guest_registration": true,
"is_transient_guest": true,
"type_id": "string",
"package_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"last_modification_date": "2019-08-24T14:15:22Z",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"group_id": "string",
"group_order": 0,
"deadline_id": "string",
"add_membership_package": true,
"membership_information": {"membership_package_id": "string"
},
"badge": {"first_name": "string",
"full_name": "string",
"organization_name": "string",
"job_title": "string",
"location": "string"
},
"sessions": [{"session_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": [{ }
]
}
]
}
],
"courses": [{"course_offering_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": [{ }
]
}
]
}
],
"registrant_acknowledges_scheduling_conflicts": true,
"functions": [{"function_id": "string",
"fee_id": "string",
"number_of_tickets": 0,
"ticket_options": [{"meal_option_id": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": [null
],
"table_value": [{ }
]
}
]
}
]
}
],
"add_ons": [{"add_on_product_id": "string",
"quantity": 1
}
],
"checkin_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"guests": [{"guest_registration_package_id": "string",
"guest_contact_info": { }
}
],
"parent_registration_id": "string",
"ribbon_ids": ["string"
],
"internal_notes": "string",
"notes": "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 registration from the system by its ID.

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

400The request was not valid.

401Unauthorized.

403Forbidden.

404The registration could not be found.

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

500General server error.

get/registrations/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

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

Response samples

application/json

{"id": "string",
"event_id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"number": 0,
"date": "2019-08-24T14:15:22Z",
"event_start_date": "2019-08-24T14:15:22Z",
"event_end_date": "2019-08-24T14:15:22Z",
"coupon_code_id": "string",
"modified_registration_id": "string",
"process_id": "string",
"contact_id": "string",
"organization_id": "string",
"status": "draft",
"is_guest_registration": true,
"is_transient_guest": true,
"type_id": "string",
"package_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"last_modification_date": "2019-08-24T14:15:22Z",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"group_id": "string",
"group_order": 0,
"deadline_id": "string",
"add_membership_package": true,
"membership_information": {"membership_package_id": "string"
},
"badge": {"first_name": "string",
"full_name": "string",
"organization_name": "string",
"job_title": "string",
"location": "string"
},
"sessions": [{"session_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": [{ }
]
}
]
}
],
"courses": [{"course_offering_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": [{ }
]
}
]
}
],
"registrant_acknowledges_scheduling_conflicts": true,
"functions": [{"function_id": "string",
"fee_id": "string",
"number_of_tickets": 0,
"ticket_options": [{"meal_option_id": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": [null
],
"table_value": [{ }
]
}
]
}
]
}
],
"add_ons": [{"add_on_product_id": "string",
"quantity": 1
}
],
"checkin_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"guests": [{"guest_registration_package_id": "string",
"guest_contact_info": { }
}
],
"parent_registration_id": "string",
"ribbon_ids": ["string"
],
"internal_notes": "string",
"notes": "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 registration with the specified ID.

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

Request Body schema: application/json

The updated registration that will be saved.

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this registration group
event_id required	string (Event) The event
first_name	string (First Name) The member's first name
last_name	string (Last Name) The member's last name
name required	string (Name) The member's name
email_address	string (Email Address) The member's email address
city	string (City) The member city
state	string (State) The state
country	string (Country) The member country
job_title	string (Job Title) The member job title
number	number <float> (Number) The registration number
date	string <date-time> (Date) The date of registration
event_start_date	string <date-time> (Event Start Date) The date of the event
event_end_date	string <date-time> (Event End Date) The date of the event
coupon_code_id	string (Coupon Code) If a coupon code was used with this registration, it is linked here
modified_registration_id	string (Modified Registration) If this registration is modifying another registration, that ID is here
process_id	string (Process) The registration process
contact_id required	string (Contact) The contact ID of the registrant
organization_id	string (Organization) The organization associated with this registration
status	string (Status) Enum: "draft" "pending approval" "active" "cancelled"
is_guest_registration	boolean (Is Guest Registration) Guest registration
is_transient_guest	boolean (Is Transient Guest) If set, the guest has no contact record
type_id required	string (Type) The registration type
package_id required	string (Package) The registration package
webinar_participant_id	string (Webinar Participant) The external ID of this registration in the linked webinar
webinar_join_url	string (Webinar Join Url) The URL used to join the webinar
last_modification_date	string <date-time> (Last Modification Date) The last time that the registration was modified
order_id	string (Order) The order
order_line_item_id	string (Order Line Item) The order line item
order_number	number <float> (Order Number) The order number
order_balance_due	number <double> (Order Balance Due) The balance due on the order
order_amount_paid	number <double> (Order Amount Paid) The amount paid
order_currency_code	string (Order Currency Code)
order_currency_symbol	string (Order Currency Symbol)
order_status	string (Order Status) Enum: "awaiting payment" "awaiting shipping" "awaiting pickup" "partially shipped" "shipped" "completed" "cancelled" "disputed" "open" "returned" "void"
order_total	number <double> (Order Total) The total of the order
group_id	string (Group) The group this registration belongs to
group_order	number <float> (Group Order) The order of the registration within the group
deadline_id	string (Deadline) The registration deadline
add_membership_package	boolean (Add Membership Package) Whether or not we add a membership package to this registration
required	object (Membership Information)
	object (Badge)
	Array of objects
	Array of objects
registrant_acknowledges_scheduling_conflicts	boolean (Registrant Acknowledges Scheduling Conflicts) True if the registrant was presented with scheduling conflicts and acknowledged them
	Array of objects
	Array of objects
checkin_date	string <date-time> (Checkin Date) The date/time of checkin
departure_date	string <date-time> (Departure Date) The date the person left the event
cancellation_date required	string <date-time> (Cancellation Date)
	Array of objects
parent_registration_id	string (Parent Registration) For guest registrations, the parent id
ribbon_ids	Array of strings (Ribbons) The ribbons on this registration
internal_notes	string (Internal Notes) Any applicable notes
notes	string (Notes) Notes
	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 registration was updated successfully.

400The registration supplied was not valid.

401Unauthorized.

403Forbidden.

404The registration could not be found.

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

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

500General server error.

put/registrations/{tenantId}/{id}

Request samples

application/json

{"id": "string",
"event_id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"number": 0,
"date": "2019-08-24T14:15:22Z",
"event_start_date": "2019-08-24T14:15:22Z",
"event_end_date": "2019-08-24T14:15:22Z",
"coupon_code_id": "string",
"modified_registration_id": "string",
"process_id": "string",
"contact_id": "string",
"organization_id": "string",
"status": "draft",
"is_guest_registration": true,
"is_transient_guest": true,
"type_id": "string",
"package_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"last_modification_date": "2019-08-24T14:15:22Z",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"group_id": "string",
"group_order": 0,
"deadline_id": "string",
"add_membership_package": true,
"membership_information": {"membership_package_id": "string"
},
"badge": {"first_name": "string",
"full_name": "string",
"organization_name": "string",
"job_title": "string",
"location": "string"
},
"sessions": [{"session_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": [{ }
]
}
]
}
],
"courses": [{"course_offering_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": [{ }
]
}
]
}
],
"registrant_acknowledges_scheduling_conflicts": true,
"functions": [{"function_id": "string",
"fee_id": "string",
"number_of_tickets": 0,
"ticket_options": [{"meal_option_id": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": [null
],
"table_value": [{ }
]
}
]
}
]
}
],
"add_ons": [{"add_on_product_id": "string",
"quantity": 1
}
],
"checkin_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"guests": [{"guest_registration_package_id": "string",
"guest_contact_info": { }
}
],
"parent_registration_id": "string",
"ribbon_ids": ["string"
],
"internal_notes": "string",
"notes": "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",
"event_id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"number": 0,
"date": "2019-08-24T14:15:22Z",
"event_start_date": "2019-08-24T14:15:22Z",
"event_end_date": "2019-08-24T14:15:22Z",
"coupon_code_id": "string",
"modified_registration_id": "string",
"process_id": "string",
"contact_id": "string",
"organization_id": "string",
"status": "draft",
"is_guest_registration": true,
"is_transient_guest": true,
"type_id": "string",
"package_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"last_modification_date": "2019-08-24T14:15:22Z",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"group_id": "string",
"group_order": 0,
"deadline_id": "string",
"add_membership_package": true,
"membership_information": {"membership_package_id": "string"
},
"badge": {"first_name": "string",
"full_name": "string",
"organization_name": "string",
"job_title": "string",
"location": "string"
},
"sessions": [{"session_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": [{ }
]
}
]
}
],
"courses": [{"course_offering_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": [{ }
]
}
]
}
],
"registrant_acknowledges_scheduling_conflicts": true,
"functions": [{"function_id": "string",
"fee_id": "string",
"number_of_tickets": 0,
"ticket_options": [{"meal_option_id": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": [null
],
"table_value": [{ }
]
}
]
}
]
}
],
"add_ons": [{"add_on_product_id": "string",
"quantity": 1
}
],
"checkin_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"guests": [{"guest_registration_package_id": "string",
"guest_contact_info": { }
}
],
"parent_registration_id": "string",
"ribbon_ids": ["string"
],
"internal_notes": "string",
"notes": "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 registration with the specified ID.

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

400The JSON patch directive you supplied was not valid.

401Unauthorized.

403Forbidden.

404The registration could not be found.

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

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

500General server error.

patch/registrations/{tenantId}/{id}

Request samples

application/json

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

Response samples

application/json

{"id": "string",
"event_id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"number": 0,
"date": "2019-08-24T14:15:22Z",
"event_start_date": "2019-08-24T14:15:22Z",
"event_end_date": "2019-08-24T14:15:22Z",
"coupon_code_id": "string",
"modified_registration_id": "string",
"process_id": "string",
"contact_id": "string",
"organization_id": "string",
"status": "draft",
"is_guest_registration": true,
"is_transient_guest": true,
"type_id": "string",
"package_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"last_modification_date": "2019-08-24T14:15:22Z",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"group_id": "string",
"group_order": 0,
"deadline_id": "string",
"add_membership_package": true,
"membership_information": {"membership_package_id": "string"
},
"badge": {"first_name": "string",
"full_name": "string",
"organization_name": "string",
"job_title": "string",
"location": "string"
},
"sessions": [{"session_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": [{ }
]
}
]
}
],
"courses": [{"course_offering_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": [{ }
]
}
]
}
],
"registrant_acknowledges_scheduling_conflicts": true,
"functions": [{"function_id": "string",
"fee_id": "string",
"number_of_tickets": 0,
"ticket_options": [{"meal_option_id": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": [null
],
"table_value": [{ }
]
}
]
}
]
}
],
"add_ons": [{"add_on_product_id": "string",
"quantity": 1
}
],
"checkin_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"guests": [{"guest_registration_package_id": "string",
"guest_contact_info": { }
}
],
"parent_registration_id": "string",
"ribbon_ids": ["string"
],
"internal_notes": "string",
"notes": "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 registration from the system by its ID.

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

Responses

200The registration was deleted successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The registration could not be found.

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

429Limit exceeded... unable to delete registration based on tenant limits.

500General server error.

delete/registrations/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

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

Response samples

application/json

"string"

Downloads a Certificate

Returns the HTML for the certificate

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed
id required	string The ID of the certifications

query Parameters

downloadAsHtml

boolean

If true, return the receipt as HTML

Responses

200The certifications was downloaded successfully

400The request was not valid.

401Unauthorized

403Forbidden

404The payment could not be found.

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

500General server error

get/registrations/{tenantId}/certificate/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://events.api.756794052567.rhythmsoftware.com/registrations/:tenantId/certificate/:id?downloadAsHtml=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

"string"

Generates an order from an event registration

This method will examine an event registration and generate an appropriate order

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed

Request Body schema: application/json

The application to generate an order

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this registration group
event_id required	string (Event) The event
first_name	string (First Name) The member's first name
last_name	string (Last Name) The member's last name
name required	string (Name) The member's name
email_address	string (Email Address) The member's email address
city	string (City) The member city
state	string (State) The state
country	string (Country) The member country
job_title	string (Job Title) The member job title
number	number <float> (Number) The registration number
date	string <date-time> (Date) The date of registration
event_start_date	string <date-time> (Event Start Date) The date of the event
event_end_date	string <date-time> (Event End Date) The date of the event
coupon_code_id	string (Coupon Code) If a coupon code was used with this registration, it is linked here
modified_registration_id	string (Modified Registration) If this registration is modifying another registration, that ID is here
process_id	string (Process) The registration process
contact_id required	string (Contact) The contact ID of the registrant
organization_id	string (Organization) The organization associated with this registration
status	string (Status) Enum: "draft" "pending approval" "active" "cancelled"
is_guest_registration	boolean (Is Guest Registration) Guest registration
is_transient_guest	boolean (Is Transient Guest) If set, the guest has no contact record
type_id required	string (Type) The registration type
package_id required	string (Package) The registration package
webinar_participant_id	string (Webinar Participant) The external ID of this registration in the linked webinar
webinar_join_url	string (Webinar Join Url) The URL used to join the webinar
last_modification_date	string <date-time> (Last Modification Date) The last time that the registration was modified
order_id	string (Order) The order
order_line_item_id	string (Order Line Item) The order line item
order_number	number <float> (Order Number) The order number
order_balance_due	number <double> (Order Balance Due) The balance due on the order
order_amount_paid	number <double> (Order Amount Paid) The amount paid
order_currency_code	string (Order Currency Code)
order_currency_symbol	string (Order Currency Symbol)
order_status	string (Order Status) Enum: "awaiting payment" "awaiting shipping" "awaiting pickup" "partially shipped" "shipped" "completed" "cancelled" "disputed" "open" "returned" "void"
order_total	number <double> (Order Total) The total of the order
group_id	string (Group) The group this registration belongs to
group_order	number <float> (Group Order) The order of the registration within the group
deadline_id	string (Deadline) The registration deadline
add_membership_package	boolean (Add Membership Package) Whether or not we add a membership package to this registration
required	object (Membership Information)
	object (Badge)
	Array of objects
	Array of objects
registrant_acknowledges_scheduling_conflicts	boolean (Registrant Acknowledges Scheduling Conflicts) True if the registrant was presented with scheduling conflicts and acknowledged them
	Array of objects
	Array of objects
checkin_date	string <date-time> (Checkin Date) The date/time of checkin
departure_date	string <date-time> (Departure Date) The date the person left the event
cancellation_date required	string <date-time> (Cancellation Date)
	Array of objects
parent_registration_id	string (Parent Registration) For guest registrations, the parent id
ribbon_ids	Array of strings (Ribbons) The ribbons on this registration
internal_notes	string (Internal Notes) Any applicable notes
notes	string (Notes) Notes
	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

200Conflicts were retrieved successfully

400The search you supplied was invalid.

401Unauthorized

403Forbidden

404The resource could not be found

429Limit exceeded... unable to add order based on tenant limits.

500General server error

post/registrations/{tenantId}/generateOrder

Request samples

application/json

{"id": "string",
"event_id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"number": 0,
"date": "2019-08-24T14:15:22Z",
"event_start_date": "2019-08-24T14:15:22Z",
"event_end_date": "2019-08-24T14:15:22Z",
"coupon_code_id": "string",
"modified_registration_id": "string",
"process_id": "string",
"contact_id": "string",
"organization_id": "string",
"status": "draft",
"is_guest_registration": true,
"is_transient_guest": true,
"type_id": "string",
"package_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"last_modification_date": "2019-08-24T14:15:22Z",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"group_id": "string",
"group_order": 0,
"deadline_id": "string",
"add_membership_package": true,
"membership_information": {"membership_package_id": "string"
},
"badge": {"first_name": "string",
"full_name": "string",
"organization_name": "string",
"job_title": "string",
"location": "string"
},
"sessions": [{"session_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": [{ }
]
}
]
}
],
"courses": [{"course_offering_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": [{ }
]
}
]
}
],
"registrant_acknowledges_scheduling_conflicts": true,
"functions": [{"function_id": "string",
"fee_id": "string",
"number_of_tickets": 0,
"ticket_options": [{"meal_option_id": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": [null
],
"table_value": [{ }
]
}
]
}
]
}
],
"add_ons": [{"add_on_product_id": "string",
"quantity": 1
}
],
"checkin_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"guests": [{"guest_registration_package_id": "string",
"guest_contact_info": { }
}
],
"parent_registration_id": "string",
"ribbon_ids": ["string"
],
"internal_notes": "string",
"notes": "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",
"event_id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"number": 0,
"date": "2019-08-24T14:15:22Z",
"event_start_date": "2019-08-24T14:15:22Z",
"event_end_date": "2019-08-24T14:15:22Z",
"coupon_code_id": "string",
"modified_registration_id": "string",
"process_id": "string",
"contact_id": "string",
"organization_id": "string",
"status": "draft",
"is_guest_registration": true,
"is_transient_guest": true,
"type_id": "string",
"package_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"last_modification_date": "2019-08-24T14:15:22Z",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"group_id": "string",
"group_order": 0,
"deadline_id": "string",
"add_membership_package": true,
"membership_information": {"membership_package_id": "string"
},
"badge": {"first_name": "string",
"full_name": "string",
"organization_name": "string",
"job_title": "string",
"location": "string"
},
"sessions": [{"session_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": [{ }
]
}
]
}
],
"courses": [{"course_offering_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": [{ }
]
}
]
}
],
"registrant_acknowledges_scheduling_conflicts": true,
"functions": [{"function_id": "string",
"fee_id": "string",
"number_of_tickets": 0,
"ticket_options": [{"meal_option_id": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": [null
],
"table_value": [{ }
]
}
]
}
]
}
],
"add_ons": [{"add_on_product_id": "string",
"quantity": 1
}
],
"checkin_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"guests": [{"guest_registration_package_id": "string",
"guest_contact_info": { }
}
],
"parent_registration_id": "string",
"ribbon_ids": ["string"
],
"internal_notes": "string",
"notes": "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"
}
]
}

Generates the payload necessary to edit a registration

This method will examine an event registration and generate an appropriate order

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed
id required	string The registration ID

Responses

200Conflicts were retrieved successfully

400The search you supplied was invalid.

401Unauthorized

403Forbidden

404The resource could not be found

429Limit exceeded... unable to add order based on tenant limits.

500General server error

get/registrations/{tenantId}/registrationModificationPayload/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  https://events.api.756794052567.rhythmsoftware.com/registrations/:tenantId/registrationModificationPayload/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"id": "string",
"event_id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"number": 0,
"date": "2019-08-24T14:15:22Z",
"event_start_date": "2019-08-24T14:15:22Z",
"event_end_date": "2019-08-24T14:15:22Z",
"coupon_code_id": "string",
"modified_registration_id": "string",
"process_id": "string",
"contact_id": "string",
"organization_id": "string",
"status": "draft",
"is_guest_registration": true,
"is_transient_guest": true,
"type_id": "string",
"package_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"last_modification_date": "2019-08-24T14:15:22Z",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"group_id": "string",
"group_order": 0,
"deadline_id": "string",
"add_membership_package": true,
"membership_information": {"membership_package_id": "string"
},
"badge": {"first_name": "string",
"full_name": "string",
"organization_name": "string",
"job_title": "string",
"location": "string"
},
"sessions": [{"session_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": [{ }
]
}
]
}
],
"courses": [{"course_offering_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": [{ }
]
}
]
}
],
"registrant_acknowledges_scheduling_conflicts": true,
"functions": [{"function_id": "string",
"fee_id": "string",
"number_of_tickets": 0,
"ticket_options": [{"meal_option_id": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": [null
],
"table_value": [{ }
]
}
]
}
]
}
],
"add_ons": [{"add_on_product_id": "string",
"quantity": 1
}
],
"checkin_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"guests": [{"guest_registration_package_id": "string",
"guest_contact_info": { }
}
],
"parent_registration_id": "string",
"ribbon_ids": ["string"
],
"internal_notes": "string",
"notes": "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"
}
]
}

Transfers a registration

Transfers a registration registration from one contact to another, and updates downstream session, tickets, and course registrations

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed
id required	string The registration id
contactId required	string The destination contact

Request Body schema: application/json

Options

send_confirmation_email

boolean (Send Confirmation Email)

Whether or not a confirmation email should be send to the target registrant

Responses

200Conflicts were retrieved successfully

400The search you supplied was invalid.

401Unauthorized

403Forbidden

404The resource could not be found

429Limit exceeded... unable to add order based on tenant limits.

500General server error

put/registrations/{tenantId}/transfer/{id}/{contactId}

Request samples

application/json

{"send_confirmation_email": true
}

Response samples

application/json

{"id": "string",
"event_id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"number": 0,
"date": "2019-08-24T14:15:22Z",
"event_start_date": "2019-08-24T14:15:22Z",
"event_end_date": "2019-08-24T14:15:22Z",
"coupon_code_id": "string",
"modified_registration_id": "string",
"process_id": "string",
"contact_id": "string",
"organization_id": "string",
"status": "draft",
"is_guest_registration": true,
"is_transient_guest": true,
"type_id": "string",
"package_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"last_modification_date": "2019-08-24T14:15:22Z",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"group_id": "string",
"group_order": 0,
"deadline_id": "string",
"add_membership_package": true,
"membership_information": {"membership_package_id": "string"
},
"badge": {"first_name": "string",
"full_name": "string",
"organization_name": "string",
"job_title": "string",
"location": "string"
},
"sessions": [{"session_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": [{ }
]
}
]
}
],
"courses": [{"course_offering_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": [{ }
]
}
]
}
],
"registrant_acknowledges_scheduling_conflicts": true,
"functions": [{"function_id": "string",
"fee_id": "string",
"number_of_tickets": 0,
"ticket_options": [{"meal_option_id": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": [null
],
"table_value": [{ }
]
}
]
}
]
}
],
"add_ons": [{"add_on_product_id": "string",
"quantity": 1
}
],
"checkin_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"guests": [{"guest_registration_package_id": "string",
"guest_contact_info": { }
}
],
"parent_registration_id": "string",
"ribbon_ids": ["string"
],
"internal_notes": "string",
"notes": "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"
}
]
}

Generates an order for a registration group

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed
groupId required	string The group id

Responses

200Conflicts were retrieved successfully

400The search you supplied was invalid.

401Unauthorized

403Forbidden

404The resource could not be found

429Limit exceeded... unable to add order based on tenant limits.

500General server error

post/registrations/{tenantId}/generateGroupOrder/{groupId}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X POST \
  https://events.api.756794052567.rhythmsoftware.com/registrations/:tenantId/generateGroupOrder/:groupId \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"id": "string",
"event_id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"number": 0,
"date": "2019-08-24T14:15:22Z",
"event_start_date": "2019-08-24T14:15:22Z",
"event_end_date": "2019-08-24T14:15:22Z",
"coupon_code_id": "string",
"modified_registration_id": "string",
"process_id": "string",
"contact_id": "string",
"organization_id": "string",
"status": "draft",
"is_guest_registration": true,
"is_transient_guest": true,
"type_id": "string",
"package_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"last_modification_date": "2019-08-24T14:15:22Z",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"group_id": "string",
"group_order": 0,
"deadline_id": "string",
"add_membership_package": true,
"membership_information": {"membership_package_id": "string"
},
"badge": {"first_name": "string",
"full_name": "string",
"organization_name": "string",
"job_title": "string",
"location": "string"
},
"sessions": [{"session_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": [{ }
]
}
]
}
],
"courses": [{"course_offering_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": [{ }
]
}
]
}
],
"registrant_acknowledges_scheduling_conflicts": true,
"functions": [{"function_id": "string",
"fee_id": "string",
"number_of_tickets": 0,
"ticket_options": [{"meal_option_id": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": [null
],
"table_value": [{ }
]
}
]
}
]
}
],
"add_ons": [{"add_on_product_id": "string",
"quantity": 1
}
],
"checkin_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"guests": [{"guest_registration_package_id": "string",
"guest_contact_info": { }
}
],
"parent_registration_id": "string",
"ribbon_ids": ["string"
],
"internal_notes": "string",
"notes": "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"
}
]
}

Examines a registration and detects any potential scheduling conflicts in the registration

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed

Request Body schema: application/json

The registration to use for conflict detection

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this registration group
event_id required	string (Event) The event
first_name	string (First Name) The member's first name
last_name	string (Last Name) The member's last name
name required	string (Name) The member's name
email_address	string (Email Address) The member's email address
city	string (City) The member city
state	string (State) The state
country	string (Country) The member country
job_title	string (Job Title) The member job title
number	number <float> (Number) The registration number
date	string <date-time> (Date) The date of registration
event_start_date	string <date-time> (Event Start Date) The date of the event
event_end_date	string <date-time> (Event End Date) The date of the event
coupon_code_id	string (Coupon Code) If a coupon code was used with this registration, it is linked here
modified_registration_id	string (Modified Registration) If this registration is modifying another registration, that ID is here
process_id	string (Process) The registration process
contact_id required	string (Contact) The contact ID of the registrant
organization_id	string (Organization) The organization associated with this registration
status	string (Status) Enum: "draft" "pending approval" "active" "cancelled"
is_guest_registration	boolean (Is Guest Registration) Guest registration
is_transient_guest	boolean (Is Transient Guest) If set, the guest has no contact record
type_id required	string (Type) The registration type
package_id required	string (Package) The registration package
webinar_participant_id	string (Webinar Participant) The external ID of this registration in the linked webinar
webinar_join_url	string (Webinar Join Url) The URL used to join the webinar
last_modification_date	string <date-time> (Last Modification Date) The last time that the registration was modified
order_id	string (Order) The order
order_line_item_id	string (Order Line Item) The order line item
order_number	number <float> (Order Number) The order number
order_balance_due	number <double> (Order Balance Due) The balance due on the order
order_amount_paid	number <double> (Order Amount Paid) The amount paid
order_currency_code	string (Order Currency Code)
order_currency_symbol	string (Order Currency Symbol)
order_status	string (Order Status) Enum: "awaiting payment" "awaiting shipping" "awaiting pickup" "partially shipped" "shipped" "completed" "cancelled" "disputed" "open" "returned" "void"
order_total	number <double> (Order Total) The total of the order
group_id	string (Group) The group this registration belongs to
group_order	number <float> (Group Order) The order of the registration within the group
deadline_id	string (Deadline) The registration deadline
add_membership_package	boolean (Add Membership Package) Whether or not we add a membership package to this registration
required	object (Membership Information)
	object (Badge)
	Array of objects
	Array of objects
registrant_acknowledges_scheduling_conflicts	boolean (Registrant Acknowledges Scheduling Conflicts) True if the registrant was presented with scheduling conflicts and acknowledged them
	Array of objects
	Array of objects
checkin_date	string <date-time> (Checkin Date) The date/time of checkin
departure_date	string <date-time> (Departure Date) The date the person left the event
cancellation_date required	string <date-time> (Cancellation Date)
	Array of objects
parent_registration_id	string (Parent Registration) For guest registrations, the parent id
ribbon_ids	Array of strings (Ribbons) The ribbons on this registration
internal_notes	string (Internal Notes) Any applicable notes
notes	string (Notes) Notes
	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

200Conflicts were retrieved successfully

400The search you supplied was invalid.

401Unauthorized

403Forbidden

404The resource could not be found

429Limit exceeded... unable to add order based on tenant limits.

500General server error

post/registrations/{tenantId}/portal/detectSchedulingConflicts

Request samples

application/json

{"id": "string",
"event_id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"number": 0,
"date": "2019-08-24T14:15:22Z",
"event_start_date": "2019-08-24T14:15:22Z",
"event_end_date": "2019-08-24T14:15:22Z",
"coupon_code_id": "string",
"modified_registration_id": "string",
"process_id": "string",
"contact_id": "string",
"organization_id": "string",
"status": "draft",
"is_guest_registration": true,
"is_transient_guest": true,
"type_id": "string",
"package_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"last_modification_date": "2019-08-24T14:15:22Z",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"group_id": "string",
"group_order": 0,
"deadline_id": "string",
"add_membership_package": true,
"membership_information": {"membership_package_id": "string"
},
"badge": {"first_name": "string",
"full_name": "string",
"organization_name": "string",
"job_title": "string",
"location": "string"
},
"sessions": [{"session_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": [{ }
]
}
]
}
],
"courses": [{"course_offering_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": [{ }
]
}
]
}
],
"registrant_acknowledges_scheduling_conflicts": true,
"functions": [{"function_id": "string",
"fee_id": "string",
"number_of_tickets": 0,
"ticket_options": [{"meal_option_id": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": [null
],
"table_value": [{ }
]
}
]
}
]
}
],
"add_ons": [{"add_on_product_id": "string",
"quantity": 1
}
],
"checkin_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"guests": [{"guest_registration_package_id": "string",
"guest_contact_info": { }
}
],
"parent_registration_id": "string",
"ribbon_ids": ["string"
],
"internal_notes": "string",
"notes": "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

{"schedulingConflicts": [{"events": [{"type": "function",
"id": "string",
"name": "string",
"start_date": "string",
"end_date": "string"
}
]
}
]
}

Returns a list of records with the specified contact_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

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/registrations/{tenantId}/contact/{contact_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://events.api.756794052567.rhythmsoftware.com/registrations/:tenantId/contact/:contact_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"event_id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"number": 0,
"date": "2019-08-24T14:15:22Z",
"event_start_date": "2019-08-24T14:15:22Z",
"event_end_date": "2019-08-24T14:15:22Z",
"coupon_code_id": "string",
"modified_registration_id": "string",
"process_id": "string",
"contact_id": "string",
"organization_id": "string",
"status": "draft",
"is_guest_registration": true,
"is_transient_guest": true,
"type_id": "string",
"package_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"last_modification_date": "2019-08-24T14:15:22Z",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"group_id": "string",
"group_order": 0,
"deadline_id": "string",
"add_membership_package": true,
"membership_information": {"membership_package_id": "string"
},
"badge": {"first_name": "string",
"full_name": "string",
"organization_name": "string",
"job_title": "string",
"location": "string"
},
"sessions": [{"session_id": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": [null
],
"table_value": [{ }
]
}
]
}
],
"courses": [{"course_offering_id": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": [null
],
"table_value": [{ }
]
}
]
}
],
"registrant_acknowledges_scheduling_conflicts": true,
"functions": [{"function_id": "string",
"fee_id": "string",
"number_of_tickets": 0,
"ticket_options": [{"meal_option_id": "string",
"custom_field_values": [null
]
}
]
}
],
"add_ons": [{"add_on_product_id": "string",
"quantity": 1
}
],
"checkin_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"guests": [{"guest_registration_package_id": "string",
"guest_contact_info": { }
}
],
"parent_registration_id": "string",
"ribbon_ids": ["string"
],
"internal_notes": "string",
"notes": "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 registrations 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 registration that you would like to be saved.

ids	Array of strings (Ids) IDs to search
first_name	string (First Name) The member's first name
last_name	string (Last Name) The member's last name
name required	string (Name) The member's name
email_address	string (Email Address) The member's email address
city	string (City) The member city
state	string (State) The state
country	string (Country) The member country
job_title	string (Job Title) The member job title
organization_id	Array of strings (Organization)
order_id	Array of strings (Order)
order_number	Array of numbers <float> (Order Number)
order_balance_due	Array of numbers <float> (Order Balance Due) 2 items
order_amount_paid	Array of numbers <float> (Order Amount Paid) 2 items
order_status	Array of strings (Order Status)
order_total	Array of numbers <float> (Order Total) 2 items
event_id required	string (Event)
date	Array of strings <date-time> (Date) 2 items
contact_id	Array of strings (Contact)
status	Array of strings (Status)
is_guest_registration	Array of booleans (Is Guest Registration)
type_id	Array of strings (Type)
package_id	Array of strings (Package)
group_id	Array of strings (Group)
deadline_id	Array of strings (Deadline)
parent_registration_id	Array of strings (Parent Registration)

Responses

200The registration search was saved successfully.

400The registration you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

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

429Limit exceeded... unable to add registration based on tenant limits.

500General server error.

post/registrations/{tenantId}/search

Request samples

application/json

{"ids": ["string"
],
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"organization_id": ["string"
],
"order_id": ["string"
],
"order_number": [0
],
"order_balance_due": [0,
0
],
"order_amount_paid": [0,
0
],
"order_status": ["string"
],
"order_total": [0,
0
],
"event_id": "string",
"date": ["2019-08-24T14:15:22Z",
"2019-08-24T14:15:22Z"
],
"contact_id": ["string"
],
"status": ["string"
],
"is_guest_registration": [true
],
"type_id": ["string"
],
"package_id": ["string"
],
"group_id": ["string"
],
"deadline_id": ["string"
],
"parent_registration_id": ["string"
]
}

Response samples

application/json

{"Items": [{"id": "string",
"contact_id": "string",
"event_id": "string",
"bio": "string",
"photo_uri": "string",
"display_order": "string",
"organization_id": "string",
"organization_name": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"featured": true
}
],
"LastEvaluatedKey": "string"
}

Returns a list of records with the specified event_contact_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
eventId required	string The event
contactId required	string The contact

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/registrations/{tenantId}/eventContact/{eventId}/{contactId}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://events.api.756794052567.rhythmsoftware.com/registrations/:tenantId/eventContact/:eventId/:contactId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"event_id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"number": 0,
"date": "2019-08-24T14:15:22Z",
"event_start_date": "2019-08-24T14:15:22Z",
"event_end_date": "2019-08-24T14:15:22Z",
"coupon_code_id": "string",
"modified_registration_id": "string",
"process_id": "string",
"contact_id": "string",
"organization_id": "string",
"status": "draft",
"is_guest_registration": true,
"is_transient_guest": true,
"type_id": "string",
"package_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"last_modification_date": "2019-08-24T14:15:22Z",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"group_id": "string",
"group_order": 0,
"deadline_id": "string",
"add_membership_package": true,
"membership_information": {"membership_package_id": "string"
},
"badge": {"first_name": "string",
"full_name": "string",
"organization_name": "string",
"job_title": "string",
"location": "string"
},
"sessions": [{"session_id": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": [null
],
"table_value": [{ }
]
}
]
}
],
"courses": [{"course_offering_id": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": [null
],
"table_value": [{ }
]
}
]
}
],
"registrant_acknowledges_scheduling_conflicts": true,
"functions": [{"function_id": "string",
"fee_id": "string",
"number_of_tickets": 0,
"ticket_options": [{"meal_option_id": "string",
"custom_field_values": [null
]
}
]
}
],
"add_ons": [{"add_on_product_id": "string",
"quantity": 1
}
],
"checkin_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"guests": [{"guest_registration_package_id": "string",
"guest_contact_info": { }
}
],
"parent_registration_id": "string",
"ribbon_ids": ["string"
],
"internal_notes": "string",
"notes": "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 parent_registration_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
parent_registration_id required	string The parent_registration_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/registrations/{tenantId}/parentRegistration/{parent_registration_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://events.api.756794052567.rhythmsoftware.com/registrations/:tenantId/parentRegistration/:parent_registration_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"event_id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"number": 0,
"date": "2019-08-24T14:15:22Z",
"event_start_date": "2019-08-24T14:15:22Z",
"event_end_date": "2019-08-24T14:15:22Z",
"coupon_code_id": "string",
"modified_registration_id": "string",
"process_id": "string",
"contact_id": "string",
"organization_id": "string",
"status": "draft",
"is_guest_registration": true,
"is_transient_guest": true,
"type_id": "string",
"package_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"last_modification_date": "2019-08-24T14:15:22Z",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"group_id": "string",
"group_order": 0,
"deadline_id": "string",
"add_membership_package": true,
"membership_information": {"membership_package_id": "string"
},
"badge": {"first_name": "string",
"full_name": "string",
"organization_name": "string",
"job_title": "string",
"location": "string"
},
"sessions": [{"session_id": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": [null
],
"table_value": [{ }
]
}
]
}
],
"courses": [{"course_offering_id": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": [null
],
"table_value": [{ }
]
}
]
}
],
"registrant_acknowledges_scheduling_conflicts": true,
"functions": [{"function_id": "string",
"fee_id": "string",
"number_of_tickets": 0,
"ticket_options": [{"meal_option_id": "string",
"custom_field_values": [null
]
}
]
}
],
"add_ons": [{"add_on_product_id": "string",
"quantity": 1
}
],
"checkin_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"guests": [{"guest_registration_package_id": "string",
"guest_contact_info": { }
}
],
"parent_registration_id": "string",
"ribbon_ids": ["string"
],
"internal_notes": "string",
"notes": "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"
}

Resends the confirmation email for a registration

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
registration_id required	string

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

post/registrations/{tenantId}/resendConfirmationEmail/{registration_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X POST \
  https://events.api.756794052567.rhythmsoftware.com/registrations/:tenantId/resendConfirmationEmail/:registration_id \
  -H 'Authorization: YOUR_API_KEY_HERE'

Returns a list of records with the specified order_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
order_id required	string The order_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/registrations/{tenantId}/order/{order_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://events.api.756794052567.rhythmsoftware.com/registrations/:tenantId/order/:order_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"event_id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"number": 0,
"date": "2019-08-24T14:15:22Z",
"event_start_date": "2019-08-24T14:15:22Z",
"event_end_date": "2019-08-24T14:15:22Z",
"coupon_code_id": "string",
"modified_registration_id": "string",
"process_id": "string",
"contact_id": "string",
"organization_id": "string",
"status": "draft",
"is_guest_registration": true,
"is_transient_guest": true,
"type_id": "string",
"package_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"last_modification_date": "2019-08-24T14:15:22Z",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"group_id": "string",
"group_order": 0,
"deadline_id": "string",
"add_membership_package": true,
"membership_information": {"membership_package_id": "string"
},
"badge": {"first_name": "string",
"full_name": "string",
"organization_name": "string",
"job_title": "string",
"location": "string"
},
"sessions": [{"session_id": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": [null
],
"table_value": [{ }
]
}
]
}
],
"courses": [{"course_offering_id": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": [null
],
"table_value": [{ }
]
}
]
}
],
"registrant_acknowledges_scheduling_conflicts": true,
"functions": [{"function_id": "string",
"fee_id": "string",
"number_of_tickets": 0,
"ticket_options": [{"meal_option_id": "string",
"custom_field_values": [null
]
}
]
}
],
"add_ons": [{"add_on_product_id": "string",
"quantity": 1
}
],
"checkin_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"guests": [{"guest_registration_package_id": "string",
"guest_contact_info": { }
}
],
"parent_registration_id": "string",
"ribbon_ids": ["string"
],
"internal_notes": "string",
"notes": "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"
}

Sends out a preview of the CRC notification email

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The tenant

Request Body schema: application/json

The domain_name to use to for record lookup

review_id	string (Review)
type	string (Type)
	object (Email Template)
destination_email_address required	string (Destination Email Address)
abstract_id	string (Abstract)
registration_id required	string (Registration)

Responses

200The record was retrieved successfully

400The request was not valid.

401Unauthorized

403Forbidden

404Unable to locate any organizations with the specified domain

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

500General server error

post/registrations/{tenantId}/previewEmail

Request samples

application/json

{"review_id": "string",
"type": "string",
"email_template": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
},
"destination_email_address": "string",
"abstract_id": "string",
"registration_id": "string"
}

Returns a list of records with the specified group_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
group_id required	string The group_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/registrations/{tenantId}/group/{group_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://events.api.756794052567.rhythmsoftware.com/registrations/:tenantId/group/:group_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"event_id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"number": 0,
"date": "2019-08-24T14:15:22Z",
"event_start_date": "2019-08-24T14:15:22Z",
"event_end_date": "2019-08-24T14:15:22Z",
"coupon_code_id": "string",
"modified_registration_id": "string",
"process_id": "string",
"contact_id": "string",
"organization_id": "string",
"status": "draft",
"is_guest_registration": true,
"is_transient_guest": true,
"type_id": "string",
"package_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"last_modification_date": "2019-08-24T14:15:22Z",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"group_id": "string",
"group_order": 0,
"deadline_id": "string",
"add_membership_package": true,
"membership_information": {"membership_package_id": "string"
},
"badge": {"first_name": "string",
"full_name": "string",
"organization_name": "string",
"job_title": "string",
"location": "string"
},
"sessions": [{"session_id": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": [null
],
"table_value": [{ }
]
}
]
}
],
"courses": [{"course_offering_id": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": [null
],
"table_value": [{ }
]
}
]
}
],
"registrant_acknowledges_scheduling_conflicts": true,
"functions": [{"function_id": "string",
"fee_id": "string",
"number_of_tickets": 0,
"ticket_options": [{"meal_option_id": "string",
"custom_field_values": [null
]
}
]
}
],
"add_ons": [{"add_on_product_id": "string",
"quantity": 1
}
],
"checkin_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"guests": [{"guest_registration_package_id": "string",
"guest_contact_info": { }
}
],
"parent_registration_id": "string",
"ribbon_ids": ["string"
],
"internal_notes": "string",
"notes": "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"
}

Sends out a preview of the CRC notification certificate

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The tenant

Request Body schema: application/json

The domain_name to use to for record lookup

registration_id required	string (Registration)
certificate_template required	string (Certificate Template)

Responses

200The record was retrieved successfully

400The request was not valid.

401Unauthorized

403Forbidden

404Unable to locate any organizations with the specified domain

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

500General server error

post/registrations/{tenantId}/previewCertificate

Request samples

application/json

{"registration_id": "string",
"certificate_template": "string"
}

Returns a list of records with the specified event_organization_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
eventId required	string The event
organizationId required	string The organization

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/registrations/{tenantId}/eventOrganization/{eventId}/{organizationId}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://events.api.756794052567.rhythmsoftware.com/registrations/:tenantId/eventOrganization/:eventId/:organizationId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"event_id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"number": 0,
"date": "2019-08-24T14:15:22Z",
"event_start_date": "2019-08-24T14:15:22Z",
"event_end_date": "2019-08-24T14:15:22Z",
"coupon_code_id": "string",
"modified_registration_id": "string",
"process_id": "string",
"contact_id": "string",
"organization_id": "string",
"status": "draft",
"is_guest_registration": true,
"is_transient_guest": true,
"type_id": "string",
"package_id": "string",
"webinar_participant_id": "string",
"webinar_join_url": "string",
"last_modification_date": "2019-08-24T14:15:22Z",
"order_id": "string",
"order_line_item_id": "string",
"order_number": 0,
"order_balance_due": 0,
"order_amount_paid": 0,
"order_currency_code": "string",
"order_currency_symbol": "string",
"order_status": "awaiting payment",
"order_total": 0,
"group_id": "string",
"group_order": 0,
"deadline_id": "string",
"add_membership_package": true,
"membership_information": {"membership_package_id": "string"
},
"badge": {"first_name": "string",
"full_name": "string",
"organization_name": "string",
"job_title": "string",
"location": "string"
},
"sessions": [{"session_id": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": [null
],
"table_value": [{ }
]
}
]
}
],
"courses": [{"course_offering_id": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": [null
],
"table_value": [{ }
]
}
]
}
],
"registrant_acknowledges_scheduling_conflicts": true,
"functions": [{"function_id": "string",
"fee_id": "string",
"number_of_tickets": 0,
"ticket_options": [{"meal_option_id": "string",
"custom_field_values": [null
]
}
]
}
],
"add_ons": [{"add_on_product_id": "string",
"quantity": 1
}
],
"checkin_date": "2019-08-24T14:15:22Z",
"departure_date": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z",
"guests": [{"guest_registration_package_id": "string",
"guest_contact_info": { }
}
],
"parent_registration_id": "string",
"ribbon_ids": ["string"
],
"internal_notes": "string",
"notes": "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 registration could not be found.

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

500General server error.

post/registrations/{tenantId}/batch

Request samples

application/json

{"operations": [{"operation": "create",
"id": "string",
"patch_directives": [{"op": "add",
"path": "string",
"value": "string"
}
],
"object": { },
"payload": {"new_status": "draft",
"suppress_email_notifications": true,
"abstract": {"id": "string",
"event_id": "string",
"main_presenter_id": "string",
"process_id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"review_status": "pending review",
"last_review_status_change": "2019-08-24T14:15:22Z",
"pending_console_review": true,
"submission_space_id": "string",
"override_bucket_assignment": true,
"round_id": "string",
"bucket_id": "string",
"average_score": 0,
"total_score": 0,
"reviewer_recommendation": "string",
"organization_id": "string",
"submitter_id": "string",
"has_co_authors": true,
"co_authors": [{"co_author_contact_info": { },
"co_author_contact_id": "string",
"speaker_type_id": "string"
}
],
"status": "draft",
"session_has_been_generated": true,
"title": "string",
"body": "string",
"type_id": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": [null
],
"table_value": [{ }
]
}
],
"date": "2019-08-24T14:15:22Z",
"session_track_ids": ["string"
],
"number": 0,
"max_contact_submissions": 0,
"submitting_on_behalf_of_presenter": true,
"presenter_info": {"contact_info": { },
"email_presenter": true
},
"review_process_id": "string",
"reviews_assigned": true,
"review_round_id": "string",
"notes": "string",
"approval_process_id": "string",
"round_scores": [{"round_id": "string",
"score": 0
}
],
"co_author_1": {"speaker_type_id": "string",
"first_name": "string",
"last_name": "string",
"email_address": "string",
"phone_number": "string"
},
"co_author_2": {"speaker_type_id": "string",
"first_name": "string",
"last_name": "string",
"email_address": "string",
"phone_number": "string"
},
"co_author_3": {"speaker_type_id": "string",
"first_name": "string",
"last_name": "string",
"email_address": "string",
"phone_number": "string"
},
"co_author_4": {"speaker_type_id": "string",
"first_name": "string",
"last_name": "string",
"email_address": "string",
"phone_number": "string"
},
"co_author_5": {"speaker_type_id": "string",
"first_name": "string",
"last_name": "string",
"email_address": "string",
"phone_number": "string"
},
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
},
"type_id": "string",
"main_presenter_speaker_type_id": "string",
"allow_duplicates": true
}
}
]
}

Response samples

application/json

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