Registration Processes

Registration Processes

Creates a new registration process record that does not already exist.

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

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this registration process

name
required
string (Name)

The name of the registration process

event_id
required
string (Event)

The event

description
string (Description)

Description of the process

display_order
number <float> (Display Order)

The order to display

form_id
required
string (Form) /events-registrations__.*/

The registration form

group_registration_form_id
string (Group Registration Form) /events-registrations__.*/

The form to use for group registration

allow_registrants_to_edit_registrations
boolean (Allow Registrants To Edit Registrations)

Whether registrants can edit their registrations

required
object (Edit Registration Options)
allow_registrants_to_cancel_registrations
boolean (Allow Registrants To Cancel Registrations)

Whether registrants can cancel registrations in the portal

deadline_for_cancelling_registrations
string <date-time> (Deadline For Cancelling Registrations)

Deadline for cancelling registrations; if not set, the registration close date is used

object (Guest Registration Options)
enable_online_registration
boolean (Enable Online Registration)

Whether or not this process is available in the portal

required
object (Online Registration Options)
show_contact_form
boolean (Show Contact Form)

Whether or not to show a contact form

required
object (Contact Form Options)
show_organization_form
boolean (Show Organization Form)

Whether or not to show an organization form

required
object (Organization Form Options)
enable_confirmation_email
boolean (Enable Confirmation Email)

Whether or not an email should be sent when the application is received

required
object (Confirmation Email)

The email to send when the application is received

override_checkout_settings
boolean (Override Checkout Settings)

Whether or not to override POC settings

required
object (Checkout Settings)
enable_custom_confirmation_page_html
boolean (Enable Custom Confirmation Page Html)

enable custom text to show on the confirmation page

custom_confirmation_page_html
required
string (Custom Confirmation Page Html)

The custom confirmation page HTML

is_active
boolean (Is Active)

Whether or not this registration process is active

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 process was saved successfully.
400The registration process you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The registration process could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add registration process based on tenant limits.
500General server error.
post/registrationProcesses/{tenantId}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "name": "string",
  • "event_id": "string",
  • "description": "string",
  • "display_order": 0,
  • "form_id": "string",
  • "group_registration_form_id": "string",
  • "allow_registrants_to_edit_registrations": true,
  • "edit_registration_options": {
    },
  • "allow_registrants_to_cancel_registrations": true,
  • "deadline_for_cancelling_registrations": "2019-08-24T14:15:22Z",
  • "guest_registration_options": {
    },
  • "enable_online_registration": true,
  • "online_registration_options": {
    },
  • "show_contact_form": true,
  • "contact_form_options": {
    },
  • "show_organization_form": true,
  • "organization_form_options": {
    },
  • "enable_confirmation_email": true,
  • "confirmation_email": {
    },
  • "override_checkout_settings": true,
  • "checkout_settings": {
    },
  • "enable_custom_confirmation_page_html": true,
  • "custom_confirmation_page_html": "string",
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "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": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "event_id": "string",
  • "description": "string",
  • "display_order": 0,
  • "form_id": "string",
  • "group_registration_form_id": "string",
  • "allow_registrants_to_edit_registrations": true,
  • "edit_registration_options": {
    },
  • "allow_registrants_to_cancel_registrations": true,
  • "deadline_for_cancelling_registrations": "2019-08-24T14:15:22Z",
  • "guest_registration_options": {
    },
  • "enable_online_registration": true,
  • "online_registration_options": {
    },
  • "show_contact_form": true,
  • "contact_form_options": {
    },
  • "show_organization_form": true,
  • "organization_form_options": {
    },
  • "enable_confirmation_email": true,
  • "confirmation_email": {
    },
  • "override_checkout_settings": true,
  • "checkout_settings": {
    },
  • "enable_custom_confirmation_page_html": true,
  • "custom_confirmation_page_html": "string",
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "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": [
    ]
}

Gets all of the registration processes in the system.

This method will scan all registration processes and and return them to the caller.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned.

