Sessions

Creates a new session record that does not already exist.

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

id required	string (ID) /^[\w\|\-:]+$/ The unique, string identifier of this session
event_id required	string (Event) The event
code	string (Code) Optional code for the event
name required	string (Name) The name of the session
display_order	number <float> (Display Order) The display/sort order for the sessions
type_id required	string (Type) The type of session
track_ids	Array of strings (Tracks) Session tracks
access	string (Access) Who has access to this session Enum: "optional" "included"
hide_from_schedule	boolean (Hide From Schedule) If selected, hide this session from the online schedule
location	string (Location)
enable_capacity	boolean (Enable Capacity) If set, the session has a capacity
required	object (Capacity Options)
sold_out	boolean (Sold Out) Whether the event is sold out
hide_from_portal	boolean (Hide From Portal) This session is not displayed in the portal or available for registration
disable_portal_registration	boolean (Disable Portal Registration) If set, portal registration for this session is disabled
enable_registration_questions	boolean (Enable Registration Questions) If set, a user is prompted to answer questions during registration
required	object (Registration Question Options)
has_fees	boolean (Has Fees) Whether or not this session has fees
room_ids	Array of strings (Rooms) The room which is holding the event
start_date	string <date-time> (Start Date) The start date/time of the session
end_date	string <date-time> (End Date) The end date/time of the session
abstract_id	string (Abstract) The abstract this session is linked to
description	string (Description) A description of the session
	Array of objects
main_presenter_speaker_type_id	string (Main Presenter Speaker Type) The type to be assigned to the main presenter for sessions generated from abstracts
	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 session was saved successfully.

400The session you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

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

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

500General server error.

post/sessions/{tenantId}

Request samples

application/json