exclusiveStartKey
string

The start key, if you're making a subsequent request

Responses
200The registration processeswere retrieved successfully.
400The request was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
429Limit exceeded... unable to add contact role based on tenant limits.
500General server error.
get/registrationProcesses/{tenantId}
Request samples
curl -i -X GET \
  'https://events.api.756794052567.rhythmsoftware.com/registrationProcesses/:tenantId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Returns a registration process from the system by its ID.

This method will look up a registration process 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 process 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 process was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The registration process could not be found.
429Limit exceeded... unable to retrieve registration process based on tenant limits.
500General server error.
get/registrationProcesses/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://events.api.756794052567.rhythmsoftware.com/registrationProcesses/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "event_id": "string",
  • "description": "string",
  • "display_order": 0,
  • "form_id": "string",
  • "group_registration_form_id": "string",
  • "allow_registrants_to_edit_registrations": true,
  • "edit_registration_options": {
    },
  • "allow_registrants_to_cancel_registrations": true,
  • "deadline_for_cancelling_registrations": "2019-08-24T14:15:22Z",
  • "guest_registration_options": {
    },
  • "enable_online_registration": true,
  • "online_registration_options": {
    },
  • "show_contact_form": true,
  • "contact_form_options": {
    },
  • "show_organization_form": true,
  • "organization_form_options": {
    },
  • "enable_confirmation_email": true,
  • "confirmation_email": {
    },
  • "override_checkout_settings": true,
  • "checkout_settings": {
    },
  • "enable_custom_confirmation_page_html": true,
  • "custom_confirmation_page_html": "string",
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "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": [
    ]
}

Updates a registration process with the specified ID.

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

Request Body schema: application/json

The updated registration process that will be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this registration process

name
required
string (Name)

The name of the registration process

event_id
required
string (Event)

The event

description
string (Description)

Description of the process

display_order
number <float> (Display Order)

The order to display

form_id
required
string (Form) /events-registrations__.*/

The registration form

group_registration_form_id
string (Group Registration Form) /events-registrations__.*/

The form to use for group registration

allow_registrants_to_edit_registrations
boolean (Allow Registrants To Edit Registrations)

Whether registrants can edit their registrations

required
object (Edit Registration Options)
allow_registrants_to_cancel_registrations
boolean (Allow Registrants To Cancel Registrations)

Whether registrants can cancel registrations in the portal

deadline_for_cancelling_registrations
string <date-time> (Deadline For Cancelling Registrations)

Deadline for cancelling registrations; if not set, the registration close date is used

object (Guest Registration Options)
enable_online_registration
boolean (Enable Online Registration)

Whether or not this process is available in the portal

required
object (Online Registration Options)
show_contact_form
boolean (Show Contact Form)

Whether or not to show a contact form

required
object (Contact Form Options)
show_organization_form
boolean (Show Organization Form)

Whether or not to show an organization form

required
object (Organization Form Options)
enable_confirmation_email
boolean (Enable Confirmation Email)

Whether or not an email should be sent when the application is received

required
object (Confirmation Email)

The email to send when the application is received

override_checkout_settings
boolean (Override Checkout Settings)

Whether or not to override POC settings

required
object (Checkout Settings)
enable_custom_confirmation_page_html
boolean (Enable Custom Confirmation Page Html)

enable custom text to show on the confirmation page

custom_confirmation_page_html
required
string (Custom Confirmation Page Html)

The custom confirmation page HTML

is_active
boolean (Is Active)

Whether or not this registration process is active

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 process was updated successfully.
400The registration process supplied was not valid.
401Unauthorized.
403Forbidden.
404The registration process could not be found.
409The registration process could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve registration process based on tenant limits.
500General server error.
put/registrationProcesses/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "name": "string",
  • "event_id": "string",
  • "description": "string",
  • "display_order": 0,
  • "form_id": "string",
  • "group_registration_form_id": "string",
  • "allow_registrants_to_edit_registrations": true,
  • "edit_registration_options": {
    },
  • "allow_registrants_to_cancel_registrations": true,
  • "deadline_for_cancelling_registrations": "2019-08-24T14:15:22Z",
  • "guest_registration_options": {
    },
  • "enable_online_registration": true,
  • "online_registration_options": {
    },
  • "show_contact_form": true,
  • "contact_form_options": {
    },
  • "show_organization_form": true,
  • "organization_form_options": {
    },
  • "enable_confirmation_email": true,
  • "confirmation_email": {
    },
  • "override_checkout_settings": true,
  • "checkout_settings": {
    },
  • "enable_custom_confirmation_page_html": true,
  • "custom_confirmation_page_html": "string",
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "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": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "event_id": "string",
  • "description": "string",
  • "display_order": 0,
  • "form_id": "string",
  • "group_registration_form_id": "string",
  • "allow_registrants_to_edit_registrations": true,
  • "edit_registration_options": {
    },
  • "allow_registrants_to_cancel_registrations": true,
  • "deadline_for_cancelling_registrations": "2019-08-24T14:15:22Z",
  • "guest_registration_options": {
    },
  • "enable_online_registration": true,
  • "online_registration_options": {
    },
  • "show_contact_form": true,
  • "contact_form_options": {
    },
  • "show_organization_form": true,
  • "organization_form_options": {
    },
  • "enable_confirmation_email": true,
  • "confirmation_email": {
    },
  • "override_checkout_settings": true,
  • "checkout_settings": {
    },
  • "enable_custom_confirmation_page_html": true,
  • "custom_confirmation_page_html": "string",
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "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": [
    ]
}

Partially updates a registration process with the specified ID.

This method will patch an existing registration process 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 process 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 process was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The registration process could not be found.
409The registration process could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve registration process based on tenant limits.
500General server error.
patch/registrationProcesses/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "event_id": "string",
  • "description": "string",
  • "display_order": 0,
  • "form_id": "string",
  • "group_registration_form_id": "string",
  • "allow_registrants_to_edit_registrations": true,
  • "edit_registration_options": {
    },
  • "allow_registrants_to_cancel_registrations": true,
  • "deadline_for_cancelling_registrations": "2019-08-24T14:15:22Z",
  • "guest_registration_options": {
    },
  • "enable_online_registration": true,
  • "online_registration_options": {
    },
  • "show_contact_form": true,
  • "contact_form_options": {
    },
  • "show_organization_form": true,
  • "organization_form_options": {
    },
  • "enable_confirmation_email": true,
  • "confirmation_email": {
    },
  • "override_checkout_settings": true,
  • "checkout_settings": {
    },
  • "enable_custom_confirmation_page_html": true,
  • "custom_confirmation_page_html": "string",
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "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": [
    ]
}

Returns a registration process from the system by its ID.

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

Responses
200The registration process was deleted successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The registration process could not be found.
409The registration process could not be deleted because other objects refers to/depends on this one.
429Limit exceeded... unable to delete registration process based on tenant limits.
500General server error.
delete/registrationProcesses/{tenantId}/{id}
Request samples
curl -i -X DELETE \
  https://events.api.756794052567.rhythmsoftware.com/registrationProcesses/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
"string"

Returns a list of records with the specified event_id

Returns a list of records with the specified event_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

event_id
required
string

The event_id to use to for record lookup

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/registrationProcesses/{tenantId}/event/{event_id}
Request samples
curl -i -X GET \
  'https://events.api.756794052567.rhythmsoftware.com/registrationProcesses/:tenantId/event/:event_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "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 process could not be found.
429Limit exceeded... unable to retrieve registration process based on tenant limits.
500General server error.
post/registrationProcesses/{tenantId}/batch
Request samples
    1 more
    Python
application/json
{
  • "operations": [
    ]
}
Response samples
application/json
{
  • "success_count": 0,
  • "error_count": 0,
  • "results": [
    ]
}