{"id": "string",
"event_id": "string",
"code": "string",
"name": "string",
"display_order": 0,
"type_id": "string",
"track_ids": ["string"
],
"access": "optional",
"hide_from_schedule": true,
"location": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0,
"enable_wait_list": true,
"waitlist_process_id": "string"
},
"sold_out": true,
"hide_from_portal": true,
"disable_portal_registration": true,
"enable_registration_questions": true,
"registration_question_options": {"registration_instructions": "string",
"custom_fields": [{"id": "string",
"required": true,
"label": "string"
}
]
},
"has_fees": true,
"room_ids": ["string"
],
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"abstract_id": "string",
"description": "string",
"speakers": [{"speaker_id": "string",
"speaker_type_id": "string"
}
],
"main_presenter_speaker_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": ["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",
"code": "string",
"name": "string",
"display_order": 0,
"type_id": "string",
"track_ids": ["string"
],
"access": "optional",
"hide_from_schedule": true,
"location": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0,
"enable_wait_list": true,
"waitlist_process_id": "string"
},
"sold_out": true,
"hide_from_portal": true,
"disable_portal_registration": true,
"enable_registration_questions": true,
"registration_question_options": {"registration_instructions": "string",
"custom_fields": [{"id": "string",
"required": true,
"label": "string"
}
]
},
"has_fees": true,
"room_ids": ["string"
],
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"abstract_id": "string",
"description": "string",
"speakers": [{"speaker_id": "string",
"speaker_type_id": "string"
}
],
"main_presenter_speaker_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": ["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 session from the system by its ID.

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

400The request was not valid.

401Unauthorized.

403Forbidden.

404The session could not be found.

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

500General server error.

get/sessions/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

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

Response samples

application/json

{"id": "string",
"event_id": "string",
"code": "string",
"name": "string",
"display_order": 0,
"type_id": "string",
"track_ids": ["string"
],
"access": "optional",
"hide_from_schedule": true,
"location": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0,
"enable_wait_list": true,
"waitlist_process_id": "string"
},
"sold_out": true,
"hide_from_portal": true,
"disable_portal_registration": true,
"enable_registration_questions": true,
"registration_question_options": {"registration_instructions": "string",
"custom_fields": [{"id": "string",
"required": true,
"label": "string"
}
]
},
"has_fees": true,
"room_ids": ["string"
],
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"abstract_id": "string",
"description": "string",
"speakers": [{"speaker_id": "string",
"speaker_type_id": "string"
}
],
"main_presenter_speaker_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": ["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 session with the specified ID.

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

Request Body schema: application/json

The updated session that will be saved.

id required	string (ID) /^[\w\|\-:]+$/ The unique, string identifier of this session
event_id required	string (Event) The event
code	string (Code) Optional code for the event
name required	string (Name) The name of the session
display_order	number <float> (Display Order) The display/sort order for the sessions
type_id required	string (Type) The type of session
track_ids	Array of strings (Tracks) Session tracks
access	string (Access) Who has access to this session Enum: "optional" "included"
hide_from_schedule	boolean (Hide From Schedule) If selected, hide this session from the online schedule
location	string (Location)
enable_capacity	boolean (Enable Capacity) If set, the session has a capacity
required	object (Capacity Options)
sold_out	boolean (Sold Out) Whether the event is sold out
hide_from_portal	boolean (Hide From Portal) This session is not displayed in the portal or available for registration
disable_portal_registration	boolean (Disable Portal Registration) If set, portal registration for this session is disabled
enable_registration_questions	boolean (Enable Registration Questions) If set, a user is prompted to answer questions during registration
required	object (Registration Question Options)
has_fees	boolean (Has Fees) Whether or not this session has fees
room_ids	Array of strings (Rooms) The room which is holding the event
start_date	string <date-time> (Start Date) The start date/time of the session
end_date	string <date-time> (End Date) The end date/time of the session
abstract_id	string (Abstract) The abstract this session is linked to
description	string (Description) A description of the session
	Array of objects
main_presenter_speaker_type_id	string (Main Presenter Speaker Type) The type to be assigned to the main presenter for sessions generated from abstracts
	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 session was updated successfully.

400The session supplied was not valid.

401Unauthorized.

403Forbidden.

404The session could not be found.

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

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

500General server error.

put/sessions/{tenantId}/{id}

Request samples

application/json

{"id": "string",
"event_id": "string",
"code": "string",
"name": "string",
"display_order": 0,
"type_id": "string",
"track_ids": ["string"
],
"access": "optional",
"hide_from_schedule": true,
"location": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0,
"enable_wait_list": true,
"waitlist_process_id": "string"
},
"sold_out": true,
"hide_from_portal": true,
"disable_portal_registration": true,
"enable_registration_questions": true,
"registration_question_options": {"registration_instructions": "string",
"custom_fields": [{"id": "string",
"required": true,
"label": "string"
}
]
},
"has_fees": true,
"room_ids": ["string"
],
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"abstract_id": "string",
"description": "string",
"speakers": [{"speaker_id": "string",
"speaker_type_id": "string"
}
],
"main_presenter_speaker_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": ["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",
"code": "string",
"name": "string",
"display_order": 0,
"type_id": "string",
"track_ids": ["string"
],
"access": "optional",
"hide_from_schedule": true,
"location": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0,
"enable_wait_list": true,
"waitlist_process_id": "string"
},
"sold_out": true,
"hide_from_portal": true,
"disable_portal_registration": true,
"enable_registration_questions": true,
"registration_question_options": {"registration_instructions": "string",
"custom_fields": [{"id": "string",
"required": true,
"label": "string"
}
]
},
"has_fees": true,
"room_ids": ["string"
],
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"abstract_id": "string",
"description": "string",
"speakers": [{"speaker_id": "string",
"speaker_type_id": "string"
}
],
"main_presenter_speaker_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": ["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 session with the specified ID.

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

400The JSON patch directive you supplied was not valid.

401Unauthorized.

403Forbidden.

404The session could not be found.

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

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

500General server error.

patch/sessions/{tenantId}/{id}

Request samples

application/json

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

Response samples

application/json

{"id": "string",
"event_id": "string",
"code": "string",
"name": "string",
"display_order": 0,
"type_id": "string",
"track_ids": ["string"
],
"access": "optional",
"hide_from_schedule": true,
"location": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0,
"enable_wait_list": true,
"waitlist_process_id": "string"
},
"sold_out": true,
"hide_from_portal": true,
"disable_portal_registration": true,
"enable_registration_questions": true,
"registration_question_options": {"registration_instructions": "string",
"custom_fields": [{"id": "string",
"required": true,
"label": "string"
}
]
},
"has_fees": true,
"room_ids": ["string"
],
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"abstract_id": "string",
"description": "string",
"speakers": [{"speaker_id": "string",
"speaker_type_id": "string"
}
],
"main_presenter_speaker_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": ["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 session from the system by its ID.

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

Responses

200The session was deleted successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The session could not be found.

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

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

500General server error.

delete/sessions/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

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

Response samples

application/json

"string"

Returns a session from the system by its ID.

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

Request

path Parameters

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

400The request was not valid.

401Unauthorized.

403Forbidden.

404The session could not be found.

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

500General server error.

get/sessions/{tenantId}/public/{id}

Request samples

curl
JavaScript
C#
PHP
Python

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

Response samples

application/json

{"id": "string",
"event_id": "string",
"code": "string",
"name": "string",
"display_order": 0,
"type_id": "string",
"track_ids": ["string"
],
"access": "optional",
"hide_from_schedule": true,
"location": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0,
"enable_wait_list": true,
"waitlist_process_id": "string"
},
"sold_out": true,
"hide_from_portal": true,
"disable_portal_registration": true,
"enable_registration_questions": true,
"registration_question_options": {"registration_instructions": "string",
"custom_fields": [{"id": "string",
"required": true,
"label": "string"
}
]
},
"has_fees": true,
"room_ids": ["string"
],
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"abstract_id": "string",
"description": "string",
"speakers": [{"speaker_id": "string",
"speaker_type_id": "string"
}
],
"main_presenter_speaker_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": ["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 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/sessions/{tenantId}/event/{event_id}

Request samples

curl
JavaScript
C#
PHP
Python

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

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"event_id": "string",
"code": "string",
"name": "string",
"display_order": 0,
"type_id": "string",
"track_ids": ["string"
],
"access": "optional",
"hide_from_schedule": true,
"location": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0,
"enable_wait_list": true,
"waitlist_process_id": "string"
},
"sold_out": true,
"hide_from_portal": true,
"disable_portal_registration": true,
"enable_registration_questions": true,
"registration_question_options": {"registration_instructions": "string",
"custom_fields": [{"id": "string",
"required": true,
"label": "string"
}
]
},
"has_fees": true,
"room_ids": ["string"
],
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"abstract_id": "string",
"description": "string",
"speakers": [{"speaker_id": "string",
"speaker_type_id": "string"
}
],
"main_presenter_speaker_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": ["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"
}

Get Privileges for a session

Returns things a person can do for a session

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
id required	string The session ID
contactId required	string The contact

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/sessions/{tenantId}/privileges/{id}/{contactId}

Request samples

curl
JavaScript
C#
PHP
Python

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

Response samples

application/json

{"can_manage_documents": true,
"can_edit_session": true,
"can_update_speaker_profile": true
}

Searches for sessions 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 session that you would like to be saved.

ids	Array of strings (Ids) IDs to search
name	string (Name)
event_id required	string (Event)
type_id	Array of strings (Type)
track_ids	Array of strings (Tracks)
access	Array of strings (Access)
has_fees	Array of booleans (Has Fees)
start_date	Array of strings <date-time> (Start Date) 2 items
end_date	Array of strings <date-time> (End Date) 2 items
abstract_id	Array of strings (Abstract)
speakers	Array of strings (Speakers)

Responses

200The session search was saved successfully.

400The session you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

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

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

500General server error.

post/sessions/{tenantId}/search

Request samples

application/json

{"ids": ["string"
],
"name": "string",
"event_id": "string",
"type_id": ["string"
],
"track_ids": ["string"
],
"access": ["string"
],
"has_fees": [true
],
"start_date": ["2019-08-24T14:15:22Z",
"2019-08-24T14:15:22Z"
],
"end_date": ["2019-08-24T14:15:22Z",
"2019-08-24T14:15:22Z"
],
"abstract_id": ["string"
],
"speakers": ["string"
]
}

Response samples

application/json

{"Items": [{"id": "string",
"event_id": "string",
"name": "string",
"type_id": "string",
"track_ids": ["string"
],
"access": "optional",
"location": "string",
"enable_capacity": true,
"enable_registration_questions": true,
"has_fees": true,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"abstract_id": "string",
"speakers": [{"speaker_id": "string",
"speaker_type_id": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Searches for sessions using predefined parameters

Request

path Parameters

tenantId

required

string

The id of the tenant being accessed.

query Parameters

exclusiveStartKey	string The start key for the search, for paging support
fieldsToReturn	string The fields that you want to retrieve; if omitted, the entire object is returned

Request Body schema: application/json

The session that you would like to be saved.

ids	Array of strings (Ids) IDs to search
name	string (Name)
event_id required	string (Event)
type_id	Array of strings (Type)
track_ids	Array of strings (Tracks)
access	Array of strings (Access)
has_fees	Array of booleans (Has Fees)
start_date	Array of strings <date-time> (Start Date) 2 items
end_date	Array of strings <date-time> (End Date) 2 items
abstract_id	Array of strings (Abstract)
speakers	Array of strings (Speakers)

Responses

200The session search was saved successfully.

400The session you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

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

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

500General server error.

post/sessions/{tenantId}/public/search

Request samples

application/json

{"ids": ["string"
],
"name": "string",
"event_id": "string",
"type_id": ["string"
],
"track_ids": ["string"
],
"access": ["string"
],
"has_fees": [true
],
"start_date": ["2019-08-24T14:15:22Z",
"2019-08-24T14:15:22Z"
],
"end_date": ["2019-08-24T14:15:22Z",
"2019-08-24T14:15:22Z"
],
"abstract_id": ["string"
],
"speakers": ["string"
]
}

Response samples

application/json

{"Items": [{"id": "string",
"event_id": "string",
"name": "string",
"type_id": "string",
"track_ids": ["string"
],
"access": "optional",
"location": "string",
"enable_capacity": true,
"enable_registration_questions": true,
"has_fees": true,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"abstract_id": "string",
"speakers": [{"speaker_id": "string",
"speaker_type_id": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Describes all of the sessions for an event

Returns a list of records with the specified event_id

Request

path Parameters

tenantId required	string The tenant
event_id required	string The event_id to use to for record lookup

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/sessions/{tenantId}/public/event/{event_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  https://events.api.756794052567.rhythmsoftware.com/sessions/:tenantId/public/event/:event_id

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"event_id": "string",
"code": "string",
"name": "string",
"display_order": 0,
"type_id": "string",
"track_ids": ["string"
],
"access": "optional",
"hide_from_schedule": true,
"location": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0,
"enable_wait_list": true,
"waitlist_process_id": "string"
},
"sold_out": true,
"hide_from_portal": true,
"disable_portal_registration": true,
"enable_registration_questions": true,
"registration_question_options": {"registration_instructions": "string",
"custom_fields": [{"id": "string",
"required": true,
"label": "string"
}
]
},
"has_fees": true,
"room_ids": ["string"
],
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"abstract_id": "string",
"description": "string",
"speakers": [{"speaker_id": "string",
"speaker_type_id": "string"
}
],
"main_presenter_speaker_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": ["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 abstract_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
abstract_id required	string The abstract_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/sessions/{tenantId}/abstract/{abstract_id}

Request samples

curl
JavaScript
C#
PHP
Python

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

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"event_id": "string",
"code": "string",
"name": "string",
"display_order": 0,
"type_id": "string",
"track_ids": ["string"
],
"access": "optional",
"hide_from_schedule": true,
"location": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0,
"enable_wait_list": true,
"waitlist_process_id": "string"
},
"sold_out": true,
"hide_from_portal": true,
"disable_portal_registration": true,
"enable_registration_questions": true,
"registration_question_options": {"registration_instructions": "string",
"custom_fields": [{"id": "string",
"required": true,
"label": "string"
}
]
},
"has_fees": true,
"room_ids": ["string"
],
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"abstract_id": "string",
"description": "string",
"speakers": [{"speaker_id": "string",
"speaker_type_id": "string"
}
],
"main_presenter_speaker_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": ["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"
}

Generate Session from Abstract

Generates a session with speaker information from an abstract record

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
abstract_id required	string The id of the abstract

Request Body schema: application/json

AbstractIDs and FormData for sessions step function

type_id required	string (Type) The type of session to create
main_presenter_speaker_type_id required	string (Main Presenter Speaker Type) The type to be assigned to the main presenter for sessions generated from abstracts
allow_duplicates	boolean (Allow Duplicates) If true, the system will create additional sessions for abstracts

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/sessions/{tenantId}/abstract/{abstract_id}

Request samples

application/json

{"type_id": "string",
"main_presenter_speaker_type_id": "string",
"allow_duplicates": true
}

Response samples

application/json

{"id": "string",
"event_id": "string",
"code": "string",
"name": "string",
"display_order": 0,
"type_id": "string",
"track_ids": ["string"
],
"access": "optional",
"hide_from_schedule": true,
"location": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0,
"enable_wait_list": true,
"waitlist_process_id": "string"
},
"sold_out": true,
"hide_from_portal": true,
"disable_portal_registration": true,
"enable_registration_questions": true,
"registration_question_options": {"registration_instructions": "string",
"custom_fields": [{"id": "string",
"required": true,
"label": "string"
}
]
},
"has_fees": true,
"room_ids": ["string"
],
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"abstract_id": "string",
"description": "string",
"speakers": [{"speaker_id": "string",
"speaker_type_id": "string"
}
],
"main_presenter_speaker_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": ["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"
}
]
}

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 session could not be found.

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

500General server error.

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