{ "components": { "requestBodies": { "BatchOperationRequest": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationRequest" } } }, "description": "The batch request", "required": true }, "DirectorySearchCriteria": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectorySearchCriteria" } } }, "description": "The query", "required": true }, "PatchDirectiveArray": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/PatchDirective" }, "type": "array" } } }, "description": "The patch directives conforming to RFC 6902.", "required": true }, "PreviewEmailRequest": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewEmailRequest" } } }, "description": "The domain_name to use to for record lookup", "required": true }, "SessionSearchParameters": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionSearchParameters" } } }, "description": "The session that you would like to be saved.", "required": true } }, "schemas": { "Abstract": { "additionalProperties": false, "properties": { "approval_process_id": { "description": "The approval process for this abstract", "title": "Approval Process", "type": "string" }, "average_score": { "description": "The average score for this submission in the most recent round", "format": "float", "title": "Average Score", "type": "number" }, "body": { "description": "The body of the abstract", "title": "Body", "type": "string" }, "bucket_id": { "description": "The review bucket", "title": "Bucket", "type": "string" }, "city": { "description": "The member city", "title": "City", "type": "string" }, "co_author_1": { "additionalProperties": false, "properties": { "email_address": { "description": "Co author email", "title": "Email Address", "type": "string" }, "first_name": { "description": "The first name of the co-author", "title": "First Name", "type": "string" }, "last_name": { "description": "The last name of the co-author", "title": "Last Name", "type": "string" }, "phone_number": { "description": "Preferred phone number of the co author", "title": "Phone Number", "type": "string" }, "speaker_type_id": { "description": "The co author speaker type", "title": "Speaker Type", "type": "string" } }, "title": "Co Author 1", "type": "object" }, "co_author_2": { "additionalProperties": false, "properties": { "email_address": { "description": "Co author email", "title": "Email Address", "type": "string" }, "first_name": { "description": "The first name of the co-author", "title": "First Name", "type": "string" }, "last_name": { "description": "The last name of the co-author", "title": "Last Name", "type": "string" }, "phone_number": { "description": "Preferred phone number of the co author", "title": "Phone Number", "type": "string" }, "speaker_type_id": { "description": "The co author speaker type", "title": "Speaker Type", "type": "string" } }, "title": "Co Author 2", "type": "object" }, "co_author_3": { "additionalProperties": false, "properties": { "email_address": { "description": "Co author email", "title": "Email Address", "type": "string" }, "first_name": { "description": "The first name of the co-author", "title": "First Name", "type": "string" }, "last_name": { "description": "The last name of the co-author", "title": "Last Name", "type": "string" }, "phone_number": { "description": "Preferred phone number of the co author", "title": "Phone Number", "type": "string" }, "speaker_type_id": { "description": "The co author speaker type", "title": "Speaker Type", "type": "string" } }, "title": "Co Author 3", "type": "object" }, "co_author_4": { "additionalProperties": false, "properties": { "email_address": { "description": "Co author email", "title": "Email Address", "type": "string" }, "first_name": { "description": "The first name of the co-author", "title": "First Name", "type": "string" }, "last_name": { "description": "The last name of the co-author", "title": "Last Name", "type": "string" }, "phone_number": { "description": "Preferred phone number of the co author", "title": "Phone Number", "type": "string" }, "speaker_type_id": { "description": "The co author speaker type", "title": "Speaker Type", "type": "string" } }, "title": "Co Author 4", "type": "object" }, "co_author_5": { "additionalProperties": false, "properties": { "email_address": { "description": "Co author email", "title": "Email Address", "type": "string" }, "first_name": { "description": "The first name of the co-author", "title": "First Name", "type": "string" }, "last_name": { "description": "The last name of the co-author", "title": "Last Name", "type": "string" }, "phone_number": { "description": "Preferred phone number of the co author", "title": "Phone Number", "type": "string" }, "speaker_type_id": { "description": "The co author speaker type", "title": "Speaker Type", "type": "string" } }, "title": "Co Author 5", "type": "object" }, "co_authors": { "items": { "additionalProperties": false, "properties": { "co_author_contact_id": { "description": "Contact id for the co-author", "title": "Co Author Contact", "type": "string" }, "co_author_contact_info": { "additionalProperties": false, "description": "The contact info for the coAuthor", "properties": {}, "title": "Co Author Contact Info", "type": "object" }, "speaker_type_id": { "description": "Speaker type for this co-author", "title": "Speaker Type", "type": "string" } }, "type": "object" }, "minItems": 1, "type": "array" }, "country": { "description": "The member country", "title": "Country", "type": "string" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "date": { "description": "The date of abstract submission ", "format": "date-time", "title": "Date", "type": "string" }, "email_address": { "description": "The member's email address", "title": "Email Address", "type": "string" }, "event_id": { "description": "The ID of the event", "title": "Event", "type": "string" }, "first_name": { "description": "The member's first name", "title": "First Name", "type": "string" }, "has_co_authors": { "description": "This abstract has co-authors", "title": "Has Co Authors", "type": "boolean" }, "id": { "description": "The unique, string identifier of this abstract", "pattern": "^[\\w-_:]+$", "title": "ID", "type": "string" }, "job_title": { "description": "The member job title", "title": "Job Title", "type": "string" }, "last_name": { "description": "The member's last name", "title": "Last Name", "type": "string" }, "last_review_status_change": { "description": "The date that the review status was last changed", "format": "date-time", "title": "Last Review Status Change", "type": "string" }, "main_presenter_id": { "description": "Id of the presenter of the abstract", "title": "Main Presenter", "type": "string" }, "max_contact_submissions": { "description": "The max number of abstracts per contact for an event", "format": "float", "title": "Max Contact Submissions", "type": "number" }, "name": { "description": "The member's name", "title": "Name", "type": "string" }, "notes": { "title": "Notes", "type": "string" }, "number": { "description": "The abstract number", "format": "float", "title": "Number", "type": "number" }, "organization_id": { "description": "The organization of the submitter", "title": "Organization", "type": "string" }, "override_bucket_assignment": { "description": "If set, the bucket is not calculated automatically, and instead manually assigned", "title": "Override Bucket Assignment", "type": "boolean" }, "pending_console_review": { "description": "If true, then this record has been reviewed and now needs action by the staff", "title": "Pending Console Review", "type": "boolean" }, "presenter_info": { "additionalProperties": false, "properties": { "contact_info": { "additionalProperties": false, "description": "Rolodex contact information of the presenter", "properties": {}, "title": "Contact Info", "type": "object" }, "email_presenter": { "description": "Email of the presenter, if set email is sent here on submission", "title": "Email Presenter", "type": "boolean" } }, "title": "Presenter Info", "type": "object" }, "process_id": { "description": "The process associated with this abstract", "title": "Process", "type": "string" }, "review_process_id": { "description": "Review process for which this abstract is assigned", "title": "Review Process", "type": "string" }, "review_round_id": { "description": "Current review round for this abstract", "title": "Review Round", "type": "string" }, "review_status": { "description": "The review status of this application", "enum": [ "accepted", "alternate", "declined", "pending review" ], "title": "Review Status", "type": "string" }, "reviewer_recommendation": { "description": "Aggregate recommendation across all reviewers", "title": "Reviewer Recommendation", "type": "string" }, "reviews_assigned": { "description": "Have reviews been assigned for this abstract", "title": "Reviews Assigned", "type": "boolean" }, "room_ids": { "description": "The room(s) where the function is located", "items": { "type": "string" }, "title": "Rooms", "type": "array" }, "round_id": { "description": "The review round", "title": "Round", "type": "string" }, "round_scores": { "items": { "additionalProperties": false, "properties": { "round_id": { "description": "The review round for this score", "title": "Round", "type": "string" }, "score": { "description": "The total score across all completed reviews", "format": "float", "title": "Score", "type": "number" } }, "required": [ "round_id", "score" ], "type": "object" }, "type": "array" }, "session_has_been_generated": { "description": "Boolean flag indicating whether or not a session has been been generated for this abstract", "title": "Session Has Been Generated", "type": "boolean" }, "session_track_ids": { "description": "Session tracks associations for the abstract", "items": { "type": "string" }, "title": "Session Tracks", "type": "array" }, "state": { "description": "The state", "title": "State", "type": "string" }, "status": { "enum": [ "accepted", "alternate", "approved/accepted by presenter", "approved/declined by presenter", "approved/pending presenter acceptance", "confirmed", "declined", "draft", "more information needed", "submitted", "under review", "withdrawn" ], "title": "Status", "type": "string" }, "submission_space_id": { "description": "The submission space to which this object belongs", "title": "Submission Space", "type": "string" }, "submitter_id": { "description": "Id of the contact that submitted the abstract", "title": "Submitter", "type": "string" }, "submitting_on_behalf_of_presenter": { "description": "Bool that identifies if the submitter is different than the presenter", "title": "Submitting On Behalf Of Presenter", "type": "boolean" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" }, "title": { "description": "The title of the abstract", "title": "Title", "type": "string" }, "total_score": { "description": "The total score for this submission in the most recent round", "format": "float", "title": "Total Score", "type": "number" }, "type_id": { "description": "The id for the type of abstract", "title": "Type", "type": "string" } }, "required": [ "body", "bucket_id", "co_authors", "event_id", "id", "name", "presenter_info", "review_round_id", "status", "submitter_id", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id", "title", "type_id" ], "type": "object" }, "AbstractApprovalProcess": { "additionalProperties": false, "properties": { "acceptance_notification_email": { "additionalProperties": false, "description": "The email to send when the abstract is received", "properties": { "bcc": { "description": "Anyone that should be bcc'ed on the email", "title": "Bcc", "type": "string" }, "body": { "description": "The email body", "title": "Body", "type": "string" }, "cc": { "description": "Anyone that should be cc'ed on the email", "title": "Cc", "type": "string" }, "from": { "description": "From email address", "title": "From", "type": "string" }, "from_name": { "description": "From name", "title": "From Name", "type": "string" }, "reply_to": { "description": "The reply to", "title": "Reply To", "type": "string" }, "subject": { "description": "The email subject", "title": "Subject", "type": "string" } }, "required": [ "body", "subject" ], "title": "Acceptance Notification Email", "type": "object" }, "approval_form_id": { "description": "Form shown to the presenter when they approve", "title": "Approval Form", "type": "string" }, "approval_notification_email": { "additionalProperties": false, "description": "The email to send when the abstract is received", "properties": { "bcc": { "description": "Anyone that should be bcc'ed on the email", "title": "Bcc", "type": "string" }, "body": { "description": "The email body", "title": "Body", "type": "string" }, "cc": { "description": "Anyone that should be cc'ed on the email", "title": "Cc", "type": "string" }, "from": { "description": "From email address", "title": "From", "type": "string" }, "from_name": { "description": "From name", "title": "From Name", "type": "string" }, "reply_to": { "description": "The reply to", "title": "Reply To", "type": "string" }, "subject": { "description": "The email subject", "title": "Subject", "type": "string" } }, "required": [ "body", "subject" ], "title": "Approval Notification Email", "type": "object" }, "decline_notification_email": { "additionalProperties": false, "description": "The email to send when the abstract is received", "properties": { "bcc": { "description": "Anyone that should be bcc'ed on the email", "title": "Bcc", "type": "string" }, "body": { "description": "The email body", "title": "Body", "type": "string" }, "cc": { "description": "Anyone that should be cc'ed on the email", "title": "Cc", "type": "string" }, "from": { "description": "From email address", "title": "From", "type": "string" }, "from_name": { "description": "From name", "title": "From Name", "type": "string" }, "reply_to": { "description": "The reply to", "title": "Reply To", "type": "string" }, "subject": { "description": "The email subject", "title": "Subject", "type": "string" } }, "required": [ "body", "subject" ], "title": "Decline Notification Email", "type": "object" }, "enable_acceptance_notification_email": { "description": "Whether or not an email should be sent when the abstract is accepted by the presenter", "title": "Enable Acceptance Notification Email", "type": "boolean" }, "enable_approval_notification_email": { "description": "Whether or not an email should be sent when the abstract is approved", "title": "Enable Approval Notification Email", "type": "boolean" }, "enable_decline_notification_email": { "description": "Whether or not an email should be sent when the abstract is declined", "title": "Enable Decline Notification Email", "type": "boolean" }, "enable_presenter_decline_email": { "description": "Whether or not an email should be sent when the abstract is approved but declined by the presenter", "title": "Enable Presenter Decline Email", "type": "boolean" }, "event_id": { "description": "ID for the event associated with this process", "title": "Event", "type": "string" }, "id": { "description": "The unique, string identifier of this abstract approval process", "pattern": "^[\\w-_:]+$", "title": "ID", "type": "string" }, "is_active": { "description": "Whether or not this abstract approval process is active", "title": "Is Active", "type": "boolean" }, "name": { "description": "The name of the abstract approval process", "title": "Name", "type": "string" }, "presenter_decline_email": { "additionalProperties": false, "description": "The email to send when the abstract is received", "properties": { "bcc": { "description": "Anyone that should be bcc'ed on the email", "title": "Bcc", "type": "string" }, "body": { "description": "The email body", "title": "Body", "type": "string" }, "cc": { "description": "Anyone that should be cc'ed on the email", "title": "Cc", "type": "string" }, "from": { "description": "From email address", "title": "From", "type": "string" }, "from_name": { "description": "From name", "title": "From Name", "type": "string" }, "reply_to": { "description": "The reply to", "title": "Reply To", "type": "string" }, "subject": { "description": "The email subject", "title": "Subject", "type": "string" } }, "required": [ "body", "subject" ], "title": "Presenter Decline Email", "type": "object" }, "presenter_decline_form_id": { "description": "Form shown to those who decline. If not selected, the accept form is used", "title": "Presenter Decline Form", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" }, "visible_in_portal": { "description": "Should we show this process in the portal", "title": "Visible In Portal", "type": "boolean" } }, "required": [ "acceptance_notification_email", "approval_form_id", "approval_notification_email", "decline_notification_email", "event_id", "id", "name", "presenter_decline_email", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "AbstractDecisionProcess": { "additionalProperties": false, "properties": { "acceptance_form_options": { "additionalProperties": false, "properties": { "acceptance_form_id": { "description": "The default contact form to present to the user to verify the contact info before proceeding", "pattern": "^rolodex-contacts__.*", "title": "Acceptance Form", "type": "string" }, "html": { "description": "Text to show on the top of the form", "title": "Html", "type": "string" } }, "required": [ "acceptance_form_id" ], "title": "Acceptance Form Options", "type": "object" }, "confirmation_email": { "additionalProperties": false, "description": "The email to send when the application is received", "properties": { "bcc": { "description": "Anyone that should be bcc'ed on the email", "title": "Bcc", "type": "string" }, "body": { "description": "The email body", "title": "Body", "type": "string" }, "cc": { "description": "Anyone that should be cc'ed on the email", "title": "Cc", "type": "string" }, "from": { "description": "From email address", "title": "From", "type": "string" }, "from_name": { "description": "From name", "title": "From Name", "type": "string" }, "reply_to": { "description": "The reply to", "title": "Reply To", "type": "string" }, "subject": { "description": "The email subject", "title": "Subject", "type": "string" } }, "required": [ "body", "subject" ], "title": "Confirmation Email", "type": "object" }, "contact_form_options": { "additionalProperties": false, "properties": { "contact_form_id": { "description": "The default contact form to present to the user to verify the contact info before proceeding", "pattern": "^rolodex-contacts__.*", "title": "Contact Form", "type": "string" }, "html": { "description": "Text to show on the top of the form", "title": "Html", "type": "string" } }, "required": [ "contact_form_id" ], "title": "Contact Form Options", "type": "object" }, "declined_email": { "additionalProperties": false, "description": "The email to send when the application is received", "properties": { "bcc": { "description": "Anyone that should be bcc'ed on the email", "title": "Bcc", "type": "string" }, "body": { "description": "The email body", "title": "Body", "type": "string" }, "cc": { "description": "Anyone that should be cc'ed on the email", "title": "Cc", "type": "string" }, "from": { "description": "From email address", "title": "From", "type": "string" }, "from_name": { "description": "From name", "title": "From Name", "type": "string" }, "reply_to": { "description": "The reply to", "title": "Reply To", "type": "string" }, "subject": { "description": "The email subject", "title": "Subject", "type": "string" } }, "required": [ "body", "subject" ], "title": "Declined Email", "type": "object" }, "enable_confirmation_email": { "description": "Whether or not an email should be sent when the application is received", "title": "Enable Confirmation Email", "type": "boolean" }, "enable_declined_email": { "description": "Whether or not an email should be sent when the application is received", "title": "Enable Declined Email", "type": "boolean" }, "enable_selection_email": { "description": "Whether or not an email should be sent when the application is received", "title": "Enable Selection Email", "type": "boolean" }, "event_id": { "description": "Event Id that to which this process belongs", "title": "Event", "type": "string" }, "id": { "description": "The unique, string identifier of this abstract decision process", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "name": { "description": "The name of the abstract decision process", "title": "Name", "type": "string" }, "organization_form_options": { "additionalProperties": false, "properties": { "html": { "description": "Text to show on the top of the form", "title": "Html", "type": "string" }, "organization_form_id": { "description": "The default organization form to present to the user to verify the organization info before proceeding", "pattern": "^rolodex-organizations__.*", "title": "Organization Form", "type": "string" } }, "required": [ "organization_form_id" ], "title": "Organization Form Options", "type": "object" }, "selection_email": { "additionalProperties": false, "description": "The email to send when the application is received", "properties": { "bcc": { "description": "Anyone that should be bcc'ed on the email", "title": "Bcc", "type": "string" }, "body": { "description": "The email body", "title": "Body", "type": "string" }, "cc": { "description": "Anyone that should be cc'ed on the email", "title": "Cc", "type": "string" }, "from": { "description": "From email address", "title": "From", "type": "string" }, "from_name": { "description": "From name", "title": "From Name", "type": "string" }, "reply_to": { "description": "The reply to", "title": "Reply To", "type": "string" }, "subject": { "description": "The email subject", "title": "Subject", "type": "string" } }, "required": [ "body", "subject" ], "title": "Selection Email", "type": "object" }, "show_contact_form": { "description": "Weather to show a contact form", "title": "Show Contact Form", "type": "boolean" }, "show_organization_form": { "description": "Whether or not to show an organization form", "title": "Show Organization Form", "type": "boolean" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "confirmation_email", "contact_form_options", "declined_email", "event_id", "id", "name", "organization_form_options", "selection_email", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "AbstractReview": { "additionalProperties": false, "properties": { "abstract_id": { "description": "Abstract associated to this review", "title": "Abstract", "type": "string" }, "abstract_title": { "description": "The title of the abstract", "title": "Abstract Title", "type": "string" }, "assignee": { "additionalProperties": false, "description": "User who to which the review has been assigned", "properties": { "city": { "description": "The member city", "title": "City", "type": "string" }, "committee_ids": { "items": { "type": "string" }, "title": "Committees", "type": "array" }, "committee_membership_ids": { "items": { "type": "string" }, "title": "Committee Memberships", "type": "array" }, "contact_id": { "title": "Contact", "type": "string" }, "country": { "description": "The member country", "title": "Country", "type": "string" }, "email_address": { "description": "The member's email address", "title": "Email Address", "type": "string" }, "first_name": { "description": "The member's first name", "title": "First Name", "type": "string" }, "job_title": { "description": "The member job title", "title": "Job Title", "type": "string" }, "last_name": { "description": "The member's last name", "title": "Last Name", "type": "string" }, "name": { "description": "The member's name", "title": "Name", "type": "string" }, "state": { "description": "The state", "title": "State", "type": "string" } }, "required": [ "contact_id", "name" ], "title": "Assignee", "type": "object" }, "comments_to_staff": { "description": "Comments displayed to the association staff", "title": "Comments To Staff", "type": "string" }, "comments_to_submitter": { "description": "Comments displayed to abstract submitter", "title": "Comments To Submitter", "type": "string" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "date": { "description": "The date the review was generated", "format": "date-time", "title": "Date", "type": "string" }, "event_id": { "description": "ID associating the review to the event", "title": "Event", "type": "string" }, "id": { "description": "The unique, string identifier of this abstract review", "pattern": "^[\\w-_:]+$", "title": "ID", "type": "string" }, "is_active": { "description": "Whether or not this abstract review is active", "title": "Is Active", "type": "boolean" }, "process_id": { "description": "ID of review process", "title": "Process", "type": "string" }, "review_round_id": { "description": "ID of review round", "title": "Review Round", "type": "string" }, "score": { "description": "The score for this review", "format": "float", "title": "Score", "type": "number" }, "status": { "description": "Status for this review: not started, draft, completed", "enum": [ "completed", "draft", "not started" ], "title": "Status", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "abstract_id", "abstract_title", "assignee", "event_id", "id", "process_id", "review_round_id", "status", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "AbstractReviewProcess": { "additionalProperties": false, "properties": { "administrators": { "items": { "additionalProperties": false, "properties": { "committee_id": { "description": "Rolodex Contact ID for an administrator for this review", "title": "Committee", "type": "string" }, "committee_position_ids": { "description": "Array of position ids for the committee", "items": { "type": "string" }, "title": "Committee Positions", "type": "array" } }, "required": [ "committee_id" ], "type": "object" }, "type": "array" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "enable_abstract_administrators": { "description": "Should have allow abstract administrators", "title": "Enable Abstract Administrators", "type": "boolean" }, "enable_review_assignment_email": { "description": "Whether or not an email should be sent when the application is received", "title": "Enable Review Assignment Email", "type": "boolean" }, "enable_review_submission_confirmation_email": { "description": "Whether or not an email should be sent when the application is received", "title": "Enable Review Submission Confirmation Email", "type": "boolean" }, "event_id": { "description": "ID for the event associated with this process", "title": "Event", "type": "string" }, "id": { "description": "The unique, string identifier of this abstract review process", "pattern": "^[\\w-_:]+$", "title": "ID", "type": "string" }, "is_active": { "description": "Whether or not this abstract review process is active", "title": "Is Active", "type": "boolean" }, "name": { "description": "The name of the abstract review process", "title": "Name", "type": "string" }, "review_assignment_email": { "additionalProperties": false, "description": "The email to send when the application is received", "properties": { "bcc": { "description": "Anyone that should be bcc'ed on the email", "title": "Bcc", "type": "string" }, "body": { "description": "The email body", "title": "Body", "type": "string" }, "cc": { "description": "Anyone that should be cc'ed on the email", "title": "Cc", "type": "string" }, "from": { "description": "From email address", "title": "From", "type": "string" }, "from_name": { "description": "From name", "title": "From Name", "type": "string" }, "reply_to": { "description": "The reply to", "title": "Reply To", "type": "string" }, "subject": { "description": "The email subject", "title": "Subject", "type": "string" } }, "required": [ "body", "subject" ], "title": "Review Assignment Email", "type": "object" }, "review_submission_confirmation_email": { "additionalProperties": false, "description": "The email to send when the application is received", "properties": { "bcc": { "description": "Anyone that should be bcc'ed on the email", "title": "Bcc", "type": "string" }, "body": { "description": "The email body", "title": "Body", "type": "string" }, "cc": { "description": "Anyone that should be cc'ed on the email", "title": "Cc", "type": "string" }, "from": { "description": "From email address", "title": "From", "type": "string" }, "from_name": { "description": "From name", "title": "From Name", "type": "string" }, "reply_to": { "description": "The reply to", "title": "Reply To", "type": "string" }, "subject": { "description": "The email subject", "title": "Subject", "type": "string" } }, "required": [ "body", "subject" ], "title": "Review Submission Confirmation Email", "type": "object" }, "rounds": { "items": { "additionalProperties": false, "properties": { "round_id": { "description": "ID of the round", "title": "Round", "type": "string" } }, "required": [ "round_id" ], "type": "object" }, "type": "array" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "administrators", "event_id", "id", "name", "review_assignment_email", "review_submission_confirmation_email", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "AbstractReviewRound": { "additionalProperties": false, "properties": { "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "date": { "description": "The date the round was created", "format": "date-time", "title": "Date", "type": "string" }, "display_order": { "description": "Sequential number order for the rounds", "format": "float", "title": "Display Order", "type": "number" }, "enable_blind_review": { "description": "Flag to indicate of review should be blind", "title": "Enable Blind Review", "type": "boolean" }, "enable_review_assignment_rules": { "description": "Flag for setting if assignment rules apply to round", "title": "Enable Review Assignment Rules", "type": "boolean" }, "error_info": { "additionalProperties": false, "description": "The body of the error", "properties": {}, "title": "Error Info", "type": "object" }, "event_id": { "description": "Event associated with this review round", "title": "Event", "type": "string" }, "id": { "description": "The unique, string identifier of this abstract review round", "pattern": "^[\\w-_:]+$", "title": "ID", "type": "string" }, "is_active": { "description": "Whether or not this abstract review round is active", "title": "Is Active", "type": "boolean" }, "name": { "description": "The name of the abstract review round", "title": "Name", "type": "string" }, "process_id": { "description": "The process associated with this round", "title": "Process", "type": "string" }, "review_assignment_rules": { "items": { "additionalProperties": false, "properties": { "display_order": { "description": "The order in which the rules are to be matched", "format": "float", "title": "Display Order", "type": "number" }, "matching_conditions": { "title": "Matching Conditions", "type": "object" }, "name": { "description": "Description of the assignment rule", "title": "Name", "type": "string" }, "targets": { "items": { "additionalProperties": false, "properties": { "committee_id": { "description": "The committee that will review the abstract", "oneOf": [ { "x-required": true } ], "title": "Committee", "type": "string" }, "committee_member_id": { "description": "The committee member that will review the abstract", "oneOf": [ { "x-required": true } ], "title": "Committee Member", "type": "string" }, "committee_position_id": { "description": "The optional committee position; if excluded, all members on the committee are assigned", "title": "Committee Position", "type": "string" }, "contact_id": { "description": "The contact that will review the abstract", "oneOf": [ { "x-required": true } ], "title": "Contact", "type": "string" }, "type": { "enum": [ "committee", "committee member", "contact" ], "title": "Type", "type": "string" } }, "required": [ "type" ], "type": "object" }, "type": "array" } }, "required": [ "matching_conditions", "name" ], "type": "object" }, "type": "array" }, "review_form_id": { "description": "Platform Webform for the Review Round", "title": "Review Form", "type": "string" }, "status": { "description": "The status of the abstract review round. This informs the UI", "enum": [ "closed", "error", "never opened", "open", "opening" ], "title": "Status", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "enable_review_assignment_rules", "event_id", "id", "name", "process_id", "review_assignment_rules", "review_form_id", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "AbstractReviewSearchParameters": { "additionalProperties": false, "properties": { "abstract_title": { "title": "Abstract Title", "type": "string" }, "assignee": { "additionalProperties": false, "properties": { "city": { "description": "The member city", "title": "City", "type": "string" }, "contact_id": { "title": "Contact", "type": "string" }, "country": { "description": "The member country", "title": "Country", "type": "string" }, "email_address": { "description": "The member's email address", "title": "Email Address", "type": "string" }, "first_name": { "description": "The member's first name", "title": "First Name", "type": "string" }, "job_title": { "description": "The member job title", "title": "Job Title", "type": "string" }, "last_name": { "description": "The member's last name", "title": "Last Name", "type": "string" }, "name": { "description": "The member's name", "title": "Name", "type": "string" }, "state": { "description": "The state", "title": "State", "type": "string" } }, "required": [ "name" ], "title": "Assignee", "type": "object" }, "date": { "items": { "format": "date-time", "type": "string" }, "maxItems": 2, "minItems": 2, "title": "Date", "type": "array" }, "event_id": { "title": "Event", "type": "string" }, "id": { "title": "ID", "type": "string" }, "processes": { "items": { "type": "string" }, "title": "Processes", "type": "array" }, "status": { "title": "Status", "type": "string" } }, "required": [ "assignee", "event_id" ], "type": "object" }, "AbstractReviewSearchResults": { "additionalProperties": false, "properties": { "abstract_id": { "title": "Abstract", "type": "string" }, "abstract_title": { "title": "Abstract Title", "type": "string" }, "assignee": { "additionalProperties": false, "properties": { "city": { "description": "The member city", "title": "City", "type": "string" }, "contact_id": { "title": "Contact", "type": "string" }, "country": { "description": "The member country", "title": "Country", "type": "string" }, "email_address": { "description": "The member's email address", "title": "Email Address", "type": "string" }, "first_name": { "description": "The member's first name", "title": "First Name", "type": "string" }, "job_title": { "description": "The member job title", "title": "Job Title", "type": "string" }, "last_name": { "description": "The member's last name", "title": "Last Name", "type": "string" }, "name": { "description": "The member's name", "title": "Name", "type": "string" }, "state": { "description": "The state", "title": "State", "type": "string" } }, "required": [ "name" ], "title": "Assignee", "type": "object" }, "date": { "items": { "format": "date-time", "type": "string" }, "maxItems": 2, "minItems": 2, "title": "Date", "type": "array" }, "event_id": { "description": "The event", "title": "Event", "type": "string" }, "id": { "description": "The unique, string identifier of this speaker profile", "title": "ID", "type": "string" }, "process_id": { "title": "Process", "type": "string" }, "status": { "title": "Status", "type": "string" } }, "required": [ "event_id" ], "type": "object" }, "AbstractSearchParameters": { "additionalProperties": false, "properties": { "body": { "title": "Body", "type": "string" }, "city": { "description": "The member city", "title": "City", "type": "string" }, "co_author_ids": { "title": "Co Authors", "type": "string" }, "country": { "description": "The member country", "title": "Country", "type": "string" }, "date": { "items": { "format": "date-time", "type": "string" }, "maxItems": 2, "minItems": 2, "title": "Date", "type": "array" }, "email_address": { "description": "The member's email address", "title": "Email Address", "type": "string" }, "event_id": { "title": "Event", "type": "string" }, "first_name": { "description": "The member's first name", "title": "First Name", "type": "string" }, "id": { "title": "ID", "type": "string" }, "job_title": { "description": "The member job title", "title": "Job Title", "type": "string" }, "last_name": { "description": "The member's last name", "title": "Last Name", "type": "string" }, "name": { "description": "The member's name", "title": "Name", "type": "string" }, "state": { "description": "The state", "title": "State", "type": "string" }, "status": { "title": "Status", "type": "string" }, "title": { "title": "Title", "type": "string" }, "type_id": { "items": { "type": "string" }, "title": "Type", "type": "array" } }, "required": [ "event_id", "name" ], "type": "object" }, "AbstractSearchResults": { "additionalProperties": false, "properties": { "city": { "description": "The member city", "title": "City", "type": "string" }, "country": { "description": "The member country", "title": "Country", "type": "string" }, "date": { "items": { "format": "date-time", "type": "string" }, "maxItems": 2, "minItems": 2, "title": "Date", "type": "array" }, "email_address": { "description": "The member's email address", "title": "Email Address", "type": "string" }, "event_id": { "description": "The event", "title": "Event", "type": "string" }, "first_name": { "description": "The member's first name", "title": "First Name", "type": "string" }, "id": { "description": "The unique, string identifier of this speaker profile", "title": "ID", "type": "string" }, "job_title": { "description": "The member job title", "title": "Job Title", "type": "string" }, "last_name": { "description": "The member's last name", "title": "Last Name", "type": "string" }, "name": { "description": "The member's name", "title": "Name", "type": "string" }, "round_scores": { "description": "The calculated score payload", "items": { "additionalProperties": false, "properties": { "round_id": { "title": "Round", "type": "string" }, "score": { "title": "Score", "type": "string" } }, "type": "object" }, "type": "array" }, "state": { "description": "The state", "title": "State", "type": "string" }, "status": { "title": "Status", "type": "string" }, "title": { "title": "Title", "type": "string" } }, "required": [ "event_id", "name" ], "type": "object" }, "AbstractSetting": { "additionalProperties": false, "properties": { "abstract_instructions": { "description": "Show instructions to those submitting abstracts", "title": "Abstract Instructions", "type": "string" }, "abstract_submission_options": { "additionalProperties": false, "properties": { "close_date": { "description": "The close date for abstract submission", "format": "date-time", "title": "Close Date", "type": "string" }, "open_date": { "description": "The open date for abstract submission", "format": "date-time", "title": "Open Date", "type": "string" } }, "required": [ "close_date", "open_date" ], "title": "Abstract Submission Options", "type": "object" }, "allow_presenters_to_manage_documents": { "description": "If true, presents can manage documents", "title": "Allow Presenters To Manage Documents", "type": "boolean" }, "allow_presenters_to_modify_their_sessions": { "description": "If true, presenters are able to modify their session", "title": "Allow Presenters To Modify Their Sessions", "type": "boolean" }, "allow_speakers_to_modify_their_profiles": { "description": "If true, speakers can modify their profile information", "title": "Allow Speakers To Modify Their Profiles", "type": "boolean" }, "document_management_options": { "additionalProperties": false, "properties": { "deadline": { "description": "The deadline after which managing documents is no longer possible", "format": "date-time", "title": "Deadline", "type": "string" }, "include_co_presenters": { "description": "If true, co-authors can change manage documents along with the presenter", "title": "Include Co Presenters", "type": "boolean" } }, "required": [ "deadline" ], "title": "Document Management Options", "type": "object" }, "enable_hide_status": { "description": "Whether or not to hide abstract status in portal", "title": "Enable Hide Status", "type": "boolean" }, "enable_online_abstract_submission": { "description": "Whether or not abstract submission is enabled", "title": "Enable Online Abstract Submission", "type": "boolean" }, "id": { "description": "The unique, string identifier of this abstract settings", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "notes": { "title": "Notes", "type": "string" }, "presenter_instructions": { "description": "Show instructions to those presenters", "title": "Presenter Instructions", "type": "string" }, "session_modification_options": { "additionalProperties": false, "properties": { "deadline": { "description": "The deadline after which session modification is no longer possible", "format": "date-time", "title": "Deadline", "type": "string" }, "include_co_presenters": { "description": "If true, co-authors can change the session along with the presenter", "title": "Include Co Presenters", "type": "boolean" }, "session_form_id": { "description": "The form that should be shown to those looking to modify sessions in the portal", "pattern": "events-sessions__", "title": "Session Form", "type": "string" } }, "required": [ "deadline", "session_form_id" ], "title": "Session Modification Options", "type": "object" }, "show_status_date": { "description": "The date to show abstract status in the portal", "format": "date-time", "title": "Show Status Date", "type": "string" }, "speaker_profile_modification_options": { "additionalProperties": false, "properties": { "deadline": { "description": "The deadline after which you cannot change the speaker bio", "format": "date-time", "title": "Deadline", "type": "string" } }, "required": [ "deadline" ], "title": "Speaker Profile Modification Options", "type": "object" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "abstract_submission_options", "document_management_options", "id", "session_modification_options", "show_status_date", "speaker_profile_modification_options", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "AbstractSubmissionProcess": { "additionalProperties": false, "properties": { "confirmation_email": { "additionalProperties": false, "description": "The email to send when the application is received", "properties": { "bcc": { "description": "Anyone that should be bcc'ed on the email", "title": "Bcc", "type": "string" }, "body": { "description": "The email body", "title": "Body", "type": "string" }, "cc": { "description": "Anyone that should be cc'ed on the email", "title": "Cc", "type": "string" }, "from": { "description": "From email address", "title": "From", "type": "string" }, "from_name": { "description": "From name", "title": "From Name", "type": "string" }, "reply_to": { "description": "The reply to", "title": "Reply To", "type": "string" }, "subject": { "description": "The email subject", "title": "Subject", "type": "string" } }, "required": [ "body", "subject" ], "title": "Confirmation Email", "type": "object" }, "contact_form_options": { "additionalProperties": false, "properties": { "contact_form_id": { "description": "The default contact form to present to the user to verify the contact info before proceeding", "pattern": "^rolodex-contacts__.*", "title": "Contact Form", "type": "string" }, "html": { "description": "Text to show on the top of the form", "title": "Html", "type": "string" } }, "required": [ "contact_form_id" ], "title": "Contact Form Options", "type": "object" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "display_order": { "description": "Order to display the submission processes in", "format": "float", "title": "Display Order", "type": "number" }, "enable_confirmation_email": { "description": "Whether or not an email should be sent when the application is received", "title": "Enable Confirmation Email", "type": "boolean" }, "event_id": { "description": "The event", "title": "Event", "type": "string" }, "id": { "description": "The unique, string identifier of this abstract submission process", "pattern": "^[\\w-_:]+$", "title": "ID", "type": "string" }, "is_active": { "description": "Whether or not this abstract submission process is active", "title": "Is Active", "type": "boolean" }, "max_contact_submissions": { "description": "The maximum number of submission per contact", "format": "float", "title": "Max Contact Submissions", "type": "number" }, "max_word_count": { "description": "Maximum number of words allowed to be input into the body field in the abstract form", "format": "float", "title": "Max Word Count", "type": "number" }, "maximum_number_of_co_authors": { "description": "The maximum # of co-authors", "format": "float", "title": "Maximum Number Of Co Authors", "type": "number" }, "maximum_number_of_session_tracks": { "description": "The maximum number of session tracks that an abstract can be submitted for", "format": "float", "title": "Maximum Number Of Session Tracks", "type": "number" }, "name": { "description": "Name of the process", "title": "Name", "type": "string" }, "organization_form_options": { "additionalProperties": false, "properties": { "html": { "description": "Text to show on the top of the form", "title": "Html", "type": "string" }, "organization_form_id": { "description": "The default organization form to present to the user to verify the organization info before proceeding", "pattern": "^rolodex-organizations__.*", "title": "Organization Form", "type": "string" } }, "required": [ "organization_form_id" ], "title": "Organization Form Options", "type": "object" }, "presenter_quick_add_options": { "additionalProperties": false, "description": "UI options for how to add the abstract submitter", "properties": {}, "title": "Presenter Quick Add Options", "type": "object" }, "quick_add_contact_options": { "additionalProperties": false, "description": "UI options for how the add co-authors should function", "properties": {}, "title": "Quick Add Contact Options", "type": "object" }, "show_contact_form": { "description": "Whether or not to show an organization form. Boolean value for showing", "title": "Show Contact Form", "type": "boolean" }, "show_in_portal": { "description": "Should show in portal", "title": "Show In Portal", "type": "boolean" }, "show_organization_form": { "description": "Whether or not to show an organization form", "title": "Show Organization Form", "type": "boolean" }, "submission_form_id": { "description": "The registration form", "pattern": "events-abstracts__.*", "title": "Submission Form", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "confirmation_email", "contact_form_options", "event_id", "id", "name", "organization_form_options", "submission_form_id", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "AbstractType": { "additionalProperties": false, "properties": { "approval_process_id": { "description": "The approval process id", "title": "Approval Process", "type": "string" }, "display_order": { "description": "The order of the abstract type", "format": "float", "title": "Display Order", "type": "number" }, "event_id": { "description": "The event id the abstract is associated with", "title": "Event", "type": "string" }, "hide_from_portal": { "description": "Hide this type from the portal", "title": "Hide From Portal", "type": "boolean" }, "id": { "description": "The unique, string identifier of this abstract type", "pattern": "^[\\w-_:]+$", "title": "ID", "type": "string" }, "is_active": { "description": "Whether or not this abstract type is active", "title": "Is Active", "type": "boolean" }, "name": { "description": "The name of the events abstract type", "title": "Name", "type": "string" }, "notes": { "description": "Notes for abstrac types", "title": "Notes", "type": "string" }, "review_process_id": { "description": "The review process id", "title": "Review Process", "type": "string" }, "submission_process_id": { "description": "The submission process id", "title": "Submission Process", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "event_id", "id", "name", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "Address": { "additionalProperties": false, "description": "A complete address", "properties": { "city": { "description": "The city of the address", "title": "City", "type": "string" }, "country": { "description": "The country ISO code", "title": "Country", "type": "string" }, "country_name": { "description": "The full name of hte country", "title": "Country Name", "type": "string" }, "county": { "description": "The county", "title": "County", "type": "string" }, "latitude": { "format": "double", "title": "Latitude", "type": "number" }, "line1": { "description": "The first line of the address", "title": "Line 1", "type": "string" }, "line2": { "description": "The second line of the address", "title": "Line 2", "type": "string" }, "line3": { "description": "The third line of the address", "title": "Line 3", "type": "string" }, "longitude": { "format": "double", "title": "Longitude", "type": "number" }, "postal_code": { "description": "The zip/postal code", "title": "Postal Code", "type": "string" }, "state": { "description": "The state/province of the address", "title": "State", "type": "string" }, "time_zone_id": { "title": "Time Zone", "type": "string" } }, "type": "object" }, "AssignReviewsRequest": { "additionalProperties": false, "properties": { "abstract_ids": { "description": "The abstract ids for which we are generating reviews", "items": { "type": "string" }, "title": "Abstracts", "type": "array" }, "committee_ids": { "description": "The committee ids to send the reviews to each member", "items": { "type": "string" }, "title": "Committees", "type": "array" }, "contact_ids": { "description": "The contact ids going to be assigned the reviews", "items": { "type": "string" }, "title": "Contacts", "type": "array" } }, "required": [ "abstract_ids" ], "type": "object" }, "BatchOperationRequest": { "additionalProperties": false, "properties": { "operations": { "items": { "additionalProperties": false, "properties": { "id": { "description": "The ID of the record", "oneOf": [ { "x-required": true } ], "title": "ID", "type": "string" }, "object": { "title": "Object", "type": "object" }, "operation": { "enum": [ "create", "delete", "generate from abstract", "patch", "read", "update" ], "title": "Operation", "type": "string" }, "patch_directives": { "items": { "additionalProperties": false, "properties": { "op": { "description": "The operation", "enum": [ "add", "copy", "move", "remove", "replace", "test" ], "title": "Op", "type": "string" }, "path": { "description": "The JSON path", "title": "Path", "type": "string" }, "value": { "title": "Value", "type": "string" } }, "required": [ "op", "path" ], "type": "object" }, "maxItems": 100, "minItems": 1, "oneOf": [ { "x-required": true } ], "type": "array" }, "payload": { "additionalProperties": false, "properties": { "abstract": { "additionalProperties": false, "description": "Updated abstract", "properties": { "approval_process_id": { "description": "The approval process for this abstract", "title": "Approval Process", "type": "string" }, "average_score": { "description": "The average score for this submission in the most recent round", "format": "float", "title": "Average Score", "type": "number" }, "body": { "description": "The body of the abstract", "title": "Body", "type": "string" }, "bucket_id": { "description": "The review bucket", "oneOf": [ { "x-required": true } ], "title": "Bucket", "type": "string" }, "city": { "description": "The member city", "title": "City", "type": "string" }, "co_author_1": { "additionalProperties": false, "properties": { "email_address": { "description": "Co author email", "title": "Email Address", "type": "string" }, "first_name": { "description": "The first name of the co-author", "title": "First Name", "type": "string" }, "last_name": { "description": "The last name of the co-author", "title": "Last Name", "type": "string" }, "phone_number": { "description": "Preferred phone number of the co author", "title": "Phone Number", "type": "string" }, "speaker_type_id": { "description": "The co author speaker type", "title": "Speaker Type", "type": "string" } }, "title": "Co Author 1", "type": "object" }, "co_author_2": { "additionalProperties": false, "properties": { "email_address": { "description": "Co author email", "title": "Email Address", "type": "string" }, "first_name": { "description": "The first name of the co-author", "title": "First Name", "type": "string" }, "last_name": { "description": "The last name of the co-author", "title": "Last Name", "type": "string" }, "phone_number": { "description": "Preferred phone number of the co author", "title": "Phone Number", "type": "string" }, "speaker_type_id": { "description": "The co author speaker type", "title": "Speaker Type", "type": "string" } }, "title": "Co Author 2", "type": "object" }, "co_author_3": { "additionalProperties": false, "properties": { "email_address": { "description": "Co author email", "title": "Email Address", "type": "string" }, "first_name": { "description": "The first name of the co-author", "title": "First Name", "type": "string" }, "last_name": { "description": "The last name of the co-author", "title": "Last Name", "type": "string" }, "phone_number": { "description": "Preferred phone number of the co author", "title": "Phone Number", "type": "string" }, "speaker_type_id": { "description": "The co author speaker type", "title": "Speaker Type", "type": "string" } }, "title": "Co Author 3", "type": "object" }, "co_author_4": { "additionalProperties": false, "properties": { "email_address": { "description": "Co author email", "title": "Email Address", "type": "string" }, "first_name": { "description": "The first name of the co-author", "title": "First Name", "type": "string" }, "last_name": { "description": "The last name of the co-author", "title": "Last Name", "type": "string" }, "phone_number": { "description": "Preferred phone number of the co author", "title": "Phone Number", "type": "string" }, "speaker_type_id": { "description": "The co author speaker type", "title": "Speaker Type", "type": "string" } }, "title": "Co Author 4", "type": "object" }, "co_author_5": { "additionalProperties": false, "properties": { "email_address": { "description": "Co author email", "title": "Email Address", "type": "string" }, "first_name": { "description": "The first name of the co-author", "title": "First Name", "type": "string" }, "last_name": { "description": "The last name of the co-author", "title": "Last Name", "type": "string" }, "phone_number": { "description": "Preferred phone number of the co author", "title": "Phone Number", "type": "string" }, "speaker_type_id": { "description": "The co author speaker type", "title": "Speaker Type", "type": "string" } }, "title": "Co Author 5", "type": "object" }, "co_authors": { "items": { "additionalProperties": false, "properties": { "co_author_contact_id": { "description": "Contact id for the co-author", "title": "Co Author Contact", "type": "string" }, "co_author_contact_info": { "additionalProperties": false, "description": "The contact info for the coAuthor", "properties": {}, "title": "Co Author Contact Info", "type": "object" }, "speaker_type_id": { "description": "Speaker type for this co-author", "title": "Speaker Type", "type": "string" } }, "type": "object" }, "minItems": 1, "oneOf": [ { "x-required": true } ], "type": "array" }, "country": { "description": "The member country", "title": "Country", "type": "string" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "date": { "description": "The date of abstract submission ", "format": "date-time", "title": "Date", "type": "string" }, "email_address": { "description": "The member's email address", "title": "Email Address", "type": "string" }, "event_id": { "description": "The ID of the event", "title": "Event", "type": "string" }, "first_name": { "description": "The member's first name", "title": "First Name", "type": "string" }, "has_co_authors": { "description": "This abstract has co-authors", "title": "Has Co Authors", "type": "boolean" }, "id": { "description": "The unique, string identifier of this abstract", "oneOf": [ { "x-required": true } ], "pattern": "^[\\w-_:]+$", "title": "ID", "type": "string" }, "job_title": { "description": "The member job title", "title": "Job Title", "type": "string" }, "last_name": { "description": "The member's last name", "title": "Last Name", "type": "string" }, "last_review_status_change": { "description": "The date that the review status was last changed", "format": "date-time", "title": "Last Review Status Change", "type": "string" }, "main_presenter_id": { "description": "Id of the presenter of the abstract", "title": "Main Presenter", "type": "string" }, "max_contact_submissions": { "description": "The max number of abstracts per contact for an event", "format": "float", "title": "Max Contact Submissions", "type": "number" }, "name": { "description": "The member's name", "title": "Name", "type": "string" }, "notes": { "title": "Notes", "type": "string" }, "number": { "description": "The abstract number", "format": "float", "title": "Number", "type": "number" }, "organization_id": { "description": "The organization of the submitter", "title": "Organization", "type": "string" }, "override_bucket_assignment": { "description": "If set, the bucket is not calculated automatically, and instead manually assigned", "title": "Override Bucket Assignment", "type": "boolean" }, "pending_console_review": { "description": "If true, then this record has been reviewed and now needs action by the staff", "title": "Pending Console Review", "type": "boolean" }, "presenter_info": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "contact_info": { "additionalProperties": false, "description": "Rolodex contact information of the presenter", "properties": {}, "title": "Contact Info", "type": "object" }, "email_presenter": { "description": "Email of the presenter, if set email is sent here on submission", "title": "Email Presenter", "type": "boolean" } }, "title": "Presenter Info", "type": "object" }, "process_id": { "description": "The process associated with this abstract", "title": "Process", "type": "string" }, "review_process_id": { "description": "Review process for which this abstract is assigned", "title": "Review Process", "type": "string" }, "review_round_id": { "description": "Current review round for this abstract", "oneOf": [ { "x-required": true } ], "title": "Review Round", "type": "string" }, "review_status": { "description": "The review status of this application", "enum": [ "accepted", "alternate", "declined", "pending review" ], "title": "Review Status", "type": "string" }, "reviewer_recommendation": { "description": "Aggregate recommendation across all reviewers", "title": "Reviewer Recommendation", "type": "string" }, "reviews_assigned": { "description": "Have reviews been assigned for this abstract", "title": "Reviews Assigned", "type": "boolean" }, "room_ids": { "description": "The room(s) where the function is located", "items": { "type": "string" }, "title": "Rooms", "type": "array" }, "round_id": { "description": "The review round", "title": "Round", "type": "string" }, "round_scores": { "items": { "additionalProperties": false, "properties": { "round_id": { "description": "The review round for this score", "title": "Round", "type": "string" }, "score": { "description": "The total score across all completed reviews", "format": "float", "title": "Score", "type": "number" } }, "required": [ "round_id", "score" ], "type": "object" }, "type": "array" }, "session_has_been_generated": { "description": "Boolean flag indicating whether or not a session has been been generated for this abstract", "title": "Session Has Been Generated", "type": "boolean" }, "session_track_ids": { "description": "Session tracks associations for the abstract", "items": { "type": "string" }, "title": "Session Tracks", "type": "array" }, "state": { "description": "The state", "title": "State", "type": "string" }, "status": { "enum": [ "accepted", "alternate", "approved/accepted by presenter", "approved/declined by presenter", "approved/pending presenter acceptance", "confirmed", "declined", "draft", "more information needed", "submitted", "under review", "withdrawn" ], "title": "Status", "type": "string" }, "submission_space_id": { "description": "The submission space to which this object belongs", "title": "Submission Space", "type": "string" }, "submitter_id": { "description": "Id of the contact that submitted the abstract", "title": "Submitter", "type": "string" }, "submitting_on_behalf_of_presenter": { "description": "Bool that identifies if the submitter is different than the presenter", "title": "Submitting On Behalf Of Presenter", "type": "boolean" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "oneOf": [ { "x-required": true } ], "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "oneOf": [ { "x-required": true } ], "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" }, "title": { "description": "The title of the abstract", "title": "Title", "type": "string" }, "total_score": { "description": "The total score for this submission in the most recent round", "format": "float", "title": "Total Score", "type": "number" }, "type_id": { "description": "The id for the type of abstract", "title": "Type", "type": "string" } }, "required": [ "body", "event_id", "id", "name", "status", "submitter_id", "title", "type_id" ], "title": "Abstract", "type": "object" }, "allow_duplicates": { "description": "If true, the system will create additional sessions for abstracts", "title": "Allow Duplicates", "type": "boolean" }, "main_presenter_speaker_type_id": { "description": "The type to be assigned to the main presenter for sessions generated from abstracts", "title": "Main Presenter Speaker Type", "type": "string" }, "make_co_authors_speakers": { "description": "If true, co-authors ", "title": "Make Co Authors Speakers", "type": "boolean" }, "new_status": { "enum": [ "accepted", "alternate", "approved/accepted by presenter", "approved/declined by presenter", "approved/pending presenter acceptance", "confirmed", "declined", "draft", "more information needed", "submitted", "under review", "withdrawn" ], "title": "New Status", "type": "string" }, "suppress_email_notifications": { "description": "If true, no email goes out", "title": "Suppress Email Notifications", "type": "boolean" }, "type_id": { "description": "The type of session to create", "title": "Type", "type": "string" } }, "required": [ "main_presenter_speaker_type_id", "type_id" ], "title": "Payload", "type": "object" } }, "required": [ "id", "object", "operation", "patch_directives" ], "type": "object" }, "type": "array" } }, "type": "object" }, "BatchOperationResponse": { "additionalProperties": false, "properties": { "error_count": { "description": "Number of error results", "format": "float", "title": "Error Count", "type": "number" }, "results": { "items": { "additionalProperties": false, "properties": { "error_message": { "title": "Error Message", "type": "string" }, "id": { "description": "The ID of the record", "title": "ID", "type": "string" }, "object": { "title": "Object", "type": "object" }, "operation": { "enum": [ "create", "delete", "patch", "read", "update" ], "title": "Operation", "type": "string" }, "outcome": { "enum": [ "error", "no change", "success" ], "title": "Outcome", "type": "string" } }, "required": [ "id", "operation" ], "type": "object" }, "type": "array" }, "success_count": { "description": "Number of successful results", "format": "float", "title": "Success Count", "type": "number" } }, "type": "object" }, "BreakoutSessionsRequestPayload": { "additionalProperties": false, "properties": { "abstractIds": { "description": "Array of ids for the abstracts that will become breakout sessions", "items": { "type": "string" }, "title": "Abstractids", "type": "array" }, "sessionData": { "title": "Sessiondata", "type": "object" } }, "required": [ "abstractIds" ], "type": "object" }, "ByFunction": { "properties": { "Items": { "items": { "$ref": "#/components/schemas/FunctionTicket" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "CloneEventRequest": { "additionalProperties": false, "properties": { "end_date": { "title": "End Date", "type": "string" }, "id": { "description": "The ID of the new event", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "include_coupons": { "description": "Whether to include coupons", "title": "Include Coupons", "type": "boolean" }, "include_functions": { "description": "Whether to include functions", "title": "Include Functions", "type": "boolean" }, "include_microsite": { "description": "Whether to include the microsite", "title": "Include Microsite", "type": "boolean" }, "include_review_spaces": { "description": "Whether or not to clone review spaces linked to this event", "title": "Include Review Spaces", "type": "boolean" }, "include_sessions": { "description": "Whether to include sessions", "title": "Include Sessions", "type": "boolean" }, "include_sponsorship_opportunities": { "description": "Whether or not to include sponsorship opportunities", "title": "Include Sponsorship Opportunities", "type": "boolean" }, "microsite_domain_name": { "title": "Microsite Domain Name", "type": "string" }, "name": { "title": "Name", "type": "string" }, "source_event_id": { "description": "The source event", "title": "Source Event", "type": "string" }, "start_date": { "title": "Start Date", "type": "string" } }, "required": [ "end_date", "id", "microsite_domain_name", "name", "source_event_id", "start_date" ], "type": "object" }, "ContactAllowanceResponse": { "additionalProperties": false, "properties": { "allowances": { "items": { "additionalProperties": false, "properties": { "contact_type_id": { "title": "Contact Type", "type": "string" }, "maximum_number_of_contacts": { "format": "float", "title": "Maximum Number Of Contacts", "type": "number" }, "number_of_contacts": { "format": "float", "title": "Number Of Contacts", "type": "number" } }, "type": "object" }, "type": "array" }, "frozen_contacts": { "items": { "type": "string" }, "title": "Frozen Contacts", "type": "array" } }, "type": "object" }, "Coupon": { "additionalProperties": false, "properties": { "add_on_products_discount_info": { "additionalProperties": false, "properties": { "add_on_product_ids": { "description": "The add on product IDs", "items": { "type": "string" }, "title": "Add On Products", "type": "array" }, "add_on_type_ids": { "description": "The add on types", "items": { "type": "string" }, "title": "Add On Types", "type": "array" }, "amount": { "format": "float", "title": "Amount", "type": "number" }, "method": { "enum": [ "amount", "percentage" ], "title": "Method", "type": "string" } }, "required": [ "amount" ], "title": "Add On Products Discount Info", "type": "object" }, "apply_to_add_on_products": { "description": "This coupon should be applied to registration add on products", "title": "Apply To Add On Products", "type": "boolean" }, "apply_to_exhibitor_add_on_products": { "description": "This coupon should be applied to exhibitor add on products", "title": "Apply To Exhibitor Add On Products", "type": "boolean" }, "apply_to_exhibitor_booth_fees": { "description": "This coupon should be applied to membership add on products", "title": "Apply To Exhibitor Booth Fees", "type": "boolean" }, "apply_to_function_fees": { "description": "If checked, this coupon applies to functions", "title": "Apply To Function Fees", "type": "boolean" }, "apply_to_registration_packages": { "description": "If checked, this coupon applies to registration packages", "title": "Apply To Registration Packages", "type": "boolean" }, "apply_to_session_fees": { "description": "If checked, this coupon applies to session fees", "title": "Apply To Session Fees", "type": "boolean" }, "code_generation_html": { "description": "Code generation HTML", "title": "Code Generation Html", "type": "string" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "discount_method": { "enum": [ "discount line item", "inline discount" ], "title": "Discount Method", "type": "string" }, "discount_product_id": { "title": "Discount Product", "type": "string" }, "event_id": { "description": "The ID of the event to which this coupon is tied", "title": "Event", "type": "string" }, "event_ids": { "description": "For global coupons, the events this applies to", "items": { "type": "string" }, "title": "Events", "type": "array" }, "event_type_ids": { "description": "For global coupons, the type of events this applies to", "items": { "type": "string" }, "title": "Event Types", "type": "array" }, "exhibitor_add_on_products_discount_info": { "additionalProperties": false, "properties": { "add_on_product_ids": { "description": "The add on product IDs to which this discount applies", "items": { "type": "string" }, "title": "Add On Products", "type": "array" }, "amount": { "format": "float", "title": "Amount", "type": "number" }, "method": { "enum": [ "amount", "percentage" ], "title": "Method", "type": "string" } }, "required": [ "amount" ], "title": "Exhibitor Add On Products Discount Info", "type": "object" }, "exhibitor_booth_fee_discount_info": { "additionalProperties": false, "properties": { "amount": { "format": "float", "title": "Amount", "type": "number" }, "booth_fee_ids": { "description": "The booth fees to which this discount applies", "items": { "type": "string" }, "title": "Booth Fees", "type": "array" }, "booth_type_ids": { "description": "The booth types to which this discount applies", "items": { "type": "string" }, "title": "Booth Types", "type": "array" }, "method": { "enum": [ "amount", "percentage" ], "title": "Method", "type": "string" } }, "required": [ "amount" ], "title": "Exhibitor Booth Fee Discount Info", "type": "object" }, "function_discount_info": { "additionalProperties": false, "properties": { "amount": { "format": "float", "title": "Amount", "type": "number" }, "function_ids": { "description": "The function IDs", "items": { "type": "string" }, "title": "Functions", "type": "array" }, "function_type_ids": { "description": "The function types", "items": { "type": "string" }, "title": "Function Types", "type": "array" }, "method": { "enum": [ "amount", "percentage" ], "title": "Method", "type": "string" } }, "required": [ "amount" ], "title": "Function Discount Info", "type": "object" }, "id": { "description": "The unique, string identifier of this coupon", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "is_active": { "description": "Whether or not this coupon is active", "title": "Is Active", "type": "boolean" }, "maximum_discount": { "description": "The optional maximum discount that this coupon can yield, irrespective of its configuration", "format": "float", "title": "Maximum Discount", "type": "number" }, "name": { "description": "The name of the coupon", "title": "Name", "type": "string" }, "registration_package_discount_info": { "additionalProperties": false, "properties": { "amount": { "format": "float", "title": "Amount", "type": "number" }, "method": { "enum": [ "amount", "percentage" ], "title": "Method", "type": "string" }, "registration_package_ids": { "description": "The registration packages", "items": { "type": "string" }, "title": "Registration Packages", "type": "array" }, "registration_type_ids": { "description": "The registration types", "items": { "type": "string" }, "title": "Registration Types", "type": "array" } }, "required": [ "amount" ], "title": "Registration Package Discount Info", "type": "object" }, "session_discount_info": { "additionalProperties": false, "properties": { "amount": { "format": "float", "title": "Amount", "type": "number" }, "method": { "enum": [ "amount", "percentage" ], "title": "Method", "type": "string" }, "session_ids": { "description": "The session ids", "items": { "type": "string" }, "title": "Sessions", "type": "array" }, "session_type_ids": { "description": "The session type ids", "items": { "type": "string" }, "title": "Session Types", "type": "array" } }, "required": [ "amount" ], "title": "Session Discount Info", "type": "object" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "add_on_products_discount_info", "discount_method", "discount_product_id", "exhibitor_add_on_products_discount_info", "exhibitor_booth_fee_discount_info", "function_discount_info", "id", "name", "registration_package_discount_info", "session_discount_info", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "CustomFieldValue": { "additionalProperties": false, "properties": { "boolean_value": { "description": "The boolean value", "title": "Boolean Value", "type": "boolean" }, "custom_field_id": { "description": "The unique identifier of the custom field", "title": "Custom Field", "type": "string" }, "file_url_value": { "description": "The pointer to a file value", "title": "File Url Value", "type": "string" }, "list_value": { "description": "The list value", "items": { "type": "string" }, "title": "List Value", "type": "array" }, "numeric_value": { "description": "The numeric value", "format": "float", "title": "Numeric Value", "type": "number" }, "string_value": { "description": "The string value of the custom field", "title": "String Value", "type": "string" }, "table_value": { "description": "A list of objects (a table)", "items": { "additionalProperties": false, "properties": {}, "type": "object" }, "type": "array" } }, "type": "object" }, "DescribeFunctionsResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/Function" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "DescribeSessionsResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/SessionPublic" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "DirectoryMessage": { "additionalProperties": false, "properties": { "bcc": { "description": "Anyone that should be bcc'ed on the email", "title": "Bcc", "type": "string" }, "body": { "description": "The email body", "title": "Body", "type": "string" }, "cc": { "description": "Anyone that should be cc'ed on the email", "title": "Cc", "type": "string" }, "from": { "description": "From email address", "title": "From", "type": "string" }, "from_name": { "description": "From name", "title": "From Name", "type": "string" }, "reply_to": { "description": "The reply to", "title": "Reply To", "type": "string" }, "subject": { "description": "The email subject", "title": "Subject", "type": "string" } }, "required": [ "body", "subject" ], "type": "object" }, "DirectorySearchCriteria": { "additionalProperties": false, "properties": { "criteria": { "title": "Criteria", "type": "object" }, "page": { "description": "The page being requested", "format": "float", "title": "Page", "type": "number" }, "radius_search": { "additionalProperties": false, "properties": { "postal_code": { "title": "Postal Code", "type": "string" }, "radius": { "format": "float", "minimum": 1, "title": "Radius", "type": "number" } }, "required": [ "postal_code", "radius" ], "title": "Radius Search", "type": "object" } }, "type": "object" }, "DirectorySearchResults": { "additionalProperties": false, "properties": { "fields": { "items": { "additionalProperties": false, "properties": { "label": { "title": "Label", "type": "string" }, "name": { "title": "Name", "type": "string" }, "type": { "title": "Type", "type": "string" } }, "type": "object" }, "type": "array" }, "query": { "additionalProperties": false, "properties": {}, "title": "Query", "type": "object" }, "rows": { "items": { "type": "object" }, "type": "array" }, "sql": { "title": "Sql", "type": "string" }, "target_service": { "description": "The target service of the query", "title": "Target Service", "type": "string" }, "totalNumberOfRows": { "format": "float", "title": "Totalnumberofrows", "type": "number" } }, "type": "object" }, "Event": { "additionalProperties": false, "properties": { "address": { "$ref": "#/components/schemas/Address" }, "business_unit_id": { "description": "The business unit of this event", "title": "Business Unit", "type": "string" }, "capacity_options": { "additionalProperties": false, "properties": { "capacity": { "format": "float", "minimum": 0, "title": "Capacity", "type": "number" }, "enable_wait_list": { "description": "If set, people can be placed on a wait list", "title": "Enable Wait List", "type": "boolean" }, "text_to_display_when_sold_out": { "description": "The text to show in the portal when the event is sold out", "title": "Text To Display When Sold Out", "type": "string" }, "waitlist_process_id": { "description": "The process to use for managing the waitlist", "oneOf": [ { "x-required": true } ], "title": "Waitlist Process", "type": "string" } }, "required": [ "capacity" ], "title": "Capacity Options", "type": "object" }, "chapter_id": { "description": "The chapter associated with this event, if applicable", "title": "Chapter", "type": "string" }, "cloned_from_id": { "description": "The event from which this event was cloned", "title": "Cloned From", "type": "string" }, "console_access_options": { "additionalProperties": false, "properties": { "administrator_security_role_ids": { "description": "The policies that should have administrator level access", "items": { "type": "string" }, "title": "Administrator Security Roles", "type": "array" }, "user_security_role_ids": { "description": "The policies that should have user level access", "items": { "type": "string" }, "title": "User Security Roles", "type": "array" } }, "title": "Console Access Options", "type": "object" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "date_to_remove_from_portal": { "description": "The date that that this event should be removed from the portal. If blank, the end date is used", "format": "date-time", "title": "Date To Remove From Portal", "type": "string" }, "description": { "description": "Event description", "title": "Description", "type": "string" }, "do_not_stretch_masthead": { "description": "If set, the masthead image is not stretched and is left as is", "title": "Do Not Stretch Masthead", "type": "boolean" }, "enable_abstracts": { "description": "Whether or not abstract submission and judging is enabled for this event", "title": "Enable Abstracts", "type": "boolean" }, "enable_capacity": { "description": "If set, the session has a capacity", "title": "Enable Capacity", "type": "boolean" }, "enable_components": { "description": "Whether or not this event has mini-conferences, or components", "title": "Enable Components", "type": "boolean" }, "enable_courses": { "description": "Whether or not certification courses can be sold during the event", "title": "Enable Courses", "type": "boolean" }, "enable_documents": { "description": "Enable documents for your event", "title": "Enable Documents", "type": "boolean" }, "enable_exhibitors": { "description": "Whether or not this event has exhibitors", "title": "Enable Exhibitors", "type": "boolean" }, "enable_functions": { "description": "Whether or not functions are enabled for this event", "title": "Enable Functions", "type": "boolean" }, "enable_logistics": { "description": "Whether or not logistics & planning are available for this event", "title": "Enable Logistics", "type": "boolean" }, "enable_onsite": { "description": "Whether or not you would like onsite checking and kiosks for this event", "title": "Enable Onsite", "type": "boolean" }, "enable_registration": { "description": "Whether or not online registration is enabled for this event", "title": "Enable Registration", "type": "boolean" }, "enable_sessions": { "description": "Whether or not onlines sessions are enabled for this event", "title": "Enable Sessions", "type": "boolean" }, "enable_sponsors": { "description": "Whether or not this event has sponsors you would like to track", "title": "Enable Sponsors", "type": "boolean" }, "enable_volunteers": { "description": "Whether or not volunteer management & tracking", "title": "Enable Volunteers", "type": "boolean" }, "end_date": { "description": "The end of the event", "format": "date-time", "title": "End Date", "type": "string" }, "featured": { "description": "If true, this event should be featured and displayed prominently", "title": "Featured", "type": "boolean" }, "featured_from": { "description": "The time during which this event should be featured", "format": "date-time", "title": "Featured From", "type": "string" }, "featured_until": { "description": "The time during which this event should be featured", "format": "date-time", "title": "Featured Until", "type": "string" }, "id": { "description": "The unique, string identifier of this event", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "masthead_image_uri": { "description": "The masthead image to be displayed for the event", "title": "Masthead Image Uri", "type": "string" }, "name": { "description": "The name of the event", "title": "Name", "type": "string" }, "portal_integrated_events_options": { "additionalProperties": false, "properties": { "registrant_directory_id": { "description": "The attendee directory ID", "oneOf": [ { "x-required": true } ], "title": "Registrant Directory", "type": "string" }, "show_group_registration": { "description": "If true, group registration is shown", "title": "Show Group Registration", "type": "boolean" }, "show_registrant_directory": { "description": "If true, a list of attendees are shown", "title": "Show Registrant Directory", "type": "boolean" }, "show_schedule": { "description": "If true, schedule is shown", "title": "Show Schedule", "type": "boolean" } }, "title": "Portal Integrated Events Options", "type": "object" }, "previous_event_id": { "description": "The event linked that occurred before this one, used for comparison", "title": "Previous Event", "type": "string" }, "registration_deadlines": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date-time", "title": "Date", "type": "string" }, "id": { "description": "The registration deadline", "title": "ID", "type": "string" } }, "required": [ "date", "id" ], "type": "object" }, "type": "array" }, "restrict_console_access": { "description": "If true, only certain console users can access this event", "title": "Restrict Console Access", "type": "boolean" }, "site_mode": { "description": "Describes how this event registration and site information will be hosted and displayed", "enum": [ "external", "microsite", "none", "portal integrated" ], "title": "Site Mode", "type": "string" }, "sold_out": { "description": "Whether the event is sold out", "title": "Sold Out", "type": "boolean" }, "start_date": { "description": "The start of the event", "format": "date-time", "title": "Start Date", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" }, "thumbnail_image_uri": { "description": "The thumbnail image to display in upcoming events", "title": "Thumbnail Image Uri", "type": "string" }, "timezone": { "description": "The timezone that the event is in", "title": "Timezone", "type": "string" }, "timezone_abbreviation": { "description": "The timezone abbreviation, based on the event start date", "title": "Timezone Abbreviation", "type": "string" }, "timezone_mode": { "enum": [ "local", "specific timezone" ], "title": "Timezone Mode", "type": "string" }, "timezone_offset": { "description": "The time zone offset, in minutes, from UTC, based on the event start date", "format": "float", "title": "Timezone Offset", "type": "number" }, "type_id": { "description": "The type of event", "title": "Type", "type": "string" }, "url": { "description": "The URL of the event site", "title": "Url", "type": "string" }, "venue_id": { "description": "The venue hosting the event", "title": "Venue", "type": "string" }, "visible_in_portal": { "description": "Whether this is visible in the portal", "title": "Visible In Portal", "type": "boolean" } }, "required": [ "capacity_options", "console_access_options", "end_date", "id", "name", "start_date", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id", "timezone", "type_id", "url" ], "type": "object" }, "EventPublic": { "additionalProperties": false, "properties": { "currency_code": { "title": "Currency Code", "type": "string" }, "currency_symbol": { "title": "Currency Symbol", "type": "string" }, "description": { "title": "Description", "type": "string" }, "enable_documents": { "description": "Whether documents is enabled", "title": "Enable Documents", "type": "boolean" }, "end_date": { "description": "The end of the event", "format": "date-time", "title": "End Date", "type": "string" }, "featured": { "description": "If true, this event should be featured and displayed prominently", "title": "Featured", "type": "boolean" }, "featured_from": { "description": "The time during which this event should be featured", "format": "date-time", "title": "Featured From", "type": "string" }, "featured_until": { "description": "The time during which this event should be featured", "format": "date-time", "title": "Featured Until", "type": "string" }, "id": { "description": "The unique, string identifier of this event", "title": "ID", "type": "string" }, "location": { "$ref": "#/components/schemas/Address" }, "masthead_image_uri": { "description": "The masthead image to be displayed for the event", "title": "Masthead Image Uri", "type": "string" }, "name": { "description": "The name of the event", "title": "Name", "type": "string" }, "portal_integrated_events_options": { "additionalProperties": false, "properties": { "registrant_directory_id": { "description": "The attendee directory ID", "title": "Registrant Directory", "type": "string" }, "show_group_registration": { "description": "If true, group registration is shown", "title": "Show Group Registration", "type": "boolean" }, "show_registrant_directory": { "description": "If true, a list of attendees are shown", "title": "Show Registrant Directory", "type": "boolean" }, "show_schedule": { "description": "If true, schedule is shown", "title": "Show Schedule", "type": "boolean" } }, "title": "Portal Integrated Events Options", "type": "object" }, "registration_deadlines": { "items": { "additionalProperties": false, "properties": { "date": { "description": "The registration deadline date/time", "format": "date-time", "title": "Date", "type": "string" }, "id": { "description": "The registration deadline", "title": "ID", "type": "string" }, "name": { "description": "Name of the deadline", "title": "Name", "type": "string" } }, "type": "object" }, "type": "array" }, "site_mode": { "description": "Describes how this event registration and site information will be hosted and displayed", "enum": [ "external", "microsite", "none", "portal integrated" ], "title": "Site Mode", "type": "string" }, "sold_out": { "description": "Whether the event is sold out", "title": "Sold Out", "type": "boolean" }, "start_date": { "description": "The start of the event", "format": "date-time", "title": "Start Date", "type": "string" }, "text_to_display_when_sold_out": { "title": "Text To Display When Sold Out", "type": "string" }, "thumbnail_image_uri": { "description": "The masthead image to be displayed for the event", "title": "Thumbnail Image Uri", "type": "string" }, "timezone": { "description": "The timezone of the event", "title": "Timezone", "type": "string" }, "timezone_abbreviation": { "description": "The timezone abbreviation, based on the event start date", "title": "Timezone Abbreviation", "type": "string" }, "timezone_offset": { "description": "The time zone offset, in minutes, from UTC, based on the event start date", "format": "float", "title": "Timezone Offset", "type": "number" }, "type_id": { "description": "The type of event", "title": "Type", "type": "string" }, "type_name": { "description": "The type of event", "title": "Type Name", "type": "string" }, "url": { "description": "The URL of the event site", "title": "Url", "type": "string" }, "venue_id": { "description": "The venue hosting the event", "title": "Venue", "type": "string" }, "venue_name": { "description": "The venue hosting the event", "title": "Venue Name", "type": "string" }, "visible_in_portal": { "title": "Visible In Portal", "type": "boolean" }, "wait_list_available": { "description": "Whether the wait list is available", "title": "Wait List Available", "type": "boolean" } }, "type": "object" }, "EventSearchParameters": { "additionalProperties": false, "properties": { "city": { "description": "City to search", "title": "City", "type": "string" }, "end_date": { "items": { "format": "date-time", "type": "string" }, "maxItems": 2, "minItems": 2, "title": "End Date", "type": "array" }, "id": { "description": "The id", "title": "ID", "type": "string" }, "name": { "description": "The name", "title": "Name", "type": "string" }, "start_date": { "items": { "format": "date-time", "type": "string" }, "maxItems": 2, "minItems": 2, "title": "Start Date", "type": "array" }, "state": { "description": "The state", "title": "State", "type": "string" }, "type_id": { "items": { "type": "string" }, "title": "Type", "type": "array" }, "venue_id": { "items": { "type": "string" }, "title": "Venue", "type": "array" }, "visible_in_portal": { "title": "Visible In Portal", "type": "boolean" } }, "type": "object" }, "EventSearchResults": { "additionalProperties": false, "properties": { "city": { "description": "City to search", "title": "City", "type": "string" }, "end_date": { "items": { "format": "date-time", "type": "string" }, "maxItems": 2, "minItems": 2, "title": "End Date", "type": "array" }, "id": { "description": "The id", "title": "ID", "type": "string" }, "name": { "description": "The name", "title": "Name", "type": "string" }, "start_date": { "items": { "format": "date-time", "type": "string" }, "maxItems": 2, "minItems": 2, "title": "Start Date", "type": "array" }, "state": { "description": "The state", "title": "State", "type": "string" }, "type_id": { "items": { "type": "string" }, "title": "Type", "type": "array" }, "venue_id": { "items": { "type": "string" }, "title": "Venue", "type": "array" }, "visible_in_portal": { "title": "Visible In Portal", "type": "boolean" } }, "type": "object" }, "Exhibitor": { "additionalProperties": false, "properties": { "add_ons": { "items": { "additionalProperties": false, "properties": { "add_on_product_id": { "description": "The add on product", "title": "Add On Product", "type": "string" }, "quantity": { "format": "float", "title": "Quantity", "type": "number" } }, "required": [ "add_on_product_id", "quantity" ], "type": "object" }, "type": "array" }, "booth_types": { "items": { "additionalProperties": false, "properties": { "booth_type_id": { "description": "The type of booth", "title": "Booth Type", "type": "string" }, "quantity": { "description": "The number of booths", "format": "float", "minimum": 1, "title": "Quantity", "type": "number" } }, "required": [ "booth_type_id", "quantity" ], "type": "object" }, "minItems": 1, "type": "array" }, "category_ids": { "description": "Exhibitor categories", "items": { "type": "string" }, "minItems": 1, "title": "Categories", "type": "array" }, "contacts": { "items": { "additionalProperties": false, "properties": { "contact_id": { "description": "The contact", "title": "Contact", "type": "string" }, "notes": { "title": "Notes", "type": "string" }, "type_id": { "description": "The exhibitor contact type", "title": "Type", "type": "string" } }, "required": [ "contact_id", "type_id" ], "type": "object" }, "type": "array" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "description": { "description": "Exhibitor description, shown in the portal", "title": "Description", "type": "string" }, "event_id": { "description": "The event ID", "title": "Event", "type": "string" }, "id": { "description": "The unique, string identifier of this exhibitor", "pattern": "^[\\w|:-]+$", "title": "ID", "type": "string" }, "logo_url": { "description": "Url of a logo for this organization", "title": "Logo Url", "type": "string" }, "name": { "description": "The name of the exhibitor", "title": "Name", "type": "string" }, "organization_id": { "description": "The organization", "title": "Organization", "type": "string" }, "process_id": { "description": "The exhibitor reg process", "title": "Process", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "event_id", "id", "name", "organization_id", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "ExhibitorAddOnProduct": { "additionalProperties": false, "properties": { "abbreviated_name": { "description": "The abbreviated name of the booth add on product, for display inside event dropdowns & lists", "title": "Abbreviated Name", "type": "string" }, "allow_customer_to_choose_installment_plan": { "description": "If true, the customer can choose their installment plan", "title": "Allow Customer To Choose Installment Plan", "type": "boolean" }, "bulk_pricing_rules": { "items": { "additionalProperties": false, "properties": { "discount_amount": { "description": "The percentage/flat rate", "format": "float", "minimum": 0, "title": "Discount Amount", "type": "number" }, "discount_type": { "description": "The type of discount rule", "enum": [ "flat rate", "percentage" ], "title": "Discount Type", "type": "string" }, "ending_range": { "description": "The ending range of the rule", "minimum": 0, "title": "Ending Range", "type": "integer" }, "starting_range": { "description": "The starting range of the rule", "minimum": 0, "title": "Starting Range", "type": "integer" } }, "required": [ "discount_amount", "discount_type" ], "type": "object" }, "minItems": 1, "type": "array" }, "bundled_products": { "items": { "additionalProperties": false, "properties": { "member_price": { "description": "The member price", "format": "double", "title": "Member Price", "type": "number" }, "price": { "description": "The price to bundle", "format": "double", "title": "Price", "type": "number" }, "product_id": { "description": "The product ID", "title": "Product", "type": "string" }, "product_type": { "description": "The product type", "title": "Product Type", "type": "string" }, "quantity": { "description": "The quantity to bundle", "title": "Quantity", "type": "integer" }, "type": { "enum": [ "bundled product", "inline bundled product" ], "title": "Type", "type": "string" } }, "required": [ "product_id", "product_type", "quantity", "type" ], "type": "object" }, "minItems": 1, "type": "array" }, "bundled_products_inventory_handling": { "description": "Whether to track inventory for the entire bundle, or for each product separately", "enum": [ "bundle", "each product" ], "title": "Bundled Products Inventory Handling", "type": "string" }, "business_unit_id": { "description": "The business unit of the product", "title": "Business Unit", "type": "string" }, "cancellation_fee": { "description": "Cancellation fees associated with this product", "format": "double", "title": "Cancellation Fee", "type": "number" }, "commerce_entitlements_to_create": { "items": { "additionalProperties": false, "properties": { "expiration_date": { "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Expiration Date", "type": "string" }, "expiration_type": { "enum": [ "none", "relative date", "specific date" ], "title": "Expiration Type", "type": "string" }, "quantity": { "description": "The quantity", "format": "float", "title": "Quantity", "type": "number" }, "relative_expiration_date": { "additionalProperties": false, "description": "The date the task is due", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Expiration Date", "type": "object" }, "type_id": { "description": "The type of entitlement", "title": "Type", "type": "string" } }, "required": [ "expiration_type", "type_id" ], "type": "object" }, "type": "array" }, "coupon_codes": { "items": { "additionalProperties": false, "properties": { "coupon_code_generation_process_id": { "description": "The process by which the coupons are generated", "title": "Coupon Code Generation Process", "type": "string" }, "coupon_code_type": { "enum": [ "multi use", "single use" ], "title": "Coupon Code Type", "type": "string" }, "coupon_id": { "title": "Coupon", "type": "string" }, "coupon_type": { "title": "Coupon Type", "type": "string" }, "expiration_date": { "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Expiration Date", "type": "string" }, "expiration_type": { "enum": [ "none", "relative date", "specific date" ], "title": "Expiration Type", "type": "string" }, "maximum_number_of_total_uses": { "description": "The maximum number of total uses", "minimum": 1, "oneOf": [ { "enum": [ 1 ], "x-required": true } ], "title": "Maximum Number Of Total Uses", "type": "integer" }, "maximum_number_of_uses_per_customer": { "description": "The maximum number of total uses for a given customer", "minimum": 1, "oneOf": [ { "enum": [ 1 ], "x-required": true } ], "title": "Maximum Number Of Uses Per Customer", "type": "integer" }, "quantity": { "description": "The number of coupons to generate", "maximum": 250, "title": "Quantity", "type": "integer" }, "relative_expiration_date": { "additionalProperties": false, "description": "Expiration date relative to purchase", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Expiration Date", "type": "object" }, "restrict_to_contact": { "description": "If true, the code generated is restricted to the contact who made the purchase", "title": "Restrict To Contact", "type": "boolean" }, "restrict_to_organization": { "description": "If true, the code generated is restricted to the organization made the purchase", "title": "Restrict To Organization", "type": "boolean" } }, "required": [ "coupon_code_generation_process_id", "coupon_code_type", "coupon_id", "coupon_type", "quantity" ], "type": "object" }, "minItems": 1, "type": "array" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "custom_pricing_options": { "additionalProperties": false, "properties": { "lambda_function_id": { "description": "The custom lambda function to use", "title": "Lambda Function", "type": "string" } }, "required": [ "lambda_function_id" ], "title": "Custom Pricing Options", "type": "object" }, "description": { "description": "Product description", "title": "Description", "type": "string" }, "display_order": { "description": "Display order of the product", "format": "float", "title": "Display Order", "type": "number" }, "document_entitlements_to_create": { "items": { "additionalProperties": false, "properties": { "expiration_date": { "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Expiration Date", "type": "string" }, "expiration_type": { "enum": [ "none", "relative date", "specific date" ], "title": "Expiration Type", "type": "string" }, "file_cabinet_id": { "description": "The file cabinet", "title": "File Cabinet", "type": "string" }, "item_id": { "description": "The item", "title": "Item", "type": "string" }, "library_path": { "description": "The optional path that items will be mounted onto the digital library", "title": "Library Path", "type": "string" }, "relative_expiration_date": { "additionalProperties": false, "description": "The date the task is due", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Expiration Date", "type": "object" } }, "required": [ "expiration_type", "file_cabinet_id" ], "type": "object" }, "type": "array" }, "enable_bulk_pricing": { "description": "Whether or not bulk pricing is enabled", "title": "Enable Bulk Pricing", "type": "boolean" }, "enable_bundled_products": { "description": "Whether to enable bundled products", "title": "Enable Bundled Products", "type": "boolean" }, "enable_cancellation_fees": { "description": "Whether or not cancellation fees are applicable", "title": "Enable Cancellation Fees", "type": "boolean" }, "enable_commerce_entitlement_creation": { "description": "If set, document entitlements will be created to access folders or documents", "title": "Enable Commerce Entitlement Creation", "type": "boolean" }, "enable_coupon_code_generation": { "description": "If true, purchasing this product will generate coupons", "title": "Enable Coupon Code Generation", "type": "boolean" }, "enable_custom_pricing": { "description": "If set, the order engine will call out to a custom lambda function for custom/complex pricing", "title": "Enable Custom Pricing", "type": "boolean" }, "enable_document_entitlement_creation": { "description": "If set, document entitlements will be created to access folders or documents", "title": "Enable Document Entitlement Creation", "type": "boolean" }, "enable_product_confirmation_email": { "description": "If enabled, a custom email goes out whenever this product is ordered", "title": "Enable Product Confirmation Email", "type": "boolean" }, "enable_purchase_limits": { "description": "If true, purchase limits are in place for this product", "title": "Enable Purchase Limits", "type": "boolean" }, "enable_purchasing_eligibility": { "description": "If set, purchases of this merchandise are restricted", "title": "Enable Purchasing Eligibility", "type": "boolean" }, "enable_special_prices": { "description": "Whether to enable special pricing logic", "title": "Enable Special Prices", "type": "boolean" }, "enable_task_generation": { "description": "If set, tasks will be generated", "title": "Enable Task Generation", "type": "boolean" }, "event_id": { "description": "The event", "title": "Event", "type": "string" }, "foreign_currency_prices": { "items": { "additionalProperties": false, "properties": { "cancellation_fee": { "description": "The cancellation fee of the product for this currency", "format": "double", "title": "Cancellation Fee", "type": "number" }, "currency_code": { "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "title": "Currency Code", "type": "string" }, "member_price": { "description": "The price of the product for a member", "format": "double", "title": "Member Price", "type": "number" }, "mode": { "description": "How this foreign currency should be treated", "enum": [ "calculate price", "prohibit purchase", "set price" ], "title": "Mode", "type": "string" }, "price": { "description": "The price of the product", "format": "double", "oneOf": [ { "x-required": true } ], "title": "Price", "type": "number" }, "restocking_fee": { "description": "The restocking fee of the product for this currency", "format": "double", "title": "Restocking Fee", "type": "number" } }, "required": [ "currency_code" ], "type": "object" }, "type": "array" }, "hide_from_portal": { "description": "If set, this product should not be shown in the portal", "title": "Hide From Portal", "type": "boolean" }, "id": { "description": "The unique, string identifier of this miscellaneous product", "pattern": "^[\\w:|-]+$", "title": "ID", "type": "string" }, "installment_plan_options": { "items": { "additionalProperties": false, "properties": { "additional_cost": { "description": "The additional cost of the installment plan", "format": "double", "title": "Additional Cost", "type": "number" }, "installment_plan_id": { "description": "The installment plan that this product supports", "title": "Installment Plan", "type": "string" }, "is_default": { "description": "Whether this is the default installment plan option", "title": "Is Default", "type": "boolean" } }, "required": [ "installment_plan_id" ], "type": "object" }, "minItems": 1, "type": "array" }, "is_active": { "description": "Whether this product is active/used", "title": "Is Active", "type": "boolean" }, "member_price": { "description": "The price of the product for an active member", "format": "double", "title": "Member Price", "type": "number" }, "name": { "description": "The name of the miscellaneous product", "title": "Name", "type": "string" }, "notes": { "description": "Notes", "title": "Notes", "type": "string" }, "portal_options": { "additionalProperties": false, "properties": { "available_from": { "description": "The date from which this product should be available", "format": "date-time", "title": "Available From", "type": "string" }, "available_until": { "description": "The date until which this product should be available", "format": "date-time", "title": "Available Until", "type": "string" } }, "title": "Portal Options", "type": "object" }, "price": { "description": "The price of the product", "format": "double", "title": "Price", "type": "number" }, "priority_point_restrictions": { "additionalProperties": false, "properties": { "range_end": { "description": "The point range end", "format": "float", "title": "Range End", "type": "number" }, "range_start": { "description": "The point range start", "format": "float", "title": "Range Start", "type": "number" } }, "required": [ "range_end", "range_start" ], "title": "Priority Point Restrictions", "type": "object" }, "product_confirmation_email_options": { "additionalProperties": false, "properties": { "product_confirmation_email_id": { "oneOf": [ { "x-required": true } ], "title": "Product Confirmation Email", "type": "string" }, "product_specific_email": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "bcc": { "description": "Anyone that should be bcc'ed on the email", "title": "Bcc", "type": "string" }, "body": { "description": "The email body", "title": "Body", "type": "string" }, "cc": { "description": "Anyone that should be cc'ed on the email", "title": "Cc", "type": "string" }, "from": { "description": "From email address", "title": "From", "type": "string" }, "from_name": { "description": "From name", "title": "From Name", "type": "string" }, "reply_to": { "description": "The reply to", "title": "Reply To", "type": "string" }, "subject": { "description": "The email subject", "title": "Subject", "type": "string" } }, "required": [ "body", "subject" ], "title": "Product Specific Email", "type": "object" }, "type": { "enum": [ "product specific", "shared" ], "title": "Type", "type": "string" } }, "title": "Product Confirmation Email Options", "type": "object" }, "publish_to_portal": { "description": "Whether or not this product should be available in the portal", "title": "Publish To Portal", "type": "boolean" }, "purchase_limits": { "additionalProperties": false, "properties": { "error_message": { "description": "The error message to show", "title": "Error Message", "type": "string" }, "maximum": { "description": "The maximum", "format": "float", "title": "Maximum", "type": "number" }, "relative_time_window": { "additionalProperties": false, "description": "the time window", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Time Window", "type": "object" }, "time_period": { "enum": [ "all time", "sliding time window" ], "title": "Time Period", "type": "string" }, "type": { "enum": [ "per customer" ], "title": "Type", "type": "string" } }, "required": [ "maximum", "time_period", "type" ], "title": "Purchase Limits", "type": "object" }, "purchasing_eligibility_criteria": { "title": "Purchasing Eligibility Criteria", "type": "object" }, "restrict_by_priority_points": { "description": "If selected, this product is only available based on an exhibitors priority points", "title": "Restrict By Priority Points", "type": "boolean" }, "restrict_by_square_footage": { "description": "If selected, this product is only available based on selected square footage", "title": "Restrict By Square Footage", "type": "boolean" }, "special_prices": { "items": { "additionalProperties": false, "properties": { "criteria": { "title": "Criteria", "type": "object" }, "enable_formula": { "description": "if set, a formula is used to calculate the price. If the formula fails, the price is used", "title": "Enable Formula", "type": "boolean" }, "formula": { "description": "The formula evaluated using the expr-eval npm package", "oneOf": [ { "x-required": true } ], "title": "Formula", "type": "string" }, "name": { "title": "Name", "type": "string" }, "price": { "format": "float", "title": "Price", "type": "number" } }, "required": [ "criteria", "price" ], "type": "object" }, "minItems": 1, "type": "array" }, "square_footage_restrictions": { "additionalProperties": false, "properties": { "range_end": { "description": "The square footage range end", "format": "float", "title": "Range End", "type": "number" }, "range_start": { "description": "The square footage range start", "format": "float", "title": "Range Start", "type": "number" } }, "required": [ "range_end", "range_start" ], "title": "Square Footage Restrictions", "type": "object" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" }, "tasks_to_generate": { "items": { "additionalProperties": false, "properties": { "assignee_type": { "enum": [ "assignment role", "queue", "user" ], "title": "Assignee Type", "type": "string" }, "assignment_role_id": { "description": "The assignment role that should receive the ask", "oneOf": [ { "x-required": true } ], "title": "Assignment Role", "type": "string" }, "description": { "description": "A description", "title": "Description", "type": "string" }, "due_date_type": { "description": "Whether there is a due date", "enum": [ "none", "relative date", "specific date" ], "title": "Due Date Type", "type": "string" }, "name": { "description": "The name of the task", "title": "Name", "type": "string" }, "notify_assignees": { "description": "Notify assignee when the task is created", "title": "Notify Assignees", "type": "boolean" }, "priority": { "enum": [ "high", "low", "normal", "urgent" ], "title": "Priority", "type": "string" }, "queue_id": { "description": "The queue that should be assigned the ask", "oneOf": [ { "x-required": true } ], "title": "Queue", "type": "string" }, "relative_due_date": { "additionalProperties": false, "description": "The date the task is due", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Due Date", "type": "object" }, "specific_due_date": { "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Specific Due Date", "type": "string" }, "type_id": { "description": "The type of task", "title": "Type", "type": "string" }, "user_id": { "description": "The user that should be assigned the ask", "oneOf": [ { "x-required": true } ], "title": "User", "type": "string" } }, "required": [ "assignee_type", "due_date_type", "name", "type_id" ], "type": "object" }, "type": "array" }, "type": { "description": "The product type", "enum": [ "events-exhibitor-add-on-products" ], "title": "Type", "type": "string" } }, "required": [ "bulk_pricing_rules", "bundled_products", "business_unit_id", "coupon_codes", "custom_pricing_options", "event_id", "id", "installment_plan_options", "name", "price", "product_confirmation_email_options", "purchase_limits", "special_prices", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "ExhibitorBooth": { "additionalProperties": false, "properties": { "additional_exhibitors": { "items": { "additionalProperties": false, "properties": { "exhibitor_id": { "description": "The exhibitor", "title": "Exhibitor", "type": "string" }, "percentage_share": { "description": "The %/share of the booth", "format": "float", "title": "Percentage Share", "type": "number" } }, "required": [ "exhibitor_id" ], "type": "object" }, "type": "array" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "description": { "description": "Optional booth description, show to users", "title": "Description", "type": "string" }, "event_id": { "description": "The event", "title": "Event", "type": "string" }, "exhibitor_id": { "description": "The exhibitor the owns this booth", "title": "Exhibitor", "type": "string" }, "fee_id": { "description": "The fee associated with the booth", "title": "Fee", "type": "string" }, "floor_id": { "description": "The show floor to which the booth belongs", "title": "Floor", "type": "string" }, "floor_plan_metadata": { "additionalProperties": false, "description": "Used to track floorplan/position information", "properties": {}, "title": "Floor Plan Metadata", "type": "object" }, "hold_expiration": { "description": "The date/time when the hold expires", "format": "date-time", "title": "Hold Expiration", "type": "string" }, "holding_organization_id": { "description": "The organization that has the booth on hold", "title": "Holding Organization", "type": "string" }, "id": { "description": "The unique, string identifier of this exhibitor booth", "pattern": "^[\\w|:-]+$", "title": "ID", "type": "string" }, "name": { "description": "The name of the booth", "title": "Name", "type": "string" }, "notes": { "title": "Notes", "type": "string" }, "number": { "description": "The booth number", "format": "float", "title": "Number", "type": "number" }, "organization_id": { "description": "The organization associated with the booth (reporting purposes)", "title": "Organization", "type": "string" }, "purchasing_warning": { "description": "Optional text to show to purchasers of this booth when the booth is purchased", "title": "Purchasing Warning", "type": "string" }, "status": { "enum": [ "approved", "available", "on hold", "reserved" ], "title": "Status", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" }, "type_id": { "description": "The type of booth", "title": "Type", "type": "string" } }, "required": [ "event_id", "exhibitor_id", "floor_id", "hold_expiration", "holding_organization_id", "id", "name", "number", "organization_id", "status", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id", "type_id" ], "type": "object" }, "ExhibitorBoothFee": { "additionalProperties": false, "properties": { "abbreviated_name": { "description": "The abbreviated name of the booth fee, for display inside event dropdowns & lists", "title": "Abbreviated Name", "type": "string" }, "allow_customer_to_choose_installment_plan": { "description": "If true, the customer can choose their installment plan", "title": "Allow Customer To Choose Installment Plan", "type": "boolean" }, "bulk_pricing_rules": { "items": { "additionalProperties": false, "properties": { "discount_amount": { "description": "The percentage/flat rate", "format": "float", "minimum": 0, "title": "Discount Amount", "type": "number" }, "discount_type": { "description": "The type of discount rule", "enum": [ "flat rate", "percentage" ], "title": "Discount Type", "type": "string" }, "ending_range": { "description": "The ending range of the rule", "minimum": 0, "title": "Ending Range", "type": "integer" }, "starting_range": { "description": "The starting range of the rule", "minimum": 0, "title": "Starting Range", "type": "integer" } }, "required": [ "discount_amount", "discount_type" ], "type": "object" }, "minItems": 1, "type": "array" }, "bundled_products": { "items": { "additionalProperties": false, "properties": { "member_price": { "description": "The member price", "format": "double", "title": "Member Price", "type": "number" }, "price": { "description": "The price to bundle", "format": "double", "title": "Price", "type": "number" }, "product_id": { "description": "The product ID", "title": "Product", "type": "string" }, "product_type": { "description": "The product type", "title": "Product Type", "type": "string" }, "quantity": { "description": "The quantity to bundle", "title": "Quantity", "type": "integer" }, "type": { "enum": [ "bundled product", "inline bundled product" ], "title": "Type", "type": "string" } }, "required": [ "product_id", "product_type", "quantity", "type" ], "type": "object" }, "minItems": 1, "type": "array" }, "bundled_products_inventory_handling": { "description": "Whether to track inventory for the entire bundle, or for each product separately", "enum": [ "bundle", "each product" ], "title": "Bundled Products Inventory Handling", "type": "string" }, "business_unit_id": { "description": "The business unit of the product", "title": "Business Unit", "type": "string" }, "cancellation_fee": { "description": "Cancellation fees associated with this product", "format": "double", "title": "Cancellation Fee", "type": "number" }, "commerce_entitlements_to_create": { "items": { "additionalProperties": false, "properties": { "expiration_date": { "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Expiration Date", "type": "string" }, "expiration_type": { "enum": [ "none", "relative date", "specific date" ], "title": "Expiration Type", "type": "string" }, "quantity": { "description": "The quantity", "format": "float", "title": "Quantity", "type": "number" }, "relative_expiration_date": { "additionalProperties": false, "description": "The date the task is due", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Expiration Date", "type": "object" }, "type_id": { "description": "The type of entitlement", "title": "Type", "type": "string" } }, "required": [ "expiration_type", "type_id" ], "type": "object" }, "type": "array" }, "coupon_codes": { "items": { "additionalProperties": false, "properties": { "coupon_code_generation_process_id": { "description": "The process by which the coupons are generated", "title": "Coupon Code Generation Process", "type": "string" }, "coupon_code_type": { "enum": [ "multi use", "single use" ], "title": "Coupon Code Type", "type": "string" }, "coupon_id": { "title": "Coupon", "type": "string" }, "coupon_type": { "title": "Coupon Type", "type": "string" }, "expiration_date": { "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Expiration Date", "type": "string" }, "expiration_type": { "enum": [ "none", "relative date", "specific date" ], "title": "Expiration Type", "type": "string" }, "maximum_number_of_total_uses": { "description": "The maximum number of total uses", "minimum": 1, "oneOf": [ { "enum": [ 1 ], "x-required": true } ], "title": "Maximum Number Of Total Uses", "type": "integer" }, "maximum_number_of_uses_per_customer": { "description": "The maximum number of total uses for a given customer", "minimum": 1, "oneOf": [ { "enum": [ 1 ], "x-required": true } ], "title": "Maximum Number Of Uses Per Customer", "type": "integer" }, "quantity": { "description": "The number of coupons to generate", "maximum": 250, "title": "Quantity", "type": "integer" }, "relative_expiration_date": { "additionalProperties": false, "description": "Expiration date relative to purchase", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Expiration Date", "type": "object" }, "restrict_to_contact": { "description": "If true, the code generated is restricted to the contact who made the purchase", "title": "Restrict To Contact", "type": "boolean" }, "restrict_to_organization": { "description": "If true, the code generated is restricted to the organization made the purchase", "title": "Restrict To Organization", "type": "boolean" } }, "required": [ "coupon_code_generation_process_id", "coupon_code_type", "coupon_id", "coupon_type", "quantity" ], "type": "object" }, "minItems": 1, "type": "array" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "custom_pricing_options": { "additionalProperties": false, "properties": { "lambda_function_id": { "description": "The custom lambda function to use", "title": "Lambda Function", "type": "string" } }, "required": [ "lambda_function_id" ], "title": "Custom Pricing Options", "type": "object" }, "description": { "description": "Portal visible description for the fee", "title": "Description", "type": "string" }, "document_entitlements_to_create": { "items": { "additionalProperties": false, "properties": { "expiration_date": { "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Expiration Date", "type": "string" }, "expiration_type": { "enum": [ "none", "relative date", "specific date" ], "title": "Expiration Type", "type": "string" }, "file_cabinet_id": { "description": "The file cabinet", "title": "File Cabinet", "type": "string" }, "item_id": { "description": "The item", "title": "Item", "type": "string" }, "library_path": { "description": "The optional path that items will be mounted onto the digital library", "title": "Library Path", "type": "string" }, "relative_expiration_date": { "additionalProperties": false, "description": "The date the task is due", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Expiration Date", "type": "object" } }, "required": [ "expiration_type", "file_cabinet_id" ], "type": "object" }, "type": "array" }, "enable_bulk_pricing": { "description": "Whether or not bulk pricing is enabled", "title": "Enable Bulk Pricing", "type": "boolean" }, "enable_bundled_products": { "description": "Whether to enable bundled products", "title": "Enable Bundled Products", "type": "boolean" }, "enable_cancellation_fees": { "description": "Whether or not cancellation fees are applicable", "title": "Enable Cancellation Fees", "type": "boolean" }, "enable_commerce_entitlement_creation": { "description": "If set, document entitlements will be created to access folders or documents", "title": "Enable Commerce Entitlement Creation", "type": "boolean" }, "enable_coupon_code_generation": { "description": "If true, purchasing this product will generate coupons", "title": "Enable Coupon Code Generation", "type": "boolean" }, "enable_custom_pricing": { "description": "If set, the order engine will call out to a custom lambda function for custom/complex pricing", "title": "Enable Custom Pricing", "type": "boolean" }, "enable_document_entitlement_creation": { "description": "If set, document entitlements will be created to access folders or documents", "title": "Enable Document Entitlement Creation", "type": "boolean" }, "enable_product_confirmation_email": { "description": "If enabled, a custom email goes out whenever this product is ordered", "title": "Enable Product Confirmation Email", "type": "boolean" }, "enable_purchase_limits": { "description": "If true, purchase limits are in place for this product", "title": "Enable Purchase Limits", "type": "boolean" }, "enable_purchasing_eligibility": { "description": "If set, purchases of this merchandise are restricted", "title": "Enable Purchasing Eligibility", "type": "boolean" }, "enable_special_prices": { "description": "Whether to enable special pricing logic", "title": "Enable Special Prices", "type": "boolean" }, "enable_task_generation": { "description": "If set, tasks will be generated", "title": "Enable Task Generation", "type": "boolean" }, "event_id": { "description": "The event", "title": "Event", "type": "string" }, "foreign_currency_prices": { "items": { "additionalProperties": false, "properties": { "cancellation_fee": { "description": "The cancellation fee of the product for this currency", "format": "double", "title": "Cancellation Fee", "type": "number" }, "currency_code": { "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "title": "Currency Code", "type": "string" }, "member_price": { "description": "The price of the product for a member", "format": "double", "title": "Member Price", "type": "number" }, "mode": { "description": "How this foreign currency should be treated", "enum": [ "calculate price", "prohibit purchase", "set price" ], "title": "Mode", "type": "string" }, "price": { "description": "The price of the product", "format": "double", "oneOf": [ { "x-required": true } ], "title": "Price", "type": "number" }, "restocking_fee": { "description": "The restocking fee of the product for this currency", "format": "double", "title": "Restocking Fee", "type": "number" } }, "required": [ "currency_code" ], "type": "object" }, "type": "array" }, "hide_from_portal": { "description": "If set, this product should not be shown in the portal", "title": "Hide From Portal", "type": "boolean" }, "id": { "description": "The unique, string identifier of this miscellaneous product", "pattern": "^[\\w:|-]+$", "title": "ID", "type": "string" }, "installment_plan_options": { "items": { "additionalProperties": false, "properties": { "additional_cost": { "description": "The additional cost of the installment plan", "format": "double", "title": "Additional Cost", "type": "number" }, "installment_plan_id": { "description": "The installment plan that this product supports", "title": "Installment Plan", "type": "string" }, "is_default": { "description": "Whether this is the default installment plan option", "title": "Is Default", "type": "boolean" } }, "required": [ "installment_plan_id" ], "type": "object" }, "minItems": 1, "type": "array" }, "is_active": { "description": "Whether this product is active/used", "title": "Is Active", "type": "boolean" }, "member_price": { "description": "The price of the product for an active member", "format": "double", "title": "Member Price", "type": "number" }, "name": { "description": "The name of the miscellaneous product", "title": "Name", "type": "string" }, "notes": { "description": "Notes", "title": "Notes", "type": "string" }, "portal_options": { "additionalProperties": false, "properties": { "available_from": { "description": "The date from which this product should be available", "format": "date-time", "title": "Available From", "type": "string" }, "available_until": { "description": "The date until which this product should be available", "format": "date-time", "title": "Available Until", "type": "string" } }, "title": "Portal Options", "type": "object" }, "price": { "description": "The price of the product", "format": "double", "title": "Price", "type": "number" }, "product_confirmation_email_options": { "additionalProperties": false, "properties": { "product_confirmation_email_id": { "oneOf": [ { "x-required": true } ], "title": "Product Confirmation Email", "type": "string" }, "product_specific_email": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "bcc": { "description": "Anyone that should be bcc'ed on the email", "title": "Bcc", "type": "string" }, "body": { "description": "The email body", "title": "Body", "type": "string" }, "cc": { "description": "Anyone that should be cc'ed on the email", "title": "Cc", "type": "string" }, "from": { "description": "From email address", "title": "From", "type": "string" }, "from_name": { "description": "From name", "title": "From Name", "type": "string" }, "reply_to": { "description": "The reply to", "title": "Reply To", "type": "string" }, "subject": { "description": "The email subject", "title": "Subject", "type": "string" } }, "required": [ "body", "subject" ], "title": "Product Specific Email", "type": "object" }, "type": { "enum": [ "product specific", "shared" ], "title": "Type", "type": "string" } }, "title": "Product Confirmation Email Options", "type": "object" }, "publish_to_portal": { "description": "Whether or not this product should be available in the portal", "title": "Publish To Portal", "type": "boolean" }, "purchase_limits": { "additionalProperties": false, "properties": { "error_message": { "description": "The error message to show", "title": "Error Message", "type": "string" }, "maximum": { "description": "The maximum", "format": "float", "title": "Maximum", "type": "number" }, "relative_time_window": { "additionalProperties": false, "description": "the time window", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Time Window", "type": "object" }, "time_period": { "enum": [ "all time", "sliding time window" ], "title": "Time Period", "type": "string" }, "type": { "enum": [ "per customer" ], "title": "Type", "type": "string" } }, "required": [ "maximum", "time_period", "type" ], "title": "Purchase Limits", "type": "object" }, "purchasing_eligibility_criteria": { "title": "Purchasing Eligibility Criteria", "type": "object" }, "special_prices": { "items": { "additionalProperties": false, "properties": { "criteria": { "title": "Criteria", "type": "object" }, "enable_formula": { "description": "if set, a formula is used to calculate the price. If the formula fails, the price is used", "title": "Enable Formula", "type": "boolean" }, "formula": { "description": "The formula evaluated using the expr-eval npm package", "oneOf": [ { "x-required": true } ], "title": "Formula", "type": "string" }, "name": { "title": "Name", "type": "string" }, "price": { "format": "float", "title": "Price", "type": "number" } }, "required": [ "criteria", "price" ], "type": "object" }, "minItems": 1, "type": "array" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" }, "tasks_to_generate": { "items": { "additionalProperties": false, "properties": { "assignee_type": { "enum": [ "assignment role", "queue", "user" ], "title": "Assignee Type", "type": "string" }, "assignment_role_id": { "description": "The assignment role that should receive the ask", "oneOf": [ { "x-required": true } ], "title": "Assignment Role", "type": "string" }, "description": { "description": "A description", "title": "Description", "type": "string" }, "due_date_type": { "description": "Whether there is a due date", "enum": [ "none", "relative date", "specific date" ], "title": "Due Date Type", "type": "string" }, "name": { "description": "The name of the task", "title": "Name", "type": "string" }, "notify_assignees": { "description": "Notify assignee when the task is created", "title": "Notify Assignees", "type": "boolean" }, "priority": { "enum": [ "high", "low", "normal", "urgent" ], "title": "Priority", "type": "string" }, "queue_id": { "description": "The queue that should be assigned the ask", "oneOf": [ { "x-required": true } ], "title": "Queue", "type": "string" }, "relative_due_date": { "additionalProperties": false, "description": "The date the task is due", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Due Date", "type": "object" }, "specific_due_date": { "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Specific Due Date", "type": "string" }, "type_id": { "description": "The type of task", "title": "Type", "type": "string" }, "user_id": { "description": "The user that should be assigned the ask", "oneOf": [ { "x-required": true } ], "title": "User", "type": "string" } }, "required": [ "assignee_type", "due_date_type", "name", "type_id" ], "type": "object" }, "type": "array" }, "type": { "description": "The product type", "enum": [ "events-exhibitor-booth-fees" ], "title": "Type", "type": "string" } }, "required": [ "bulk_pricing_rules", "bundled_products", "business_unit_id", "coupon_codes", "custom_pricing_options", "event_id", "id", "installment_plan_options", "name", "price", "product_confirmation_email_options", "purchase_limits", "special_prices", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "ExhibitorBoothGenerationResponse": { "items": { "properties": { "reason": { "type": "string" }, "status": { "enum": [ "fulfilled", "rejected" ], "type": "string" }, "value": { "$ref": "#/components/schemas/ExhibitorBooth" } }, "type": "object" }, "type": "array" }, "ExhibitorBoothType": { "additionalProperties": false, "properties": { "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "id": { "description": "The unique, string identifier of this exhibitor booth type", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "is_active": { "description": "Whether or not this exhibitor booth type is active", "title": "Is Active", "type": "boolean" }, "length": { "description": "Length of the booth", "format": "float", "title": "Length", "type": "number" }, "name": { "description": "The name of the exhibitor booth type", "title": "Name", "type": "string" }, "square_footage": { "description": "The square footage of the booth", "format": "float", "title": "Square Footage", "type": "number" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" }, "width": { "description": "Width of the booth", "format": "float", "title": "Width", "type": "number" } }, "required": [ "id", "length", "name", "square_footage", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id", "width" ], "type": "object" }, "ExhibitorCategory": { "additionalProperties": false, "properties": { "id": { "description": "The unique, string identifier of this exhibitor category", "pattern": "^[\\w:|-]+$", "title": "ID", "type": "string" }, "is_active": { "description": "Whether or not this exhibitor category is active", "title": "Is Active", "type": "boolean" }, "name": { "description": "The name of the exhibitor category", "title": "Name", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "id", "name", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "ExhibitorContactType": { "additionalProperties": false, "properties": { "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "has_administrative_access": { "description": "If true, contacts of this type have administrative access to manage the exhibitors", "title": "Has Administrative Access", "type": "boolean" }, "id": { "description": "The unique, string identifier of this exhibitor contact type", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "is_active": { "description": "Whether or not this exhibitor contact type is active", "title": "Is Active", "type": "boolean" }, "name": { "description": "The name of the exhibitor contact type", "title": "Name", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "id", "name", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "ExhibitorPriorityPointType": { "additionalProperties": false, "properties": { "accumulation_rules": { "items": { "additionalProperties": false, "properties": { "consideration_range_end": { "enum": [ "a relative date", "a specific date", "all time" ], "title": "Consideration Range End", "type": "string" }, "consideration_range_end_relative_date": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Consideration Range End Relative Date", "type": "object" }, "consideration_range_end_specific_date": { "description": "The end date", "oneOf": [ { "x-required": true } ], "title": "Consideration Range End Specific Date", "type": "string" }, "consideration_range_start": { "enum": [ "a relative date", "a specific date", "all time" ], "title": "Consideration Range Start", "type": "string" }, "consideration_range_start_relative_date": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Consideration Range Start Relative Date", "type": "object" }, "consideration_range_start_specific_date": { "description": "The start date", "oneOf": [ { "x-required": true } ], "title": "Consideration Range Start Specific Date", "type": "string" }, "custom_accumulation_rule": { "additionalProperties": false, "anyOf": [ { "x-required": true } ], "properties": { "lambda_function_id": { "description": "The custom lambda function to use", "title": "Lambda Function", "type": "string" } }, "required": [ "lambda_function_id" ], "title": "Custom Accumulation Rule", "type": "object" }, "exhibitor_accumulation_rule": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "booth_type_ids": { "items": { "type": "string" }, "minItems": 1, "oneOf": [ { "x-required": true } ], "title": "Booth Types", "type": "array" }, "booth_type_restriction": { "description": "Determines if/how to restrict the category of booths to include ", "enum": [ "exclude", "include", "none" ], "title": "Booth Type Restriction", "type": "string" }, "calculation_strategy": { "enum": [ "fixed", "per event", "per square footage", "per year" ], "title": "Calculation Strategy", "type": "string" }, "event_ids": { "items": { "type": "string" }, "minItems": 1, "oneOf": [ { "x-required": true } ], "title": "Events", "type": "array" }, "event_restriction": { "description": "Determines if/how to restrict the category of events to include ", "enum": [ "exclude", "include", "none" ], "title": "Event Restriction", "type": "string" }, "event_type_ids": { "items": { "type": "string" }, "minItems": 1, "oneOf": [ { "x-required": true } ], "title": "Event Types", "type": "array" }, "event_type_restriction": { "description": "Determines if/how to restrict the category of events to include ", "enum": [ "exclude", "include", "none" ], "title": "Event Type Restriction", "type": "string" }, "maximum_square_footage": { "description": "Optional maximum amount to consider", "format": "float", "title": "Maximum Square Footage", "type": "number" }, "minimum_square_footage": { "description": "Optional minimum amount of sponsorship to consider", "format": "float", "title": "Minimum Square Footage", "type": "number" }, "number_of_points": { "description": "The number of points to give for the sponsorship", "format": "float", "title": "Number Of Points", "type": "number" }, "square_footage_multiplier": { "format": "float", "minimum": 1, "oneOf": [ { "x-required": true } ], "title": "Square Footage Multiplier", "type": "number" } }, "required": [ "calculation_strategy", "number_of_points" ], "title": "Exhibitor Accumulation Rule", "type": "object" }, "id": { "description": "The rule ID", "title": "ID", "type": "string" }, "membership_accumulation_rule": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "package_ids": { "items": { "type": "string" }, "minItems": 1, "oneOf": [ { "x-required": true } ], "title": "Packages", "type": "array" }, "package_restriction": { "description": "Determines if/how to restrict the package of memberships to include ", "enum": [ "exclude", "include", "none" ], "title": "Package Restriction", "type": "string" }, "points_per_year": { "description": "The number of points received per each year of membership", "format": "float", "title": "Points Per Year", "type": "number" }, "type_ids": { "items": { "type": "string" }, "minItems": 1, "oneOf": [ { "x-required": true } ], "title": "Types", "type": "array" }, "type_restriction": { "description": "Determines if/how to restrict the type of memberships to include ", "enum": [ "exclude", "include", "none" ], "title": "Type Restriction", "type": "string" } }, "required": [ "points_per_year" ], "title": "Membership Accumulation Rule", "type": "object" }, "name": { "description": "A name that describes the rule", "title": "Name", "type": "string" }, "sponsorship_accumulation_rule": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "calculation_strategy": { "enum": [ "assign number of points", "multiply by quantity" ], "title": "Calculation Strategy", "type": "string" }, "category_ids": { "items": { "type": "string" }, "minItems": 1, "oneOf": [ { "x-required": true } ], "title": "Categories", "type": "array" }, "category_restriction": { "description": "Determines if/how to restrict the category of sponsorships to include ", "enum": [ "exclude", "include", "none" ], "title": "Category Restriction", "type": "string" }, "maximum_amount_per_sponsorship": { "description": "Optional maximum amount of sponsorship to consider, per sponsorship", "format": "float", "title": "Maximum Amount Per Sponsorship", "type": "number" }, "maximum_total_amount": { "description": "Optional maximum amount of aggregate sponsorship amount to consider", "format": "float", "title": "Maximum Total Amount", "type": "number" }, "minimum_amount_per_sponsorship": { "description": "Optional minimum amount of sponsorship to consider, per sponsorship", "format": "float", "title": "Minimum Amount Per Sponsorship", "type": "number" }, "minimum_total_amount": { "description": "Optional minimum amount of aggregate sponsorship amount to consider", "format": "float", "title": "Minimum Total Amount", "type": "number" }, "number_of_points": { "description": "The number of points to give for the sponsorship", "format": "float", "title": "Number Of Points", "type": "number" }, "opportunity_ids": { "items": { "type": "string" }, "minItems": 1, "oneOf": [ { "x-required": true } ], "title": "Opportunities", "type": "array" }, "opportunity_restriction": { "description": "Determines if/how to restrict the opportunity of sponsorships to include ", "enum": [ "exclude", "include", "none" ], "title": "Opportunity Restriction", "type": "string" } }, "required": [ "calculation_strategy", "number_of_points" ], "title": "Sponsorship Accumulation Rule", "type": "object" }, "type": { "enum": [ "custom", "exhibitor", "membership", "sponsorship" ], "title": "Type", "type": "string" } }, "required": [ "id", "name", "type" ], "type": "object" }, "minItems": 1, "type": "array" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "enable_accumulation_rules": { "description": "If set, there are automatic rules that allow for point accumulation", "title": "Enable Accumulation Rules", "type": "boolean" }, "id": { "description": "The unique, string identifier of this exhibitor priority point type", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "is_active": { "description": "Whether or not this exhibitor priority point type is active", "title": "Is Active", "type": "boolean" }, "name": { "description": "The name of the exhibitor priority point type", "title": "Name", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "accumulation_rules", "id", "name", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "ExhibitorRegProcess": { "additionalProperties": false, "properties": { "add_on_rules": { "items": { "additionalProperties": false, "properties": { "booth_number_restrictions": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "range_end": { "description": "Number of booths range end", "format": "float", "title": "Range End", "type": "number" }, "range_start": { "description": "Number of booths range start", "format": "float", "title": "Range Start", "type": "number" } }, "title": "Booth Number Restrictions", "type": "object" }, "custom_error_message": { "description": "Optional message to show when restriction is not met", "title": "Custom Error Message", "type": "string" }, "expression_restriction": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "expression": { "description": "The restriction", "title": "Expression", "type": "string" } }, "required": [ "expression" ], "title": "Expression Restriction", "type": "object" }, "id": { "title": "ID", "type": "string" }, "organization_restrictions": { "additionalProperties": false, "properties": { "organization_ids": { "description": "The specific organizations to which this rule applies", "items": { "type": "string" }, "minItems": 1, "title": "Organizations", "type": "array" }, "restriction_type": { "description": "Tye pf restriction (all/none)", "enum": [ "all except specified", "all specified" ], "title": "Restriction Type", "type": "string" } }, "required": [ "organization_ids", "restriction_type" ], "title": "Organization Restrictions", "type": "object" }, "priority_point_restrictions": { "additionalProperties": false, "properties": { "priority_point_type_id": { "description": "Type of priority point", "title": "Priority Point Type", "type": "string" }, "range_end": { "description": "Number of booths range end", "format": "float", "title": "Range End", "type": "number" }, "range_start": { "description": "Number of booths range start", "format": "float", "title": "Range Start", "type": "number" } }, "required": [ "priority_point_type_id" ], "title": "Priority Point Restrictions", "type": "object" }, "restrict_by_number_of_booths": { "description": "If true, this rule takes into account the number of booths selected", "title": "Restrict By Number Of Booths", "type": "boolean" }, "restrict_by_priority_points": { "description": "If true, then we want to restrict b priority points", "title": "Restrict By Priority Points", "type": "boolean" }, "restrict_by_square_footage": { "title": "Restrict By Square Footage", "type": "boolean" }, "restrict_to_specific_organizations": { "description": "If true, only specific organizations have this rule applied to them", "title": "Restrict To Specific Organizations", "type": "boolean" }, "restriction_type": { "enum": [ "expression", "simple" ], "title": "Restriction Type", "type": "string" }, "simple_restriction": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "add_on_product_ids": { "description": "The add on products to which this rule applies", "items": { "type": "string" }, "minItems": 1, "title": "Add On Products", "type": "array" }, "maximum_quantity": { "description": "The maximum quantity of add on products that can be selected from the group of product IDs", "format": "float", "title": "Maximum Quantity", "type": "number" }, "minimum_quantity": { "description": "The minimum quantity of add on products that can be selected from the group of product IDs", "format": "float", "title": "Minimum Quantity", "type": "number" } }, "title": "Simple Restriction", "type": "object" }, "square_footage_restrictions": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "range_end": { "description": "Start of the square footage range", "format": "float", "title": "Range End", "type": "number" }, "range_start": { "description": "Start of the square footage range", "format": "float", "title": "Range Start", "type": "number" } }, "title": "Square Footage Restrictions", "type": "object" } }, "required": [ "id" ], "type": "object" }, "minItems": 1, "type": "array" }, "booth_hold_time": { "description": "The amount of time a booth should be held once selected during a checkout process", "format": "float", "maximum": 60, "minimum": 1, "title": "Booth Hold Time", "type": "number" }, "booth_type_prices": { "items": { "additionalProperties": false, "properties": { "booth_fee_id": { "description": "The booth fee associated with this type", "title": "Booth Fee", "type": "string" }, "booth_type_id": { "description": "The booth type", "title": "Booth Type", "type": "string" } }, "required": [ "booth_fee_id", "booth_type_id" ], "type": "object" }, "minItems": 1, "type": "array" }, "checkout_settings": { "additionalProperties": false, "properties": { "allow_customer_to_choose_installment_plan": { "description": "If true, the customer can choose their installment plan", "title": "Allow Customer To Choose Installment Plan", "type": "boolean" }, "bank_account_id": { "description": "The default bank account that the store should use to receive payments", "title": "Bank Account", "type": "string" }, "bill_my_organization_options": { "additionalProperties": false, "properties": { "billing_address": { "enum": [ "do not show", "optional", "required" ], "title": "Billing Address", "type": "string" }, "purchase_order_number": { "enum": [ "do not show", "optional", "required" ], "title": "Purchase Order Number", "type": "string" }, "reference_number": { "description": "The reference #", "title": "Reference Number", "type": "string" } }, "title": "Bill My Organization Options", "type": "object" }, "bill_my_parent_organization_options": { "additionalProperties": false, "properties": { "billing_address": { "enum": [ "do not show", "optional", "required" ], "title": "Billing Address", "type": "string" }, "purchase_order_number": { "enum": [ "do not show", "optional", "required" ], "title": "Purchase Order Number", "type": "string" }, "reference_number": { "description": "The reference #", "title": "Reference Number", "type": "string" } }, "title": "Bill My Parent Organization Options", "type": "object" }, "business_unit_id": { "description": "The business unit of the store", "title": "Business Unit", "type": "string" }, "cancellation_fee_product_id": { "description": "The ID of the product used for cancellation fees", "title": "Cancellation Fee Product", "type": "string" }, "checkout_donation_options": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "simple_checkout_donation_options": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "allow_user_to_specify_custom_amount": { "description": "If set, the user can specify their own custom donation", "title": "Allow User To Specify Custom Amount", "type": "boolean" }, "donation_ask_text": { "description": "The text shown to the user when making the donation", "title": "Donation Ask Text", "type": "string" }, "donation_denominations": { "items": { "format": "double", "type": "number" }, "title": "Donation Denominations", "type": "array" }, "donation_information": { "description": "Additional information about the donation", "title": "Donation Information", "type": "string" }, "donation_product_id": { "description": "The misc product that should be used", "title": "Donation Product", "type": "string" }, "override_donation_denominations": { "description": "If set, donation denominations are specified here and the defaults are not used", "title": "Override Donation Denominations", "type": "boolean" }, "suggested_donation": { "description": "A suggested donation", "format": "double", "title": "Suggested Donation", "type": "number" } }, "required": [ "donation_product_id" ], "title": "Simple Checkout Donation Options", "type": "object" }, "type": { "enum": [ "simple" ], "title": "Type", "type": "string" } }, "title": "Checkout Donation Options", "type": "object" }, "credit_card_minimum_range_end": { "description": "If set, the maximum amount for which credit cards can be taken", "format": "float", "title": "Credit Card Minimum Range End", "type": "number" }, "credit_card_minimum_range_start": { "description": "If set, the minimum amount for which credit cards can be taken", "format": "float", "title": "Credit Card Minimum Range Start", "type": "number" }, "credit_card_mode": { "description": "Determines whether or not credit cards are accepted", "enum": [ "disabled", "enabled", "range" ], "title": "Credit Card Mode", "type": "string" }, "credit_card_processing_fee_mode": { "description": "Determines how credit card processing fees should be handled", "enum": [ "charge", "do not charge", "prompt user" ], "title": "Credit Card Processing Fee Mode", "type": "string" }, "credit_card_processing_fee_options": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "fee_percentage": { "description": "The fee percentage to charge for credit card processing ", "format": "float", "title": "Fee Percentage", "type": "number" }, "maximum_fee": { "description": "The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged", "format": "float", "title": "Maximum Fee", "type": "number" }, "minimum_fee": { "description": "The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged", "format": "float", "title": "Minimum Fee", "type": "number" }, "product_id": { "description": "The misc product to use for the credit card processing", "title": "Product", "type": "string" }, "prompt_sub_text": { "description": "Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used", "title": "Prompt Sub Text", "type": "string" }, "prompt_text": { "description": "The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used", "title": "Prompt Text", "type": "string" } }, "required": [ "fee_percentage", "product_id" ], "title": "Credit Card Processing Fee Options", "type": "object" }, "disable_electronic_payment_vaulting": { "description": "If set, in the portal people are not allowed to save credit cards", "title": "Disable Electronic Payment Vaulting", "type": "boolean" }, "enable_bill_my_organization": { "description": "If set, the user has the option to bill their organization", "title": "Enable Bill My Organization", "type": "boolean" }, "enable_bill_my_parent_organization": { "description": "If set, the user has the option to bill their organization's parent organization", "title": "Enable Bill My Parent Organization", "type": "boolean" }, "enable_donations_at_checkout": { "description": "If selected, users will be prompted to make a donation upon checking out", "title": "Enable Donations At Checkout", "type": "boolean" }, "enable_electronic_checks": { "description": "If set, electronic checks are allowed", "title": "Enable Electronic Checks", "type": "boolean" }, "enable_pay_later": { "description": "If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed", "title": "Enable Pay Later", "type": "boolean" }, "enable_payroll_deduction": { "description": "If set, payroll deduction is allowed", "title": "Enable Payroll Deduction", "type": "boolean" }, "enable_split_payments": { "description": "If set, users are allowed to split payments", "title": "Enable Split Payments", "type": "boolean" }, "installment_plan_options": { "items": { "additionalProperties": false, "properties": { "additional_cost": { "description": "The additional cost of the installment plan", "format": "double", "title": "Additional Cost", "type": "number" }, "installment_plan_id": { "description": "The installment plan that this product supports", "title": "Installment Plan", "type": "string" }, "is_default": { "description": "Whether this is the default installment plan option", "title": "Is Default", "type": "boolean" } }, "required": [ "installment_plan_id" ], "type": "object" }, "minItems": 1, "oneOf": [ { "x-required": true } ], "type": "array" }, "invoice_payment_terms_id": { "description": "The payment terms for invoices; if left blank, default is used", "title": "Invoice Payment Terms", "type": "string" }, "invoice_template_id": { "description": "The template to use for invoices created during this process", "title": "Invoice Template", "type": "string" }, "merchant_account_id": { "description": "The merchant account that the store should use to receive payments", "title": "Merchant Account", "type": "string" }, "pay_later_options": { "additionalProperties": false, "properties": { "billing_address": { "enum": [ "do not show", "optional", "required" ], "title": "Billing Address", "type": "string" }, "purchase_order_number": { "enum": [ "do not show", "optional", "required" ], "title": "Purchase Order Number", "type": "string" }, "reference_number": { "description": "The reference #", "title": "Reference Number", "type": "string" } }, "title": "Pay Later Options", "type": "object" }, "restocking_fee_product_id": { "description": "The ID of the product used for restocking fees", "title": "Restocking Fee Product", "type": "string" }, "special_instructions": { "description": "Instructions shown to the user", "title": "Special Instructions", "type": "string" }, "use_pro_forma_invoices": { "description": "Whether to use pro forma invoices when user elects to pay later", "title": "Use Pro Forma Invoices", "type": "boolean" } }, "required": [ "bank_account_id", "business_unit_id", "merchant_account_id" ], "title": "Checkout Settings", "type": "object" }, "close_date": { "description": "The date at which the process is closed and no longer available", "format": "date-time", "title": "Close Date", "type": "string" }, "confirmation_email": { "additionalProperties": false, "description": "The email to send when the application is received", "properties": { "bcc": { "description": "Anyone that should be bcc'ed on the email", "title": "Bcc", "type": "string" }, "body": { "description": "The email body", "title": "Body", "type": "string" }, "cc": { "description": "Anyone that should be cc'ed on the email", "title": "Cc", "type": "string" }, "from": { "description": "From email address", "title": "From", "type": "string" }, "from_name": { "description": "From name", "title": "From Name", "type": "string" }, "reply_to": { "description": "The reply to", "title": "Reply To", "type": "string" }, "subject": { "description": "The email subject", "title": "Subject", "type": "string" } }, "required": [ "body", "subject" ], "title": "Confirmation Email", "type": "object" }, "contact_form_options": { "additionalProperties": false, "properties": { "contact_form_id": { "description": "The default contact form to present to the user to verify the contact info before proceeding", "pattern": "^rolodex-contacts__.*", "title": "Contact Form", "type": "string" }, "html": { "description": "Text to show on the top of the form", "title": "Html", "type": "string" } }, "required": [ "contact_form_id" ], "title": "Contact Form Options", "type": "object" }, "custom_confirmation_page_html": { "description": "The custom confirmation page HTML", "title": "Custom Confirmation Page Html", "type": "string" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "description": { "description": "Description of the process", "title": "Description", "type": "string" }, "display_in_portal_as": { "description": "How this process should appear in the portal", "title": "Display In Portal As", "type": "string" }, "display_order": { "description": "The display order", "format": "float", "title": "Display Order", "type": "number" }, "eligibility_criteria": { "additionalProperties": false, "description": "The criteria to use", "properties": { "advanced_rule_error_message": { "description": "The error message to show when the advanced rule fails", "title": "Advanced Rule Error Message", "type": "string" }, "advanced_rules": { "title": "Advanced Rules", "type": "object" }, "age_restrictions": { "additionalProperties": false, "properties": { "maximum_age": { "description": "The maximum age of the contact", "format": "float", "title": "Maximum Age", "type": "number" }, "minimum_age": { "description": "The minimum age of the contact", "format": "float", "title": "Minimum Age", "type": "number" } }, "title": "Age Restrictions", "type": "object" }, "award_options": { "additionalProperties": false, "properties": { "award_ids": { "items": { "type": "string" }, "title": "Awards", "type": "array" }, "award_type_ids": { "items": { "type": "string" }, "title": "Award Types", "type": "array" }, "logic_operator": { "enum": [ "and", "not" ], "title": "Logic Operator", "type": "string" } }, "title": "Award Options", "type": "object" }, "award_recipients": { "description": "If set, only people who have received awards", "title": "Award Recipients", "type": "boolean" }, "by_location": { "description": "If true, then filter by location", "title": "By Location", "type": "boolean" }, "certificants": { "description": "If set, only people with specific certifications", "title": "Certificants", "type": "boolean" }, "certification_options": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "logic_operator": { "enum": [ "and", "not" ], "title": "Logic Operator", "type": "string" }, "program_ids": { "items": { "type": "string" }, "title": "Programs", "type": "array" } }, "title": "Certification Options", "type": "object" }, "committee_member_options": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "committee_ids": { "items": { "type": "string" }, "title": "Committees", "type": "array" }, "committee_position_ids": { "items": { "type": "string" }, "title": "Committee Positions", "type": "array" }, "committee_type_ids": { "items": { "type": "string" }, "title": "Committee Types", "type": "array" }, "logic_operator": { "enum": [ "and", "not" ], "title": "Logic Operator", "type": "string" } }, "title": "Committee Member Options", "type": "object" }, "committee_members": { "description": "If set, active members who belong to a committee can purchase", "title": "Committee Members", "type": "boolean" }, "custom_logic_options": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "lambda_function_id": { "description": "The custom lambda function to use", "title": "Lambda Function", "type": "string" } }, "required": [ "lambda_function_id" ], "title": "Custom Logic Options", "type": "object" }, "customer_type": { "enum": [ "contact", "organization" ], "title": "Customer Type", "type": "string" }, "donor_options": { "additionalProperties": false, "properties": { "donor_club_ids": { "items": { "type": "string" }, "title": "Donor Clubs", "type": "array" }, "logic_operator": { "enum": [ "and", "not" ], "title": "Logic Operator", "type": "string" } }, "title": "Donor Options", "type": "object" }, "donors": { "description": "If true, only donors", "title": "Donors", "type": "boolean" }, "enable_advanced_rules": { "description": "Enable advanced JSON rules", "title": "Enable Advanced Rules", "type": "boolean" }, "enable_age_restrictions": { "description": "Age registrations", "title": "Enable Age Restrictions", "type": "boolean" }, "enable_custom_logic": { "description": "If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion", "title": "Enable Custom Logic", "type": "boolean" }, "enable_entitlement_restrictions": { "description": "If set, then you must have certain entitlements", "title": "Enable Entitlement Restrictions", "type": "boolean" }, "enable_expression": { "description": "Whether or not to enable an expression for evaluation", "title": "Enable Expression", "type": "boolean" }, "enable_organization_restrictions": { "description": "If set, you can restrict organizations", "title": "Enable Organization Restrictions", "type": "boolean" }, "enable_status_restriction": { "description": "If set, you can restrict by status", "title": "Enable Status Restriction", "type": "boolean" }, "entitlement_restrictions": { "items": { "additionalProperties": false, "properties": { "quantity": { "description": "The quantity you must have", "format": "float", "title": "Quantity", "type": "number" }, "type_id": { "description": "The type of entitlement", "title": "Type", "type": "string" } }, "required": [ "type_id" ], "type": "object" }, "type": "array" }, "event_registration_options": { "additionalProperties": false, "properties": { "event_ids": { "items": { "type": "string" }, "title": "Events", "type": "array" }, "logic_operator": { "enum": [ "and", "not" ], "title": "Logic Operator", "type": "string" }, "registration_category_ids": { "items": { "type": "string" }, "title": "Registration Categories", "type": "array" } }, "title": "Event Registration Options", "type": "object" }, "event_registrations": { "description": "If set, only people who have registered for events", "title": "Event Registrations", "type": "boolean" }, "expression": { "description": "The expression", "title": "Expression", "type": "string" }, "expression_error_message": { "description": "The error message to show when the expression fails", "title": "Expression Error Message", "type": "string" }, "location": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "countries": { "description": "Countries", "items": { "type": "string" }, "title": "Countries", "type": "array" }, "negate_logic": { "description": "If true, the logic in this section is negated; so NOT from these places", "title": "Negate Logic", "type": "boolean" } }, "title": "Location", "type": "object" }, "logic_operator": { "enum": [ "and", "not" ], "title": "Logic Operator", "type": "string" }, "member_options": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "chapter_member_options": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "chapter_ids": { "items": { "type": "string" }, "title": "Chapters", "type": "array" }, "chapter_type_ids": { "items": { "type": "string" }, "title": "Chapter Types", "type": "array" }, "logic_operator": { "enum": [ "and", "not" ], "title": "Logic Operator", "type": "string" } }, "title": "Chapter Member Options", "type": "object" }, "chapter_members": { "description": "If set, active members who belong to a chapter can purchase", "title": "Chapter Members", "type": "boolean" }, "member_package_ids": { "description": "The member package", "items": { "type": "string" }, "title": "Member Packages", "type": "array" }, "member_status_reason_ids": { "items": { "type": "string" }, "title": "Member Status Reasons", "type": "array" }, "member_statuses": { "items": { "enum": [ "active", "inactive", "suspended" ], "type": "string" }, "title": "Member Statuses", "type": "array" }, "member_type_ids": { "description": "The member types", "items": { "type": "string" }, "title": "Member Types", "type": "array" }, "section_member_options": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "logic_operator": { "enum": [ "and", "not" ], "title": "Logic Operator", "type": "string" }, "section_ids": { "items": { "type": "string" }, "title": "Sections", "type": "array" }, "section_type_ids": { "items": { "type": "string" }, "title": "Section Types", "type": "array" } }, "title": "Section Member Options", "type": "object" }, "section_members": { "description": "If set, active members who belong to a section can purchase", "title": "Section Members", "type": "boolean" } }, "title": "Member Options", "type": "object" }, "members": { "description": "If set, active members can purchase this", "title": "Members", "type": "boolean" }, "non_members": { "description": "If set, only nonmembers can purchase", "title": "Non Members", "type": "boolean" }, "organization_restrictions": { "additionalProperties": false, "properties": { "contact_role_ids": { "items": { "type": "string" }, "title": "Contact Roles", "type": "array" }, "organization_type_ids": { "items": { "type": "string" }, "title": "Organization Types", "type": "array" } }, "title": "Organization Restrictions", "type": "object" }, "status_restrictions": { "description": "The statuses", "items": { "type": "string" }, "minItems": 1, "oneOf": [ { "x-required": true } ], "title": "Status Restrictions", "type": "array" }, "use_organization_for_eligibility": { "description": "If checked, a person's organization is used to check for eligibility, rather than the person themselves", "title": "Use Organization For Eligibility", "type": "boolean" } }, "title": "Eligibility Criteria", "type": "object" }, "enable_add_on_rules": { "description": "If set, you can define rules about how many adds on can or should be selected", "title": "Enable Add On Rules", "type": "boolean" }, "enable_confirmation_email": { "description": "Whether or not an email should be sent when the application is received", "title": "Enable Confirmation Email", "type": "boolean" }, "enable_custom_confirmation_page_html": { "description": "enable custom text to show on the confirmation page", "title": "Enable Custom Confirmation Page Html", "type": "boolean" }, "enable_eligibility_criteria": { "description": "If set, only certain people can register with this type", "title": "Enable Eligibility Criteria", "type": "boolean" }, "event_id": { "description": "The event", "title": "Event", "type": "string" }, "form_id": { "description": "The registration form", "pattern": "events-exhibitor-registrations__.*", "title": "Form", "type": "string" }, "id": { "description": "The unique, string identifier of this exhibitor reg process", "title": "ID", "type": "string" }, "is_active": { "description": "Whether or not this exhibitor reg process is active", "title": "Is Active", "type": "boolean" }, "name": { "description": "The name of the exhibitor reg process", "title": "Name", "type": "string" }, "open_date": { "description": "The date at which the process is open", "format": "date-time", "title": "Open Date", "type": "string" }, "organization_form_options": { "additionalProperties": false, "properties": { "html": { "description": "Text to show on the top of the form", "title": "Html", "type": "string" }, "organization_form_id": { "description": "The default organization form to present to the user to verify the organization info before proceeding", "pattern": "^rolodex-organizations__.*", "title": "Organization Form", "type": "string" } }, "required": [ "organization_form_id" ], "title": "Organization Form Options", "type": "object" }, "override_checkout_settings": { "description": "Whether or not to override POC settings", "title": "Override Checkout Settings", "type": "boolean" }, "priority_point_restriction": { "additionalProperties": false, "properties": { "maximum": { "description": "The maximum number of points", "format": "float", "title": "Maximum", "type": "number" }, "minimum": { "description": "The minimum number of points", "format": "float", "title": "Minimum", "type": "number" }, "priority_point_type_id": { "description": "The type of priority point", "title": "Priority Point Type", "type": "string" } }, "required": [ "priority_point_type_id" ], "title": "Priority Point Restriction", "type": "object" }, "restrict_by_priority_points": { "description": "If true, this process is only available to people with a certain number of priority points", "title": "Restrict By Priority Points", "type": "boolean" }, "selectable_in_portal": { "description": "Whether this type can be chosen in the portal", "title": "Selectable In Portal", "type": "boolean" }, "selection_mode": { "description": "Determines how the user will select booths for this floor", "enum": [ "select booth types", "select booths", "virtual show floor" ], "title": "Selection Mode", "type": "string" }, "show_contact_form": { "description": "Whether or not to show a contact form", "title": "Show Contact Form", "type": "boolean" }, "show_organization_form": { "description": "Whether or not to show an organization form", "title": "Show Organization Form", "type": "boolean" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "add_on_rules", "booth_type_prices", "checkout_settings", "close_date", "confirmation_email", "contact_form_options", "custom_confirmation_page_html", "eligibility_criteria", "event_id", "form_id", "id", "name", "open_date", "organization_form_options", "priority_point_restriction", "selection_mode", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "ExhibitorRegistration": { "additionalProperties": false, "properties": { "add_ons": { "items": { "additionalProperties": false, "properties": { "add_on_product_id": { "description": "The add on product", "title": "Add On Product", "type": "string" }, "quantity": { "format": "float", "title": "Quantity", "type": "number" } }, "required": [ "add_on_product_id", "quantity" ], "type": "object" }, "type": "array" }, "booth_types": { "items": { "additionalProperties": false, "properties": { "booth_type_id": { "description": "The type of booth", "title": "Booth Type", "type": "string" }, "quantity": { "description": "The number of booths", "format": "float", "minimum": 1, "title": "Quantity", "type": "number" } }, "required": [ "booth_type_id", "quantity" ], "type": "object" }, "minItems": 1, "type": "array" }, "booths": { "items": { "additionalProperties": false, "properties": { "booth_id": { "description": "The booth", "title": "Booth", "type": "string" } }, "required": [ "booth_id" ], "type": "object" }, "minItems": 1, "type": "array" }, "contact_id": { "description": "The contact ID of the registrant", "title": "Contact", "type": "string" }, "contacts": { "items": { "additionalProperties": false, "properties": { "contact_id": { "oneOf": [ { "x-required": true } ], "title": "Contact", "type": "string" }, "new_contact_info": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": {}, "title": "New Contact Info", "type": "object" }, "new_or_existing": { "enum": [ "existing", "new" ], "title": "New Or Existing", "type": "string" }, "type_id": { "description": "The contact type", "title": "Type", "type": "string" } }, "required": [ "new_or_existing", "type_id" ], "type": "object" }, "type": "array" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "date": { "description": "The date of registration", "format": "date-time", "title": "Date", "type": "string" }, "description": { "description": "Exhibitor description, shown in the portal", "title": "Description", "type": "string" }, "event_id": { "description": "The event", "title": "Event", "type": "string" }, "exhibitor_id": { "description": "The exhibitor id", "title": "Exhibitor", "type": "string" }, "id": { "description": "The unique, string identifier of this registration group", "pattern": "^[\\w|:-]+$", "title": "ID", "type": "string" }, "internal_notes": { "description": "Any applicable notes", "title": "Internal Notes", "type": "string" }, "logo_url": { "description": "Url of a logo for this organization", "title": "Logo Url", "type": "string" }, "notes": { "description": "Notes", "title": "Notes", "type": "string" }, "number": { "description": "The registration number", "format": "float", "title": "Number", "type": "number" }, "order_amount_paid": { "description": "The amount paid", "format": "double", "title": "Order Amount Paid", "type": "number" }, "order_balance_due": { "description": "The balance due on the order", "format": "double", "title": "Order Balance Due", "type": "number" }, "order_currency_code": { "title": "Order Currency Code", "type": "string" }, "order_currency_symbol": { "title": "Order Currency Symbol", "type": "string" }, "order_id": { "description": "The order", "title": "Order", "type": "string" }, "order_line_item_id": { "description": "The order line item", "title": "Order Line Item", "type": "string" }, "order_number": { "description": "The order number", "format": "float", "title": "Order Number", "type": "number" }, "order_status": { "enum": [ "awaiting payment", "awaiting pickup", "awaiting shipping", "cancelled", "completed", "disputed", "open", "partially shipped", "returned", "shipped", "void" ], "title": "Order Status", "type": "string" }, "order_total": { "description": "The total of the order", "format": "double", "title": "Order Total", "type": "number" }, "organization_id": { "description": "The organization associated with this registration", "title": "Organization", "type": "string" }, "process_id": { "description": "The registration process", "title": "Process", "type": "string" }, "status": { "enum": [ "cancelled", "draft", "fulfilled" ], "title": "Status", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "contact_id", "event_id", "exhibitor_id", "id", "organization_id", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "ExhibitorSetting": { "additionalProperties": false, "properties": { "allow_customer_to_choose_installment_plan": { "description": "If true, the customer can choose their installment plan", "title": "Allow Customer To Choose Installment Plan", "type": "boolean" }, "bank_account_id": { "description": "The default bank account that the store should use to receive payments", "title": "Bank Account", "type": "string" }, "bill_my_organization_options": { "additionalProperties": false, "properties": { "billing_address": { "enum": [ "do not show", "optional", "required" ], "title": "Billing Address", "type": "string" }, "purchase_order_number": { "enum": [ "do not show", "optional", "required" ], "title": "Purchase Order Number", "type": "string" }, "reference_number": { "description": "The reference #", "title": "Reference Number", "type": "string" } }, "title": "Bill My Organization Options", "type": "object" }, "bill_my_parent_organization_options": { "additionalProperties": false, "properties": { "billing_address": { "enum": [ "do not show", "optional", "required" ], "title": "Billing Address", "type": "string" }, "purchase_order_number": { "enum": [ "do not show", "optional", "required" ], "title": "Purchase Order Number", "type": "string" }, "reference_number": { "description": "The reference #", "title": "Reference Number", "type": "string" } }, "title": "Bill My Parent Organization Options", "type": "object" }, "booth_colors": { "additionalProperties": false, "description": "Allow you to set colors for the show floor", "properties": { "available": { "title": "Available", "type": "string" }, "pending": { "title": "Pending", "type": "string" }, "reserved": { "title": "Reserved", "type": "string" } }, "title": "Booth Colors", "type": "object" }, "business_unit_id": { "description": "The business unit of the store", "title": "Business Unit", "type": "string" }, "cancellation_fee_product_id": { "description": "The ID of the product used for cancellation fees", "title": "Cancellation Fee Product", "type": "string" }, "checkout_donation_options": { "additionalProperties": false, "properties": { "simple_checkout_donation_options": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "allow_user_to_specify_custom_amount": { "description": "If set, the user can specify their own custom donation", "title": "Allow User To Specify Custom Amount", "type": "boolean" }, "donation_ask_text": { "description": "The text shown to the user when making the donation", "title": "Donation Ask Text", "type": "string" }, "donation_denominations": { "items": { "format": "double", "type": "number" }, "title": "Donation Denominations", "type": "array" }, "donation_information": { "description": "Additional information about the donation", "title": "Donation Information", "type": "string" }, "donation_product_id": { "description": "The misc product that should be used", "title": "Donation Product", "type": "string" }, "override_donation_denominations": { "description": "If set, donation denominations are specified here and the defaults are not used", "title": "Override Donation Denominations", "type": "boolean" }, "suggested_donation": { "description": "A suggested donation", "format": "double", "title": "Suggested Donation", "type": "number" } }, "required": [ "donation_product_id" ], "title": "Simple Checkout Donation Options", "type": "object" }, "type": { "enum": [ "simple" ], "title": "Type", "type": "string" } }, "title": "Checkout Donation Options", "type": "object" }, "contact_restriction_rules": { "description": "Contact rules restricted if enabled by enable_contact_restriction_rules flag", "items": { "additionalProperties": false, "properties": { "contact_type_id": { "title": "Contact Type", "type": "string" }, "maximum_number_of_contacts": { "format": "float", "title": "Maximum Number Of Contacts", "type": "number" }, "priority_point_type_id": { "description": "The optional priority point type to use for restricting points", "title": "Priority Point Type", "type": "string" }, "priority_points_range_end": { "format": "float", "title": "Priority Points Range End", "type": "number" }, "priority_points_range_start": { "format": "float", "title": "Priority Points Range Start", "type": "number" }, "square_footage_range_end": { "format": "float", "title": "Square Footage Range End", "type": "number" }, "square_footage_range_start": { "format": "float", "title": "Square Footage Range Start", "type": "number" } }, "required": [ "contact_type_id", "maximum_number_of_contacts" ], "type": "object" }, "minItems": 1, "type": "array" }, "contact_role_ids": { "description": "When access is restricted, these contact roles can perform exhibitor activities", "items": { "type": "string" }, "minItems": 1, "title": "Contact Roles", "type": "array" }, "credit_card_minimum_range_end": { "description": "If set, the maximum amount for which credit cards can be taken", "format": "float", "title": "Credit Card Minimum Range End", "type": "number" }, "credit_card_minimum_range_start": { "description": "If set, the minimum amount for which credit cards can be taken", "format": "float", "title": "Credit Card Minimum Range Start", "type": "number" }, "credit_card_mode": { "description": "Determines whether or not credit cards are accepted", "enum": [ "disabled", "enabled", "range" ], "title": "Credit Card Mode", "type": "string" }, "credit_card_processing_fee_mode": { "description": "Determines how credit card processing fees should be handled", "enum": [ "charge", "do not charge", "prompt user" ], "title": "Credit Card Processing Fee Mode", "type": "string" }, "credit_card_processing_fee_options": { "additionalProperties": false, "properties": { "fee_percentage": { "description": "The fee percentage to charge for credit card processing ", "format": "float", "title": "Fee Percentage", "type": "number" }, "maximum_fee": { "description": "The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged", "format": "float", "title": "Maximum Fee", "type": "number" }, "minimum_fee": { "description": "The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged", "format": "float", "title": "Minimum Fee", "type": "number" }, "product_id": { "description": "The misc product to use for the credit card processing", "title": "Product", "type": "string" }, "prompt_sub_text": { "description": "Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used", "title": "Prompt Sub Text", "type": "string" }, "prompt_text": { "description": "The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used", "title": "Prompt Text", "type": "string" } }, "required": [ "fee_percentage", "product_id" ], "title": "Credit Card Processing Fee Options", "type": "object" }, "disable_electronic_payment_vaulting": { "description": "If set, in the portal people are not allowed to save credit cards", "title": "Disable Electronic Payment Vaulting", "type": "boolean" }, "enable_bill_my_organization": { "description": "If set, the user has the option to bill their organization", "title": "Enable Bill My Organization", "type": "boolean" }, "enable_bill_my_parent_organization": { "description": "If set, the user has the option to bill their organization's parent organization", "title": "Enable Bill My Parent Organization", "type": "boolean" }, "enable_contact_restriction_rules": { "title": "Enable Contact Restriction Rules", "type": "boolean" }, "enable_donations_at_checkout": { "description": "If selected, users will be prompted to make a donation upon checking out", "title": "Enable Donations At Checkout", "type": "boolean" }, "enable_electronic_checks": { "description": "If set, electronic checks are allowed", "title": "Enable Electronic Checks", "type": "boolean" }, "enable_pay_later": { "description": "If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed", "title": "Enable Pay Later", "type": "boolean" }, "enable_payroll_deduction": { "description": "If set, payroll deduction is allowed", "title": "Enable Payroll Deduction", "type": "boolean" }, "enable_split_payments": { "description": "If set, users are allowed to split payments", "title": "Enable Split Payments", "type": "boolean" }, "id": { "description": "The unique, string identifier of this exhibitor setting", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "installment_plan_options": { "items": { "additionalProperties": false, "properties": { "additional_cost": { "description": "The additional cost of the installment plan", "format": "double", "title": "Additional Cost", "type": "number" }, "installment_plan_id": { "description": "The installment plan that this product supports", "title": "Installment Plan", "type": "string" }, "is_default": { "description": "Whether this is the default installment plan option", "title": "Is Default", "type": "boolean" } }, "required": [ "installment_plan_id" ], "type": "object" }, "minItems": 1, "type": "array" }, "invoice_payment_terms_id": { "description": "The payment terms for invoices; if left blank, default is used", "title": "Invoice Payment Terms", "type": "string" }, "invoice_template_id": { "description": "The template to use for invoices created during this process", "title": "Invoice Template", "type": "string" }, "maximum_description_character_count": { "description": "The maximum number of characters for the exhibitor description", "format": "float", "title": "Maximum Description Character Count", "type": "number" }, "merchant_account_id": { "description": "The merchant account that the store should use to receive payments", "title": "Merchant Account", "type": "string" }, "notes": { "title": "Notes", "type": "string" }, "pay_later_options": { "additionalProperties": false, "properties": { "billing_address": { "enum": [ "do not show", "optional", "required" ], "title": "Billing Address", "type": "string" }, "purchase_order_number": { "enum": [ "do not show", "optional", "required" ], "title": "Purchase Order Number", "type": "string" }, "reference_number": { "description": "The reference #", "title": "Reference Number", "type": "string" } }, "title": "Pay Later Options", "type": "object" }, "restocking_fee_product_id": { "description": "The ID of the product used for restocking fees", "title": "Restocking Fee Product", "type": "string" }, "restrict_portal_access": { "description": "If true, only certain contact roles can access exhibitor settings", "title": "Restrict Portal Access", "type": "boolean" }, "schedule": { "description": "An array of date/time ranges that indicate the hours at which the show floor is open.", "items": { "additionalProperties": false, "properties": { "name": { "title": "Name", "type": "string" }, "range_end": { "format": "date-time", "title": "Range End", "type": "string" }, "range_start": { "format": "date-time", "title": "Range Start", "type": "string" } }, "required": [ "name", "range_end", "range_start" ], "type": "object" }, "type": "array" }, "special_instructions": { "description": "Instructions shown to the user", "title": "Special Instructions", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" }, "use_pro_forma_invoices": { "description": "Whether to use pro forma invoices when user elects to pay later", "title": "Use Pro Forma Invoices", "type": "boolean" } }, "required": [ "bank_account_id", "business_unit_id", "checkout_donation_options", "contact_restriction_rules", "contact_role_ids", "credit_card_processing_fee_options", "id", "installment_plan_options", "merchant_account_id", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "ExhibitorShowFloor": { "additionalProperties": false, "properties": { "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "display_order": { "description": "The display order of the floor", "format": "float", "title": "Display Order", "type": "number" }, "enable_virtual_show_floor": { "description": "If true, a virtual show floor is displayed to the user for selection", "title": "Enable Virtual Show Floor", "type": "boolean" }, "event_id": { "description": "The event id", "title": "Event", "type": "string" }, "id": { "description": "The unique, string identifier of this exhibitor show floor", "pattern": "^[\\w|:-]+$", "title": "ID", "type": "string" }, "image_uri": { "description": "Image representation of the show flow", "title": "Image Uri", "type": "string" }, "instructions": { "description": "Instructions to display to a user purchasing booths on this floor", "title": "Instructions", "type": "string" }, "name": { "description": "The name of the exhibitor show floor", "title": "Name", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" }, "virtual_show_floor_layout": { "additionalProperties": false, "description": "Contains a JSON representation of the booth configuration", "properties": {}, "title": "Virtual Show Floor Layout", "type": "object" } }, "required": [ "display_order", "event_id", "id", "name", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id", "virtual_show_floor_layout" ], "type": "object" }, "Function": { "additionalProperties": false, "properties": { "capacity_options": { "additionalProperties": false, "properties": { "capacity": { "format": "float", "minimum": 0, "title": "Capacity", "type": "number" }, "enable_wait_list": { "description": "If set, people can be placed on a wait list", "title": "Enable Wait List", "type": "boolean" }, "waitlist_process_id": { "description": "The process to use for managing the waitlist", "oneOf": [ { "x-required": true } ], "title": "Waitlist Process", "type": "string" } }, "required": [ "capacity" ], "title": "Capacity Options", "type": "object" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "description": { "description": "Description of the function", "title": "Description", "type": "string" }, "display_order": { "description": "Display order", "format": "float", "title": "Display Order", "type": "number" }, "enable_capacity": { "description": "If set, the session has a capacity", "title": "Enable Capacity", "type": "boolean" }, "enable_meal_options": { "description": "Whether or not meal options are available", "title": "Enable Meal Options", "type": "boolean" }, "enable_registration_questions": { "description": "If set, a user is prompted to answer questions during registration", "title": "Enable Registration Questions", "type": "boolean" }, "end_date": { "format": "date-time", "title": "End Date", "type": "string" }, "event_id": { "description": "The event id", "title": "Event", "type": "string" }, "hide_from_portal": { "description": "This session is not displayed in the portal or available for registration", "title": "Hide From Portal", "type": "boolean" }, "hide_from_schedule": { "description": "If selected, hide this session from the online schedule", "title": "Hide From Schedule", "type": "boolean" }, "id": { "description": "The unique, string identifier of this function", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "location": { "title": "Location", "type": "string" }, "maximum_allowed_tickets": { "description": "The maximum # of tickets that can be purchased", "format": "float", "title": "Maximum Allowed Tickets", "type": "number" }, "meal_options": { "items": { "additionalProperties": false, "properties": { "description": { "title": "Description", "type": "string" }, "id": { "title": "ID", "type": "string" }, "items": { "items": { "additionalProperties": false, "properties": { "logistics_item_id": { "description": "The item ID", "title": "Logistics Item", "type": "string" }, "quantity": { "description": "The quantity", "format": "float", "title": "Quantity", "type": "number" } }, "required": [ "logistics_item_id" ], "type": "object" }, "type": "array" }, "name": { "title": "Name", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "minItems": 1, "type": "array" }, "name": { "description": "The name of the function", "title": "Name", "type": "string" }, "purchase_restriction": { "enum": [ "by registration package", "disabled", "for all registrants" ], "title": "Purchase Restriction", "type": "string" }, "registration_package_restrictions": { "items": { "additionalProperties": false, "properties": { "maximum_allowed_tickets": { "description": "The maximum # of tickets; if unset, there is no maximum", "format": "float", "title": "Maximum Allowed Tickets", "type": "number" }, "registration_package_id": { "description": "The registration package", "title": "Registration Package", "type": "string" } }, "required": [ "registration_package_id" ], "type": "object" }, "type": "array" }, "registration_question_options": { "additionalProperties": false, "properties": { "custom_fields": { "description": "The custom fields to display", "items": { "additionalProperties": false, "properties": { "id": { "description": "The custom field", "title": "ID", "type": "string" }, "label": { "description": "An optional label", "title": "Label", "type": "string" }, "required": { "description": "Whether the field is required", "title": "Required", "type": "boolean" } }, "required": [ "id" ], "type": "object" }, "type": "array" }, "registration_instructions": { "description": "Instructions to show during registration for the session", "title": "Registration Instructions", "type": "string" }, "request_meal_preference": { "description": "If true, the meal preference should be requested", "title": "Request Meal Preference", "type": "boolean" } }, "title": "Registration Question Options", "type": "object" }, "room_ids": { "description": "The room(s) where the function is located", "items": { "type": "string" }, "title": "Rooms", "type": "array" }, "sold_out": { "description": "Whether the function is sold out", "title": "Sold Out", "type": "boolean" }, "start_date": { "format": "date-time", "title": "Start Date", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" }, "type_id": { "description": "The type of function", "title": "Type", "type": "string" } }, "required": [ "capacity_options", "event_id", "id", "maximum_allowed_tickets", "meal_options", "name", "registration_package_restrictions", "registration_question_options", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id", "type_id" ], "type": "object" }, "FunctionFee": { "additionalProperties": false, "properties": { "abbreviated_name": { "description": "The abbreviated name when viewing the product inside of an event", "title": "Abbreviated Name", "type": "string" }, "allow_customer_to_choose_installment_plan": { "description": "If true, the customer can choose their installment plan", "title": "Allow Customer To Choose Installment Plan", "type": "boolean" }, "bulk_pricing_rules": { "items": { "additionalProperties": false, "properties": { "discount_amount": { "description": "The percentage/flat rate", "format": "float", "minimum": 0, "title": "Discount Amount", "type": "number" }, "discount_type": { "description": "The type of discount rule", "enum": [ "flat rate", "percentage" ], "title": "Discount Type", "type": "string" }, "ending_range": { "description": "The ending range of the rule", "minimum": 0, "title": "Ending Range", "type": "integer" }, "starting_range": { "description": "The starting range of the rule", "minimum": 0, "title": "Starting Range", "type": "integer" } }, "required": [ "discount_amount", "discount_type" ], "type": "object" }, "minItems": 1, "type": "array" }, "bundled_products": { "items": { "additionalProperties": false, "properties": { "member_price": { "description": "The member price", "format": "double", "title": "Member Price", "type": "number" }, "price": { "description": "The price to bundle", "format": "double", "title": "Price", "type": "number" }, "product_id": { "description": "The product ID", "title": "Product", "type": "string" }, "product_type": { "description": "The product type", "title": "Product Type", "type": "string" }, "quantity": { "description": "The quantity to bundle", "title": "Quantity", "type": "integer" }, "type": { "enum": [ "bundled product", "inline bundled product" ], "title": "Type", "type": "string" } }, "required": [ "product_id", "product_type", "quantity", "type" ], "type": "object" }, "minItems": 1, "type": "array" }, "bundled_products_inventory_handling": { "description": "Whether to track inventory for the entire bundle, or for each product separately", "enum": [ "bundle", "each product" ], "title": "Bundled Products Inventory Handling", "type": "string" }, "business_unit_id": { "description": "The business unit of the product", "title": "Business Unit", "type": "string" }, "cancellation_fee": { "description": "Cancellation fees associated with this product", "format": "double", "title": "Cancellation Fee", "type": "number" }, "capacity_options": { "additionalProperties": false, "properties": { "capacity": { "format": "float", "minimum": 1, "title": "Capacity", "type": "number" } }, "required": [ "capacity" ], "title": "Capacity Options", "type": "object" }, "commerce_entitlements_to_create": { "items": { "additionalProperties": false, "properties": { "expiration_date": { "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Expiration Date", "type": "string" }, "expiration_type": { "enum": [ "none", "relative date", "specific date" ], "title": "Expiration Type", "type": "string" }, "quantity": { "description": "The quantity", "format": "float", "title": "Quantity", "type": "number" }, "relative_expiration_date": { "additionalProperties": false, "description": "The date the task is due", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Expiration Date", "type": "object" }, "type_id": { "description": "The type of entitlement", "title": "Type", "type": "string" } }, "required": [ "expiration_type", "type_id" ], "type": "object" }, "type": "array" }, "coupon_codes": { "items": { "additionalProperties": false, "properties": { "coupon_code_generation_process_id": { "description": "The process by which the coupons are generated", "title": "Coupon Code Generation Process", "type": "string" }, "coupon_code_type": { "enum": [ "multi use", "single use" ], "title": "Coupon Code Type", "type": "string" }, "coupon_id": { "title": "Coupon", "type": "string" }, "coupon_type": { "title": "Coupon Type", "type": "string" }, "expiration_date": { "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Expiration Date", "type": "string" }, "expiration_type": { "enum": [ "none", "relative date", "specific date" ], "title": "Expiration Type", "type": "string" }, "maximum_number_of_total_uses": { "description": "The maximum number of total uses", "minimum": 1, "oneOf": [ { "enum": [ 1 ], "x-required": true } ], "title": "Maximum Number Of Total Uses", "type": "integer" }, "maximum_number_of_uses_per_customer": { "description": "The maximum number of total uses for a given customer", "minimum": 1, "oneOf": [ { "enum": [ 1 ], "x-required": true } ], "title": "Maximum Number Of Uses Per Customer", "type": "integer" }, "quantity": { "description": "The number of coupons to generate", "maximum": 250, "title": "Quantity", "type": "integer" }, "relative_expiration_date": { "additionalProperties": false, "description": "Expiration date relative to purchase", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Expiration Date", "type": "object" }, "restrict_to_contact": { "description": "If true, the code generated is restricted to the contact who made the purchase", "title": "Restrict To Contact", "type": "boolean" }, "restrict_to_organization": { "description": "If true, the code generated is restricted to the organization made the purchase", "title": "Restrict To Organization", "type": "boolean" } }, "required": [ "coupon_code_generation_process_id", "coupon_code_type", "coupon_id", "coupon_type", "quantity" ], "type": "object" }, "minItems": 1, "type": "array" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "custom_pricing_options": { "additionalProperties": false, "properties": { "lambda_function_id": { "description": "The custom lambda function to use", "title": "Lambda Function", "type": "string" } }, "required": [ "lambda_function_id" ], "title": "Custom Pricing Options", "type": "object" }, "deadline_based_pricing": { "items": { "additionalProperties": false, "properties": { "deadline_id": { "description": "The deadline", "title": "Deadline", "type": "string" }, "member_price": { "description": "The member price at this deadline", "format": "double", "title": "Member Price", "type": "number" }, "price": { "description": "The price at this deadline", "format": "double", "title": "Price", "type": "number" } }, "required": [ "deadline_id" ], "type": "object" }, "type": "array" }, "document_entitlements_to_create": { "items": { "additionalProperties": false, "properties": { "expiration_date": { "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Expiration Date", "type": "string" }, "expiration_type": { "enum": [ "none", "relative date", "specific date" ], "title": "Expiration Type", "type": "string" }, "file_cabinet_id": { "description": "The file cabinet", "title": "File Cabinet", "type": "string" }, "item_id": { "description": "The item", "title": "Item", "type": "string" }, "library_path": { "description": "The optional path that items will be mounted onto the digital library", "title": "Library Path", "type": "string" }, "relative_expiration_date": { "additionalProperties": false, "description": "The date the task is due", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Expiration Date", "type": "object" } }, "required": [ "expiration_type", "file_cabinet_id" ], "type": "object" }, "type": "array" }, "enable_bulk_pricing": { "description": "Whether or not bulk pricing is enabled", "title": "Enable Bulk Pricing", "type": "boolean" }, "enable_bundled_products": { "description": "Whether to enable bundled products", "title": "Enable Bundled Products", "type": "boolean" }, "enable_cancellation_fees": { "description": "Whether or not cancellation fees are applicable", "title": "Enable Cancellation Fees", "type": "boolean" }, "enable_capacity": { "description": "If set, the function has a capacity", "title": "Enable Capacity", "type": "boolean" }, "enable_commerce_entitlement_creation": { "description": "If set, document entitlements will be created to access folders or documents", "title": "Enable Commerce Entitlement Creation", "type": "boolean" }, "enable_coupon_code_generation": { "description": "If true, purchasing this product will generate coupons", "title": "Enable Coupon Code Generation", "type": "boolean" }, "enable_custom_pricing": { "description": "If set, the order engine will call out to a custom lambda function for custom/complex pricing", "title": "Enable Custom Pricing", "type": "boolean" }, "enable_document_entitlement_creation": { "description": "If set, document entitlements will be created to access folders or documents", "title": "Enable Document Entitlement Creation", "type": "boolean" }, "enable_product_confirmation_email": { "description": "If enabled, a custom email goes out whenever this product is ordered", "title": "Enable Product Confirmation Email", "type": "boolean" }, "enable_purchase_limits": { "description": "If true, purchase limits are in place for this product", "title": "Enable Purchase Limits", "type": "boolean" }, "enable_purchasing_eligibility": { "description": "If set, purchases of this merchandise are restricted", "title": "Enable Purchasing Eligibility", "type": "boolean" }, "enable_special_prices": { "description": "Whether to enable special pricing logic", "title": "Enable Special Prices", "type": "boolean" }, "enable_task_generation": { "description": "If set, tasks will be generated", "title": "Enable Task Generation", "type": "boolean" }, "event_id": { "description": "The event this fee belongs to", "title": "Event", "type": "string" }, "foreign_currency_prices": { "items": { "additionalProperties": false, "properties": { "cancellation_fee": { "description": "The cancellation fee of the product for this currency", "format": "double", "title": "Cancellation Fee", "type": "number" }, "currency_code": { "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "title": "Currency Code", "type": "string" }, "member_price": { "description": "The price of the product for a member", "format": "double", "title": "Member Price", "type": "number" }, "mode": { "description": "How this foreign currency should be treated", "enum": [ "calculate price", "prohibit purchase", "set price" ], "title": "Mode", "type": "string" }, "price": { "description": "The price of the product", "format": "double", "oneOf": [ { "x-required": true } ], "title": "Price", "type": "number" }, "restocking_fee": { "description": "The restocking fee of the product for this currency", "format": "double", "title": "Restocking Fee", "type": "number" } }, "required": [ "currency_code" ], "type": "object" }, "type": "array" }, "function_id": { "description": "The function this fee belongs to", "title": "Function", "type": "string" }, "hide_from_portal": { "description": "If set, this product should not be shown in the portal", "title": "Hide From Portal", "type": "boolean" }, "id": { "description": "The unique, string identifier of this miscellaneous product", "pattern": "^[\\w:|-]+$", "title": "ID", "type": "string" }, "installment_plan_options": { "items": { "additionalProperties": false, "properties": { "additional_cost": { "description": "The additional cost of the installment plan", "format": "double", "title": "Additional Cost", "type": "number" }, "installment_plan_id": { "description": "The installment plan that this product supports", "title": "Installment Plan", "type": "string" }, "is_default": { "description": "Whether this is the default installment plan option", "title": "Is Default", "type": "boolean" } }, "required": [ "installment_plan_id" ], "type": "object" }, "minItems": 1, "type": "array" }, "is_active": { "description": "Whether this product is active/used", "title": "Is Active", "type": "boolean" }, "member_price": { "description": "The price of the product for an active member", "format": "double", "title": "Member Price", "type": "number" }, "name": { "description": "The name of the miscellaneous product", "title": "Name", "type": "string" }, "notes": { "description": "Notes", "title": "Notes", "type": "string" }, "portal_options": { "additionalProperties": false, "properties": { "available_from": { "description": "The date from which this product should be available", "format": "date-time", "title": "Available From", "type": "string" }, "available_until": { "description": "The date until which this product should be available", "format": "date-time", "title": "Available Until", "type": "string" } }, "title": "Portal Options", "type": "object" }, "price": { "description": "The price of the product", "format": "double", "title": "Price", "type": "number" }, "product_confirmation_email_options": { "additionalProperties": false, "properties": { "product_confirmation_email_id": { "oneOf": [ { "x-required": true } ], "title": "Product Confirmation Email", "type": "string" }, "product_specific_email": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "bcc": { "description": "Anyone that should be bcc'ed on the email", "title": "Bcc", "type": "string" }, "body": { "description": "The email body", "title": "Body", "type": "string" }, "cc": { "description": "Anyone that should be cc'ed on the email", "title": "Cc", "type": "string" }, "from": { "description": "From email address", "title": "From", "type": "string" }, "from_name": { "description": "From name", "title": "From Name", "type": "string" }, "reply_to": { "description": "The reply to", "title": "Reply To", "type": "string" }, "subject": { "description": "The email subject", "title": "Subject", "type": "string" } }, "required": [ "body", "subject" ], "title": "Product Specific Email", "type": "object" }, "type": { "enum": [ "product specific", "shared" ], "title": "Type", "type": "string" } }, "title": "Product Confirmation Email Options", "type": "object" }, "publish_to_portal": { "description": "Whether or not this product should be available in the portal", "title": "Publish To Portal", "type": "boolean" }, "purchase_limits": { "additionalProperties": false, "properties": { "error_message": { "description": "The error message to show", "title": "Error Message", "type": "string" }, "maximum": { "description": "The maximum", "format": "float", "title": "Maximum", "type": "number" }, "relative_time_window": { "additionalProperties": false, "description": "the time window", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Time Window", "type": "object" }, "time_period": { "enum": [ "all time", "sliding time window" ], "title": "Time Period", "type": "string" }, "type": { "enum": [ "per customer" ], "title": "Type", "type": "string" } }, "required": [ "maximum", "time_period", "type" ], "title": "Purchase Limits", "type": "object" }, "purchasing_eligibility_criteria": { "title": "Purchasing Eligibility Criteria", "type": "object" }, "special_prices": { "items": { "additionalProperties": false, "properties": { "criteria": { "title": "Criteria", "type": "object" }, "enable_formula": { "description": "if set, a formula is used to calculate the price. If the formula fails, the price is used", "title": "Enable Formula", "type": "boolean" }, "formula": { "description": "The formula evaluated using the expr-eval npm package", "oneOf": [ { "x-required": true } ], "title": "Formula", "type": "string" }, "name": { "title": "Name", "type": "string" }, "price": { "format": "float", "title": "Price", "type": "number" } }, "required": [ "criteria", "price" ], "type": "object" }, "minItems": 1, "type": "array" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" }, "tasks_to_generate": { "items": { "additionalProperties": false, "properties": { "assignee_type": { "enum": [ "assignment role", "queue", "user" ], "title": "Assignee Type", "type": "string" }, "assignment_role_id": { "description": "The assignment role that should receive the ask", "oneOf": [ { "x-required": true } ], "title": "Assignment Role", "type": "string" }, "description": { "description": "A description", "title": "Description", "type": "string" }, "due_date_type": { "description": "Whether there is a due date", "enum": [ "none", "relative date", "specific date" ], "title": "Due Date Type", "type": "string" }, "name": { "description": "The name of the task", "title": "Name", "type": "string" }, "notify_assignees": { "description": "Notify assignee when the task is created", "title": "Notify Assignees", "type": "boolean" }, "priority": { "enum": [ "high", "low", "normal", "urgent" ], "title": "Priority", "type": "string" }, "queue_id": { "description": "The queue that should be assigned the ask", "oneOf": [ { "x-required": true } ], "title": "Queue", "type": "string" }, "relative_due_date": { "additionalProperties": false, "description": "The date the task is due", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Due Date", "type": "object" }, "specific_due_date": { "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Specific Due Date", "type": "string" }, "type_id": { "description": "The type of task", "title": "Type", "type": "string" }, "user_id": { "description": "The user that should be assigned the ask", "oneOf": [ { "x-required": true } ], "title": "User", "type": "string" } }, "required": [ "assignee_type", "due_date_type", "name", "type_id" ], "type": "object" }, "type": "array" }, "type": { "description": "The product type", "enum": [ "events-function-fees" ], "title": "Type", "type": "string" } }, "required": [ "abbreviated_name", "bulk_pricing_rules", "bundled_products", "business_unit_id", "capacity_options", "coupon_codes", "custom_pricing_options", "event_id", "function_id", "id", "installment_plan_options", "name", "price", "product_confirmation_email_options", "purchase_limits", "special_prices", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "FunctionPublic": { "additionalProperties": false, "properties": { "capacity_options": { "additionalProperties": false, "properties": { "capacity": { "format": "float", "minimum": 0, "title": "Capacity", "type": "number" }, "enable_wait_list": { "description": "If set, people can be placed on a wait list", "title": "Enable Wait List", "type": "boolean" }, "waitlist_process_id": { "description": "The process to use for managing the waitlist", "oneOf": [ { "x-required": true } ], "title": "Waitlist Process", "type": "string" } }, "required": [ "capacity" ], "title": "Capacity Options", "type": "object" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "description": { "description": "Description of the function", "title": "Description", "type": "string" }, "display_order": { "description": "Display order", "format": "float", "title": "Display Order", "type": "number" }, "enable_capacity": { "description": "If set, the session has a capacity", "title": "Enable Capacity", "type": "boolean" }, "enable_meal_options": { "description": "Whether or not meal options are available", "title": "Enable Meal Options", "type": "boolean" }, "enable_registration_questions": { "description": "If set, a user is prompted to answer questions during registration", "title": "Enable Registration Questions", "type": "boolean" }, "end_date": { "format": "date-time", "title": "End Date", "type": "string" }, "event_id": { "description": "The event id", "title": "Event", "type": "string" }, "hide_from_portal": { "description": "This session is not displayed in the portal or available for registration", "title": "Hide From Portal", "type": "boolean" }, "hide_from_schedule": { "description": "If selected, hide this session from the online schedule", "title": "Hide From Schedule", "type": "boolean" }, "id": { "description": "The unique, string identifier of this function", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "location": { "title": "Location", "type": "string" }, "maximum_allowed_tickets": { "description": "The maximum # of tickets that can be purchased", "format": "float", "title": "Maximum Allowed Tickets", "type": "number" }, "meal_options": { "items": { "additionalProperties": false, "properties": { "description": { "title": "Description", "type": "string" }, "id": { "title": "ID", "type": "string" }, "items": { "items": { "additionalProperties": false, "properties": { "logistics_item_id": { "description": "The item ID", "title": "Logistics Item", "type": "string" }, "quantity": { "description": "The quantity", "format": "float", "title": "Quantity", "type": "number" } }, "required": [ "logistics_item_id" ], "type": "object" }, "type": "array" }, "name": { "title": "Name", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "minItems": 1, "type": "array" }, "name": { "description": "The name of the function", "title": "Name", "type": "string" }, "purchase_restriction": { "enum": [ "by registration package", "disabled", "for all registrants" ], "title": "Purchase Restriction", "type": "string" }, "registration_package_restrictions": { "items": { "additionalProperties": false, "properties": { "maximum_allowed_tickets": { "description": "The maximum # of tickets; if unset, there is no maximum", "format": "float", "title": "Maximum Allowed Tickets", "type": "number" }, "registration_package_id": { "description": "The registration package", "title": "Registration Package", "type": "string" } }, "required": [ "registration_package_id" ], "type": "object" }, "type": "array" }, "registration_question_options": { "additionalProperties": false, "properties": { "custom_fields": { "description": "The custom fields to display", "items": { "additionalProperties": false, "properties": { "id": { "description": "The custom field", "title": "ID", "type": "string" }, "label": { "description": "An optional label", "title": "Label", "type": "string" }, "required": { "description": "Whether the field is required", "title": "Required", "type": "boolean" } }, "required": [ "id" ], "type": "object" }, "type": "array" }, "registration_instructions": { "description": "Instructions to show during registration for the session", "title": "Registration Instructions", "type": "string" }, "request_meal_preference": { "description": "If true, the meal preference should be requested", "title": "Request Meal Preference", "type": "boolean" } }, "title": "Registration Question Options", "type": "object" }, "room_ids": { "description": "The room(s) where the function is located", "items": { "type": "string" }, "title": "Rooms", "type": "array" }, "sold_out": { "description": "Whether the function is sold out", "title": "Sold Out", "type": "boolean" }, "start_date": { "format": "date-time", "title": "Start Date", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" }, "type_id": { "description": "The type of function", "title": "Type", "type": "string" } }, "required": [ "capacity_options", "event_id", "id", "maximum_allowed_tickets", "meal_options", "name", "registration_package_restrictions", "registration_question_options", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id", "type_id" ], "type": "object" }, "FunctionSearchParameters": { "additionalProperties": false, "properties": { "end_date": { "items": { "format": "date-time", "type": "string" }, "maxItems": 2, "minItems": 2, "title": "End Date", "type": "array" }, "event_id": { "title": "Event", "type": "string" }, "ids": { "description": "IDs to search", "items": { "type": "string" }, "title": "Ids", "type": "array" }, "name": { "title": "Name", "type": "string" }, "start_date": { "items": { "format": "date-time", "type": "string" }, "maxItems": 2, "minItems": 2, "title": "Start Date", "type": "array" }, "type_id": { "items": { "type": "string" }, "title": "Type", "type": "array" } }, "required": [ "event_id" ], "type": "object" }, "FunctionSearchResults": { "additionalProperties": false, "properties": { "abstract_id": { "description": "The abstract this session is linked to", "title": "Abstract", "type": "string" }, "access": { "description": "Who has access to this session", "enum": [ "included", "optional" ], "title": "Access", "type": "string" }, "enable_capacity": { "description": "If set, the session has a capacity", "title": "Enable Capacity", "type": "boolean" }, "enable_registration_questions": { "description": "If set, a user is prompted to answer questions during registration", "title": "Enable Registration Questions", "type": "boolean" }, "end_date": { "format": "date-time", "title": "End Date", "type": "string" }, "event_id": { "description": "The event", "title": "Event", "type": "string" }, "has_fees": { "description": "Whether or not this session has fees", "title": "Has Fees", "type": "boolean" }, "id": { "title": "ID", "type": "string" }, "name": { "description": "The name of the session", "title": "Name", "type": "string" }, "speakers": { "items": { "additionalProperties": false, "properties": { "speaker_id": { "title": "Speaker", "type": "string" }, "type": { "description": "The type of speaker", "title": "Type", "type": "string" } }, "required": [ "speaker_id", "type" ], "type": "object" }, "type": "array" }, "start_date": { "format": "date-time", "title": "Start Date", "type": "string" }, "track_ids": { "description": "Session tracks", "items": { "type": "string" }, "title": "Tracks", "type": "array" }, "type_id": { "description": "The type of session", "title": "Type", "type": "string" } }, "required": [ "event_id", "name", "type_id" ], "type": "object" }, "FunctionTicket": { "additionalProperties": false, "properties": { "contact_id": { "description": "The contact", "title": "Contact", "type": "string" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "event_id": { "description": "The event", "title": "Event", "type": "string" }, "fee_id": { "description": "The fee", "title": "Fee", "type": "string" }, "function_id": { "description": "The event", "title": "Function", "type": "string" }, "id": { "description": "The unique, string identifier of this function ticket", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "meal_option_id": { "description": "the meal option", "title": "Meal Option", "type": "string" }, "name": { "description": "The name of the function ticket", "title": "Name", "type": "string" }, "notes": { "description": "The notice", "title": "Notes", "type": "string" }, "order_id": { "description": "The order associated with this ticket", "title": "Order", "type": "string" }, "order_line_item_id": { "description": "The order line item ID", "title": "Order Line Item", "type": "string" }, "organization_id": { "description": "The organization", "title": "Organization", "type": "string" }, "registration_id": { "description": "The registration to which this ticket is tied", "title": "Registration", "type": "string" }, "status": { "enum": [ "active", "cancelled" ], "title": "Status", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "contact_id", "event_id", "function_id", "id", "name", "status", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "FunctionType": { "additionalProperties": false, "properties": { "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "id": { "description": "The unique, string identifier of this function type", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "is_active": { "description": "Whether or not this function type is active", "title": "Is Active", "type": "boolean" }, "name": { "description": "The name of the function type", "title": "Name", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "id", "name", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "GetCoAuthorInfoResponse": { "additionalProperties": false, "properties": { "email_address": { "title": "Email Address", "type": "string" }, "name": { "title": "Name", "type": "string" } }, "type": "object" }, "ListAbstractApprovalProcessesResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/AbstractApprovalProcess" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListAbstractReviewProcessesResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/AbstractReviewProcess" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListAbstractReviewRoundsResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/AbstractReviewRound" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListAbstractReviewsResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/AbstractReview" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListAbstractSubmissionProcessesResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/AbstractSubmissionProcess" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListAbstractTypesResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/AbstractType" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListAbstractsResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/Abstract" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListByRoundIdRequestPayload": { "properties": { "status": { "type": "string" } }, "type": "object" }, "ListCouponsResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/Coupon" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListEventsResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/Event" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListExhibitorAddOnProductsResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/ExhibitorAddOnProduct" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListExhibitorBoothFeesResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/ExhibitorBoothFee" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListExhibitorBoothsResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/ExhibitorBooth" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListExhibitorRegProcessesResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/ExhibitorRegProcess" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListExhibitorRegistrationsResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/ExhibitorRegistration" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListExhibitorShowFloorsResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/ExhibitorShowFloor" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListExhibitorsResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/Exhibitor" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListFunctionFeesResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/FunctionFee" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListFunctionTicketsResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/FunctionTicket" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListFunctionsResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/Function" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListMiscellaneousEventsResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/MiscellaneousEvent" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListPriorityPointAssignmentsResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/PriorityPointAssignment" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListPublicEventResponse": { "properties": { "Items": { "items": { "$ref": "#/components/schemas/EventPublic" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListRegistrantDirectoriesResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/RegistrantDirectory" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListRegistrationAddOnProductsResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/RegistrationAddOnProduct" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListRegistrationGroupsResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/RegistrationGroup" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListRegistrationPackagesResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/RegistrationPackage" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListRegistrationProcessesResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/RegistrationProcess" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListRegistrationSubstitutionsResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/RegistrationSubstitution" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListRegistrationTypesResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/RegistrationType" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListRegistrationsResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/Registration" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListRoomsResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/Room" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListSessionFeesResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/SessionFee" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListSessionRegistrationsResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/SessionRegistration" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListSessionTracksResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/SessionTrack" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListSessionsResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/Session" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListSpeakersResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/Speaker" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListSponsorsResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/Sponsor" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "ListStandardQueryDefinitionsResponse": { "items": { "$ref": "#/components/schemas/StandardQueryDefinition" }, "type": "array" }, "ListWaitlistedContactsResponse": { "properties": { "Count": { "type": "integer" }, "Items": { "items": { "$ref": "#/components/schemas/WaitlistedContact" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "MiscellaneousEvent": { "additionalProperties": false, "properties": { "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "description": { "description": "Description of the miscellaneous event", "title": "Description", "type": "string" }, "display_order": { "description": "The display/sort order for the sessions", "format": "float", "title": "Display Order", "type": "number" }, "end_date": { "description": "The end date/time of the miscellaneous event", "format": "date-time", "title": "End Date", "type": "string" }, "event_id": { "description": "The event", "title": "Event", "type": "string" }, "id": { "description": "The unique, string identifier of this session", "pattern": "^[\\w|\\-:]+$", "title": "ID", "type": "string" }, "location": { "description": "Location of this event", "title": "Location", "type": "string" }, "name": { "description": "Name of the miscellaneous event", "title": "Name", "type": "string" }, "start_date": { "description": "The start date/time of the miscellaneous event", "format": "date-time", "title": "Start Date", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "end_date", "event_id", "id", "name", "start_date", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "OrderGenerationRequest": { "properties": { "guest_regisrations": { "items": { "$ref": "#/components/schemas/Registration" }, "type": "array" }, "registration": { "$ref": "#/components/schemas/Registration" } }, "type": "object" }, "PagedAbstractReviewSearchResults": { "properties": { "Items": { "items": { "$ref": "#/components/schemas/AbstractSearchResults" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "PagedAbstractSearchResults": { "properties": { "Items": { "items": { "$ref": "#/components/schemas/AbstractSearchResults" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "PagedEventSearchResults": { "properties": { "Items": { "items": { "$ref": "#/components/schemas/EventSearchResults" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "PagedFunctionSearchResults": { "properties": { "Items": { "items": { "$ref": "#/components/schemas/FunctionSearchResults" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "PagedRegistrationGroupSearchResults": { "properties": { "Items": { "items": { "$ref": "#/components/schemas/RegistrationGroupSearchResults" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "PagedRegistrationSearchResults": { "properties": { "Items": { "items": { "$ref": "#/components/schemas/RegistrationSearchResults" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "PagedSessionSearchResults": { "properties": { "Items": { "items": { "$ref": "#/components/schemas/SessionSearchResults" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "PagedSpeakerProfileSearchResults": { "properties": { "Items": { "items": { "$ref": "#/components/schemas/SpeakerProfileSearchResults" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "PagedSpeakerSearchResults": { "properties": { "Items": { "items": { "$ref": "#/components/schemas/SpeakerSearchResults" }, "type": "array" }, "LastEvaluatedKey": { "type": "string" } }, "type": "object" }, "PatchDirective": { "additionalProperties": false, "properties": { "op": { "description": "The operation", "enum": [ "add", "copy", "move", "remove", "replace", "test" ], "title": "Op", "type": "string" }, "path": { "description": "The JSON path", "title": "Path", "type": "string" }, "value": { "description": "The updated value", "title": "Value", "type": "string" } }, "required": [ "op", "path" ], "type": "object" }, "PreviewCertificateRequest": { "additionalProperties": false, "properties": { "certificate_template": { "title": "Certificate Template", "type": "string" }, "registration_id": { "title": "Registration", "type": "string" } }, "required": [ "certificate_template", "registration_id" ], "type": "object" }, "PreviewEmailRequest": { "additionalProperties": false, "properties": { "abstract_id": { "title": "Abstract", "type": "string" }, "destination_email_address": { "title": "Destination Email Address", "type": "string" }, "email_template": { "additionalProperties": false, "properties": { "bcc": { "description": "Anyone that should be bcc'ed on the email", "title": "Bcc", "type": "string" }, "body": { "description": "The email body", "title": "Body", "type": "string" }, "cc": { "description": "Anyone that should be cc'ed on the email", "title": "Cc", "type": "string" }, "from": { "description": "From email address", "title": "From", "type": "string" }, "from_name": { "description": "From name", "title": "From Name", "type": "string" }, "reply_to": { "description": "The reply to", "title": "Reply To", "type": "string" }, "subject": { "description": "The email subject", "title": "Subject", "type": "string" } }, "required": [ "body", "subject" ], "title": "Email Template", "type": "object" }, "registration_id": { "title": "Registration", "type": "string" }, "review_id": { "title": "Review", "type": "string" }, "type": { "title": "Type", "type": "string" } }, "required": [ "destination_email_address", "registration_id" ], "type": "object" }, "PreviewNotification": { "additionalProperties": false, "properties": { "contact_id": { "title": "Contact", "type": "string" }, "destination_email_address": { "title": "Destination Email Address", "type": "string" }, "email_template": { "additionalProperties": false, "properties": { "bcc": { "description": "Anyone that should be bcc'ed on the email", "title": "Bcc", "type": "string" }, "body": { "description": "The email body", "title": "Body", "type": "string" }, "cc": { "description": "Anyone that should be cc'ed on the email", "title": "Cc", "type": "string" }, "from": { "description": "From email address", "title": "From", "type": "string" }, "from_name": { "description": "From name", "title": "From Name", "type": "string" }, "reply_to": { "description": "The reply to", "title": "Reply To", "type": "string" }, "subject": { "description": "The email subject", "title": "Subject", "type": "string" } }, "required": [ "body", "subject" ], "title": "Email Template", "type": "object" }, "event_id": { "title": "Event", "type": "string" }, "organization_id": { "title": "Organization", "type": "string" } }, "required": [ "contact_id", "destination_email_address", "email_template", "event_id" ], "type": "object" }, "PriorityPointAssignment": { "additionalProperties": false, "properties": { "accumulation_rule_id": { "title": "Accumulation Rule", "type": "string" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "date": { "description": "The date the priority points were assigned", "title": "Date", "type": "string" }, "id": { "description": "The unique, string identifier of this priority point assignment", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "name": { "description": "The origin/reason why the priority points were assigned", "title": "Name", "type": "string" }, "notes": { "description": "Description/notes", "title": "Notes", "type": "string" }, "organization_id": { "description": "The organization that received the priority points", "title": "Organization", "type": "string" }, "origin": { "description": "The origin of the assignment", "enum": [ "accumulation rule", "manual" ], "title": "Origin", "type": "string" }, "quantity": { "description": "The number of priority points", "format": "float", "title": "Quantity", "type": "number" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" }, "type_id": { "description": "The type of priority point", "title": "Type", "type": "string" } }, "required": [ "accumulation_rule_id", "date", "id", "name", "organization_id", "quantity", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id", "type_id" ], "type": "object" }, "PrivilegesResponse": { "additionalProperties": false, "properties": { "can_edit_session": { "title": "Can Edit Session", "type": "boolean" }, "can_manage_documents": { "title": "Can Manage Documents", "type": "boolean" }, "can_update_speaker_profile": { "title": "Can Update Speaker Profile", "type": "boolean" } }, "type": "object" }, "PublicEventRegistrationPackagesRequest": { "properties": { "event_ids": { "items": { "type": "string" }, "minItems": 0, "title": "Events", "type": "array" }, "event_restriction": { "enum": [ "exclude", "include", "none" ], "title": "Event Restriction", "type": "string" }, "event_type_ids": { "items": { "type": "string" }, "minItems": 0, "title": "Event Types", "type": "array" }, "event_type_restriction": { "enum": [ "exclude", "include", "none" ], "title": "Event Type Restriction", "type": "string" } }, "required": [ "event_ids", "event_type_ids" ], "type": "object" }, "PublicEventRegistrationPackagesResponse": { "additionalProperties": false, "properties": { "event_types": { "items": { "additionalProperties": false, "properties": { "display_in_portal_as": { "description": "Portal display", "title": "Display In Portal As", "type": "string" }, "id": { "description": "ID of the event type", "title": "ID", "type": "string" }, "name": { "description": "Name of the event type", "title": "Name", "type": "string" } }, "type": "object" }, "type": "array" }, "events": { "items": { "additionalProperties": false, "properties": { "description": { "title": "Description", "type": "string" }, "id": { "description": "ID of the event ", "title": "ID", "type": "string" }, "name": { "description": "Name of the event", "title": "Name", "type": "string" }, "sold_out": { "title": "Sold Out", "type": "boolean" }, "thumbnail_image_uri": { "title": "Thumbnail Image Uri", "type": "string" }, "type_id": { "title": "Type", "type": "string" } }, "type": "object" }, "type": "array" }, "registration_packages": { "items": { "additionalProperties": false, "properties": { "description": { "description": "Description of the package", "title": "Description", "type": "string" }, "display_in_portal_as": { "description": "Portal display", "title": "Display In Portal As", "type": "string" }, "enable_special_prices": { "description": "Whether special prices are used", "title": "Enable Special Prices", "type": "boolean" }, "event_id": { "description": "The event type", "title": "Event", "type": "string" }, "id": { "description": "ID of the event package", "title": "ID", "type": "string" }, "member_price": { "description": "Renewal price of the package", "format": "float", "title": "Member Price", "type": "number" }, "name": { "description": "Name of the event package", "title": "Name", "type": "string" }, "price": { "description": "Price of the package", "format": "float", "title": "Price", "type": "number" }, "registration_type_id": { "title": "Registration Type", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "RateSchedule": { "additionalProperties": false, "properties": { "currency_code": { "title": "Currency Code", "type": "string" }, "deadlines": { "items": { "additionalProperties": false, "properties": { "date": { "format": "date-time", "title": "Date", "type": "string" }, "id": { "title": "ID", "type": "string" }, "name": { "title": "Name", "type": "string" } }, "type": "object" }, "type": "array" }, "event_id": { "title": "Event", "type": "string" }, "registration_types": { "items": { "additionalProperties": false, "properties": { "registration_packages": { "items": { "additionalProperties": false, "properties": { "deadlines": { "items": { "additionalProperties": false, "properties": { "deadline_id": { "title": "Deadline", "type": "string" }, "member_price": { "format": "float", "title": "Member Price", "type": "number" }, "price": { "format": "float", "title": "Price", "type": "number" } }, "type": "object" }, "type": "array" }, "member_price": { "format": "float", "title": "Member Price", "type": "number" }, "package_abbreviated_name": { "title": "Package Abbreviated Name", "type": "string" }, "package_id": { "title": "Package", "type": "string" }, "package_name": { "title": "Package Name", "type": "string" }, "price": { "format": "float", "title": "Price", "type": "number" } }, "type": "object" }, "type": "array" }, "type_id": { "title": "Type", "type": "string" }, "type_name": { "title": "Type Name", "type": "string" } }, "type": "object" }, "type": "array" }, "some_packages_have_member_prices": { "title": "Some Packages Have Member Prices", "type": "boolean" }, "uses_deadlines": { "description": "This event uses deadlines", "title": "Uses Deadlines", "type": "boolean" } }, "type": "object" }, "RegistrantDirectory": { "additionalProperties": false, "properties": { "additional_fields": { "description": "These are additional fields that should be in the directory query, which will be available in the search results", "items": { "type": "string" }, "title": "Additional Fields", "type": "array" }, "comment_options": { "additionalProperties": false, "properties": { "comments_header_text": { "description": "The text shown in the header of the comments section", "title": "Comments Header Text", "type": "string" }, "comments_instructions": { "description": "Instructions given to those submitting comments", "title": "Comments Instructions", "type": "string" }, "comments_placeholder_text": { "description": "The placeholder text for the comments", "title": "Comments Placeholder Text", "type": "string" }, "enable_ratings": { "description": "If set, users can rate", "title": "Enable Ratings", "type": "boolean" }, "hide_submitter_name": { "description": "If set, comment submitter names are hidden from the directory", "title": "Hide Submitter Name", "type": "boolean" }, "leave_comment_button_text": { "description": "The button text for Leave Comment", "title": "Leave Comment Button Text", "type": "string" }, "max_rating": { "description": "The maximum rating", "format": "float", "maximum": 10, "minimum": 1, "oneOf": [ { "x-required": true } ], "title": "Max Rating", "type": "number" }, "no_comments_text": { "description": "The text shown when no comments are present", "title": "No Comments Text", "type": "string" }, "rating_label": { "description": "The label for the rating", "title": "Rating Label", "type": "string" }, "save_comment_button": { "description": "The button text for saving a comment", "title": "Save Comment Button", "type": "string" } }, "title": "Comment Options", "type": "object" }, "custom_directory_entry_template": { "title": "Custom Directory Entry Template", "type": "string" }, "custom_search_results_template": { "title": "Custom Search Results Template", "type": "string" }, "custom_sort_fields": { "items": { "additionalProperties": false, "properties": { "descending": { "title": "Descending", "type": "boolean" }, "name": { "title": "Name", "type": "string" } }, "required": [ "name" ], "type": "object" }, "minItems": 1, "type": "array" }, "directory_entry_mode": { "enum": [ "custom", "do not show", "use default" ], "title": "Directory Entry Mode", "type": "string" }, "display_mode": { "description": "The way that the directory should be displayed", "enum": [ "list", "search" ], "title": "Display Mode", "type": "string" }, "eligibility_criteria": { "additionalProperties": false, "description": "The criteria to use", "properties": { "advanced_rule_error_message": { "description": "The error message to show when the advanced rule fails", "title": "Advanced Rule Error Message", "type": "string" }, "advanced_rules": { "title": "Advanced Rules", "type": "object" }, "age_restrictions": { "additionalProperties": false, "properties": { "maximum_age": { "description": "The maximum age of the contact", "format": "float", "title": "Maximum Age", "type": "number" }, "minimum_age": { "description": "The minimum age of the contact", "format": "float", "title": "Minimum Age", "type": "number" } }, "title": "Age Restrictions", "type": "object" }, "award_options": { "additionalProperties": false, "properties": { "award_ids": { "items": { "type": "string" }, "title": "Awards", "type": "array" }, "award_type_ids": { "items": { "type": "string" }, "title": "Award Types", "type": "array" }, "logic_operator": { "enum": [ "and", "not" ], "title": "Logic Operator", "type": "string" } }, "title": "Award Options", "type": "object" }, "award_recipients": { "description": "If set, only people who have received awards", "title": "Award Recipients", "type": "boolean" }, "by_location": { "description": "If true, then filter by location", "title": "By Location", "type": "boolean" }, "certificants": { "description": "If set, only people with specific certifications", "title": "Certificants", "type": "boolean" }, "certification_options": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "logic_operator": { "enum": [ "and", "not" ], "title": "Logic Operator", "type": "string" }, "program_ids": { "items": { "type": "string" }, "title": "Programs", "type": "array" } }, "title": "Certification Options", "type": "object" }, "committee_member_options": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "committee_ids": { "items": { "type": "string" }, "title": "Committees", "type": "array" }, "committee_position_ids": { "items": { "type": "string" }, "title": "Committee Positions", "type": "array" }, "committee_type_ids": { "items": { "type": "string" }, "title": "Committee Types", "type": "array" }, "logic_operator": { "enum": [ "and", "not" ], "title": "Logic Operator", "type": "string" } }, "title": "Committee Member Options", "type": "object" }, "committee_members": { "description": "If set, active members who belong to a committee can purchase", "title": "Committee Members", "type": "boolean" }, "custom_logic_options": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "lambda_function_id": { "description": "The custom lambda function to use", "title": "Lambda Function", "type": "string" } }, "required": [ "lambda_function_id" ], "title": "Custom Logic Options", "type": "object" }, "customer_type": { "enum": [ "contact", "organization" ], "title": "Customer Type", "type": "string" }, "donor_options": { "additionalProperties": false, "properties": { "donor_club_ids": { "items": { "type": "string" }, "title": "Donor Clubs", "type": "array" }, "logic_operator": { "enum": [ "and", "not" ], "title": "Logic Operator", "type": "string" } }, "title": "Donor Options", "type": "object" }, "donors": { "description": "If true, only donors", "title": "Donors", "type": "boolean" }, "enable_advanced_rules": { "description": "Enable advanced JSON rules", "title": "Enable Advanced Rules", "type": "boolean" }, "enable_age_restrictions": { "description": "Age registrations", "title": "Enable Age Restrictions", "type": "boolean" }, "enable_custom_logic": { "description": "If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion", "title": "Enable Custom Logic", "type": "boolean" }, "enable_entitlement_restrictions": { "description": "If set, then you must have certain entitlements", "title": "Enable Entitlement Restrictions", "type": "boolean" }, "enable_expression": { "description": "Whether or not to enable an expression for evaluation", "title": "Enable Expression", "type": "boolean" }, "enable_organization_restrictions": { "description": "If set, you can restrict organizations", "title": "Enable Organization Restrictions", "type": "boolean" }, "enable_status_restriction": { "description": "If set, you can restrict by status", "title": "Enable Status Restriction", "type": "boolean" }, "entitlement_restrictions": { "items": { "additionalProperties": false, "properties": { "quantity": { "description": "The quantity you must have", "format": "float", "title": "Quantity", "type": "number" }, "type_id": { "description": "The type of entitlement", "title": "Type", "type": "string" } }, "required": [ "type_id" ], "type": "object" }, "type": "array" }, "event_registration_options": { "additionalProperties": false, "properties": { "event_ids": { "items": { "type": "string" }, "title": "Events", "type": "array" }, "logic_operator": { "enum": [ "and", "not" ], "title": "Logic Operator", "type": "string" }, "registration_category_ids": { "items": { "type": "string" }, "title": "Registration Categories", "type": "array" } }, "title": "Event Registration Options", "type": "object" }, "event_registrations": { "description": "If set, only people who have registered for events", "title": "Event Registrations", "type": "boolean" }, "expression": { "description": "The expression", "title": "Expression", "type": "string" }, "expression_error_message": { "description": "The error message to show when the expression fails", "title": "Expression Error Message", "type": "string" }, "location": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "countries": { "description": "Countries", "items": { "type": "string" }, "title": "Countries", "type": "array" }, "negate_logic": { "description": "If true, the logic in this section is negated; so NOT from these places", "title": "Negate Logic", "type": "boolean" } }, "title": "Location", "type": "object" }, "logic_operator": { "enum": [ "and", "not" ], "title": "Logic Operator", "type": "string" }, "member_options": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "chapter_member_options": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "chapter_ids": { "items": { "type": "string" }, "title": "Chapters", "type": "array" }, "chapter_type_ids": { "items": { "type": "string" }, "title": "Chapter Types", "type": "array" }, "logic_operator": { "enum": [ "and", "not" ], "title": "Logic Operator", "type": "string" } }, "title": "Chapter Member Options", "type": "object" }, "chapter_members": { "description": "If set, active members who belong to a chapter can purchase", "title": "Chapter Members", "type": "boolean" }, "member_package_ids": { "description": "The member package", "items": { "type": "string" }, "title": "Member Packages", "type": "array" }, "member_status_reason_ids": { "items": { "type": "string" }, "title": "Member Status Reasons", "type": "array" }, "member_statuses": { "items": { "enum": [ "active", "inactive", "suspended" ], "type": "string" }, "title": "Member Statuses", "type": "array" }, "member_type_ids": { "description": "The member types", "items": { "type": "string" }, "title": "Member Types", "type": "array" }, "section_member_options": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "logic_operator": { "enum": [ "and", "not" ], "title": "Logic Operator", "type": "string" }, "section_ids": { "items": { "type": "string" }, "title": "Sections", "type": "array" }, "section_type_ids": { "items": { "type": "string" }, "title": "Section Types", "type": "array" } }, "title": "Section Member Options", "type": "object" }, "section_members": { "description": "If set, active members who belong to a section can purchase", "title": "Section Members", "type": "boolean" } }, "title": "Member Options", "type": "object" }, "members": { "description": "If set, active members can purchase this", "title": "Members", "type": "boolean" }, "non_members": { "description": "If set, only nonmembers can purchase", "title": "Non Members", "type": "boolean" }, "organization_restrictions": { "additionalProperties": false, "properties": { "contact_role_ids": { "items": { "type": "string" }, "title": "Contact Roles", "type": "array" }, "organization_type_ids": { "items": { "type": "string" }, "title": "Organization Types", "type": "array" } }, "title": "Organization Restrictions", "type": "object" }, "status_restrictions": { "description": "The statuses", "items": { "type": "string" }, "minItems": 1, "oneOf": [ { "x-required": true } ], "title": "Status Restrictions", "type": "array" }, "use_organization_for_eligibility": { "description": "If checked, a person's organization is used to check for eligibility, rather than the person themselves", "title": "Use Organization For Eligibility", "type": "boolean" } }, "title": "Eligibility Criteria", "type": "object" }, "enable_comments": { "description": "If set, users are allowed to submit comments in the directory", "title": "Enable Comments", "type": "boolean" }, "enable_custom_search_results_template": { "description": "If set, a custom search results template is displayed", "title": "Enable Custom Search Results Template", "type": "boolean" }, "enable_custom_sorting": { "description": "If true, the directory results will be sorted differently that the query", "title": "Enable Custom Sorting", "type": "boolean" }, "enable_eligibility_criteria": { "description": "If set, only certain people can access this directory", "title": "Enable Eligibility Criteria", "type": "boolean" }, "enable_messaging": { "description": "When true, users are able to contact other users through the directory", "title": "Enable Messaging", "type": "boolean" }, "enable_query_expression_filter": { "description": "If set to true, an expression can be used to further filter the query", "title": "Enable Query Expression Filter", "type": "boolean" }, "enable_query_filter": { "description": "If set to true, the directory can display a subset of records based on the provided filter. If false, the default filter is used", "title": "Enable Query Filter", "type": "boolean" }, "enable_radius_search": { "description": "If true, the user can search across zip code radius", "title": "Enable Radius Search", "type": "boolean" }, "event_id": { "description": "The event", "title": "Event", "type": "string" }, "id": { "description": "The unique, string identifier of this directory", "pattern": "^[\\w:|-]+$", "title": "ID", "type": "string" }, "is_active": { "description": "Whether or not this directory is active", "title": "Is Active", "type": "boolean" }, "is_public": { "description": "If true, this is a public directory that can be accessed without security", "title": "Is Public", "type": "boolean" }, "name": { "description": "The name of the directory", "title": "Name", "type": "string" }, "page_size": { "description": "The page size, used for server side page and to combat scraping attacks", "format": "float", "maximum": 50, "minimum": 1, "title": "Page Size", "type": "number" }, "query_filter_expression": { "description": "The expression to use to filter the directory", "title": "Query Filter Expression", "type": "string" }, "query_filter_rules": { "title": "Query Filter Rules", "type": "object" }, "radius_search_options": { "additionalProperties": false, "properties": { "postal_code_field": { "description": "The field to use as the basis for a radius search", "title": "Postal Code Field", "type": "string" }, "radius_options": { "description": "The various default radius that can be selected", "items": { "format": "float", "type": "number" }, "minItems": 1, "title": "Radius Options", "type": "array" } }, "required": [ "postal_code_field", "radius_options" ], "title": "Radius Search Options", "type": "object" }, "refresh_period": { "description": "The period of time (in minutes) after which the directory should refresh it self", "format": "float", "minimum": 5, "title": "Refresh Period", "type": "number" }, "restrict_to_registrants": { "description": "If true, only those registered for this event can access the directory", "title": "Restrict To Registrants", "type": "boolean" }, "searchable_fields": { "description": "The fields in the directory that are displayed as search criteria", "items": { "additionalProperties": false, "properties": { "group_name": { "description": "The group/display label", "title": "Group Name", "type": "string" }, "label": { "description": "The label that the field should be displayed", "title": "Label", "type": "string" }, "name": { "description": "The field name", "title": "Name", "type": "string" } }, "required": [ "name" ], "type": "object" }, "minItems": 1, "type": "array" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "custom_directory_entry_template", "custom_search_results_template", "custom_sort_fields", "eligibility_criteria", "event_id", "id", "name", "query_filter_expression", "radius_search_options", "searchable_fields", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "Registration": { "additionalProperties": false, "properties": { "add_membership_package": { "description": "Whether or not we add a membership package to this registration", "title": "Add Membership Package", "type": "boolean" }, "add_ons": { "items": { "additionalProperties": false, "properties": { "add_on_product_id": { "description": "The add on", "title": "Add On Product", "type": "string" }, "quantity": { "description": "The quantity of add on", "format": "float", "minimum": 1, "title": "Quantity", "type": "number" } }, "required": [ "add_on_product_id" ], "type": "object" }, "type": "array" }, "badge": { "additionalProperties": false, "properties": { "first_name": { "title": "First Name", "type": "string" }, "full_name": { "title": "Full Name", "type": "string" }, "job_title": { "title": "Job Title", "type": "string" }, "location": { "title": "Location", "type": "string" }, "organization_name": { "title": "Organization Name", "type": "string" } }, "title": "Badge", "type": "object" }, "cancellation_date": { "format": "date-time", "title": "Cancellation Date", "type": "string" }, "checkin_date": { "description": "The date/time of checkin", "format": "date-time", "title": "Checkin Date", "type": "string" }, "city": { "description": "The member city", "title": "City", "type": "string" }, "contact_id": { "description": "The contact ID of the registrant", "title": "Contact", "type": "string" }, "country": { "description": "The member country", "title": "Country", "type": "string" }, "coupon_code_id": { "description": "If a coupon code was used with this registration, it is linked here", "title": "Coupon Code", "type": "string" }, "courses": { "items": { "additionalProperties": false, "properties": { "course_offering_id": { "title": "Course Offering", "type": "string" }, "custom_field_values": { "description": "Course registration custom fields", "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" } }, "type": "object" }, "type": "array" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "date": { "description": "The date of registration", "format": "date-time", "title": "Date", "type": "string" }, "deadline_id": { "description": "The registration deadline", "title": "Deadline", "type": "string" }, "departure_date": { "description": "The date the person left the event", "format": "date-time", "title": "Departure Date", "type": "string" }, "email_address": { "description": "The member's email address", "title": "Email Address", "type": "string" }, "embed_membership_application": { "description": "Whether or not to embed a whole membership application", "title": "Embed Membership Application", "type": "boolean" }, "event_end_date": { "description": "The date of the event", "format": "date-time", "title": "Event End Date", "type": "string" }, "event_id": { "description": "The event", "title": "Event", "type": "string" }, "event_start_date": { "description": "The date of the event", "format": "date-time", "title": "Event Start Date", "type": "string" }, "first_name": { "description": "The member's first name", "title": "First Name", "type": "string" }, "functions": { "items": { "additionalProperties": false, "properties": { "fee_id": { "description": "The fee id of the function", "title": "Fee", "type": "string" }, "function_id": { "description": "The function", "title": "Function", "type": "string" }, "number_of_tickets": { "description": "The number of tickets", "format": "float", "title": "Number Of Tickets", "type": "number" }, "ticket_options": { "items": { "additionalProperties": false, "properties": { "custom_field_values": { "description": "Ticket custom fields", "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "meal_option_id": { "description": "The meal option, if applicable", "title": "Meal Option", "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "fee_id", "function_id" ], "type": "object" }, "type": "array" }, "group_id": { "description": "The group this registration belongs to", "title": "Group", "type": "string" }, "group_order": { "description": "The order of the registration within the group", "format": "float", "title": "Group Order", "type": "number" }, "guests": { "items": { "additionalProperties": false, "properties": { "guest_contact_info": { "additionalProperties": false, "description": "The contact info for the guest", "properties": {}, "title": "Guest Contact Info", "type": "object" }, "guest_registration_package_id": { "title": "Guest Registration Package", "type": "string" }, "id": { "description": "The guest ID", "title": "ID", "type": "string" } }, "required": [ "guest_registration_package_id" ], "type": "object" }, "type": "array" }, "id": { "description": "The unique, string identifier of this registration group", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "internal_notes": { "description": "Any applicable notes", "title": "Internal Notes", "type": "string" }, "is_guest_registration": { "description": "Guest registration", "title": "Is Guest Registration", "type": "boolean" }, "is_transient_guest": { "description": "If set, the guest has no contact record", "title": "Is Transient Guest", "type": "boolean" }, "job_title": { "description": "The member job title", "title": "Job Title", "type": "string" }, "last_modification_date": { "description": "The last time that the registration was modified", "format": "date-time", "title": "Last Modification Date", "type": "string" }, "last_name": { "description": "The member's last name", "title": "Last Name", "type": "string" }, "meeting_join_url": { "description": "The URL used to join the meeting", "title": "Meeting Join Url", "type": "string" }, "meeting_participant_id": { "description": "The external ID of this registration in the linked meeting", "title": "Meeting Participant", "type": "string" }, "membership_information": { "additionalProperties": false, "properties": { "membership_package_id": { "description": "The membership package", "title": "Membership Package", "type": "string" } }, "required": [ "membership_package_id" ], "title": "Membership Information", "type": "object" }, "modified_registration_id": { "description": "If this registration is modifying another registration, that ID is here", "title": "Modified Registration", "type": "string" }, "name": { "description": "The member's name", "title": "Name", "type": "string" }, "notes": { "description": "Notes", "title": "Notes", "type": "string" }, "number": { "description": "The registration number", "format": "float", "title": "Number", "type": "number" }, "order_amount_paid": { "description": "The amount paid", "format": "double", "title": "Order Amount Paid", "type": "number" }, "order_balance_due": { "description": "The balance due on the order", "format": "double", "title": "Order Balance Due", "type": "number" }, "order_currency_code": { "title": "Order Currency Code", "type": "string" }, "order_currency_symbol": { "title": "Order Currency Symbol", "type": "string" }, "order_id": { "description": "The order", "title": "Order", "type": "string" }, "order_line_item_id": { "description": "The order line item", "title": "Order Line Item", "type": "string" }, "order_number": { "description": "The order number", "format": "float", "title": "Order Number", "type": "number" }, "order_status": { "enum": [ "awaiting payment", "awaiting pickup", "awaiting shipping", "cancelled", "completed", "disputed", "open", "partially shipped", "returned", "shipped", "void" ], "title": "Order Status", "type": "string" }, "order_total": { "description": "The total of the order", "format": "double", "title": "Order Total", "type": "number" }, "organization_id": { "description": "The organization associated with this registration", "title": "Organization", "type": "string" }, "package_id": { "description": "The registration package", "title": "Package", "type": "string" }, "parent_registration_guest_id": { "description": "The ID of the guest in the parent registration array", "title": "Parent Registration Guest", "type": "string" }, "parent_registration_id": { "description": "For guest registrations, the parent id", "title": "Parent Registration", "type": "string" }, "process_id": { "description": "The registration process", "title": "Process", "type": "string" }, "registrant_acknowledges_scheduling_conflicts": { "description": "True if the registrant was presented with scheduling conflicts and acknowledged them", "title": "Registrant Acknowledges Scheduling Conflicts", "type": "boolean" }, "ribbon_ids": { "description": "The ribbons on this registration", "items": { "type": "string" }, "title": "Ribbons", "type": "array" }, "sessions": { "items": { "additionalProperties": false, "properties": { "custom_field_values": { "description": "Session custom fields", "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "session_id": { "title": "Session", "type": "string" } }, "type": "object" }, "type": "array" }, "state": { "description": "The state", "title": "State", "type": "string" }, "status": { "enum": [ "active", "cancelled", "draft", "pending approval" ], "title": "Status", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" }, "type_id": { "description": "The registration type", "title": "Type", "type": "string" }, "webinar_join_url": { "description": "The URL used to join the webinar", "title": "Webinar Join Url", "type": "string" }, "webinar_participant_id": { "description": "The external ID of this registration in the linked webinar", "title": "Webinar Participant", "type": "string" } }, "required": [ "cancellation_date", "contact_id", "event_id", "id", "membership_information", "name", "package_id", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id", "type_id" ], "type": "object" }, "RegistrationAddOnProduct": { "additionalProperties": false, "properties": { "abbreviated_name": { "description": "The abbreviated name to show during events", "title": "Abbreviated Name", "type": "string" }, "add_on_type_id": { "description": "The add on type", "title": "Add On Type", "type": "string" }, "allow_customer_to_choose_installment_plan": { "description": "If true, the customer can choose their installment plan", "title": "Allow Customer To Choose Installment Plan", "type": "boolean" }, "bulk_pricing_rules": { "items": { "additionalProperties": false, "properties": { "discount_amount": { "description": "The percentage/flat rate", "format": "float", "minimum": 0, "title": "Discount Amount", "type": "number" }, "discount_type": { "description": "The type of discount rule", "enum": [ "flat rate", "percentage" ], "title": "Discount Type", "type": "string" }, "ending_range": { "description": "The ending range of the rule", "minimum": 0, "title": "Ending Range", "type": "integer" }, "starting_range": { "description": "The starting range of the rule", "minimum": 0, "title": "Starting Range", "type": "integer" } }, "required": [ "discount_amount", "discount_type" ], "type": "object" }, "minItems": 1, "type": "array" }, "bundled_products": { "items": { "additionalProperties": false, "properties": { "member_price": { "description": "The member price", "format": "double", "title": "Member Price", "type": "number" }, "price": { "description": "The price to bundle", "format": "double", "title": "Price", "type": "number" }, "product_id": { "description": "The product ID", "title": "Product", "type": "string" }, "product_type": { "description": "The product type", "title": "Product Type", "type": "string" }, "quantity": { "description": "The quantity to bundle", "title": "Quantity", "type": "integer" }, "type": { "enum": [ "bundled product", "inline bundled product" ], "title": "Type", "type": "string" } }, "required": [ "product_id", "product_type", "quantity", "type" ], "type": "object" }, "minItems": 1, "type": "array" }, "bundled_products_inventory_handling": { "description": "Whether to track inventory for the entire bundle, or for each product separately", "enum": [ "bundle", "each product" ], "title": "Bundled Products Inventory Handling", "type": "string" }, "business_unit_id": { "description": "The business unit of the product", "title": "Business Unit", "type": "string" }, "cancellation_fee": { "description": "Cancellation fees associated with this product", "format": "double", "title": "Cancellation Fee", "type": "number" }, "commerce_entitlements_to_create": { "items": { "additionalProperties": false, "properties": { "expiration_date": { "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Expiration Date", "type": "string" }, "expiration_type": { "enum": [ "none", "relative date", "specific date" ], "title": "Expiration Type", "type": "string" }, "quantity": { "description": "The quantity", "format": "float", "title": "Quantity", "type": "number" }, "relative_expiration_date": { "additionalProperties": false, "description": "The date the task is due", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Expiration Date", "type": "object" }, "type_id": { "description": "The type of entitlement", "title": "Type", "type": "string" } }, "required": [ "expiration_type", "type_id" ], "type": "object" }, "type": "array" }, "coupon_codes": { "items": { "additionalProperties": false, "properties": { "coupon_code_generation_process_id": { "description": "The process by which the coupons are generated", "title": "Coupon Code Generation Process", "type": "string" }, "coupon_code_type": { "enum": [ "multi use", "single use" ], "title": "Coupon Code Type", "type": "string" }, "coupon_id": { "title": "Coupon", "type": "string" }, "coupon_type": { "title": "Coupon Type", "type": "string" }, "expiration_date": { "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Expiration Date", "type": "string" }, "expiration_type": { "enum": [ "none", "relative date", "specific date" ], "title": "Expiration Type", "type": "string" }, "maximum_number_of_total_uses": { "description": "The maximum number of total uses", "minimum": 1, "oneOf": [ { "enum": [ 1 ], "x-required": true } ], "title": "Maximum Number Of Total Uses", "type": "integer" }, "maximum_number_of_uses_per_customer": { "description": "The maximum number of total uses for a given customer", "minimum": 1, "oneOf": [ { "enum": [ 1 ], "x-required": true } ], "title": "Maximum Number Of Uses Per Customer", "type": "integer" }, "quantity": { "description": "The number of coupons to generate", "maximum": 250, "title": "Quantity", "type": "integer" }, "relative_expiration_date": { "additionalProperties": false, "description": "Expiration date relative to purchase", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Expiration Date", "type": "object" }, "restrict_to_contact": { "description": "If true, the code generated is restricted to the contact who made the purchase", "title": "Restrict To Contact", "type": "boolean" }, "restrict_to_organization": { "description": "If true, the code generated is restricted to the organization made the purchase", "title": "Restrict To Organization", "type": "boolean" } }, "required": [ "coupon_code_generation_process_id", "coupon_code_type", "coupon_id", "coupon_type", "quantity" ], "type": "object" }, "minItems": 1, "type": "array" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "custom_pricing_options": { "additionalProperties": false, "properties": { "lambda_function_id": { "description": "The custom lambda function to use", "title": "Lambda Function", "type": "string" } }, "required": [ "lambda_function_id" ], "title": "Custom Pricing Options", "type": "object" }, "deadline_based_pricing": { "items": { "additionalProperties": false, "properties": { "deadline_id": { "description": "The deadline", "title": "Deadline", "type": "string" }, "member_price": { "description": "The member price at this deadline", "format": "double", "title": "Member Price", "type": "number" }, "price": { "description": "The price at this deadline", "format": "double", "title": "Price", "type": "number" } }, "required": [ "deadline_id" ], "type": "object" }, "type": "array" }, "description": { "description": "Product description", "title": "Description", "type": "string" }, "display_order": { "format": "float", "title": "Display Order", "type": "number" }, "document_entitlements_to_create": { "items": { "additionalProperties": false, "properties": { "expiration_date": { "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Expiration Date", "type": "string" }, "expiration_type": { "enum": [ "none", "relative date", "specific date" ], "title": "Expiration Type", "type": "string" }, "file_cabinet_id": { "description": "The file cabinet", "title": "File Cabinet", "type": "string" }, "item_id": { "description": "The item", "title": "Item", "type": "string" }, "library_path": { "description": "The optional path that items will be mounted onto the digital library", "title": "Library Path", "type": "string" }, "relative_expiration_date": { "additionalProperties": false, "description": "The date the task is due", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Expiration Date", "type": "object" } }, "required": [ "expiration_type", "file_cabinet_id" ], "type": "object" }, "type": "array" }, "enable_bulk_pricing": { "description": "Whether or not bulk pricing is enabled", "title": "Enable Bulk Pricing", "type": "boolean" }, "enable_bundled_products": { "description": "Whether to enable bundled products", "title": "Enable Bundled Products", "type": "boolean" }, "enable_cancellation_fees": { "description": "Whether or not cancellation fees are applicable", "title": "Enable Cancellation Fees", "type": "boolean" }, "enable_commerce_entitlement_creation": { "description": "If set, document entitlements will be created to access folders or documents", "title": "Enable Commerce Entitlement Creation", "type": "boolean" }, "enable_coupon_code_generation": { "description": "If true, purchasing this product will generate coupons", "title": "Enable Coupon Code Generation", "type": "boolean" }, "enable_custom_pricing": { "description": "If set, the order engine will call out to a custom lambda function for custom/complex pricing", "title": "Enable Custom Pricing", "type": "boolean" }, "enable_document_entitlement_creation": { "description": "If set, document entitlements will be created to access folders or documents", "title": "Enable Document Entitlement Creation", "type": "boolean" }, "enable_product_confirmation_email": { "description": "If enabled, a custom email goes out whenever this product is ordered", "title": "Enable Product Confirmation Email", "type": "boolean" }, "enable_purchase_limits": { "description": "If true, purchase limits are in place for this product", "title": "Enable Purchase Limits", "type": "boolean" }, "enable_purchasing_eligibility": { "description": "If set, purchases of this merchandise are restricted", "title": "Enable Purchasing Eligibility", "type": "boolean" }, "enable_special_prices": { "description": "Whether to enable special pricing logic", "title": "Enable Special Prices", "type": "boolean" }, "enable_task_generation": { "description": "If set, tasks will be generated", "title": "Enable Task Generation", "type": "boolean" }, "event_id": { "description": "The event", "title": "Event", "type": "string" }, "foreign_currency_prices": { "items": { "additionalProperties": false, "properties": { "cancellation_fee": { "description": "The cancellation fee of the product for this currency", "format": "double", "title": "Cancellation Fee", "type": "number" }, "currency_code": { "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "title": "Currency Code", "type": "string" }, "member_price": { "description": "The price of the product for a member", "format": "double", "title": "Member Price", "type": "number" }, "mode": { "description": "How this foreign currency should be treated", "enum": [ "calculate price", "prohibit purchase", "set price" ], "title": "Mode", "type": "string" }, "price": { "description": "The price of the product", "format": "double", "oneOf": [ { "x-required": true } ], "title": "Price", "type": "number" }, "restocking_fee": { "description": "The restocking fee of the product for this currency", "format": "double", "title": "Restocking Fee", "type": "number" } }, "required": [ "currency_code" ], "type": "object" }, "type": "array" }, "hide_from_portal": { "description": "If set, this product should not be shown in the portal", "title": "Hide From Portal", "type": "boolean" }, "id": { "description": "The unique, string identifier of this miscellaneous product", "pattern": "^[\\w:|-]+$", "title": "ID", "type": "string" }, "installment_plan_options": { "items": { "additionalProperties": false, "properties": { "additional_cost": { "description": "The additional cost of the installment plan", "format": "double", "title": "Additional Cost", "type": "number" }, "installment_plan_id": { "description": "The installment plan that this product supports", "title": "Installment Plan", "type": "string" }, "is_default": { "description": "Whether this is the default installment plan option", "title": "Is Default", "type": "boolean" } }, "required": [ "installment_plan_id" ], "type": "object" }, "minItems": 1, "type": "array" }, "is_active": { "description": "Whether this product is active/used", "title": "Is Active", "type": "boolean" }, "max_purchase_quantity": { "description": "The maximum amount that can be purchased", "format": "float", "title": "Max Purchase Quantity", "type": "number" }, "member_price": { "description": "The price of the product for an active member", "format": "double", "title": "Member Price", "type": "number" }, "name": { "description": "The name of the miscellaneous product", "title": "Name", "type": "string" }, "notes": { "description": "Notes", "title": "Notes", "type": "string" }, "portal_options": { "additionalProperties": false, "properties": { "available_from": { "description": "The date from which this product should be available", "format": "date-time", "title": "Available From", "type": "string" }, "available_until": { "description": "The date until which this product should be available", "format": "date-time", "title": "Available Until", "type": "string" } }, "title": "Portal Options", "type": "object" }, "price": { "description": "The price of the product", "format": "double", "title": "Price", "type": "number" }, "product_confirmation_email_options": { "additionalProperties": false, "properties": { "product_confirmation_email_id": { "oneOf": [ { "x-required": true } ], "title": "Product Confirmation Email", "type": "string" }, "product_specific_email": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "bcc": { "description": "Anyone that should be bcc'ed on the email", "title": "Bcc", "type": "string" }, "body": { "description": "The email body", "title": "Body", "type": "string" }, "cc": { "description": "Anyone that should be cc'ed on the email", "title": "Cc", "type": "string" }, "from": { "description": "From email address", "title": "From", "type": "string" }, "from_name": { "description": "From name", "title": "From Name", "type": "string" }, "reply_to": { "description": "The reply to", "title": "Reply To", "type": "string" }, "subject": { "description": "The email subject", "title": "Subject", "type": "string" } }, "required": [ "body", "subject" ], "title": "Product Specific Email", "type": "object" }, "type": { "enum": [ "product specific", "shared" ], "title": "Type", "type": "string" } }, "title": "Product Confirmation Email Options", "type": "object" }, "publish_to_portal": { "description": "Whether or not this product should be available in the portal", "title": "Publish To Portal", "type": "boolean" }, "purchase_limits": { "additionalProperties": false, "properties": { "error_message": { "description": "The error message to show", "title": "Error Message", "type": "string" }, "maximum": { "description": "The maximum", "format": "float", "title": "Maximum", "type": "number" }, "relative_time_window": { "additionalProperties": false, "description": "the time window", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Time Window", "type": "object" }, "time_period": { "enum": [ "all time", "sliding time window" ], "title": "Time Period", "type": "string" }, "type": { "enum": [ "per customer" ], "title": "Type", "type": "string" } }, "required": [ "maximum", "time_period", "type" ], "title": "Purchase Limits", "type": "object" }, "purchasing_eligibility_criteria": { "title": "Purchasing Eligibility Criteria", "type": "object" }, "special_prices": { "items": { "additionalProperties": false, "properties": { "criteria": { "title": "Criteria", "type": "object" }, "enable_formula": { "description": "if set, a formula is used to calculate the price. If the formula fails, the price is used", "title": "Enable Formula", "type": "boolean" }, "formula": { "description": "The formula evaluated using the expr-eval npm package", "oneOf": [ { "x-required": true } ], "title": "Formula", "type": "string" }, "name": { "title": "Name", "type": "string" }, "price": { "format": "float", "title": "Price", "type": "number" } }, "required": [ "criteria", "price" ], "type": "object" }, "minItems": 1, "type": "array" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" }, "tasks_to_generate": { "items": { "additionalProperties": false, "properties": { "assignee_type": { "enum": [ "assignment role", "queue", "user" ], "title": "Assignee Type", "type": "string" }, "assignment_role_id": { "description": "The assignment role that should receive the ask", "oneOf": [ { "x-required": true } ], "title": "Assignment Role", "type": "string" }, "description": { "description": "A description", "title": "Description", "type": "string" }, "due_date_type": { "description": "Whether there is a due date", "enum": [ "none", "relative date", "specific date" ], "title": "Due Date Type", "type": "string" }, "name": { "description": "The name of the task", "title": "Name", "type": "string" }, "notify_assignees": { "description": "Notify assignee when the task is created", "title": "Notify Assignees", "type": "boolean" }, "priority": { "enum": [ "high", "low", "normal", "urgent" ], "title": "Priority", "type": "string" }, "queue_id": { "description": "The queue that should be assigned the ask", "oneOf": [ { "x-required": true } ], "title": "Queue", "type": "string" }, "relative_due_date": { "additionalProperties": false, "description": "The date the task is due", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Due Date", "type": "object" }, "specific_due_date": { "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Specific Due Date", "type": "string" }, "type_id": { "description": "The type of task", "title": "Type", "type": "string" }, "user_id": { "description": "The user that should be assigned the ask", "oneOf": [ { "x-required": true } ], "title": "User", "type": "string" } }, "required": [ "assignee_type", "due_date_type", "name", "type_id" ], "type": "object" }, "type": "array" }, "type": { "description": "The product type", "enum": [ "events-registration-add-on-products" ], "title": "Type", "type": "string" } }, "required": [ "abbreviated_name", "add_on_type_id", "bulk_pricing_rules", "bundled_products", "business_unit_id", "coupon_codes", "custom_pricing_options", "event_id", "id", "installment_plan_options", "name", "price", "product_confirmation_email_options", "purchase_limits", "special_prices", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "RegistrationAddOnType": { "additionalProperties": false, "properties": { "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "description": { "description": "A description to be displayed in the portal", "title": "Description", "type": "string" }, "display_order": { "description": "Display order", "format": "float", "title": "Display Order", "type": "number" }, "id": { "description": "The unique, string identifier of this registration add on type", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "is_active": { "description": "Whether or not this registration add on type is active", "title": "Is Active", "type": "boolean" }, "name": { "description": "The name of the registration add on type", "title": "Name", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "id", "name", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "RegistrationCategory": { "additionalProperties": false, "properties": { "id": { "description": "The unique, string identifier of this registration category", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "is_active": { "description": "Whether or not this registration category is active", "title": "Is Active", "type": "boolean" }, "name": { "description": "The name of the registration category", "title": "Name", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "id", "name", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "RegistrationChangeFee": { "additionalProperties": false, "properties": { "allow_customer_to_choose_installment_plan": { "description": "If true, the customer can choose their installment plan", "title": "Allow Customer To Choose Installment Plan", "type": "boolean" }, "bulk_pricing_rules": { "items": { "additionalProperties": false, "properties": { "discount_amount": { "description": "The percentage/flat rate", "format": "float", "minimum": 0, "title": "Discount Amount", "type": "number" }, "discount_type": { "description": "The type of discount rule", "enum": [ "flat rate", "percentage" ], "title": "Discount Type", "type": "string" }, "ending_range": { "description": "The ending range of the rule", "minimum": 0, "title": "Ending Range", "type": "integer" }, "starting_range": { "description": "The starting range of the rule", "minimum": 0, "title": "Starting Range", "type": "integer" } }, "required": [ "discount_amount", "discount_type" ], "type": "object" }, "minItems": 1, "type": "array" }, "bundled_products": { "items": { "additionalProperties": false, "properties": { "member_price": { "description": "The member price", "format": "double", "title": "Member Price", "type": "number" }, "price": { "description": "The price to bundle", "format": "double", "title": "Price", "type": "number" }, "product_id": { "description": "The product ID", "title": "Product", "type": "string" }, "product_type": { "description": "The product type", "title": "Product Type", "type": "string" }, "quantity": { "description": "The quantity to bundle", "title": "Quantity", "type": "integer" }, "type": { "enum": [ "bundled product", "inline bundled product" ], "title": "Type", "type": "string" } }, "required": [ "product_id", "product_type", "quantity", "type" ], "type": "object" }, "minItems": 1, "type": "array" }, "bundled_products_inventory_handling": { "description": "Whether to track inventory for the entire bundle, or for each product separately", "enum": [ "bundle", "each product" ], "title": "Bundled Products Inventory Handling", "type": "string" }, "business_unit_id": { "description": "The business unit of the product", "title": "Business Unit", "type": "string" }, "cancellation_fee": { "description": "Cancellation fees associated with this product", "format": "double", "title": "Cancellation Fee", "type": "number" }, "commerce_entitlements_to_create": { "items": { "additionalProperties": false, "properties": { "expiration_date": { "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Expiration Date", "type": "string" }, "expiration_type": { "enum": [ "none", "relative date", "specific date" ], "title": "Expiration Type", "type": "string" }, "quantity": { "description": "The quantity", "format": "float", "title": "Quantity", "type": "number" }, "relative_expiration_date": { "additionalProperties": false, "description": "The date the task is due", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Expiration Date", "type": "object" }, "type_id": { "description": "The type of entitlement", "title": "Type", "type": "string" } }, "required": [ "expiration_type", "type_id" ], "type": "object" }, "type": "array" }, "coupon_codes": { "items": { "additionalProperties": false, "properties": { "coupon_code_generation_process_id": { "description": "The process by which the coupons are generated", "title": "Coupon Code Generation Process", "type": "string" }, "coupon_code_type": { "enum": [ "multi use", "single use" ], "title": "Coupon Code Type", "type": "string" }, "coupon_id": { "title": "Coupon", "type": "string" }, "coupon_type": { "title": "Coupon Type", "type": "string" }, "expiration_date": { "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Expiration Date", "type": "string" }, "expiration_type": { "enum": [ "none", "relative date", "specific date" ], "title": "Expiration Type", "type": "string" }, "maximum_number_of_total_uses": { "description": "The maximum number of total uses", "minimum": 1, "oneOf": [ { "enum": [ 1 ], "x-required": true } ], "title": "Maximum Number Of Total Uses", "type": "integer" }, "maximum_number_of_uses_per_customer": { "description": "The maximum number of total uses for a given customer", "minimum": 1, "oneOf": [ { "enum": [ 1 ], "x-required": true } ], "title": "Maximum Number Of Uses Per Customer", "type": "integer" }, "quantity": { "description": "The number of coupons to generate", "maximum": 250, "title": "Quantity", "type": "integer" }, "relative_expiration_date": { "additionalProperties": false, "description": "Expiration date relative to purchase", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Expiration Date", "type": "object" }, "restrict_to_contact": { "description": "If true, the code generated is restricted to the contact who made the purchase", "title": "Restrict To Contact", "type": "boolean" }, "restrict_to_organization": { "description": "If true, the code generated is restricted to the organization made the purchase", "title": "Restrict To Organization", "type": "boolean" } }, "required": [ "coupon_code_generation_process_id", "coupon_code_type", "coupon_id", "coupon_type", "quantity" ], "type": "object" }, "minItems": 1, "type": "array" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "custom_pricing_options": { "additionalProperties": false, "properties": { "lambda_function_id": { "description": "The custom lambda function to use", "title": "Lambda Function", "type": "string" } }, "required": [ "lambda_function_id" ], "title": "Custom Pricing Options", "type": "object" }, "document_entitlements_to_create": { "items": { "additionalProperties": false, "properties": { "expiration_date": { "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Expiration Date", "type": "string" }, "expiration_type": { "enum": [ "none", "relative date", "specific date" ], "title": "Expiration Type", "type": "string" }, "file_cabinet_id": { "description": "The file cabinet", "title": "File Cabinet", "type": "string" }, "item_id": { "description": "The item", "title": "Item", "type": "string" }, "library_path": { "description": "The optional path that items will be mounted onto the digital library", "title": "Library Path", "type": "string" }, "relative_expiration_date": { "additionalProperties": false, "description": "The date the task is due", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Expiration Date", "type": "object" } }, "required": [ "expiration_type", "file_cabinet_id" ], "type": "object" }, "type": "array" }, "enable_bulk_pricing": { "description": "Whether or not bulk pricing is enabled", "title": "Enable Bulk Pricing", "type": "boolean" }, "enable_bundled_products": { "description": "Whether to enable bundled products", "title": "Enable Bundled Products", "type": "boolean" }, "enable_cancellation_fees": { "description": "Whether or not cancellation fees are applicable", "title": "Enable Cancellation Fees", "type": "boolean" }, "enable_commerce_entitlement_creation": { "description": "If set, document entitlements will be created to access folders or documents", "title": "Enable Commerce Entitlement Creation", "type": "boolean" }, "enable_coupon_code_generation": { "description": "If true, purchasing this product will generate coupons", "title": "Enable Coupon Code Generation", "type": "boolean" }, "enable_custom_pricing": { "description": "If set, the order engine will call out to a custom lambda function for custom/complex pricing", "title": "Enable Custom Pricing", "type": "boolean" }, "enable_document_entitlement_creation": { "description": "If set, document entitlements will be created to access folders or documents", "title": "Enable Document Entitlement Creation", "type": "boolean" }, "enable_product_confirmation_email": { "description": "If enabled, a custom email goes out whenever this product is ordered", "title": "Enable Product Confirmation Email", "type": "boolean" }, "enable_purchase_limits": { "description": "If true, purchase limits are in place for this product", "title": "Enable Purchase Limits", "type": "boolean" }, "enable_purchasing_eligibility": { "description": "If set, purchases of this merchandise are restricted", "title": "Enable Purchasing Eligibility", "type": "boolean" }, "enable_special_prices": { "description": "Whether to enable special pricing logic", "title": "Enable Special Prices", "type": "boolean" }, "enable_task_generation": { "description": "If set, tasks will be generated", "title": "Enable Task Generation", "type": "boolean" }, "foreign_currency_prices": { "items": { "additionalProperties": false, "properties": { "cancellation_fee": { "description": "The cancellation fee of the product for this currency", "format": "double", "title": "Cancellation Fee", "type": "number" }, "currency_code": { "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "title": "Currency Code", "type": "string" }, "member_price": { "description": "The price of the product for a member", "format": "double", "title": "Member Price", "type": "number" }, "mode": { "description": "How this foreign currency should be treated", "enum": [ "calculate price", "prohibit purchase", "set price" ], "title": "Mode", "type": "string" }, "price": { "description": "The price of the product", "format": "double", "oneOf": [ { "x-required": true } ], "title": "Price", "type": "number" }, "restocking_fee": { "description": "The restocking fee of the product for this currency", "format": "double", "title": "Restocking Fee", "type": "number" } }, "required": [ "currency_code" ], "type": "object" }, "type": "array" }, "hide_from_portal": { "description": "If set, this product should not be shown in the portal", "title": "Hide From Portal", "type": "boolean" }, "id": { "description": "The unique, string identifier of this miscellaneous product", "pattern": "^[\\w:|-]+$", "title": "ID", "type": "string" }, "installment_plan_options": { "items": { "additionalProperties": false, "properties": { "additional_cost": { "description": "The additional cost of the installment plan", "format": "double", "title": "Additional Cost", "type": "number" }, "installment_plan_id": { "description": "The installment plan that this product supports", "title": "Installment Plan", "type": "string" }, "is_default": { "description": "Whether this is the default installment plan option", "title": "Is Default", "type": "boolean" } }, "required": [ "installment_plan_id" ], "type": "object" }, "minItems": 1, "type": "array" }, "is_active": { "description": "Whether this product is active/used", "title": "Is Active", "type": "boolean" }, "member_price": { "description": "The price of the product for an active member", "format": "double", "title": "Member Price", "type": "number" }, "name": { "description": "The name of the miscellaneous product", "title": "Name", "type": "string" }, "notes": { "description": "Notes", "title": "Notes", "type": "string" }, "portal_options": { "additionalProperties": false, "properties": { "available_from": { "description": "The date from which this product should be available", "format": "date-time", "title": "Available From", "type": "string" }, "available_until": { "description": "The date until which this product should be available", "format": "date-time", "title": "Available Until", "type": "string" } }, "title": "Portal Options", "type": "object" }, "price": { "description": "The price of the product", "format": "double", "title": "Price", "type": "number" }, "product_confirmation_email_options": { "additionalProperties": false, "properties": { "product_confirmation_email_id": { "oneOf": [ { "x-required": true } ], "title": "Product Confirmation Email", "type": "string" }, "product_specific_email": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "bcc": { "description": "Anyone that should be bcc'ed on the email", "title": "Bcc", "type": "string" }, "body": { "description": "The email body", "title": "Body", "type": "string" }, "cc": { "description": "Anyone that should be cc'ed on the email", "title": "Cc", "type": "string" }, "from": { "description": "From email address", "title": "From", "type": "string" }, "from_name": { "description": "From name", "title": "From Name", "type": "string" }, "reply_to": { "description": "The reply to", "title": "Reply To", "type": "string" }, "subject": { "description": "The email subject", "title": "Subject", "type": "string" } }, "required": [ "body", "subject" ], "title": "Product Specific Email", "type": "object" }, "type": { "enum": [ "product specific", "shared" ], "title": "Type", "type": "string" } }, "title": "Product Confirmation Email Options", "type": "object" }, "publish_to_portal": { "description": "Whether or not this product should be available in the portal", "title": "Publish To Portal", "type": "boolean" }, "purchase_limits": { "additionalProperties": false, "properties": { "error_message": { "description": "The error message to show", "title": "Error Message", "type": "string" }, "maximum": { "description": "The maximum", "format": "float", "title": "Maximum", "type": "number" }, "relative_time_window": { "additionalProperties": false, "description": "the time window", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Time Window", "type": "object" }, "time_period": { "enum": [ "all time", "sliding time window" ], "title": "Time Period", "type": "string" }, "type": { "enum": [ "per customer" ], "title": "Type", "type": "string" } }, "required": [ "maximum", "time_period", "type" ], "title": "Purchase Limits", "type": "object" }, "purchasing_eligibility_criteria": { "title": "Purchasing Eligibility Criteria", "type": "object" }, "special_prices": { "items": { "additionalProperties": false, "properties": { "criteria": { "title": "Criteria", "type": "object" }, "enable_formula": { "description": "if set, a formula is used to calculate the price. If the formula fails, the price is used", "title": "Enable Formula", "type": "boolean" }, "formula": { "description": "The formula evaluated using the expr-eval npm package", "oneOf": [ { "x-required": true } ], "title": "Formula", "type": "string" }, "name": { "title": "Name", "type": "string" }, "price": { "format": "float", "title": "Price", "type": "number" } }, "required": [ "criteria", "price" ], "type": "object" }, "minItems": 1, "type": "array" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" }, "tasks_to_generate": { "items": { "additionalProperties": false, "properties": { "assignee_type": { "enum": [ "assignment role", "queue", "user" ], "title": "Assignee Type", "type": "string" }, "assignment_role_id": { "description": "The assignment role that should receive the ask", "oneOf": [ { "x-required": true } ], "title": "Assignment Role", "type": "string" }, "description": { "description": "A description", "title": "Description", "type": "string" }, "due_date_type": { "description": "Whether there is a due date", "enum": [ "none", "relative date", "specific date" ], "title": "Due Date Type", "type": "string" }, "name": { "description": "The name of the task", "title": "Name", "type": "string" }, "notify_assignees": { "description": "Notify assignee when the task is created", "title": "Notify Assignees", "type": "boolean" }, "priority": { "enum": [ "high", "low", "normal", "urgent" ], "title": "Priority", "type": "string" }, "queue_id": { "description": "The queue that should be assigned the ask", "oneOf": [ { "x-required": true } ], "title": "Queue", "type": "string" }, "relative_due_date": { "additionalProperties": false, "description": "The date the task is due", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Due Date", "type": "object" }, "specific_due_date": { "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Specific Due Date", "type": "string" }, "type_id": { "description": "The type of task", "title": "Type", "type": "string" }, "user_id": { "description": "The user that should be assigned the ask", "oneOf": [ { "x-required": true } ], "title": "User", "type": "string" } }, "required": [ "assignee_type", "due_date_type", "name", "type_id" ], "type": "object" }, "type": "array" }, "type": { "description": "The product type", "enum": [ "events-registration-change-fees" ], "title": "Type", "type": "string" } }, "required": [ "bulk_pricing_rules", "bundled_products", "business_unit_id", "coupon_codes", "custom_pricing_options", "id", "installment_plan_options", "name", "price", "product_confirmation_email_options", "purchase_limits", "special_prices", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "RegistrationDeadline": { "additionalProperties": false, "properties": { "display_order": { "description": "The display order of the deadline", "format": "float", "title": "Display Order", "type": "number" }, "id": { "description": "The unique, string identifier of this registration deadline", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "is_active": { "description": "Whether or not this registration deadline is active", "title": "Is Active", "type": "boolean" }, "name": { "description": "The name of the registration deadline", "title": "Name", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "id", "name", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "RegistrationGroup": { "additionalProperties": false, "properties": { "administrator_id": { "description": "The contact that is the group administrator", "title": "Administrator", "type": "string" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "event_id": { "description": "The event ID", "title": "Event", "type": "string" }, "id": { "description": "The unique, string identifier of this registration group", "pattern": "^[\\w|:-]+$", "title": "ID", "type": "string" }, "name": { "description": "The name of the registration group", "title": "Name", "type": "string" }, "organization_id": { "description": "The organization to which this group belongs", "title": "Organization", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "event_id", "id", "name", "organization_id", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "RegistrationGroupSearchParameters": { "additionalProperties": false, "properties": { "administrator_id": { "items": { "type": "string" }, "title": "Administrator", "type": "array" }, "event_id": { "title": "Event", "type": "string" }, "ids": { "description": "IDs to search", "items": { "type": "string" }, "title": "Ids", "type": "array" }, "name": { "title": "Name", "type": "string" }, "organization_id": { "items": { "type": "string" }, "title": "Organization", "type": "array" } }, "required": [ "event_id" ], "type": "object" }, "RegistrationGroupSearchResults": { "additionalProperties": false, "properties": { "administrator_id": { "description": "The contact that is the group administrator", "title": "Administrator", "type": "string" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "event_id": { "description": "The event ID", "title": "Event", "type": "string" }, "id": { "description": "The unique, string identifier of this registration group", "pattern": "^[\\w|:-]+$", "title": "ID", "type": "string" }, "name": { "description": "The name of the registration group", "title": "Name", "type": "string" }, "organization_id": { "description": "The organization to which this group belongs", "title": "Organization", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "event_id", "id", "name", "organization_id", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "RegistrationPackage": { "additionalProperties": false, "properties": { "abbreviated_name": { "description": "The abbreviated name of the registration package, for display inside event dropdowns & lists", "title": "Abbreviated Name", "type": "string" }, "allow_customer_to_choose_installment_plan": { "description": "If true, the customer can choose their installment plan", "title": "Allow Customer To Choose Installment Plan", "type": "boolean" }, "allow_guest_registrations": { "description": "Whether or not this package allows for guests", "title": "Allow Guest Registrations", "type": "boolean" }, "auto_renew_opt_out": { "description": "If set, auto renew is set automatically on the membership and the member must opt out", "title": "Auto Renew Opt Out", "type": "boolean" }, "bulk_pricing_rules": { "items": { "additionalProperties": false, "properties": { "discount_amount": { "description": "The percentage/flat rate", "format": "float", "minimum": 0, "title": "Discount Amount", "type": "number" }, "discount_type": { "description": "The type of discount rule", "enum": [ "flat rate", "percentage" ], "title": "Discount Type", "type": "string" }, "ending_range": { "description": "The ending range of the rule", "minimum": 0, "title": "Ending Range", "type": "integer" }, "starting_range": { "description": "The starting range of the rule", "minimum": 0, "title": "Starting Range", "type": "integer" } }, "required": [ "discount_amount", "discount_type" ], "type": "object" }, "minItems": 1, "type": "array" }, "bundled_products": { "items": { "additionalProperties": false, "properties": { "member_price": { "description": "The member price", "format": "double", "title": "Member Price", "type": "number" }, "price": { "description": "The price to bundle", "format": "double", "title": "Price", "type": "number" }, "product_id": { "description": "The product ID", "title": "Product", "type": "string" }, "product_type": { "description": "The product type", "title": "Product Type", "type": "string" }, "quantity": { "description": "The quantity to bundle", "title": "Quantity", "type": "integer" }, "type": { "enum": [ "bundled product", "inline bundled product" ], "title": "Type", "type": "string" } }, "required": [ "product_id", "product_type", "quantity", "type" ], "type": "object" }, "minItems": 1, "type": "array" }, "bundled_products_inventory_handling": { "description": "Whether to track inventory for the entire bundle, or for each product separately", "enum": [ "bundle", "each product" ], "title": "Bundled Products Inventory Handling", "type": "string" }, "business_unit_id": { "description": "The business unit of the product", "title": "Business Unit", "type": "string" }, "cancellation_fee": { "description": "Cancellation fees associated with this product", "format": "double", "title": "Cancellation Fee", "type": "number" }, "cancellation_policy": { "additionalProperties": false, "properties": { "cancellation_deadline": { "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Cancellation Deadline", "type": "string" }, "cancellation_policy": { "enum": [ "none", "relative date", "specific date" ], "title": "Cancellation Policy", "type": "string" }, "cancellation_relative_date": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Cancellation Relative Date", "type": "object" } }, "title": "Cancellation Policy", "type": "object" }, "commerce_entitlements_to_create": { "items": { "additionalProperties": false, "properties": { "expiration_date": { "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Expiration Date", "type": "string" }, "expiration_type": { "enum": [ "none", "relative date", "specific date" ], "title": "Expiration Type", "type": "string" }, "quantity": { "description": "The quantity", "format": "float", "title": "Quantity", "type": "number" }, "relative_expiration_date": { "additionalProperties": false, "description": "The date the task is due", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Expiration Date", "type": "object" }, "type_id": { "description": "The type of entitlement", "title": "Type", "type": "string" } }, "required": [ "expiration_type", "type_id" ], "type": "object" }, "type": "array" }, "coupon_codes": { "items": { "additionalProperties": false, "properties": { "coupon_code_generation_process_id": { "description": "The process by which the coupons are generated", "title": "Coupon Code Generation Process", "type": "string" }, "coupon_code_type": { "enum": [ "multi use", "single use" ], "title": "Coupon Code Type", "type": "string" }, "coupon_id": { "title": "Coupon", "type": "string" }, "coupon_type": { "title": "Coupon Type", "type": "string" }, "expiration_date": { "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Expiration Date", "type": "string" }, "expiration_type": { "enum": [ "none", "relative date", "specific date" ], "title": "Expiration Type", "type": "string" }, "maximum_number_of_total_uses": { "description": "The maximum number of total uses", "minimum": 1, "oneOf": [ { "enum": [ 1 ], "x-required": true } ], "title": "Maximum Number Of Total Uses", "type": "integer" }, "maximum_number_of_uses_per_customer": { "description": "The maximum number of total uses for a given customer", "minimum": 1, "oneOf": [ { "enum": [ 1 ], "x-required": true } ], "title": "Maximum Number Of Uses Per Customer", "type": "integer" }, "quantity": { "description": "The number of coupons to generate", "maximum": 250, "title": "Quantity", "type": "integer" }, "relative_expiration_date": { "additionalProperties": false, "description": "Expiration date relative to purchase", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Expiration Date", "type": "object" }, "restrict_to_contact": { "description": "If true, the code generated is restricted to the contact who made the purchase", "title": "Restrict To Contact", "type": "boolean" }, "restrict_to_organization": { "description": "If true, the code generated is restricted to the organization made the purchase", "title": "Restrict To Organization", "type": "boolean" } }, "required": [ "coupon_code_generation_process_id", "coupon_code_type", "coupon_id", "coupon_type", "quantity" ], "type": "object" }, "minItems": 1, "type": "array" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "custom_pricing_options": { "additionalProperties": false, "properties": { "lambda_function_id": { "description": "The custom lambda function to use", "title": "Lambda Function", "type": "string" } }, "required": [ "lambda_function_id" ], "title": "Custom Pricing Options", "type": "object" }, "days": { "description": "The days", "items": { "format": "date", "type": "string" }, "minItems": 1, "title": "Days", "type": "array" }, "deadline_based_pricing": { "items": { "additionalProperties": false, "properties": { "deadline_id": { "description": "The deadline", "title": "Deadline", "type": "string" }, "foreign_currency_prices": { "items": { "additionalProperties": false, "properties": { "currency_code": { "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "title": "Currency Code", "type": "string" }, "member_price": { "description": "The price of the product for a member", "format": "double", "title": "Member Price", "type": "number" }, "mode": { "description": "How this foreign currency should be treated", "enum": [ "calculate price", "prohibit purchase", "set price" ], "title": "Mode", "type": "string" }, "price": { "description": "The price of the product", "format": "double", "oneOf": [ { "x-required": true } ], "title": "Price", "type": "number" } }, "required": [ "currency_code" ], "type": "object" }, "type": "array" }, "member_price": { "description": "The member price at this deadline", "format": "double", "title": "Member Price", "type": "number" }, "price": { "description": "The price at this deadline", "format": "double", "title": "Price", "type": "number" } }, "required": [ "deadline_id" ], "type": "object" }, "type": "array" }, "description": { "description": "A description of the package", "title": "Description", "type": "string" }, "display_order": { "description": "Display order", "format": "float", "title": "Display Order", "type": "number" }, "document_entitlements_to_create": { "items": { "additionalProperties": false, "properties": { "expiration_date": { "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Expiration Date", "type": "string" }, "expiration_type": { "enum": [ "none", "relative date", "specific date" ], "title": "Expiration Type", "type": "string" }, "file_cabinet_id": { "description": "The file cabinet", "title": "File Cabinet", "type": "string" }, "item_id": { "description": "The item", "title": "Item", "type": "string" }, "library_path": { "description": "The optional path that items will be mounted onto the digital library", "title": "Library Path", "type": "string" }, "relative_expiration_date": { "additionalProperties": false, "description": "The date the task is due", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Expiration Date", "type": "object" } }, "required": [ "expiration_type", "file_cabinet_id" ], "type": "object" }, "type": "array" }, "enable_bulk_pricing": { "description": "Whether or not bulk pricing is enabled", "title": "Enable Bulk Pricing", "type": "boolean" }, "enable_bundled_products": { "description": "Whether to enable bundled products", "title": "Enable Bundled Products", "type": "boolean" }, "enable_cancellation_fees": { "description": "Whether or not cancellation fees are applicable", "title": "Enable Cancellation Fees", "type": "boolean" }, "enable_commerce_entitlement_creation": { "description": "If set, document entitlements will be created to access folders or documents", "title": "Enable Commerce Entitlement Creation", "type": "boolean" }, "enable_coupon_code_generation": { "description": "If true, purchasing this product will generate coupons", "title": "Enable Coupon Code Generation", "type": "boolean" }, "enable_custom_pricing": { "description": "If set, the order engine will call out to a custom lambda function for custom/complex pricing", "title": "Enable Custom Pricing", "type": "boolean" }, "enable_document_entitlement_creation": { "description": "If set, document entitlements will be created to access folders or documents", "title": "Enable Document Entitlement Creation", "type": "boolean" }, "enable_product_confirmation_email": { "description": "If enabled, a custom email goes out whenever this product is ordered", "title": "Enable Product Confirmation Email", "type": "boolean" }, "enable_purchase_limits": { "description": "If true, purchase limits are in place for this product", "title": "Enable Purchase Limits", "type": "boolean" }, "enable_purchasing_eligibility": { "description": "If set, purchases of this merchandise are restricted", "title": "Enable Purchasing Eligibility", "type": "boolean" }, "enable_special_prices": { "description": "Whether to enable special pricing logic", "title": "Enable Special Prices", "type": "boolean" }, "enable_task_generation": { "description": "If set, tasks will be generated", "title": "Enable Task Generation", "type": "boolean" }, "event_id": { "description": "The event", "title": "Event", "type": "string" }, "foreign_currency_prices": { "items": { "additionalProperties": false, "properties": { "cancellation_fee": { "description": "The cancellation fee of the product for this currency", "format": "double", "title": "Cancellation Fee", "type": "number" }, "currency_code": { "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "title": "Currency Code", "type": "string" }, "member_price": { "description": "The price of the product for a member", "format": "double", "title": "Member Price", "type": "number" }, "mode": { "description": "How this foreign currency should be treated", "enum": [ "calculate price", "prohibit purchase", "set price" ], "title": "Mode", "type": "string" }, "price": { "description": "The price of the product", "format": "double", "oneOf": [ { "x-required": true } ], "title": "Price", "type": "number" }, "restocking_fee": { "description": "The restocking fee of the product for this currency", "format": "double", "title": "Restocking Fee", "type": "number" } }, "required": [ "currency_code" ], "type": "object" }, "type": "array" }, "function_ids": { "items": { "type": "string" }, "minItems": 1, "title": "Functions", "type": "array" }, "guest_registration_options": { "additionalProperties": false, "properties": { "guest_types": { "items": { "additionalProperties": false, "properties": { "maximum_number_of_guests": { "description": "Max guests", "format": "float", "title": "Maximum Number Of Guests", "type": "number" }, "registration_type_id": { "description": "The registration type", "title": "Registration Type", "type": "string" } }, "type": "object" }, "type": "array" }, "maximum_number_of_guests": { "format": "float", "title": "Maximum Number Of Guests", "type": "number" } }, "title": "Guest Registration Options", "type": "object" }, "hide_from_online_store": { "description": "If true, this package is not available in the online store", "title": "Hide From Online Store", "type": "boolean" }, "hide_from_portal": { "description": "If set, this product should not be shown in the portal", "title": "Hide From Portal", "type": "boolean" }, "id": { "description": "The unique, string identifier of this miscellaneous product", "pattern": "^[\\w:|-]+$", "title": "ID", "type": "string" }, "include_add_ons": { "description": "Whether or not add ons are included in this package", "title": "Include Add Ons", "type": "boolean" }, "include_courses": { "description": "Whether or not courses are included in this package", "title": "Include Courses", "type": "boolean" }, "include_sessions": { "description": "Whether or not sessions are included in this package", "title": "Include Sessions", "type": "boolean" }, "include_tickets": { "description": "Whether or not sessions are included in this package", "title": "Include Tickets", "type": "boolean" }, "included_add_ons": { "items": { "additionalProperties": false, "properties": { "add_on_product_id": { "title": "Add On Product", "type": "string" }, "quantity": { "format": "float", "minimum": 1, "title": "Quantity", "type": "number" } }, "required": [ "add_on_product_id", "quantity" ], "type": "object" }, "minItems": 1, "type": "array" }, "included_courses": { "items": { "additionalProperties": false, "properties": { "course_id": { "title": "Course", "type": "string" } }, "required": [ "course_id" ], "type": "object" }, "minItems": 1, "type": "array" }, "included_sessions": { "items": { "additionalProperties": false, "properties": { "session_id": { "title": "Session", "type": "string" } }, "required": [ "session_id" ], "type": "object" }, "minItems": 1, "type": "array" }, "included_tickets": { "items": { "additionalProperties": false, "properties": { "function_fee_id": { "description": "The function fee", "title": "Function Fee", "type": "string" }, "function_id": { "description": "The function", "title": "Function", "type": "string" }, "number_of_tickets": { "format": "float", "title": "Number Of Tickets", "type": "number" } }, "required": [ "function_fee_id", "function_id" ], "type": "object" }, "minItems": 1, "type": "array" }, "installment_plan_options": { "items": { "additionalProperties": false, "properties": { "additional_cost": { "description": "The additional cost of the installment plan", "format": "double", "title": "Additional Cost", "type": "number" }, "installment_plan_id": { "description": "The installment plan that this product supports", "title": "Installment Plan", "type": "string" }, "is_default": { "description": "Whether this is the default installment plan option", "title": "Is Default", "type": "boolean" } }, "required": [ "installment_plan_id" ], "type": "object" }, "minItems": 1, "type": "array" }, "is_active": { "description": "Whether this product is active/used", "title": "Is Active", "type": "boolean" }, "member_price": { "description": "The price of the product for an active member", "format": "double", "title": "Member Price", "type": "number" }, "name": { "description": "The name of the miscellaneous product", "title": "Name", "type": "string" }, "notes": { "description": "Notes", "title": "Notes", "type": "string" }, "override_cancellation_policy": { "description": "If set, the cancellation policy for this registration is overridden", "title": "Override Cancellation Policy", "type": "boolean" }, "portal_options": { "additionalProperties": false, "properties": { "available_from": { "description": "The date from which this product should be available", "format": "date-time", "title": "Available From", "type": "string" }, "available_until": { "description": "The date until which this product should be available", "format": "date-time", "title": "Available Until", "type": "string" } }, "title": "Portal Options", "type": "object" }, "price": { "description": "The price of the product", "format": "double", "title": "Price", "type": "number" }, "product_confirmation_email_options": { "additionalProperties": false, "properties": { "product_confirmation_email_id": { "oneOf": [ { "x-required": true } ], "title": "Product Confirmation Email", "type": "string" }, "product_specific_email": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "bcc": { "description": "Anyone that should be bcc'ed on the email", "title": "Bcc", "type": "string" }, "body": { "description": "The email body", "title": "Body", "type": "string" }, "cc": { "description": "Anyone that should be cc'ed on the email", "title": "Cc", "type": "string" }, "from": { "description": "From email address", "title": "From", "type": "string" }, "from_name": { "description": "From name", "title": "From Name", "type": "string" }, "reply_to": { "description": "The reply to", "title": "Reply To", "type": "string" }, "subject": { "description": "The email subject", "title": "Subject", "type": "string" } }, "required": [ "body", "subject" ], "title": "Product Specific Email", "type": "object" }, "type": { "enum": [ "product specific", "shared" ], "title": "Type", "type": "string" } }, "title": "Product Confirmation Email Options", "type": "object" }, "publish_to_portal": { "description": "Whether or not this product should be available in the portal", "title": "Publish To Portal", "type": "boolean" }, "purchase_limits": { "additionalProperties": false, "properties": { "error_message": { "description": "The error message to show", "title": "Error Message", "type": "string" }, "maximum": { "description": "The maximum", "format": "float", "title": "Maximum", "type": "number" }, "relative_time_window": { "additionalProperties": false, "description": "the time window", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Time Window", "type": "object" }, "time_period": { "enum": [ "all time", "sliding time window" ], "title": "Time Period", "type": "string" }, "type": { "enum": [ "per customer" ], "title": "Type", "type": "string" } }, "required": [ "maximum", "time_period", "type" ], "title": "Purchase Limits", "type": "object" }, "purchasing_eligibility_criteria": { "title": "Purchasing Eligibility Criteria", "type": "object" }, "registrants_can_only_attend_on_certain_days": { "description": "If true, this package only allows registrants to attend on certain days", "title": "Registrants Can Only Attend On Certain Days", "type": "boolean" }, "registration_type_id": { "description": "The registration type to which this fee is tied; if null, is a \"catch all\" and applies to all types", "title": "Registration Type", "type": "string" }, "session_attendance": { "enum": [ "can attend all sessions", "can attend certain session tracks", "can attend no sessions" ], "title": "Session Attendance", "type": "string" }, "special_prices": { "items": { "additionalProperties": false, "properties": { "criteria": { "title": "Criteria", "type": "object" }, "enable_formula": { "description": "if set, a formula is used to calculate the price. If the formula fails, the price is used", "title": "Enable Formula", "type": "boolean" }, "formula": { "description": "The formula evaluated using the expr-eval npm package", "oneOf": [ { "x-required": true } ], "title": "Formula", "type": "string" }, "name": { "title": "Name", "type": "string" }, "price": { "format": "float", "title": "Price", "type": "number" } }, "required": [ "criteria", "price" ], "type": "object" }, "minItems": 1, "type": "array" }, "specific_session_track_ids": { "items": { "type": "string" }, "minItems": 1, "title": "Specific Session Tracks", "type": "array" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" }, "tasks_to_generate": { "items": { "additionalProperties": false, "properties": { "assignee_type": { "enum": [ "assignment role", "queue", "user" ], "title": "Assignee Type", "type": "string" }, "assignment_role_id": { "description": "The assignment role that should receive the ask", "oneOf": [ { "x-required": true } ], "title": "Assignment Role", "type": "string" }, "description": { "description": "A description", "title": "Description", "type": "string" }, "due_date_type": { "description": "Whether there is a due date", "enum": [ "none", "relative date", "specific date" ], "title": "Due Date Type", "type": "string" }, "name": { "description": "The name of the task", "title": "Name", "type": "string" }, "notify_assignees": { "description": "Notify assignee when the task is created", "title": "Notify Assignees", "type": "boolean" }, "priority": { "enum": [ "high", "low", "normal", "urgent" ], "title": "Priority", "type": "string" }, "queue_id": { "description": "The queue that should be assigned the ask", "oneOf": [ { "x-required": true } ], "title": "Queue", "type": "string" }, "relative_due_date": { "additionalProperties": false, "description": "The date the task is due", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Due Date", "type": "object" }, "specific_due_date": { "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Specific Due Date", "type": "string" }, "type_id": { "description": "The type of task", "title": "Type", "type": "string" }, "user_id": { "description": "The user that should be assigned the ask", "oneOf": [ { "x-required": true } ], "title": "User", "type": "string" } }, "required": [ "assignee_type", "due_date_type", "name", "type_id" ], "type": "object" }, "type": "array" }, "ticket_purchase_restrictions": { "enum": [ "all except the functions specified", "none", "only the functions specified" ], "title": "Ticket Purchase Restrictions", "type": "string" }, "type": { "description": "The product type", "enum": [ "events-registration-packages" ], "title": "Type", "type": "string" } }, "required": [ "bulk_pricing_rules", "bundled_products", "business_unit_id", "coupon_codes", "custom_pricing_options", "days", "event_id", "function_ids", "guest_registration_options", "id", "included_add_ons", "included_courses", "included_sessions", "included_tickets", "installment_plan_options", "name", "price", "product_confirmation_email_options", "purchase_limits", "registration_type_id", "special_prices", "specific_session_track_ids", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "RegistrationProcess": { "additionalProperties": false, "properties": { "allow_registrants_to_cancel_registrations": { "description": "Whether registrants can cancel registrations in the portal", "title": "Allow Registrants To Cancel Registrations", "type": "boolean" }, "allow_registrants_to_edit_registrations": { "description": "Whether registrants can edit their registrations", "title": "Allow Registrants To Edit Registrations", "type": "boolean" }, "checkout_settings": { "additionalProperties": false, "properties": { "allow_customer_to_choose_installment_plan": { "description": "If true, the customer can choose their installment plan", "title": "Allow Customer To Choose Installment Plan", "type": "boolean" }, "bank_account_id": { "description": "The default bank account that the store should use to receive payments", "title": "Bank Account", "type": "string" }, "bill_my_organization_options": { "additionalProperties": false, "properties": { "billing_address": { "enum": [ "do not show", "optional", "required" ], "title": "Billing Address", "type": "string" }, "purchase_order_number": { "enum": [ "do not show", "optional", "required" ], "title": "Purchase Order Number", "type": "string" }, "reference_number": { "description": "The reference #", "title": "Reference Number", "type": "string" } }, "title": "Bill My Organization Options", "type": "object" }, "bill_my_parent_organization_options": { "additionalProperties": false, "properties": { "billing_address": { "enum": [ "do not show", "optional", "required" ], "title": "Billing Address", "type": "string" }, "purchase_order_number": { "enum": [ "do not show", "optional", "required" ], "title": "Purchase Order Number", "type": "string" }, "reference_number": { "description": "The reference #", "title": "Reference Number", "type": "string" } }, "title": "Bill My Parent Organization Options", "type": "object" }, "business_unit_id": { "description": "The business unit of the store", "title": "Business Unit", "type": "string" }, "cancellation_fee_product_id": { "description": "The ID of the product used for cancellation fees", "title": "Cancellation Fee Product", "type": "string" }, "checkout_donation_options": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "simple_checkout_donation_options": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "allow_user_to_specify_custom_amount": { "description": "If set, the user can specify their own custom donation", "title": "Allow User To Specify Custom Amount", "type": "boolean" }, "donation_ask_text": { "description": "The text shown to the user when making the donation", "title": "Donation Ask Text", "type": "string" }, "donation_denominations": { "items": { "format": "double", "type": "number" }, "title": "Donation Denominations", "type": "array" }, "donation_information": { "description": "Additional information about the donation", "title": "Donation Information", "type": "string" }, "donation_product_id": { "description": "The misc product that should be used", "title": "Donation Product", "type": "string" }, "override_donation_denominations": { "description": "If set, donation denominations are specified here and the defaults are not used", "title": "Override Donation Denominations", "type": "boolean" }, "suggested_donation": { "description": "A suggested donation", "format": "double", "title": "Suggested Donation", "type": "number" } }, "required": [ "donation_product_id" ], "title": "Simple Checkout Donation Options", "type": "object" }, "type": { "enum": [ "simple" ], "title": "Type", "type": "string" } }, "title": "Checkout Donation Options", "type": "object" }, "credit_card_minimum_range_end": { "description": "If set, the maximum amount for which credit cards can be taken", "format": "float", "title": "Credit Card Minimum Range End", "type": "number" }, "credit_card_minimum_range_start": { "description": "If set, the minimum amount for which credit cards can be taken", "format": "float", "title": "Credit Card Minimum Range Start", "type": "number" }, "credit_card_mode": { "description": "Determines whether or not credit cards are accepted", "enum": [ "disabled", "enabled", "range" ], "title": "Credit Card Mode", "type": "string" }, "credit_card_processing_fee_mode": { "description": "Determines how credit card processing fees should be handled", "enum": [ "charge", "do not charge", "prompt user" ], "title": "Credit Card Processing Fee Mode", "type": "string" }, "credit_card_processing_fee_options": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "fee_percentage": { "description": "The fee percentage to charge for credit card processing ", "format": "float", "title": "Fee Percentage", "type": "number" }, "maximum_fee": { "description": "The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged", "format": "float", "title": "Maximum Fee", "type": "number" }, "minimum_fee": { "description": "The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged", "format": "float", "title": "Minimum Fee", "type": "number" }, "product_id": { "description": "The misc product to use for the credit card processing", "title": "Product", "type": "string" }, "prompt_sub_text": { "description": "Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used", "title": "Prompt Sub Text", "type": "string" }, "prompt_text": { "description": "The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used", "title": "Prompt Text", "type": "string" } }, "required": [ "fee_percentage", "product_id" ], "title": "Credit Card Processing Fee Options", "type": "object" }, "disable_electronic_payment_vaulting": { "description": "If set, in the portal people are not allowed to save credit cards", "title": "Disable Electronic Payment Vaulting", "type": "boolean" }, "enable_bill_my_organization": { "description": "If set, the user has the option to bill their organization", "title": "Enable Bill My Organization", "type": "boolean" }, "enable_bill_my_parent_organization": { "description": "If set, the user has the option to bill their organization's parent organization", "title": "Enable Bill My Parent Organization", "type": "boolean" }, "enable_donations_at_checkout": { "description": "If selected, users will be prompted to make a donation upon checking out", "title": "Enable Donations At Checkout", "type": "boolean" }, "enable_electronic_checks": { "description": "If set, electronic checks are allowed", "title": "Enable Electronic Checks", "type": "boolean" }, "enable_pay_later": { "description": "If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed", "title": "Enable Pay Later", "type": "boolean" }, "enable_payroll_deduction": { "description": "If set, payroll deduction is allowed", "title": "Enable Payroll Deduction", "type": "boolean" }, "enable_split_payments": { "description": "If set, users are allowed to split payments", "title": "Enable Split Payments", "type": "boolean" }, "installment_plan_options": { "items": { "additionalProperties": false, "properties": { "additional_cost": { "description": "The additional cost of the installment plan", "format": "double", "title": "Additional Cost", "type": "number" }, "installment_plan_id": { "description": "The installment plan that this product supports", "title": "Installment Plan", "type": "string" }, "is_default": { "description": "Whether this is the default installment plan option", "title": "Is Default", "type": "boolean" } }, "required": [ "installment_plan_id" ], "type": "object" }, "minItems": 1, "oneOf": [ { "x-required": true } ], "type": "array" }, "invoice_payment_terms_id": { "description": "The payment terms for invoices; if left blank, default is used", "title": "Invoice Payment Terms", "type": "string" }, "invoice_template_id": { "description": "The template to use for invoices created during this process", "title": "Invoice Template", "type": "string" }, "merchant_account_id": { "description": "The merchant account that the store should use to receive payments", "title": "Merchant Account", "type": "string" }, "pay_later_options": { "additionalProperties": false, "properties": { "billing_address": { "enum": [ "do not show", "optional", "required" ], "title": "Billing Address", "type": "string" }, "purchase_order_number": { "enum": [ "do not show", "optional", "required" ], "title": "Purchase Order Number", "type": "string" }, "reference_number": { "description": "The reference #", "title": "Reference Number", "type": "string" } }, "title": "Pay Later Options", "type": "object" }, "restocking_fee_product_id": { "description": "The ID of the product used for restocking fees", "title": "Restocking Fee Product", "type": "string" }, "special_instructions": { "description": "Instructions shown to the user", "title": "Special Instructions", "type": "string" }, "use_pro_forma_invoices": { "description": "Whether to use pro forma invoices when user elects to pay later", "title": "Use Pro Forma Invoices", "type": "boolean" } }, "required": [ "bank_account_id", "business_unit_id", "merchant_account_id" ], "title": "Checkout Settings", "type": "object" }, "confirmation_email": { "additionalProperties": false, "description": "The email to send when the application is received", "properties": { "bcc": { "description": "Anyone that should be bcc'ed on the email", "title": "Bcc", "type": "string" }, "body": { "description": "The email body", "title": "Body", "type": "string" }, "cc": { "description": "Anyone that should be cc'ed on the email", "title": "Cc", "type": "string" }, "from": { "description": "From email address", "title": "From", "type": "string" }, "from_name": { "description": "From name", "title": "From Name", "type": "string" }, "reply_to": { "description": "The reply to", "title": "Reply To", "type": "string" }, "subject": { "description": "The email subject", "title": "Subject", "type": "string" } }, "required": [ "body", "subject" ], "title": "Confirmation Email", "type": "object" }, "contact_form_options": { "additionalProperties": false, "properties": { "contact_form_id": { "description": "The default contact form to present to the user to verify the contact info before proceeding", "pattern": "^rolodex-contacts__.*", "title": "Contact Form", "type": "string" }, "html": { "description": "Text to show on the top of the form", "title": "Html", "type": "string" } }, "required": [ "contact_form_id" ], "title": "Contact Form Options", "type": "object" }, "custom_confirmation_page_html": { "description": "The custom confirmation page HTML", "title": "Custom Confirmation Page Html", "type": "string" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "deadline_for_cancelling_registrations": { "description": "Deadline for cancelling registrations; if not set, the registration close date is used", "format": "date-time", "title": "Deadline For Cancelling Registrations", "type": "string" }, "description": { "description": "Description of the process", "title": "Description", "type": "string" }, "display_order": { "description": "The order to display", "format": "float", "title": "Display Order", "type": "number" }, "edit_registration_options": { "additionalProperties": false, "properties": { "change_fee_id": { "description": "The change fee used when registrations are being edited", "title": "Change Fee", "type": "string" }, "deadline": { "description": "Deadline for editing registrations; if not set, the registration close date is used", "format": "date-time", "title": "Deadline", "type": "string" }, "edit_form_id": { "description": "The form to use for editing registrations, if different from the default", "pattern": "events-registrations__.*", "title": "Edit Form", "type": "string" } }, "required": [ "change_fee_id" ], "title": "Edit Registration Options", "type": "object" }, "enable_confirmation_email": { "description": "Whether or not an email should be sent when the application is received", "title": "Enable Confirmation Email", "type": "boolean" }, "enable_custom_confirmation_page_html": { "description": "enable custom text to show on the confirmation page", "title": "Enable Custom Confirmation Page Html", "type": "boolean" }, "enable_online_registration": { "description": "Whether or not this process is available in the portal", "title": "Enable Online Registration", "type": "boolean" }, "event_id": { "description": "The event", "title": "Event", "type": "string" }, "form_id": { "description": "The registration form", "pattern": "events-registrations__.*", "title": "Form", "type": "string" }, "group_registration_form_id": { "description": "The form to use for group registration", "pattern": "events-registrations__.*", "title": "Group Registration Form", "type": "string" }, "guest_registration_options": { "additionalProperties": false, "properties": { "do_not_save_guests_as_contacts": { "description": "If set, guests will not be saved as contacts and instead registrations will be linked to the parent", "title": "Do Not Save Guests As Contacts", "type": "boolean" }, "guest_registration_type_ids": { "items": { "type": "string" }, "title": "Guest Registration Types", "type": "array" }, "maximum_number_of_guests": { "description": "The maximum number of guests", "format": "float", "title": "Maximum Number Of Guests", "type": "number" }, "quick_add_contact_options": { "additionalProperties": false, "description": "UI options for how the add org contacts should function", "properties": {}, "title": "Quick Add Contact Options", "type": "object" } }, "required": [ "quick_add_contact_options" ], "title": "Guest Registration Options", "type": "object" }, "id": { "description": "The unique, string identifier of this registration process", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "is_active": { "description": "Whether or not this registration process is active", "title": "Is Active", "type": "boolean" }, "name": { "description": "The name of the registration process", "title": "Name", "type": "string" }, "online_registration_options": { "additionalProperties": false, "properties": { "close_date": { "description": "The date online registration closes", "format": "date-time", "title": "Close Date", "type": "string" }, "open_date": { "description": "The date online registration opens", "format": "date-time", "title": "Open Date", "type": "string" } }, "title": "Online Registration Options", "type": "object" }, "organization_form_options": { "additionalProperties": false, "properties": { "html": { "description": "Text to show on the top of the form", "title": "Html", "type": "string" }, "organization_form_id": { "description": "The default organization form to present to the user to verify the organization info before proceeding", "pattern": "^rolodex-organizations__.*", "title": "Organization Form", "type": "string" } }, "required": [ "organization_form_id" ], "title": "Organization Form Options", "type": "object" }, "override_checkout_settings": { "description": "Whether or not to override POC settings", "title": "Override Checkout Settings", "type": "boolean" }, "show_contact_form": { "description": "Whether or not to show a contact form", "title": "Show Contact Form", "type": "boolean" }, "show_organization_form": { "description": "Whether or not to show an organization form", "title": "Show Organization Form", "type": "boolean" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "checkout_settings", "confirmation_email", "contact_form_options", "custom_confirmation_page_html", "edit_registration_options", "event_id", "form_id", "id", "name", "online_registration_options", "organization_form_options", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "RegistrationSearchParameters": { "additionalProperties": false, "properties": { "city": { "description": "The member city", "title": "City", "type": "string" }, "contact_id": { "items": { "type": "string" }, "title": "Contact", "type": "array" }, "country": { "description": "The member country", "title": "Country", "type": "string" }, "date": { "items": { "format": "date-time", "type": "string" }, "maxItems": 2, "minItems": 2, "title": "Date", "type": "array" }, "deadline_id": { "items": { "type": "string" }, "title": "Deadline", "type": "array" }, "email_address": { "description": "The member's email address", "title": "Email Address", "type": "string" }, "event_id": { "title": "Event", "type": "string" }, "first_name": { "description": "The member's first name", "title": "First Name", "type": "string" }, "group_id": { "items": { "type": "string" }, "title": "Group", "type": "array" }, "ids": { "description": "IDs to search", "items": { "type": "string" }, "title": "Ids", "type": "array" }, "is_guest_registration": { "items": { "type": "boolean" }, "title": "Is Guest Registration", "type": "array" }, "job_title": { "description": "The member job title", "title": "Job Title", "type": "string" }, "last_name": { "description": "The member's last name", "title": "Last Name", "type": "string" }, "name": { "description": "The member's name", "title": "Name", "type": "string" }, "order_amount_paid": { "items": { "format": "float", "type": "number" }, "maxItems": 2, "minItems": 2, "title": "Order Amount Paid", "type": "array" }, "order_balance_due": { "items": { "format": "float", "type": "number" }, "maxItems": 2, "minItems": 2, "title": "Order Balance Due", "type": "array" }, "order_id": { "items": { "type": "string" }, "title": "Order", "type": "array" }, "order_number": { "items": { "format": "float", "type": "number" }, "title": "Order Number", "type": "array" }, "order_status": { "items": { "type": "string" }, "title": "Order Status", "type": "array" }, "order_total": { "items": { "format": "float", "type": "number" }, "maxItems": 2, "minItems": 2, "title": "Order Total", "type": "array" }, "organization_id": { "items": { "type": "string" }, "title": "Organization", "type": "array" }, "package_id": { "items": { "type": "string" }, "title": "Package", "type": "array" }, "parent_registration_id": { "items": { "type": "string" }, "title": "Parent Registration", "type": "array" }, "state": { "description": "The state", "title": "State", "type": "string" }, "status": { "items": { "type": "string" }, "title": "Status", "type": "array" }, "type_id": { "items": { "type": "string" }, "title": "Type", "type": "array" } }, "required": [ "event_id", "name" ], "type": "object" }, "RegistrationSearchResults": { "additionalProperties": false, "properties": { "bio": { "description": "The speaker bio", "title": "Bio", "type": "string" }, "city": { "description": "The member city", "title": "City", "type": "string" }, "contact_id": { "description": "The contact", "title": "Contact", "type": "string" }, "country": { "description": "The member country", "title": "Country", "type": "string" }, "display_order": { "description": "Display order", "title": "Display Order", "type": "string" }, "email_address": { "description": "The member's email address", "title": "Email Address", "type": "string" }, "event_id": { "description": "The event", "title": "Event", "type": "string" }, "featured": { "description": "Whether or not this is a featured speaker", "title": "Featured", "type": "boolean" }, "first_name": { "description": "The member's first name", "title": "First Name", "type": "string" }, "id": { "description": "The unique, string identifier of this speaker profile", "title": "ID", "type": "string" }, "job_title": { "description": "The member job title", "title": "Job Title", "type": "string" }, "last_name": { "description": "The member's last name", "title": "Last Name", "type": "string" }, "name": { "description": "The member's name", "title": "Name", "type": "string" }, "organization_id": { "description": "The organization id", "title": "Organization", "type": "string" }, "organization_name": { "description": "The organization name", "title": "Organization Name", "type": "string" }, "photo_uri": { "description": "The speaker photo", "title": "Photo Uri", "type": "string" }, "state": { "description": "The state", "title": "State", "type": "string" } }, "required": [ "contact_id", "event_id", "name" ], "type": "object" }, "RegistrationSetting": { "additionalProperties": false, "properties": { "allow_customer_to_choose_installment_plan": { "description": "If true, the customer can choose their installment plan", "title": "Allow Customer To Choose Installment Plan", "type": "boolean" }, "bank_account_id": { "description": "The default bank account that the store should use to receive payments", "title": "Bank Account", "type": "string" }, "bill_my_organization_options": { "additionalProperties": false, "properties": { "billing_address": { "enum": [ "do not show", "optional", "required" ], "title": "Billing Address", "type": "string" }, "purchase_order_number": { "enum": [ "do not show", "optional", "required" ], "title": "Purchase Order Number", "type": "string" }, "reference_number": { "description": "The reference #", "title": "Reference Number", "type": "string" } }, "title": "Bill My Organization Options", "type": "object" }, "bill_my_parent_organization_options": { "additionalProperties": false, "properties": { "billing_address": { "enum": [ "do not show", "optional", "required" ], "title": "Billing Address", "type": "string" }, "purchase_order_number": { "enum": [ "do not show", "optional", "required" ], "title": "Purchase Order Number", "type": "string" }, "reference_number": { "description": "The reference #", "title": "Reference Number", "type": "string" } }, "title": "Bill My Parent Organization Options", "type": "object" }, "business_unit_id": { "description": "The business unit of the store", "title": "Business Unit", "type": "string" }, "cancellation_deadline": { "format": "date-time", "title": "Cancellation Deadline", "type": "string" }, "cancellation_fee_product_id": { "description": "The ID of the product used for cancellation fees", "title": "Cancellation Fee Product", "type": "string" }, "cancellation_policy": { "enum": [ "none", "relative date", "specific date" ], "title": "Cancellation Policy", "type": "string" }, "cancellation_relative_date": { "additionalProperties": false, "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Cancellation Relative Date", "type": "object" }, "certificate_mode": { "enum": [ "automatically generate", "create manually", "disabled" ], "title": "Certificate Mode", "type": "string" }, "certificate_template": { "title": "Certificate Template", "type": "string" }, "certification_credit_options": { "additionalProperties": false, "properties": { "applicable_registration_type_ids": { "description": "The applicable registration types; leave blank for all non-guest registrations", "items": { "type": "string" }, "title": "Applicable Registration Types", "type": "array" }, "credits": { "items": { "additionalProperties": false, "properties": { "credit_type_id": { "description": "The type of credit", "title": "Credit Type", "type": "string" }, "quantity": { "description": "The number of credits to assign", "format": "float", "title": "Quantity", "type": "number" } }, "required": [ "credit_type_id", "quantity" ], "type": "object" }, "minItems": 1, "type": "array" }, "mark_as_verified": { "description": "If true, the credits should be marked as verified", "title": "Mark As Verified", "type": "boolean" }, "single_quantity_credits": { "description": "If set to true, the system will only generate credits with a quantity of 1; so specifying 4 will generate 4 credits with a quantity of 1 rather than 1 credit with qty 4 ", "title": "Single Quantity Credits", "type": "boolean" } }, "required": [ "credits" ], "title": "Certification Credit Options", "type": "object" }, "checkout_donation_options": { "additionalProperties": false, "properties": { "simple_checkout_donation_options": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "allow_user_to_specify_custom_amount": { "description": "If set, the user can specify their own custom donation", "title": "Allow User To Specify Custom Amount", "type": "boolean" }, "donation_ask_text": { "description": "The text shown to the user when making the donation", "title": "Donation Ask Text", "type": "string" }, "donation_denominations": { "items": { "format": "double", "type": "number" }, "title": "Donation Denominations", "type": "array" }, "donation_information": { "description": "Additional information about the donation", "title": "Donation Information", "type": "string" }, "donation_product_id": { "description": "The misc product that should be used", "title": "Donation Product", "type": "string" }, "override_donation_denominations": { "description": "If set, donation denominations are specified here and the defaults are not used", "title": "Override Donation Denominations", "type": "boolean" }, "suggested_donation": { "description": "A suggested donation", "format": "double", "title": "Suggested Donation", "type": "number" } }, "required": [ "donation_product_id" ], "title": "Simple Checkout Donation Options", "type": "object" }, "type": { "enum": [ "simple" ], "title": "Type", "type": "string" } }, "title": "Checkout Donation Options", "type": "object" }, "course_registration_settings": { "additionalProperties": false, "properties": { "course_reg_process_id": { "description": "The process for course registration", "title": "Course Reg Process", "type": "string" } }, "required": [ "course_reg_process_id" ], "title": "Course Registration Settings", "type": "object" }, "credit_card_minimum_range_end": { "description": "If set, the maximum amount for which credit cards can be taken", "format": "float", "title": "Credit Card Minimum Range End", "type": "number" }, "credit_card_minimum_range_start": { "description": "If set, the minimum amount for which credit cards can be taken", "format": "float", "title": "Credit Card Minimum Range Start", "type": "number" }, "credit_card_mode": { "description": "Determines whether or not credit cards are accepted", "enum": [ "disabled", "enabled", "range" ], "title": "Credit Card Mode", "type": "string" }, "credit_card_processing_fee_mode": { "description": "Determines how credit card processing fees should be handled", "enum": [ "charge", "do not charge", "prompt user" ], "title": "Credit Card Processing Fee Mode", "type": "string" }, "credit_card_processing_fee_options": { "additionalProperties": false, "properties": { "fee_percentage": { "description": "The fee percentage to charge for credit card processing ", "format": "float", "title": "Fee Percentage", "type": "number" }, "maximum_fee": { "description": "The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged", "format": "float", "title": "Maximum Fee", "type": "number" }, "minimum_fee": { "description": "The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged", "format": "float", "title": "Minimum Fee", "type": "number" }, "product_id": { "description": "The misc product to use for the credit card processing", "title": "Product", "type": "string" }, "prompt_sub_text": { "description": "Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used", "title": "Prompt Sub Text", "type": "string" }, "prompt_text": { "description": "The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used", "title": "Prompt Text", "type": "string" } }, "required": [ "fee_percentage", "product_id" ], "title": "Credit Card Processing Fee Options", "type": "object" }, "custom_order_preprocessing_options": { "additionalProperties": false, "properties": { "lambda_function_id": { "description": "The custom lambda function to use", "title": "Lambda Function", "type": "string" } }, "required": [ "lambda_function_id" ], "title": "Custom Order Preprocessing Options", "type": "object" }, "custom_order_pricing_options": { "additionalProperties": false, "properties": { "lambda_function_id": { "description": "The custom lambda function to use", "title": "Lambda Function", "type": "string" } }, "required": [ "lambda_function_id" ], "title": "Custom Order Pricing Options", "type": "object" }, "default_registration_process_id": { "description": "The default registration process, which can be used for registrations that have no process (such as imported registrations)", "title": "Default Registration Process", "type": "string" }, "disable_electronic_payment_vaulting": { "description": "If set, in the portal people are not allowed to save credit cards", "title": "Disable Electronic Payment Vaulting", "type": "boolean" }, "enable_bill_my_organization": { "description": "If set, the user has the option to bill their organization", "title": "Enable Bill My Organization", "type": "boolean" }, "enable_bill_my_parent_organization": { "description": "If set, the user has the option to bill their organization's parent organization", "title": "Enable Bill My Parent Organization", "type": "boolean" }, "enable_certification_credits": { "description": "If true, then this event will generate certification credits", "title": "Enable Certification Credits", "type": "boolean" }, "enable_course_registration": { "description": "If true, registrants can access certification", "title": "Enable Course Registration", "type": "boolean" }, "enable_custom_order_preprocessing": { "description": "If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion", "title": "Enable Custom Order Preprocessing", "type": "boolean" }, "enable_custom_order_pricing": { "description": "If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation", "title": "Enable Custom Order Pricing", "type": "boolean" }, "enable_donations_at_checkout": { "description": "If selected, users will be prompted to make a donation upon checking out", "title": "Enable Donations At Checkout", "type": "boolean" }, "enable_electronic_checks": { "description": "If set, electronic checks are allowed", "title": "Enable Electronic Checks", "type": "boolean" }, "enable_group_registration": { "description": "Whether or not group registration is enabled", "title": "Enable Group Registration", "type": "boolean" }, "enable_pay_later": { "description": "If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed", "title": "Enable Pay Later", "type": "boolean" }, "enable_payroll_deduction": { "description": "If set, payroll deduction is allowed", "title": "Enable Payroll Deduction", "type": "boolean" }, "enable_split_payments": { "description": "If set, users are allowed to split payments", "title": "Enable Split Payments", "type": "boolean" }, "enable_webinar_integration": { "description": "If selecting, registration will be linked to an external webinar service", "title": "Enable Webinar Integration", "type": "boolean" }, "group_registration_options": { "additionalProperties": false, "properties": { "allow_users_to_update_organization": { "description": "If true, users can update the organization details during the group registration process", "title": "Allow Users To Update Organization", "type": "boolean" }, "close_date": { "description": "When group registration should be closed. If not set, it will close when the event closes.", "format": "date-time", "title": "Close Date", "type": "string" }, "confirmation_email_recipient": { "enum": [ "both", "group administrator", "registrant" ], "title": "Confirmation Email Recipient", "type": "string" }, "contact_form_html": { "description": "Special instructions to show on the contact form", "title": "Contact Form Html", "type": "string" }, "contact_form_id": { "description": "The contact form to show to group administrators when they are registering individuals", "pattern": "^rolodex-contacts__.*", "title": "Contact Form", "type": "string" }, "contact_role_ids": { "description": "The contact roles that can perform group registration", "items": { "type": "string" }, "oneOf": [ { "x-required": true } ], "title": "Contact Roles", "type": "array" }, "enable_tiered_discounts": { "description": "If set, then the system will automatically discount registrants from the same organization/group based on rules you specify", "title": "Enable Tiered Discounts", "type": "boolean" }, "group_administrator_confirmation_email": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "bcc": { "description": "Anyone that should be bcc'ed on the email", "title": "Bcc", "type": "string" }, "body": { "description": "The email body", "title": "Body", "type": "string" }, "cc": { "description": "Anyone that should be cc'ed on the email", "title": "Cc", "type": "string" }, "from": { "description": "From email address", "title": "From", "type": "string" }, "from_name": { "description": "From name", "title": "From Name", "type": "string" }, "reply_to": { "description": "The reply to", "title": "Reply To", "type": "string" }, "subject": { "description": "The email subject", "title": "Subject", "type": "string" } }, "required": [ "body", "subject" ], "title": "Group Administrator Confirmation Email", "type": "object" }, "open_date": { "description": "When group registration should be open", "format": "date-time", "title": "Open Date", "type": "string" }, "organization_form_html": { "description": "Special instructions to show on the organization form", "title": "Organization Form Html", "type": "string" }, "organization_form_id": { "description": "The organization form to show to group administrators when they are registering an organization", "oneOf": [ { "x-required": true } ], "pattern": "^rolodex-organizations__.*", "title": "Organization Form", "type": "string" }, "restrict_to_specific_contact_roles": { "description": "If true, only certain contact roles can perform group registration", "title": "Restrict To Specific Contact Roles", "type": "boolean" }, "send_confirmation_email_to_group_administrator": { "description": "If true, an email is sent to the administrator of the group once registration is complete", "title": "Send Confirmation Email To Group Administrator", "type": "boolean" }, "tiered_discount_rules": { "items": { "additionalProperties": false, "properties": { "discount_amount": { "description": "The amount/percentage to discount", "format": "float", "title": "Discount Amount", "type": "number" }, "discount_type": { "enum": [ "amount", "percentage" ], "title": "Discount Type", "type": "string" }, "end_range": { "description": "The end range for this rule (one-based)", "format": "float", "minimum": 1, "title": "End Range", "type": "number" }, "start_range": { "description": "The starting range for this rule (one-based)", "format": "float", "minimum": 1, "title": "Start Range", "type": "number" } }, "required": [ "discount_amount", "discount_type", "end_range", "start_range" ], "type": "object" }, "minItems": 1, "oneOf": [ { "x-required": true } ], "type": "array" } }, "required": [ "contact_form_id" ], "title": "Group Registration Options", "type": "object" }, "id": { "description": "The unique, string identifier of this registration setting", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "installment_plan_options": { "items": { "additionalProperties": false, "properties": { "additional_cost": { "description": "The additional cost of the installment plan", "format": "double", "title": "Additional Cost", "type": "number" }, "installment_plan_id": { "description": "The installment plan that this product supports", "title": "Installment Plan", "type": "string" }, "is_default": { "description": "Whether this is the default installment plan option", "title": "Is Default", "type": "boolean" } }, "required": [ "installment_plan_id" ], "type": "object" }, "minItems": 1, "type": "array" }, "invoice_payment_terms_id": { "description": "The payment terms for invoices; if left blank, default is used", "title": "Invoice Payment Terms", "type": "string" }, "invoice_template_id": { "description": "The template to use for invoices created during this process", "title": "Invoice Template", "type": "string" }, "maximum_number_of_registrants_from_the_same_organization": { "format": "float", "minimum": 1, "title": "Maximum Number Of Registrants From The Same Organization", "type": "number" }, "membership_renewal_window": { "description": "When prompting for membership renewal during the event, the number of days during which if the member is expiring, they are prompted to renew", "format": "float", "title": "Membership Renewal Window", "type": "number" }, "merchant_account_id": { "description": "The merchant account that the store should use to receive payments", "title": "Merchant Account", "type": "string" }, "notes": { "description": "Notes about the settings", "title": "Notes", "type": "string" }, "pay_later_options": { "additionalProperties": false, "properties": { "billing_address": { "enum": [ "do not show", "optional", "required" ], "title": "Billing Address", "type": "string" }, "purchase_order_number": { "enum": [ "do not show", "optional", "required" ], "title": "Purchase Order Number", "type": "string" }, "reference_number": { "description": "The reference #", "title": "Reference Number", "type": "string" } }, "title": "Pay Later Options", "type": "object" }, "registration_deadlines": { "description": "The registration deadline dates", "items": { "additionalProperties": false, "properties": { "date": { "description": "The deadline date & time", "format": "date-time", "title": "Date", "type": "string" }, "deadline_id": { "description": "The deadline", "title": "Deadline", "type": "string" } }, "required": [ "deadline_id" ], "type": "object" }, "minItems": 1, "type": "array" }, "restocking_fee_product_id": { "description": "The ID of the product used for restocking fees", "title": "Restocking Fee Product", "type": "string" }, "restrict_registrants_from_same_organization": { "description": "If checked, then the system will restrict how many people from the same organization can register for this event", "title": "Restrict Registrants From Same Organization", "type": "boolean" }, "special_instructions": { "description": "Instructions shown to the user", "title": "Special Instructions", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" }, "use_pro_forma_invoices": { "description": "Whether to use pro forma invoices when user elects to pay later", "title": "Use Pro Forma Invoices", "type": "boolean" }, "use_registration_deadlines": { "description": "Whether or not registration should have deadlines", "title": "Use Registration Deadlines", "type": "boolean" }, "webinar_integration_options": { "additionalProperties": false, "properties": { "meeting_id": { "description": "The meeting id", "oneOf": [ { "x-required": true } ], "title": "Meeting", "type": "string" }, "type": { "description": "The video conference type ", "enum": [ "meeting", "webinar" ], "title": "Type", "type": "string" }, "webinar_account_id": { "description": "The account ID", "title": "Webinar Account", "type": "string" }, "webinar_id": { "description": "The webinar id", "oneOf": [ { "x-required": true } ], "title": "Webinar", "type": "string" }, "webinar_service": { "description": "The integration service", "enum": [ "integrations-zoom-accounts" ], "title": "Webinar Service", "type": "string" } }, "required": [ "webinar_account_id", "webinar_service" ], "title": "Webinar Integration Options", "type": "object" } }, "required": [ "bank_account_id", "business_unit_id", "cancellation_deadline", "cancellation_relative_date", "certificate_template", "certification_credit_options", "checkout_donation_options", "course_registration_settings", "credit_card_processing_fee_options", "custom_order_preprocessing_options", "custom_order_pricing_options", "group_registration_options", "id", "installment_plan_options", "maximum_number_of_registrants_from_the_same_organization", "merchant_account_id", "registration_deadlines", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id", "webinar_integration_options" ], "type": "object" }, "RegistrationSubstitution": { "additionalProperties": false, "properties": { "date": { "description": "The date of the substitution", "format": "date-time", "title": "Date", "type": "string" }, "event_id": { "description": "The applicable event", "title": "Event", "type": "string" }, "id": { "description": "The unique, string identifier of this registration substitution", "pattern": "^[\\w:|-]+$", "title": "ID", "type": "string" }, "new_contact_id": { "description": "The ID of the new contact that had the registration", "title": "New Contact", "type": "string" }, "notes": { "description": "Notes", "title": "Notes", "type": "string" }, "previous_contact_id": { "description": "The ID of the previous contact that had the registration", "title": "Previous Contact", "type": "string" }, "registration_id": { "description": "The registration that was substituted", "title": "Registration", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "date", "event_id", "id", "new_contact_id", "previous_contact_id", "registration_id", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "RegistrationType": { "additionalProperties": false, "properties": { "category_id": { "description": "The global registration category to which this type belongs", "title": "Category", "type": "string" }, "coupon_code_options": { "additionalProperties": false, "properties": { "automatically_add_coupon_to_order": { "description": "If true, when the customer puts in the coupon code, its also added to the order", "title": "Automatically Add Coupon To Order", "type": "boolean" }, "coupon_ids": { "description": "The IDs of the event coupons that must be presented", "items": { "type": "string" }, "title": "Coupons", "type": "array" }, "prompt_text": { "description": "Text to show to the user", "title": "Prompt Text", "type": "string" } }, "title": "Coupon Code Options", "type": "object" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "description": { "description": "Portal-viewable description of this type", "title": "Description", "type": "string" }, "display_order": { "description": "The display order", "format": "float", "title": "Display Order", "type": "number" }, "enable_restrictions": { "description": "If set, only certain people can register with this type", "title": "Enable Restrictions", "type": "boolean" }, "event_id": { "description": "The event", "title": "Event", "type": "string" }, "exhibitor_options": { "additionalProperties": false, "properties": { "contact_type_ids": { "description": "If set, these are the contact ids that are allowed to receive this package ", "items": { "type": "string" }, "title": "Contact Types", "type": "array" } }, "title": "Exhibitor Options", "type": "object" }, "id": { "description": "The unique, string identifier of this registration type", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "is_active": { "description": "Whether or not this registration type is active", "title": "Is Active", "type": "boolean" }, "name": { "description": "The name of the registration type", "title": "Name", "type": "string" }, "process_id": { "description": "The registration process for this type", "title": "Process", "type": "string" }, "requires_coupon_code": { "description": "If set, then a valid coupon code for one of the specified coupons must be provided before someone can register as this type", "title": "Requires Coupon Code", "type": "boolean" }, "restrict_to_exhibitors": { "description": "If true, only contacts tied to exhibiting organizations are allowed to get this package", "title": "Restrict To Exhibitors", "type": "boolean" }, "restrict_to_guests": { "description": "Whether this is a guest registration type", "title": "Restrict To Guests", "type": "boolean" }, "restrict_to_speakers": { "description": "Whether this is a speaker registration type", "title": "Restrict To Speakers", "type": "boolean" }, "restrictions": { "additionalProperties": false, "properties": { "criteria": { "additionalProperties": false, "description": "The criteria to use", "properties": { "advanced_rule_error_message": { "description": "The error message to show when the advanced rule fails", "title": "Advanced Rule Error Message", "type": "string" }, "advanced_rules": { "title": "Advanced Rules", "type": "object" }, "age_restrictions": { "additionalProperties": false, "properties": { "maximum_age": { "description": "The maximum age of the contact", "format": "float", "title": "Maximum Age", "type": "number" }, "minimum_age": { "description": "The minimum age of the contact", "format": "float", "title": "Minimum Age", "type": "number" } }, "title": "Age Restrictions", "type": "object" }, "award_options": { "additionalProperties": false, "properties": { "award_ids": { "items": { "type": "string" }, "title": "Awards", "type": "array" }, "award_type_ids": { "items": { "type": "string" }, "title": "Award Types", "type": "array" }, "logic_operator": { "enum": [ "and", "not" ], "title": "Logic Operator", "type": "string" } }, "title": "Award Options", "type": "object" }, "award_recipients": { "description": "If set, only people who have received awards", "title": "Award Recipients", "type": "boolean" }, "by_location": { "description": "If true, then filter by location", "title": "By Location", "type": "boolean" }, "certificants": { "description": "If set, only people with specific certifications", "title": "Certificants", "type": "boolean" }, "certification_options": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "logic_operator": { "enum": [ "and", "not" ], "title": "Logic Operator", "type": "string" }, "program_ids": { "items": { "type": "string" }, "title": "Programs", "type": "array" } }, "title": "Certification Options", "type": "object" }, "committee_member_options": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "committee_ids": { "items": { "type": "string" }, "title": "Committees", "type": "array" }, "committee_position_ids": { "items": { "type": "string" }, "title": "Committee Positions", "type": "array" }, "committee_type_ids": { "items": { "type": "string" }, "title": "Committee Types", "type": "array" }, "logic_operator": { "enum": [ "and", "not" ], "title": "Logic Operator", "type": "string" } }, "title": "Committee Member Options", "type": "object" }, "committee_members": { "description": "If set, active members who belong to a committee can purchase", "title": "Committee Members", "type": "boolean" }, "custom_logic_options": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "lambda_function_id": { "description": "The custom lambda function to use", "title": "Lambda Function", "type": "string" } }, "required": [ "lambda_function_id" ], "title": "Custom Logic Options", "type": "object" }, "customer_type": { "enum": [ "contact", "organization" ], "title": "Customer Type", "type": "string" }, "donor_options": { "additionalProperties": false, "properties": { "donor_club_ids": { "items": { "type": "string" }, "title": "Donor Clubs", "type": "array" }, "logic_operator": { "enum": [ "and", "not" ], "title": "Logic Operator", "type": "string" } }, "title": "Donor Options", "type": "object" }, "donors": { "description": "If true, only donors", "title": "Donors", "type": "boolean" }, "enable_advanced_rules": { "description": "Enable advanced JSON rules", "title": "Enable Advanced Rules", "type": "boolean" }, "enable_age_restrictions": { "description": "Age registrations", "title": "Enable Age Restrictions", "type": "boolean" }, "enable_custom_logic": { "description": "If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion", "title": "Enable Custom Logic", "type": "boolean" }, "enable_entitlement_restrictions": { "description": "If set, then you must have certain entitlements", "title": "Enable Entitlement Restrictions", "type": "boolean" }, "enable_expression": { "description": "Whether or not to enable an expression for evaluation", "title": "Enable Expression", "type": "boolean" }, "enable_organization_restrictions": { "description": "If set, you can restrict organizations", "title": "Enable Organization Restrictions", "type": "boolean" }, "enable_status_restriction": { "description": "If set, you can restrict by status", "title": "Enable Status Restriction", "type": "boolean" }, "entitlement_restrictions": { "items": { "additionalProperties": false, "properties": { "quantity": { "description": "The quantity you must have", "format": "float", "title": "Quantity", "type": "number" }, "type_id": { "description": "The type of entitlement", "title": "Type", "type": "string" } }, "required": [ "type_id" ], "type": "object" }, "type": "array" }, "event_registration_options": { "additionalProperties": false, "properties": { "event_ids": { "items": { "type": "string" }, "title": "Events", "type": "array" }, "logic_operator": { "enum": [ "and", "not" ], "title": "Logic Operator", "type": "string" }, "registration_category_ids": { "items": { "type": "string" }, "title": "Registration Categories", "type": "array" } }, "title": "Event Registration Options", "type": "object" }, "event_registrations": { "description": "If set, only people who have registered for events", "title": "Event Registrations", "type": "boolean" }, "expression": { "description": "The expression", "title": "Expression", "type": "string" }, "expression_error_message": { "description": "The error message to show when the expression fails", "title": "Expression Error Message", "type": "string" }, "location": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "countries": { "description": "Countries", "items": { "type": "string" }, "title": "Countries", "type": "array" }, "negate_logic": { "description": "If true, the logic in this section is negated; so NOT from these places", "title": "Negate Logic", "type": "boolean" } }, "title": "Location", "type": "object" }, "logic_operator": { "enum": [ "and", "not" ], "title": "Logic Operator", "type": "string" }, "member_options": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "chapter_member_options": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "chapter_ids": { "items": { "type": "string" }, "title": "Chapters", "type": "array" }, "chapter_type_ids": { "items": { "type": "string" }, "title": "Chapter Types", "type": "array" }, "logic_operator": { "enum": [ "and", "not" ], "title": "Logic Operator", "type": "string" } }, "title": "Chapter Member Options", "type": "object" }, "chapter_members": { "description": "If set, active members who belong to a chapter can purchase", "title": "Chapter Members", "type": "boolean" }, "member_package_ids": { "description": "The member package", "items": { "type": "string" }, "title": "Member Packages", "type": "array" }, "member_status_reason_ids": { "items": { "type": "string" }, "title": "Member Status Reasons", "type": "array" }, "member_statuses": { "items": { "enum": [ "active", "inactive", "suspended" ], "type": "string" }, "title": "Member Statuses", "type": "array" }, "member_type_ids": { "description": "The member types", "items": { "type": "string" }, "title": "Member Types", "type": "array" }, "section_member_options": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "logic_operator": { "enum": [ "and", "not" ], "title": "Logic Operator", "type": "string" }, "section_ids": { "items": { "type": "string" }, "title": "Sections", "type": "array" }, "section_type_ids": { "items": { "type": "string" }, "title": "Section Types", "type": "array" } }, "title": "Section Member Options", "type": "object" }, "section_members": { "description": "If set, active members who belong to a section can purchase", "title": "Section Members", "type": "boolean" } }, "title": "Member Options", "type": "object" }, "members": { "description": "If set, active members can purchase this", "title": "Members", "type": "boolean" }, "non_members": { "description": "If set, only nonmembers can purchase", "title": "Non Members", "type": "boolean" }, "organization_restrictions": { "additionalProperties": false, "properties": { "contact_role_ids": { "items": { "type": "string" }, "title": "Contact Roles", "type": "array" }, "organization_type_ids": { "items": { "type": "string" }, "title": "Organization Types", "type": "array" } }, "title": "Organization Restrictions", "type": "object" }, "status_restrictions": { "description": "The statuses", "items": { "type": "string" }, "minItems": 1, "oneOf": [ { "x-required": true } ], "title": "Status Restrictions", "type": "array" }, "use_organization_for_eligibility": { "description": "If checked, a person's organization is used to check for eligibility, rather than the person themselves", "title": "Use Organization For Eligibility", "type": "boolean" } }, "title": "Criteria", "type": "object" } }, "required": [ "criteria" ], "title": "Restrictions", "type": "object" }, "selectable_in_portal": { "description": "Whether this type can be chosen in the portal", "title": "Selectable In Portal", "type": "boolean" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" }, "type": { "enum": [ "exhibitor", "general attendee", "guest", "invite only", "speaker" ], "title": "Type", "type": "string" } }, "required": [ "coupon_code_options", "event_id", "id", "name", "restrictions", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "RibbonType": { "additionalProperties": false, "properties": { "id": { "description": "The unique, string identifier of this ribbon type", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "is_active": { "description": "Whether or not this ribbon type is active", "title": "Is Active", "type": "boolean" }, "name": { "description": "The name of the ribbon type", "title": "Name", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "id", "name", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "Room": { "additionalProperties": false, "properties": { "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "description": { "description": "A description of the room", "title": "Description", "type": "string" }, "event_id": { "description": "The ID of the room", "title": "Event", "type": "string" }, "id": { "description": "The unique, string identifier of this abstract", "pattern": "^[\\w-_:]+$", "title": "ID", "type": "string" }, "name": { "description": "The name of the room", "title": "Name", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "event_id", "id", "name", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "SchedulingConflictResponse": { "additionalProperties": false, "properties": { "schedulingConflicts": { "items": { "additionalProperties": false, "properties": { "events": { "items": { "additionalProperties": false, "properties": { "end_date": { "title": "End Date", "type": "string" }, "id": { "title": "ID", "type": "string" }, "name": { "title": "Name", "type": "string" }, "start_date": { "title": "Start Date", "type": "string" }, "type": { "enum": [ "course", "function", "session" ], "title": "Type", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "SelfCancellationDescription": { "additionalProperties": false, "properties": { "currency_code": { "title": "Currency Code", "type": "string" }, "items": { "items": { "additionalProperties": false, "properties": { "amount_to_refund": { "format": "float", "title": "Amount To Refund", "type": "number" }, "cancellation_fee": { "format": "float", "title": "Cancellation Fee", "type": "number" }, "currency_code": { "title": "Currency Code", "type": "string" }, "order_line_item_id": { "title": "Order Line Item", "type": "string" }, "product_name": { "title": "Product Name", "type": "string" } }, "type": "object" }, "type": "array" }, "total_amount_to_refund": { "format": "float", "title": "Total Amount To Refund", "type": "number" } }, "type": "object" }, "SendAssignmentEmailRequest": { "additionalProperties": false, "properties": { "review": { "title": "Review", "type": "string" }, "template": { "additionalProperties": false, "properties": { "bcc": { "description": "Anyone that should be bcc'ed on the email", "title": "Bcc", "type": "string" }, "body": { "description": "The email body", "title": "Body", "type": "string" }, "cc": { "description": "Anyone that should be cc'ed on the email", "title": "Cc", "type": "string" }, "from": { "description": "From email address", "title": "From", "type": "string" }, "from_name": { "description": "From name", "title": "From Name", "type": "string" }, "reply_to": { "description": "The reply to", "title": "Reply To", "type": "string" }, "subject": { "description": "The email subject", "title": "Subject", "type": "string" } }, "required": [ "body", "subject" ], "title": "Template", "type": "object" } }, "required": [ "review" ], "type": "object" }, "Session": { "additionalProperties": false, "properties": { "abstract_id": { "description": "The abstract this session is linked to", "title": "Abstract", "type": "string" }, "access": { "description": "Who has access to this session", "enum": [ "included", "optional" ], "title": "Access", "type": "string" }, "capacity_options": { "additionalProperties": false, "properties": { "capacity": { "format": "float", "minimum": 0, "title": "Capacity", "type": "number" }, "enable_wait_list": { "description": "If set, people can be placed on a wait list", "title": "Enable Wait List", "type": "boolean" }, "waitlist_process_id": { "description": "The process to use for managing the waitlist", "oneOf": [ { "x-required": true } ], "title": "Waitlist Process", "type": "string" } }, "required": [ "capacity" ], "title": "Capacity Options", "type": "object" }, "code": { "description": "Optional code for the event", "title": "Code", "type": "string" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "description": { "description": "A description of the session", "title": "Description", "type": "string" }, "disable_portal_registration": { "description": "If set, portal registration for this session is disabled", "title": "Disable Portal Registration", "type": "boolean" }, "display_order": { "description": "The display/sort order for the sessions", "format": "float", "title": "Display Order", "type": "number" }, "enable_capacity": { "description": "If set, the session has a capacity", "title": "Enable Capacity", "type": "boolean" }, "enable_registration_questions": { "description": "If set, a user is prompted to answer questions during registration", "title": "Enable Registration Questions", "type": "boolean" }, "end_date": { "description": "The end date/time of the session", "format": "date-time", "title": "End Date", "type": "string" }, "event_id": { "description": "The event", "title": "Event", "type": "string" }, "has_fees": { "description": "Whether or not this session has fees", "title": "Has Fees", "type": "boolean" }, "hide_from_portal": { "description": "This session is not displayed in the portal or available for registration", "title": "Hide From Portal", "type": "boolean" }, "hide_from_schedule": { "description": "If selected, hide this session from the online schedule", "title": "Hide From Schedule", "type": "boolean" }, "id": { "description": "The unique, string identifier of this session", "pattern": "^[\\w|\\-:]+$", "title": "ID", "type": "string" }, "location": { "title": "Location", "type": "string" }, "main_presenter_speaker_type_id": { "description": "The type to be assigned to the main presenter for sessions generated from abstracts", "title": "Main Presenter Speaker Type", "type": "string" }, "name": { "description": "The name of the session", "title": "Name", "type": "string" }, "registration_question_options": { "additionalProperties": false, "properties": { "custom_fields": { "description": "The custom fields to display", "items": { "additionalProperties": false, "properties": { "id": { "description": "The custom field", "title": "ID", "type": "string" }, "label": { "description": "An optional label", "title": "Label", "type": "string" }, "required": { "description": "Whether the field is required", "title": "Required", "type": "boolean" } }, "required": [ "id" ], "type": "object" }, "type": "array" }, "registration_instructions": { "description": "Instructions to show during registration for the session", "title": "Registration Instructions", "type": "string" } }, "title": "Registration Question Options", "type": "object" }, "room_ids": { "description": "The room which is holding the event", "items": { "type": "string" }, "title": "Rooms", "type": "array" }, "sold_out": { "description": "Whether the event is sold out", "title": "Sold Out", "type": "boolean" }, "speakers": { "items": { "additionalProperties": false, "properties": { "speaker_id": { "title": "Speaker", "type": "string" }, "speaker_type_id": { "description": "The type of speaker", "title": "Speaker Type", "type": "string" } }, "required": [ "speaker_id", "speaker_type_id" ], "type": "object" }, "type": "array" }, "start_date": { "description": "The start date/time of the session", "format": "date-time", "title": "Start Date", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" }, "track_ids": { "description": "Session tracks", "items": { "type": "string" }, "title": "Tracks", "type": "array" }, "type_id": { "description": "The type of session", "title": "Type", "type": "string" } }, "required": [ "capacity_options", "event_id", "id", "name", "registration_question_options", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id", "type_id" ], "type": "object" }, "SessionFee": { "additionalProperties": false, "properties": { "abbreviated_name": { "description": "The abbreviated name when viewing the product inside of an event", "title": "Abbreviated Name", "type": "string" }, "allow_customer_to_choose_installment_plan": { "description": "If true, the customer can choose their installment plan", "title": "Allow Customer To Choose Installment Plan", "type": "boolean" }, "bulk_pricing_rules": { "items": { "additionalProperties": false, "properties": { "discount_amount": { "description": "The percentage/flat rate", "format": "float", "minimum": 0, "title": "Discount Amount", "type": "number" }, "discount_type": { "description": "The type of discount rule", "enum": [ "flat rate", "percentage" ], "title": "Discount Type", "type": "string" }, "ending_range": { "description": "The ending range of the rule", "minimum": 0, "title": "Ending Range", "type": "integer" }, "starting_range": { "description": "The starting range of the rule", "minimum": 0, "title": "Starting Range", "type": "integer" } }, "required": [ "discount_amount", "discount_type" ], "type": "object" }, "minItems": 1, "type": "array" }, "bundled_products": { "items": { "additionalProperties": false, "properties": { "member_price": { "description": "The member price", "format": "double", "title": "Member Price", "type": "number" }, "price": { "description": "The price to bundle", "format": "double", "title": "Price", "type": "number" }, "product_id": { "description": "The product ID", "title": "Product", "type": "string" }, "product_type": { "description": "The product type", "title": "Product Type", "type": "string" }, "quantity": { "description": "The quantity to bundle", "title": "Quantity", "type": "integer" }, "type": { "enum": [ "bundled product", "inline bundled product" ], "title": "Type", "type": "string" } }, "required": [ "product_id", "product_type", "quantity", "type" ], "type": "object" }, "minItems": 1, "type": "array" }, "bundled_products_inventory_handling": { "description": "Whether to track inventory for the entire bundle, or for each product separately", "enum": [ "bundle", "each product" ], "title": "Bundled Products Inventory Handling", "type": "string" }, "business_unit_id": { "description": "The business unit of the product", "title": "Business Unit", "type": "string" }, "cancellation_fee": { "description": "Cancellation fees associated with this product", "format": "double", "title": "Cancellation Fee", "type": "number" }, "commerce_entitlements_to_create": { "items": { "additionalProperties": false, "properties": { "expiration_date": { "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Expiration Date", "type": "string" }, "expiration_type": { "enum": [ "none", "relative date", "specific date" ], "title": "Expiration Type", "type": "string" }, "quantity": { "description": "The quantity", "format": "float", "title": "Quantity", "type": "number" }, "relative_expiration_date": { "additionalProperties": false, "description": "The date the task is due", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Expiration Date", "type": "object" }, "type_id": { "description": "The type of entitlement", "title": "Type", "type": "string" } }, "required": [ "expiration_type", "type_id" ], "type": "object" }, "type": "array" }, "coupon_codes": { "items": { "additionalProperties": false, "properties": { "coupon_code_generation_process_id": { "description": "The process by which the coupons are generated", "title": "Coupon Code Generation Process", "type": "string" }, "coupon_code_type": { "enum": [ "multi use", "single use" ], "title": "Coupon Code Type", "type": "string" }, "coupon_id": { "title": "Coupon", "type": "string" }, "coupon_type": { "title": "Coupon Type", "type": "string" }, "expiration_date": { "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Expiration Date", "type": "string" }, "expiration_type": { "enum": [ "none", "relative date", "specific date" ], "title": "Expiration Type", "type": "string" }, "maximum_number_of_total_uses": { "description": "The maximum number of total uses", "minimum": 1, "oneOf": [ { "enum": [ 1 ], "x-required": true } ], "title": "Maximum Number Of Total Uses", "type": "integer" }, "maximum_number_of_uses_per_customer": { "description": "The maximum number of total uses for a given customer", "minimum": 1, "oneOf": [ { "enum": [ 1 ], "x-required": true } ], "title": "Maximum Number Of Uses Per Customer", "type": "integer" }, "quantity": { "description": "The number of coupons to generate", "maximum": 250, "title": "Quantity", "type": "integer" }, "relative_expiration_date": { "additionalProperties": false, "description": "Expiration date relative to purchase", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Expiration Date", "type": "object" }, "restrict_to_contact": { "description": "If true, the code generated is restricted to the contact who made the purchase", "title": "Restrict To Contact", "type": "boolean" }, "restrict_to_organization": { "description": "If true, the code generated is restricted to the organization made the purchase", "title": "Restrict To Organization", "type": "boolean" } }, "required": [ "coupon_code_generation_process_id", "coupon_code_type", "coupon_id", "coupon_type", "quantity" ], "type": "object" }, "minItems": 1, "type": "array" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "custom_pricing_options": { "additionalProperties": false, "properties": { "lambda_function_id": { "description": "The custom lambda function to use", "title": "Lambda Function", "type": "string" } }, "required": [ "lambda_function_id" ], "title": "Custom Pricing Options", "type": "object" }, "deadline_based_pricing": { "items": { "additionalProperties": false, "properties": { "deadline_id": { "description": "The deadline", "title": "Deadline", "type": "string" }, "member_price": { "description": "The member price at this deadline", "format": "double", "title": "Member Price", "type": "number" }, "price": { "description": "The price at this deadline", "format": "double", "title": "Price", "type": "number" } }, "required": [ "deadline_id" ], "type": "object" }, "type": "array" }, "document_entitlements_to_create": { "items": { "additionalProperties": false, "properties": { "expiration_date": { "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Expiration Date", "type": "string" }, "expiration_type": { "enum": [ "none", "relative date", "specific date" ], "title": "Expiration Type", "type": "string" }, "file_cabinet_id": { "description": "The file cabinet", "title": "File Cabinet", "type": "string" }, "item_id": { "description": "The item", "title": "Item", "type": "string" }, "library_path": { "description": "The optional path that items will be mounted onto the digital library", "title": "Library Path", "type": "string" }, "relative_expiration_date": { "additionalProperties": false, "description": "The date the task is due", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Expiration Date", "type": "object" } }, "required": [ "expiration_type", "file_cabinet_id" ], "type": "object" }, "type": "array" }, "enable_bulk_pricing": { "description": "Whether or not bulk pricing is enabled", "title": "Enable Bulk Pricing", "type": "boolean" }, "enable_bundled_products": { "description": "Whether to enable bundled products", "title": "Enable Bundled Products", "type": "boolean" }, "enable_cancellation_fees": { "description": "Whether or not cancellation fees are applicable", "title": "Enable Cancellation Fees", "type": "boolean" }, "enable_commerce_entitlement_creation": { "description": "If set, document entitlements will be created to access folders or documents", "title": "Enable Commerce Entitlement Creation", "type": "boolean" }, "enable_coupon_code_generation": { "description": "If true, purchasing this product will generate coupons", "title": "Enable Coupon Code Generation", "type": "boolean" }, "enable_custom_pricing": { "description": "If set, the order engine will call out to a custom lambda function for custom/complex pricing", "title": "Enable Custom Pricing", "type": "boolean" }, "enable_document_entitlement_creation": { "description": "If set, document entitlements will be created to access folders or documents", "title": "Enable Document Entitlement Creation", "type": "boolean" }, "enable_product_confirmation_email": { "description": "If enabled, a custom email goes out whenever this product is ordered", "title": "Enable Product Confirmation Email", "type": "boolean" }, "enable_purchase_limits": { "description": "If true, purchase limits are in place for this product", "title": "Enable Purchase Limits", "type": "boolean" }, "enable_purchasing_eligibility": { "description": "If set, purchases of this merchandise are restricted", "title": "Enable Purchasing Eligibility", "type": "boolean" }, "enable_special_prices": { "description": "Whether to enable special pricing logic", "title": "Enable Special Prices", "type": "boolean" }, "enable_task_generation": { "description": "If set, tasks will be generated", "title": "Enable Task Generation", "type": "boolean" }, "event_id": { "description": "The event", "title": "Event", "type": "string" }, "foreign_currency_prices": { "items": { "additionalProperties": false, "properties": { "cancellation_fee": { "description": "The cancellation fee of the product for this currency", "format": "double", "title": "Cancellation Fee", "type": "number" }, "currency_code": { "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "title": "Currency Code", "type": "string" }, "member_price": { "description": "The price of the product for a member", "format": "double", "title": "Member Price", "type": "number" }, "mode": { "description": "How this foreign currency should be treated", "enum": [ "calculate price", "prohibit purchase", "set price" ], "title": "Mode", "type": "string" }, "price": { "description": "The price of the product", "format": "double", "oneOf": [ { "x-required": true } ], "title": "Price", "type": "number" }, "restocking_fee": { "description": "The restocking fee of the product for this currency", "format": "double", "title": "Restocking Fee", "type": "number" } }, "required": [ "currency_code" ], "type": "object" }, "type": "array" }, "hide_from_portal": { "description": "If set, this product should not be shown in the portal", "title": "Hide From Portal", "type": "boolean" }, "id": { "description": "The unique, string identifier of this miscellaneous product", "pattern": "^[\\w:|-]+$", "title": "ID", "type": "string" }, "installment_plan_options": { "items": { "additionalProperties": false, "properties": { "additional_cost": { "description": "The additional cost of the installment plan", "format": "double", "title": "Additional Cost", "type": "number" }, "installment_plan_id": { "description": "The installment plan that this product supports", "title": "Installment Plan", "type": "string" }, "is_default": { "description": "Whether this is the default installment plan option", "title": "Is Default", "type": "boolean" } }, "required": [ "installment_plan_id" ], "type": "object" }, "minItems": 1, "type": "array" }, "is_active": { "description": "Whether this product is active/used", "title": "Is Active", "type": "boolean" }, "member_price": { "description": "The price of the product for an active member", "format": "double", "title": "Member Price", "type": "number" }, "name": { "description": "The name of the miscellaneous product", "title": "Name", "type": "string" }, "notes": { "description": "Notes", "title": "Notes", "type": "string" }, "portal_options": { "additionalProperties": false, "properties": { "available_from": { "description": "The date from which this product should be available", "format": "date-time", "title": "Available From", "type": "string" }, "available_until": { "description": "The date until which this product should be available", "format": "date-time", "title": "Available Until", "type": "string" } }, "title": "Portal Options", "type": "object" }, "price": { "description": "The price of the product", "format": "double", "title": "Price", "type": "number" }, "product_confirmation_email_options": { "additionalProperties": false, "properties": { "product_confirmation_email_id": { "oneOf": [ { "x-required": true } ], "title": "Product Confirmation Email", "type": "string" }, "product_specific_email": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "bcc": { "description": "Anyone that should be bcc'ed on the email", "title": "Bcc", "type": "string" }, "body": { "description": "The email body", "title": "Body", "type": "string" }, "cc": { "description": "Anyone that should be cc'ed on the email", "title": "Cc", "type": "string" }, "from": { "description": "From email address", "title": "From", "type": "string" }, "from_name": { "description": "From name", "title": "From Name", "type": "string" }, "reply_to": { "description": "The reply to", "title": "Reply To", "type": "string" }, "subject": { "description": "The email subject", "title": "Subject", "type": "string" } }, "required": [ "body", "subject" ], "title": "Product Specific Email", "type": "object" }, "type": { "enum": [ "product specific", "shared" ], "title": "Type", "type": "string" } }, "title": "Product Confirmation Email Options", "type": "object" }, "publish_to_portal": { "description": "Whether or not this product should be available in the portal", "title": "Publish To Portal", "type": "boolean" }, "purchase_limits": { "additionalProperties": false, "properties": { "error_message": { "description": "The error message to show", "title": "Error Message", "type": "string" }, "maximum": { "description": "The maximum", "format": "float", "title": "Maximum", "type": "number" }, "relative_time_window": { "additionalProperties": false, "description": "the time window", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Time Window", "type": "object" }, "time_period": { "enum": [ "all time", "sliding time window" ], "title": "Time Period", "type": "string" }, "type": { "enum": [ "per customer" ], "title": "Type", "type": "string" } }, "required": [ "maximum", "time_period", "type" ], "title": "Purchase Limits", "type": "object" }, "purchasing_eligibility_criteria": { "title": "Purchasing Eligibility Criteria", "type": "object" }, "registration_package_id": { "description": "The package", "title": "Registration Package", "type": "string" }, "session_id": { "description": "The session id", "title": "Session", "type": "string" }, "special_prices": { "items": { "additionalProperties": false, "properties": { "criteria": { "title": "Criteria", "type": "object" }, "enable_formula": { "description": "if set, a formula is used to calculate the price. If the formula fails, the price is used", "title": "Enable Formula", "type": "boolean" }, "formula": { "description": "The formula evaluated using the expr-eval npm package", "oneOf": [ { "x-required": true } ], "title": "Formula", "type": "string" }, "name": { "title": "Name", "type": "string" }, "price": { "format": "float", "title": "Price", "type": "number" } }, "required": [ "criteria", "price" ], "type": "object" }, "minItems": 1, "type": "array" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" }, "tasks_to_generate": { "items": { "additionalProperties": false, "properties": { "assignee_type": { "enum": [ "assignment role", "queue", "user" ], "title": "Assignee Type", "type": "string" }, "assignment_role_id": { "description": "The assignment role that should receive the ask", "oneOf": [ { "x-required": true } ], "title": "Assignment Role", "type": "string" }, "description": { "description": "A description", "title": "Description", "type": "string" }, "due_date_type": { "description": "Whether there is a due date", "enum": [ "none", "relative date", "specific date" ], "title": "Due Date Type", "type": "string" }, "name": { "description": "The name of the task", "title": "Name", "type": "string" }, "notify_assignees": { "description": "Notify assignee when the task is created", "title": "Notify Assignees", "type": "boolean" }, "priority": { "enum": [ "high", "low", "normal", "urgent" ], "title": "Priority", "type": "string" }, "queue_id": { "description": "The queue that should be assigned the ask", "oneOf": [ { "x-required": true } ], "title": "Queue", "type": "string" }, "relative_due_date": { "additionalProperties": false, "description": "The date the task is due", "oneOf": [ { "x-required": true } ], "properties": { "number": { "description": "The unit of time", "format": "float", "minimum": 0, "oneOf": [ {} ], "title": "Number", "type": "number" }, "position": { "description": "How the unit relates to the reference date", "enum": [ "after", "before", "on" ], "title": "Position", "type": "string" }, "relative_to": { "enum": [ "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date" ], "title": "Relative To", "type": "string" }, "unit_of_time": { "enum": [ "days", "months", "weeks", "years" ], "oneOf": [ {} ], "title": "Unit Of Time", "type": "string" } }, "required": [ "number", "position", "relative_to", "unit_of_time" ], "title": "Relative Due Date", "type": "object" }, "specific_due_date": { "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Specific Due Date", "type": "string" }, "type_id": { "description": "The type of task", "title": "Type", "type": "string" }, "user_id": { "description": "The user that should be assigned the ask", "oneOf": [ { "x-required": true } ], "title": "User", "type": "string" } }, "required": [ "assignee_type", "due_date_type", "name", "type_id" ], "type": "object" }, "type": "array" }, "type": { "description": "The product type", "enum": [ "events-session-fees" ], "title": "Type", "type": "string" } }, "required": [ "abbreviated_name", "bulk_pricing_rules", "bundled_products", "business_unit_id", "coupon_codes", "custom_pricing_options", "event_id", "id", "installment_plan_options", "name", "price", "product_confirmation_email_options", "purchase_limits", "session_id", "special_prices", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "SessionGenerationRequest": { "additionalProperties": false, "properties": { "allow_duplicates": { "description": "If true, the system will create additional sessions for abstracts", "title": "Allow Duplicates", "type": "boolean" }, "main_presenter_speaker_type_id": { "description": "The type to be assigned to the main presenter for sessions generated from abstracts", "title": "Main Presenter Speaker Type", "type": "string" }, "make_co_authors_speakers": { "description": "If true, co-authors ", "title": "Make Co Authors Speakers", "type": "boolean" }, "type_id": { "description": "The type of session to create", "title": "Type", "type": "string" } }, "required": [ "main_presenter_speaker_type_id", "type_id" ], "type": "object" }, "SessionPublic": { "additionalProperties": false, "properties": { "abstract_id": { "description": "The abstract this session is linked to", "title": "Abstract", "type": "string" }, "access": { "description": "Who has access to this session", "enum": [ "included", "optional" ], "title": "Access", "type": "string" }, "capacity_options": { "additionalProperties": false, "properties": { "capacity": { "format": "float", "minimum": 0, "title": "Capacity", "type": "number" }, "enable_wait_list": { "description": "If set, people can be placed on a wait list", "title": "Enable Wait List", "type": "boolean" }, "waitlist_process_id": { "description": "The process to use for managing the waitlist", "oneOf": [ { "x-required": true } ], "title": "Waitlist Process", "type": "string" } }, "required": [ "capacity" ], "title": "Capacity Options", "type": "object" }, "code": { "description": "Optional code for the event", "title": "Code", "type": "string" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "description": { "description": "A description of the session", "title": "Description", "type": "string" }, "disable_portal_registration": { "description": "If set, portal registration for this session is disabled", "title": "Disable Portal Registration", "type": "boolean" }, "display_order": { "description": "The display/sort order for the sessions", "format": "float", "title": "Display Order", "type": "number" }, "enable_capacity": { "description": "If set, the session has a capacity", "title": "Enable Capacity", "type": "boolean" }, "enable_registration_questions": { "description": "If set, a user is prompted to answer questions during registration", "title": "Enable Registration Questions", "type": "boolean" }, "end_date": { "description": "The end date/time of the session", "format": "date-time", "title": "End Date", "type": "string" }, "event_id": { "description": "The event", "title": "Event", "type": "string" }, "has_fees": { "description": "Whether or not this session has fees", "title": "Has Fees", "type": "boolean" }, "hide_from_portal": { "description": "This session is not displayed in the portal or available for registration", "title": "Hide From Portal", "type": "boolean" }, "hide_from_schedule": { "description": "If selected, hide this session from the online schedule", "title": "Hide From Schedule", "type": "boolean" }, "id": { "description": "The unique, string identifier of this session", "pattern": "^[\\w|\\-:]+$", "title": "ID", "type": "string" }, "location": { "title": "Location", "type": "string" }, "main_presenter_speaker_type_id": { "description": "The type to be assigned to the main presenter for sessions generated from abstracts", "title": "Main Presenter Speaker Type", "type": "string" }, "name": { "description": "The name of the session", "title": "Name", "type": "string" }, "registration_question_options": { "additionalProperties": false, "properties": { "custom_fields": { "description": "The custom fields to display", "items": { "additionalProperties": false, "properties": { "id": { "description": "The custom field", "title": "ID", "type": "string" }, "label": { "description": "An optional label", "title": "Label", "type": "string" }, "required": { "description": "Whether the field is required", "title": "Required", "type": "boolean" } }, "required": [ "id" ], "type": "object" }, "type": "array" }, "registration_instructions": { "description": "Instructions to show during registration for the session", "title": "Registration Instructions", "type": "string" } }, "title": "Registration Question Options", "type": "object" }, "room_ids": { "description": "The room which is holding the event", "items": { "type": "string" }, "title": "Rooms", "type": "array" }, "sold_out": { "description": "Whether the event is sold out", "title": "Sold Out", "type": "boolean" }, "speakers": { "items": { "additionalProperties": false, "properties": { "speaker_id": { "title": "Speaker", "type": "string" }, "speaker_type_id": { "description": "The type of speaker", "title": "Speaker Type", "type": "string" } }, "required": [ "speaker_id", "speaker_type_id" ], "type": "object" }, "type": "array" }, "start_date": { "description": "The start date/time of the session", "format": "date-time", "title": "Start Date", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" }, "track_ids": { "description": "Session tracks", "items": { "type": "string" }, "title": "Tracks", "type": "array" }, "type_id": { "description": "The type of session", "title": "Type", "type": "string" } }, "required": [ "capacity_options", "event_id", "id", "name", "registration_question_options", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id", "type_id" ], "type": "object" }, "SessionRegistration": { "additionalProperties": false, "properties": { "city": { "description": "The member city", "title": "City", "type": "string" }, "contact_id": { "description": "The contact", "title": "Contact", "type": "string" }, "country": { "description": "The member country", "title": "Country", "type": "string" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "email_address": { "description": "The member's email address", "title": "Email Address", "type": "string" }, "event_id": { "description": "The event", "title": "Event", "type": "string" }, "first_name": { "description": "The member's first name", "title": "First Name", "type": "string" }, "id": { "description": "The unique, string identifier of this session registration", "pattern": "^[\\w|\\-:|_]+$", "title": "ID", "type": "string" }, "job_title": { "description": "The member job title", "title": "Job Title", "type": "string" }, "last_name": { "description": "The member's last name", "title": "Last Name", "type": "string" }, "name": { "description": "The member's name", "title": "Name", "type": "string" }, "notes": { "description": "The notice", "title": "Notes", "type": "string" }, "organization_id": { "description": "The organization", "title": "Organization", "type": "string" }, "registration_id": { "description": "The registration to which this session registration is tied", "title": "Registration", "type": "string" }, "session_id": { "description": "The event", "title": "Session", "type": "string" }, "state": { "description": "The state", "title": "State", "type": "string" }, "status": { "enum": [ "active", "attended", "cancelled" ], "title": "Status", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "contact_id", "event_id", "id", "name", "session_id", "status", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "SessionSearchParameters": { "additionalProperties": false, "properties": { "abstract_id": { "items": { "type": "string" }, "title": "Abstract", "type": "array" }, "access": { "items": { "type": "string" }, "title": "Access", "type": "array" }, "end_date": { "items": { "format": "date-time", "type": "string" }, "maxItems": 2, "minItems": 2, "title": "End Date", "type": "array" }, "event_id": { "title": "Event", "type": "string" }, "has_fees": { "items": { "type": "boolean" }, "title": "Has Fees", "type": "array" }, "ids": { "description": "IDs to search", "items": { "type": "string" }, "title": "Ids", "type": "array" }, "name": { "title": "Name", "type": "string" }, "speakers": { "items": { "type": "string" }, "title": "Speakers", "type": "array" }, "start_date": { "items": { "format": "date-time", "type": "string" }, "maxItems": 2, "minItems": 2, "title": "Start Date", "type": "array" }, "track_ids": { "items": { "type": "string" }, "title": "Tracks", "type": "array" }, "type_id": { "items": { "type": "string" }, "title": "Type", "type": "array" } }, "required": [ "event_id" ], "type": "object" }, "SessionSearchResults": { "additionalProperties": false, "properties": { "abstract_id": { "description": "The abstract this session is linked to", "title": "Abstract", "type": "string" }, "access": { "description": "Who has access to this session", "enum": [ "included", "optional" ], "title": "Access", "type": "string" }, "enable_capacity": { "description": "If set, the session has a capacity", "title": "Enable Capacity", "type": "boolean" }, "enable_registration_questions": { "description": "If set, a user is prompted to answer questions during registration", "title": "Enable Registration Questions", "type": "boolean" }, "end_date": { "format": "date-time", "title": "End Date", "type": "string" }, "event_id": { "description": "The event", "title": "Event", "type": "string" }, "has_fees": { "description": "Whether or not this session has fees", "title": "Has Fees", "type": "boolean" }, "id": { "title": "ID", "type": "string" }, "location": { "title": "Location", "type": "string" }, "name": { "description": "The name of the session", "title": "Name", "type": "string" }, "speakers": { "items": { "additionalProperties": false, "properties": { "speaker_id": { "title": "Speaker", "type": "string" }, "speaker_type_id": { "description": "The type of speaker", "title": "Speaker Type", "type": "string" } }, "type": "object" }, "type": "array" }, "start_date": { "format": "date-time", "title": "Start Date", "type": "string" }, "track_ids": { "description": "Session tracks", "items": { "type": "string" }, "title": "Tracks", "type": "array" }, "type_id": { "description": "The type of session", "title": "Type", "type": "string" } }, "required": [ "event_id", "name", "type_id" ], "type": "object" }, "SessionTrack": { "additionalProperties": false, "properties": { "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "description": { "description": "Description of the track", "title": "Description", "type": "string" }, "display_order": { "description": "The display order for the track", "format": "float", "title": "Display Order", "type": "number" }, "enable_speakers": { "description": "If set, speakers are enabled for this track", "title": "Enable Speakers", "type": "boolean" }, "event_id": { "description": "The event this track is tied to", "title": "Event", "type": "string" }, "id": { "description": "The unique, string identifier of this session track", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "is_active": { "description": "Whether or not this session track is active", "title": "Is Active", "type": "boolean" }, "name": { "description": "The name of the session track", "title": "Name", "type": "string" }, "schedule_css_color": { "description": "The color to show this track on the portal schedule", "title": "Schedule Css Color", "type": "string" }, "speakers": { "items": { "additionalProperties": false, "properties": { "speaker_id": { "title": "Speaker", "type": "string" }, "speaker_type_id": { "title": "Speaker Type", "type": "string" } }, "required": [ "speaker_id" ], "type": "object" }, "minItems": 1, "type": "array" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "event_id", "id", "name", "speakers", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "SessionType": { "additionalProperties": false, "properties": { "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "id": { "description": "The unique, string identifier of this session type", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "is_active": { "description": "Whether or not this session type is active", "title": "Is Active", "type": "boolean" }, "name": { "description": "The name of the session type", "title": "Name", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "id", "name", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "Setting": { "additionalProperties": false, "properties": { "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "name": { "description": "The name of the setting", "title": "Name", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "name", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "ShowFloor": { "properties": { "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "display_order": { "description": "The order to show the floor", "format": "float", "title": "Display Order", "type": "number" }, "enable_virtual_show_floor": { "description": "If true, the virtual show floor is enabled", "title": "Enable Virtual Show Floor", "type": "boolean" }, "event_id": { "description": "The event", "title": "Event", "type": "string" }, "id": { "description": "The unique, string identifier of this show floor", "pattern": "/^[\\w-_:]+$/", "title": "ID", "type": "string" }, "layout_uri": { "description": "A floor layout", "title": "Layout Uri", "type": "string" }, "name": { "description": "The name of the show floor", "title": "Name", "type": "string" }, "show_id": { "description": "The show", "title": "Show", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" }, "virtual_show_floor_options": { "properties": { "booth_layout": { "title": "Booth Layout", "type": "object" } }, "title": "Virtual Show Floor Options", "type": "object" } }, "required": [ "event_id", "id", "name", "show_id", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id", "virtual_show_floor_options" ], "type": "object" }, "Speaker": { "additionalProperties": false, "properties": { "bio": { "description": "The speaker bio", "title": "Bio", "type": "string" }, "city": { "description": "The member city", "title": "City", "type": "string" }, "contact_id": { "description": "The contact", "title": "Contact", "type": "string" }, "country": { "description": "The member country", "title": "Country", "type": "string" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "display_order": { "description": "Display order", "title": "Display Order", "type": "string" }, "email_address": { "description": "The member's email address", "title": "Email Address", "type": "string" }, "event_id": { "description": "The event", "title": "Event", "type": "string" }, "featured": { "description": "Whether or not this is a featured speaker", "title": "Featured", "type": "boolean" }, "fee": { "description": "The speaking fee, if applicable", "format": "float", "title": "Fee", "type": "number" }, "first_name": { "description": "The member's first name", "title": "First Name", "type": "string" }, "id": { "description": "The unique, string identifier of this speaker profile", "pattern": "^[\\w-]+$", "title": "ID", "type": "string" }, "job_title": { "description": "The member job title", "title": "Job Title", "type": "string" }, "last_name": { "description": "The member's last name", "title": "Last Name", "type": "string" }, "name": { "description": "The member's name", "title": "Name", "type": "string" }, "notes": { "description": "notes", "title": "Notes", "type": "string" }, "organization_id": { "description": "The organization id", "title": "Organization", "type": "string" }, "organization_name": { "description": "The organization name", "title": "Organization Name", "type": "string" }, "photo_uri": { "description": "The speaker photo", "title": "Photo Uri", "type": "string" }, "plaintext_bio": { "description": "The speaker bio, with HTML stripped as plaintext", "title": "Plaintext Bio", "type": "string" }, "state": { "description": "The state", "title": "State", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "contact_id", "event_id", "id", "name", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "SpeakerProfile": { "additionalProperties": false, "properties": { "bio": { "description": "The biography for this speaker profile", "title": "Bio", "type": "string" }, "city": { "description": "The member city", "title": "City", "type": "string" }, "contact_person": { "additionalProperties": false, "properties": { "email_address": { "description": "The email of the contact person", "format": "email", "title": "Email Address", "type": "string" }, "job_title": { "description": "The contact person title", "title": "Job Title", "type": "string" }, "name": { "description": "The name of the contact person for this speaker", "title": "Name", "type": "string" }, "organization": { "description": "The organization", "title": "Organization", "type": "string" }, "phone_number": { "description": "The name of the contact person for this speaker", "title": "Phone Number", "type": "string" } }, "title": "Contact Person", "type": "object" }, "country": { "description": "The member country", "title": "Country", "type": "string" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "dietary_restrictions": { "description": "Special dietary restrictions", "title": "Dietary Restrictions", "type": "string" }, "email_address": { "description": "The member's email address", "title": "Email Address", "type": "string" }, "first_name": { "description": "The member's first name", "title": "First Name", "type": "string" }, "honorarium": { "description": "The honorarium for this speaker", "format": "float", "title": "Honorarium", "type": "number" }, "id": { "description": "The unique, string identifier of this speaker profile", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "is_active": { "description": "Whether or not this speaker profile is active", "title": "Is Active", "type": "boolean" }, "job_title": { "description": "The member job title", "title": "Job Title", "type": "string" }, "last_name": { "description": "The member's last name", "title": "Last Name", "type": "string" }, "name": { "description": "The member's name", "title": "Name", "type": "string" }, "notes": { "description": "Any relevant notes", "title": "Notes", "type": "string" }, "photo_approved": { "description": "Whether or not the photo is approved", "title": "Photo Approved", "type": "boolean" }, "photo_uri": { "description": "Upload string for path for photo for the profile", "title": "Photo Uri", "type": "string" }, "preferred_name": { "description": "The referred spelling of this persons name", "title": "Preferred Name", "type": "string" }, "speakers_bureau": { "description": "The bureau for this speaker", "title": "Speakers Bureau", "type": "string" }, "state": { "description": "The state", "title": "State", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" }, "topic_ids": { "description": "Array of accreditation topic ids", "items": { "type": "string" }, "title": "Topics", "type": "array" }, "url": { "description": "The url for this speaker", "title": "Url", "type": "string" } }, "required": [ "id", "name", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "SpeakerProfileSearchParameters": { "additionalProperties": false, "properties": { "contact_person_name": { "title": "Contact Person Name", "type": "string" }, "ids": { "description": "IDs to search", "items": { "type": "string" }, "title": "Ids", "type": "array" }, "is_active": { "title": "Is Active", "type": "boolean" }, "topic_ids": { "items": { "type": "string" }, "title": "Topics", "type": "array" } }, "type": "object" }, "SpeakerProfileSearchResults": { "additionalProperties": false, "properties": { "bio": { "title": "Bio", "type": "string" }, "contact_person_name": { "title": "Contact Person Name", "type": "string" }, "contact_person_phone_number": { "title": "Contact Person Phone Number", "type": "string" }, "contact_person_role": { "title": "Contact Person Role", "type": "string" }, "id": { "description": "The unique, string identifier of this speaker profile", "title": "ID", "type": "string" }, "is_active": { "title": "Is Active", "type": "boolean" }, "name": { "title": "Name", "type": "string" }, "photo_uri": { "title": "Photo Uri", "type": "string" }, "topic_ids": { "title": "Topics", "type": "string" } }, "type": "object" }, "SpeakerSearchParameters": { "additionalProperties": false, "properties": { "bio": { "title": "Bio", "type": "string" }, "city": { "description": "The member city", "title": "City", "type": "string" }, "country": { "description": "The member country", "title": "Country", "type": "string" }, "email_address": { "description": "The member's email address", "title": "Email Address", "type": "string" }, "event_id": { "title": "Event", "type": "string" }, "featured": { "items": { "type": "boolean" }, "title": "Featured", "type": "array" }, "first_name": { "description": "The member's first name", "title": "First Name", "type": "string" }, "ids": { "description": "IDs to search", "items": { "type": "string" }, "title": "Ids", "type": "array" }, "job_title": { "description": "The member job title", "title": "Job Title", "type": "string" }, "last_name": { "description": "The member's last name", "title": "Last Name", "type": "string" }, "name": { "description": "The member's name", "title": "Name", "type": "string" }, "organization_id": { "items": { "type": "string" }, "title": "Organization", "type": "array" }, "organization_name": { "title": "Organization Name", "type": "string" }, "state": { "description": "The state", "title": "State", "type": "string" } }, "required": [ "event_id", "name" ], "type": "object" }, "SpeakerSearchResults": { "additionalProperties": false, "properties": { "bio": { "description": "The speaker bio", "title": "Bio", "type": "string" }, "city": { "description": "The member city", "title": "City", "type": "string" }, "contact_id": { "description": "The contact", "title": "Contact", "type": "string" }, "country": { "description": "The member country", "title": "Country", "type": "string" }, "display_order": { "description": "Display order", "title": "Display Order", "type": "string" }, "email_address": { "description": "The member's email address", "title": "Email Address", "type": "string" }, "event_id": { "description": "The event", "title": "Event", "type": "string" }, "featured": { "description": "Whether or not this is a featured speaker", "title": "Featured", "type": "boolean" }, "first_name": { "description": "The member's first name", "title": "First Name", "type": "string" }, "id": { "description": "The unique, string identifier of this speaker profile", "title": "ID", "type": "string" }, "job_title": { "description": "The member job title", "title": "Job Title", "type": "string" }, "last_name": { "description": "The member's last name", "title": "Last Name", "type": "string" }, "name": { "description": "The member's name", "title": "Name", "type": "string" }, "organization_id": { "description": "The organization id", "title": "Organization", "type": "string" }, "organization_name": { "description": "The organization name", "title": "Organization Name", "type": "string" }, "photo_uri": { "description": "The speaker photo", "title": "Photo Uri", "type": "string" }, "state": { "description": "The state", "title": "State", "type": "string" } }, "required": [ "contact_id", "event_id", "name" ], "type": "object" }, "SpeakerTopic": { "additionalProperties": false, "properties": { "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "id": { "description": "The unique, string identifier of this speaker topic", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "is_active": { "description": "Whether or not this speaker topic is active", "title": "Is Active", "type": "boolean" }, "name": { "description": "The name of the speaker topic", "title": "Name", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "id", "name", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "SpeakerType": { "additionalProperties": false, "properties": { "display_order": { "format": "float", "title": "Display Order", "type": "number" }, "id": { "description": "The unique, string identifier of this speaker type", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "is_active": { "description": "Whether or not this speaker type is active", "title": "Is Active", "type": "boolean" }, "name": { "description": "The name of the speaker type", "title": "Name", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "id", "name", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "Sponsor": { "additionalProperties": false, "properties": { "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "date": { "title": "Date", "type": "string" }, "event_id": { "description": "The event", "title": "Event", "type": "string" }, "id": { "description": "The unique, string identifier of this sponsor", "pattern": "^[\\w-|:]+$", "title": "ID", "type": "string" }, "logo_uri": { "description": "The logo for public display", "title": "Logo Uri", "type": "string" }, "name": { "description": "The name of the sponsor", "title": "Name", "type": "string" }, "notes": { "description": "Sponsor notes", "title": "Notes", "type": "string" }, "organization_id": { "title": "Organization", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "event_id", "id", "name", "organization_id", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "SponsorLevel": { "properties": { "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "display_order": { "description": "The display order", "format": "float", "title": "Display Order", "type": "number" }, "id": { "description": "The unique, string identifier of this sponsor level", "pattern": "/^[\\w|-]+$/", "title": "ID", "type": "string" }, "is_active": { "description": "Whether or not this sponsor level is active", "title": "Is Active", "type": "boolean" }, "name": { "description": "The name of the sponsor level", "title": "Name", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "id", "name", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "StandardQueryDefinition": { "additionalProperties": false, "properties": { "category": { "title": "Category", "type": "string" }, "definition": { "additionalProperties": false, "properties": {}, "title": "Definition", "type": "object" }, "id": { "title": "ID", "type": "string" }, "name": { "title": "Name", "type": "string" } }, "type": "object" }, "Statistic": { "additionalProperties": false, "properties": { "dataSource": { "description": "The datasource used to generate this value", "title": "Datasource", "type": "string" }, "error": { "description": "If the cache encountered an error, this is it", "title": "Error", "type": "string" }, "id": { "description": "The unique, string identifier of this statistic", "pattern": "^[\\w-:%\\/]+$", "title": "ID", "type": "string" }, "name": { "description": "The name of the statistic", "title": "Name", "type": "string" }, "status": { "description": "The description of the statistic", "enum": [ "error", "processing", "valid" ], "title": "Status", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" }, "value": { "description": "The numeric value of the statistic", "format": "float", "title": "Value", "type": "number" }, "value_difference_numeric": { "description": "When a value & previous value is present, this is the numeric difference", "format": "float", "title": "Value Difference Numeric", "type": "number" }, "value_difference_percentage": { "description": "When a value & previous value is present, this is the percentage difference", "format": "float", "title": "Value Difference Percentage", "type": "number" }, "value_for_previous_period": { "description": "For statistics that can compare values from a previous period, this is the value", "format": "float", "title": "Value For Previous Period", "type": "number" }, "values": { "description": "If the stat hs values in a row form, this variable contains it", "items": { "additionalProperties": false, "properties": {}, "type": "object" }, "type": "array" } }, "required": [ "id", "name", "status", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id", "value" ], "type": "object" }, "StatusChangeRequest": { "additionalProperties": false, "properties": { "abstract": { "additionalProperties": false, "description": "Updated abstract", "properties": { "approval_process_id": { "description": "The approval process for this abstract", "title": "Approval Process", "type": "string" }, "average_score": { "description": "The average score for this submission in the most recent round", "format": "float", "title": "Average Score", "type": "number" }, "body": { "description": "The body of the abstract", "title": "Body", "type": "string" }, "bucket_id": { "description": "The review bucket", "oneOf": [ { "x-required": true } ], "title": "Bucket", "type": "string" }, "city": { "description": "The member city", "title": "City", "type": "string" }, "co_author_1": { "additionalProperties": false, "properties": { "email_address": { "description": "Co author email", "title": "Email Address", "type": "string" }, "first_name": { "description": "The first name of the co-author", "title": "First Name", "type": "string" }, "last_name": { "description": "The last name of the co-author", "title": "Last Name", "type": "string" }, "phone_number": { "description": "Preferred phone number of the co author", "title": "Phone Number", "type": "string" }, "speaker_type_id": { "description": "The co author speaker type", "title": "Speaker Type", "type": "string" } }, "title": "Co Author 1", "type": "object" }, "co_author_2": { "additionalProperties": false, "properties": { "email_address": { "description": "Co author email", "title": "Email Address", "type": "string" }, "first_name": { "description": "The first name of the co-author", "title": "First Name", "type": "string" }, "last_name": { "description": "The last name of the co-author", "title": "Last Name", "type": "string" }, "phone_number": { "description": "Preferred phone number of the co author", "title": "Phone Number", "type": "string" }, "speaker_type_id": { "description": "The co author speaker type", "title": "Speaker Type", "type": "string" } }, "title": "Co Author 2", "type": "object" }, "co_author_3": { "additionalProperties": false, "properties": { "email_address": { "description": "Co author email", "title": "Email Address", "type": "string" }, "first_name": { "description": "The first name of the co-author", "title": "First Name", "type": "string" }, "last_name": { "description": "The last name of the co-author", "title": "Last Name", "type": "string" }, "phone_number": { "description": "Preferred phone number of the co author", "title": "Phone Number", "type": "string" }, "speaker_type_id": { "description": "The co author speaker type", "title": "Speaker Type", "type": "string" } }, "title": "Co Author 3", "type": "object" }, "co_author_4": { "additionalProperties": false, "properties": { "email_address": { "description": "Co author email", "title": "Email Address", "type": "string" }, "first_name": { "description": "The first name of the co-author", "title": "First Name", "type": "string" }, "last_name": { "description": "The last name of the co-author", "title": "Last Name", "type": "string" }, "phone_number": { "description": "Preferred phone number of the co author", "title": "Phone Number", "type": "string" }, "speaker_type_id": { "description": "The co author speaker type", "title": "Speaker Type", "type": "string" } }, "title": "Co Author 4", "type": "object" }, "co_author_5": { "additionalProperties": false, "properties": { "email_address": { "description": "Co author email", "title": "Email Address", "type": "string" }, "first_name": { "description": "The first name of the co-author", "title": "First Name", "type": "string" }, "last_name": { "description": "The last name of the co-author", "title": "Last Name", "type": "string" }, "phone_number": { "description": "Preferred phone number of the co author", "title": "Phone Number", "type": "string" }, "speaker_type_id": { "description": "The co author speaker type", "title": "Speaker Type", "type": "string" } }, "title": "Co Author 5", "type": "object" }, "co_authors": { "items": { "additionalProperties": false, "properties": { "co_author_contact_id": { "description": "Contact id for the co-author", "title": "Co Author Contact", "type": "string" }, "co_author_contact_info": { "additionalProperties": false, "description": "The contact info for the coAuthor", "properties": {}, "title": "Co Author Contact Info", "type": "object" }, "speaker_type_id": { "description": "Speaker type for this co-author", "title": "Speaker Type", "type": "string" } }, "type": "object" }, "minItems": 1, "oneOf": [ { "x-required": true } ], "type": "array" }, "country": { "description": "The member country", "title": "Country", "type": "string" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "date": { "description": "The date of abstract submission ", "format": "date-time", "title": "Date", "type": "string" }, "email_address": { "description": "The member's email address", "title": "Email Address", "type": "string" }, "event_id": { "description": "The ID of the event", "title": "Event", "type": "string" }, "first_name": { "description": "The member's first name", "title": "First Name", "type": "string" }, "has_co_authors": { "description": "This abstract has co-authors", "title": "Has Co Authors", "type": "boolean" }, "id": { "description": "The unique, string identifier of this abstract", "oneOf": [ { "x-required": true } ], "pattern": "^[\\w-_:]+$", "title": "ID", "type": "string" }, "job_title": { "description": "The member job title", "title": "Job Title", "type": "string" }, "last_name": { "description": "The member's last name", "title": "Last Name", "type": "string" }, "last_review_status_change": { "description": "The date that the review status was last changed", "format": "date-time", "title": "Last Review Status Change", "type": "string" }, "main_presenter_id": { "description": "Id of the presenter of the abstract", "title": "Main Presenter", "type": "string" }, "max_contact_submissions": { "description": "The max number of abstracts per contact for an event", "format": "float", "title": "Max Contact Submissions", "type": "number" }, "name": { "description": "The member's name", "title": "Name", "type": "string" }, "notes": { "title": "Notes", "type": "string" }, "number": { "description": "The abstract number", "format": "float", "title": "Number", "type": "number" }, "organization_id": { "description": "The organization of the submitter", "title": "Organization", "type": "string" }, "override_bucket_assignment": { "description": "If set, the bucket is not calculated automatically, and instead manually assigned", "title": "Override Bucket Assignment", "type": "boolean" }, "pending_console_review": { "description": "If true, then this record has been reviewed and now needs action by the staff", "title": "Pending Console Review", "type": "boolean" }, "presenter_info": { "additionalProperties": false, "oneOf": [ { "x-required": true } ], "properties": { "contact_info": { "additionalProperties": false, "description": "Rolodex contact information of the presenter", "properties": {}, "title": "Contact Info", "type": "object" }, "email_presenter": { "description": "Email of the presenter, if set email is sent here on submission", "title": "Email Presenter", "type": "boolean" } }, "title": "Presenter Info", "type": "object" }, "process_id": { "description": "The process associated with this abstract", "title": "Process", "type": "string" }, "review_process_id": { "description": "Review process for which this abstract is assigned", "title": "Review Process", "type": "string" }, "review_round_id": { "description": "Current review round for this abstract", "oneOf": [ { "x-required": true } ], "title": "Review Round", "type": "string" }, "review_status": { "description": "The review status of this application", "enum": [ "accepted", "alternate", "declined", "pending review" ], "title": "Review Status", "type": "string" }, "reviewer_recommendation": { "description": "Aggregate recommendation across all reviewers", "title": "Reviewer Recommendation", "type": "string" }, "reviews_assigned": { "description": "Have reviews been assigned for this abstract", "title": "Reviews Assigned", "type": "boolean" }, "room_ids": { "description": "The room(s) where the function is located", "items": { "type": "string" }, "title": "Rooms", "type": "array" }, "round_id": { "description": "The review round", "title": "Round", "type": "string" }, "round_scores": { "items": { "additionalProperties": false, "properties": { "round_id": { "description": "The review round for this score", "title": "Round", "type": "string" }, "score": { "description": "The total score across all completed reviews", "format": "float", "title": "Score", "type": "number" } }, "required": [ "round_id", "score" ], "type": "object" }, "type": "array" }, "session_has_been_generated": { "description": "Boolean flag indicating whether or not a session has been been generated for this abstract", "title": "Session Has Been Generated", "type": "boolean" }, "session_track_ids": { "description": "Session tracks associations for the abstract", "items": { "type": "string" }, "title": "Session Tracks", "type": "array" }, "state": { "description": "The state", "title": "State", "type": "string" }, "status": { "enum": [ "accepted", "alternate", "approved/accepted by presenter", "approved/declined by presenter", "approved/pending presenter acceptance", "confirmed", "declined", "draft", "more information needed", "submitted", "under review", "withdrawn" ], "title": "Status", "type": "string" }, "submission_space_id": { "description": "The submission space to which this object belongs", "title": "Submission Space", "type": "string" }, "submitter_id": { "description": "Id of the contact that submitted the abstract", "title": "Submitter", "type": "string" }, "submitting_on_behalf_of_presenter": { "description": "Bool that identifies if the submitter is different than the presenter", "title": "Submitting On Behalf Of Presenter", "type": "boolean" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "oneOf": [ { "x-required": true } ], "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "oneOf": [ { "x-required": true } ], "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "oneOf": [ { "x-required": true } ], "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" }, "title": { "description": "The title of the abstract", "title": "Title", "type": "string" }, "total_score": { "description": "The total score for this submission in the most recent round", "format": "float", "title": "Total Score", "type": "number" }, "type_id": { "description": "The id for the type of abstract", "title": "Type", "type": "string" } }, "required": [ "body", "event_id", "id", "name", "status", "submitter_id", "title", "type_id" ], "title": "Abstract", "type": "object" }, "new_status": { "enum": [ "accepted", "alternate", "approved/accepted by presenter", "approved/declined by presenter", "approved/pending presenter acceptance", "confirmed", "declined", "draft", "more information needed", "submitted", "under review", "withdrawn" ], "title": "New Status", "type": "string" }, "suppress_email_notifications": { "description": "If true, no email goes out", "title": "Suppress Email Notifications", "type": "boolean" } }, "required": [ "new_status" ], "type": "object" }, "StatusChangeResponse": { "additionalProperties": false, "properties": { "results": { "items": { "additionalProperties": false, "properties": { "abstract": { "title": "Abstract", "type": "object" }, "error_message": { "title": "Error Message", "type": "string" }, "outcome": { "enum": [ "error", "success" ], "title": "Outcome", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "TransferRegistrationOptions": { "additionalProperties": false, "properties": { "send_confirmation_email": { "description": "Whether or not a confirmation email should be send to the target registrant", "title": "Send Confirmation Email", "type": "boolean" } }, "type": "object" }, "Type": { "additionalProperties": false, "properties": { "display_in_portal_as": { "description": "How to display in the portal/online store", "title": "Display In Portal As", "type": "string" }, "id": { "description": "The unique, string identifier of this type", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "is_active": { "description": "Whether or not this type is active", "title": "Is Active", "type": "boolean" }, "name": { "description": "The name of the type", "title": "Name", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "id", "name", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "UpdateStatusRequestPayload": { "items": { "type": "string" }, "type": "array" }, "ValidateAddOnsResponse": { "additionalProperties": false, "properties": { "errors": { "items": { "additionalProperties": false, "properties": { "custom_error_message": { "title": "Custom Error Message", "type": "string" }, "rule_id": { "title": "Rule", "type": "string" } }, "type": "object" }, "type": "array" }, "result_code": { "enum": [ "ERROR", "OK" ], "title": "Result Code", "type": "string" }, "result_code_detail": { "title": "Result Code Detail", "type": "string" } }, "type": "object" }, "Venue": { "additionalProperties": false, "properties": { "address": { "$ref": "#/components/schemas/Address" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "id": { "description": "The unique, string identifier of this venue", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "is_active": { "description": "Whether or not this venue is active", "title": "Is Active", "type": "boolean" }, "main_phone_number": { "description": "The primary phone number", "title": "Main Phone Number", "type": "string" }, "name": { "description": "The name of the venue", "title": "Name", "type": "string" }, "organization_id": { "description": "The organization tied to this venue", "title": "Organization", "type": "string" }, "photo_uri": { "description": "The venue photo", "title": "Photo Uri", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "id", "name", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "WaitlistProcess": { "additionalProperties": false, "properties": { "automatic_options": { "additionalProperties": false, "properties": { "registration_window": { "description": "Amount of time a person on the waitlist has to register before the next person on the list is notified", "format": "float", "minimum": 1, "title": "Registration Window", "type": "number" }, "registration_window_type": { "enum": [ "business days", "days", "hours", "minutes" ], "title": "Registration Window Type", "type": "string" } }, "required": [ "registration_window", "registration_window_type" ], "title": "Automatic Options", "type": "object" }, "confirmation_email": { "additionalProperties": false, "description": "The email to send when the application is received", "properties": { "bcc": { "description": "Anyone that should be bcc'ed on the email", "title": "Bcc", "type": "string" }, "body": { "description": "The email body", "title": "Body", "type": "string" }, "cc": { "description": "Anyone that should be cc'ed on the email", "title": "Cc", "type": "string" }, "from": { "description": "From email address", "title": "From", "type": "string" }, "from_name": { "description": "From name", "title": "From Name", "type": "string" }, "reply_to": { "description": "The reply to", "title": "Reply To", "type": "string" }, "subject": { "description": "The email subject", "title": "Subject", "type": "string" } }, "required": [ "body", "subject" ], "title": "Confirmation Email", "type": "object" }, "enable_confirmation_email": { "description": "Whether or not an email should be sent when the person is put on the waitlist", "title": "Enable Confirmation Email", "type": "boolean" }, "enable_final_notification": { "description": "A final notification to people before they are bumped", "title": "Enable Final Notification", "type": "boolean" }, "enable_sms": { "description": "Whether to enable SMS messaging", "title": "Enable Sms", "type": "boolean" }, "final_notification_options": { "additionalProperties": false, "properties": { "email": { "additionalProperties": false, "description": "The email to a person can registered", "properties": { "bcc": { "description": "Anyone that should be bcc'ed on the email", "title": "Bcc", "type": "string" }, "body": { "description": "The email body", "title": "Body", "type": "string" }, "cc": { "description": "Anyone that should be cc'ed on the email", "title": "Cc", "type": "string" }, "from": { "description": "From email address", "title": "From", "type": "string" }, "from_name": { "description": "From name", "title": "From Name", "type": "string" }, "reply_to": { "description": "The reply to", "title": "Reply To", "type": "string" }, "subject": { "description": "The email subject", "title": "Subject", "type": "string" } }, "required": [ "body", "subject" ], "title": "Email", "type": "object" }, "sms": { "description": "The sms to send as a final notification", "title": "Sms", "type": "string" }, "window": { "description": "The amount of time before the deadline that a final notification is sent", "format": "float", "title": "Window", "type": "number" }, "window_type": { "enum": [ "business days", "days", "hours", "minutes" ], "title": "Window Type", "type": "string" } }, "required": [ "email", "window", "window_type" ], "title": "Final Notification Options", "type": "object" }, "id": { "description": "The unique, string identifier of this waitlist process", "pattern": "^[\\w|-]+$", "title": "ID", "type": "string" }, "is_active": { "description": "Whether or not this waitlist process is active", "title": "Is Active", "type": "boolean" }, "mode": { "enum": [ "automatic", "manual" ], "title": "Mode", "type": "string" }, "name": { "description": "The name of the waitlist process", "title": "Name", "type": "string" }, "notification_email": { "additionalProperties": false, "description": "The email to a person can registered", "properties": { "bcc": { "description": "Anyone that should be bcc'ed on the email", "title": "Bcc", "type": "string" }, "body": { "description": "The email body", "title": "Body", "type": "string" }, "cc": { "description": "Anyone that should be cc'ed on the email", "title": "Cc", "type": "string" }, "from": { "description": "From email address", "title": "From", "type": "string" }, "from_name": { "description": "From name", "title": "From Name", "type": "string" }, "reply_to": { "description": "The reply to", "title": "Reply To", "type": "string" }, "subject": { "description": "The email subject", "title": "Subject", "type": "string" } }, "required": [ "body", "subject" ], "title": "Notification Email", "type": "object" }, "notification_sms": { "description": "A template for the SMS message to send when a person is ready to join", "title": "Notification Sms", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" } }, "required": [ "automatic_options", "confirmation_email", "id", "mode", "name", "notification_email", "notification_sms", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id" ], "type": "object" }, "WaitlistedContact": { "additionalProperties": false, "properties": { "city": { "description": "The member city", "title": "City", "type": "string" }, "contact_id": { "description": "The contact ID of the registrant", "title": "Contact", "type": "string" }, "country": { "description": "The member country", "title": "Country", "type": "string" }, "custom_field_values": { "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "title": "Custom Field Values", "type": "array" }, "date_placed_on_waitlist": { "description": "The date the person was put on the wait list", "format": "date-time", "title": "Date Placed On Waitlist", "type": "string" }, "email_address": { "description": "The member's email address", "title": "Email Address", "type": "string" }, "enable_sms_notification": { "description": "Whether to enable by SMS", "title": "Enable Sms Notification", "type": "boolean" }, "event_id": { "description": "The event", "title": "Event", "type": "string" }, "final_notification_date": { "description": "The date of final notification that they can register", "format": "date-time", "title": "Final Notification Date", "type": "string" }, "first_name": { "description": "The member's first name", "title": "First Name", "type": "string" }, "function_id": { "title": "Function", "type": "string" }, "id": { "description": "The unique, string identifier of this waitlisted contact", "pattern": "^[\\w-|:]+$", "title": "ID", "type": "string" }, "job_title": { "description": "The member job title", "title": "Job Title", "type": "string" }, "last_name": { "description": "The member's last name", "title": "Last Name", "type": "string" }, "mobile_phone_number": { "title": "Mobile Phone Number", "type": "string" }, "name": { "description": "The member's name", "title": "Name", "type": "string" }, "notes": { "title": "Notes", "type": "string" }, "notification_date": { "description": "The date they were notified that they can register", "format": "date-time", "title": "Notification Date", "type": "string" }, "notification_email": { "title": "Notification Email", "type": "string" }, "organization_id": { "description": "The organization associated with this registration", "title": "Organization", "type": "string" }, "priority": { "description": "An optional priority to assign those on the waitlist", "format": "float", "maximum": 99999, "minimum": 0, "title": "Priority", "type": "number" }, "session_id": { "title": "Session", "type": "string" }, "state": { "description": "The state", "title": "State", "type": "string" }, "status": { "enum": [ "eligible to register", "missed registration window", "processing", "waiting" ], "title": "Status", "type": "string" }, "sys_bulk_load_at": { "description": "If this record was loaded via bulk, the timestamp when the record was processed", "title": "Sys Bulk Load At", "type": "string" }, "sys_bulk_load_id": { "description": "If this record was loaded via bulk, the ID of the bulk load process", "title": "Sys Bulk Load", "type": "string" }, "sys_bulk_load_pk": { "description": "If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key", "title": "Sys Bulk Load Pk", "type": "string" }, "sys_bulk_load_record_no": { "description": "If this record was loaded via bulk, the record number in the source file", "format": "float", "title": "Sys Bulk Load Record No", "type": "number" }, "sys_bulk_load_source_file": { "description": "If this record was loaded via bulk, the source file", "title": "Sys Bulk Load Source File", "type": "string" }, "sys_calculated_field_error": { "description": "The error associated with the calculated field", "title": "Sys Calculated Field Error", "type": "string" }, "sys_calculated_field_errors": { "items": { "additionalProperties": false, "properties": { "error": { "title": "Error", "type": "string" }, "field": { "title": "Field", "type": "string" } }, "type": "object" }, "type": "array" }, "sys_configuration_snapshot_id": { "description": "If a snapshot was restored/applies to this record, the ID of the snapshot", "title": "Sys Configuration Snapshot", "type": "string" }, "sys_created_at": { "description": "The date/time that this record was created, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Created At", "type": "string" }, "sys_created_by_id": { "description": "The ID of the user that created this record", "title": "Sys Created By", "type": "string" }, "sys_deleted_by_id": { "description": "The ID of the user that deleted (or last tried to delete) this object", "title": "Sys Deleted By", "type": "string" }, "sys_directive": { "description": "Means for passing directive information into an object processing logic", "title": "Sys Directive", "type": "string" }, "sys_external_id": { "description": "The ID that a record has from an external system or data import", "title": "Sys External", "type": "string" }, "sys_has_files_in_s3": { "description": "If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion", "title": "Sys Has Files In S3", "type": "boolean" }, "sys_last_bulk_data_operation_id": { "description": "If this record was last touched by a bulk data operation, the ID of that operation", "title": "Sys Last Bulk Data Operation", "type": "string" }, "sys_last_bulk_data_operation_sys_version": { "description": "If this record was last touched by a bulk data operation, the sys_version at the time of that operation", "title": "Sys Last Bulk Data Operation Sys Version", "type": "string" }, "sys_last_modified_at": { "description": "The date/time that this record record was last modified, expressed in ISO-8601 date format", "format": "date-time", "title": "Sys Last Modified At", "type": "string" }, "sys_last_modified_by_id": { "description": "The ID of the user that last modified this record", "title": "Sys Last Modified By", "type": "string" }, "sys_last_security_context": { "description": "The security context of the last insert, modify, or delete performed on this item", "properties": {}, "title": "Sys Last Security Context", "type": "object" }, "sys_locked": { "description": "If set, this record is locked and cannot be changed via the API", "title": "Sys Locked", "type": "boolean" }, "sys_snapshot_base_version": { "description": "The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox", "format": "float", "title": "Sys Snapshot Base Version", "type": "number" }, "sys_version": { "description": "A number representing the version of this record in the database", "format": "float", "title": "Sys Version", "type": "number" }, "type": { "enum": [ "event", "function", "session" ], "title": "Type", "type": "string" } }, "required": [ "contact_id", "event_id", "function_id", "id", "mobile_phone_number", "name", "notification_email", "session_id", "sys_created_at", "sys_created_by_id", "sys_last_modified_at", "sys_last_modified_by_id", "type" ], "type": "object" } }, "securitySchemes": { "knox-authorizer": { "bearerFormat": "JWT", "scheme": "bearer", "type": "http" } } }, "info": { "description": "The Meetings & Shows, or Events, API is used to manage all aspects of events from recurring webinars to annual trade shows. \nFrom this API you can access Registrants, Speakers, and Abstracts as well as update the details of your events themselves.\n\nLike most of the other Rhythm apps, the Events API includes endpoints for Query Definitions. These endpoints are commonly\nused to retrieve saved queries, which can then be executed using the Query endpoints of the System API. \n", "title": "Events (Meetings & Shows)", "version": "v1-2025-04-18" }, "openapi": "3.0.0", "paths": { "/abstractApprovalProcesses/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new abstract approval process. If an ID is specified for the abstract approval process, an error will be thrown.", "operationId": "createAbstractApprovalProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractApprovalProcess" } } }, "description": "The abstract approval process that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractApprovalProcess" } } }, "description": "The abstract approval process was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The abstract approval process you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract approval process could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add abstract approval process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new abstract approval process record that does not already exist.", "tags": [ "Abstract Approval Processes" ] } }, "/abstractApprovalProcesses/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract approval process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract approval process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Abstract Approval Processes" ] } }, "/abstractApprovalProcesses/{tenantId}/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listProcessesByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAbstractApprovalProcessesResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_id", "tags": [ "Abstract Approval Processes" ] } }, "/abstractApprovalProcesses/{tenantId}/{id}": { "delete": { "description": "This method will delete a abstract approval process with the specified ID.", "operationId": "deleteAbstractApprovalProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract approval process to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The abstract approval process was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract approval process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract approval process could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete abstract approval process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a abstract approval process from the system by its ID.", "tags": [ "Abstract Approval Processes" ] }, "get": { "description": "This method will look up a abstract approval process by the specified ID and return it back.", "operationId": "getAbstractApprovalProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract approval process to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractApprovalProcess" } } }, "description": "The abstract approval process was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract approval process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract approval process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a abstract approval process from the system by its ID.", "tags": [ "Abstract Approval Processes" ] }, "patch": { "description": "This method will patch an existing abstract approval process with the specified ID, using the HTTP PATCH specification.", "operationId": "patchAbstractApprovalProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract approval process to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractApprovalProcess" } } }, "description": "The abstract approval process was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract approval process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract approval process could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract approval process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a abstract approval process with the specified ID.", "tags": [ "Abstract Approval Processes" ] }, "put": { "description": "This method will update an existing abstract approval process with the specified ID.", "operationId": "updateAbstractApprovalProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract approval process to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractApprovalProcess" } } }, "description": "The updated abstract approval process that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractApprovalProcess" } } }, "description": "The abstract approval process was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The abstract approval process supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract approval process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract approval process could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract approval process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a abstract approval process with the specified ID.", "tags": [ "Abstract Approval Processes" ] } }, "/abstractDecisionProcesses/{tenantId}": { "get": { "description": "This method will scan all abstract decision processes and and return them to the caller.", "operationId": "listAbstractDecisionProcesses", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key, if you're making a subsequent request", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AbstractDecisionProcess" }, "type": "array" } } }, "description": "The abstract decision processeswere retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add contact role based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Gets all of the abstract decision processes in the system.", "tags": [ "Abstract Decision Processes" ] }, "post": { "description": "This method will auto-generate an ID and create a new abstract decision process. If an ID is specified for the abstract decision process, an error will be thrown.", "operationId": "createAbstractDecisionProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractDecisionProcess" } } }, "description": "The abstract decision process that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractDecisionProcess" } } }, "description": "The abstract decision process was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The abstract decision process you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract decision process could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add abstract decision process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new abstract decision process record that does not already exist.", "tags": [ "Abstract Decision Processes" ] } }, "/abstractDecisionProcesses/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract decision process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract decision process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Abstract Decision Processes" ] } }, "/abstractDecisionProcesses/{tenantId}/{id}": { "delete": { "description": "This method will delete a abstract decision process with the specified ID.", "operationId": "deleteAbstractDecisionProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract decision process to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The abstract decision process was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract decision process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract decision process could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete abstract decision process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a abstract decision process from the system by its ID.", "tags": [ "Abstract Decision Processes" ] }, "get": { "description": "This method will look up a abstract decision process by the specified ID and return it back.", "operationId": "getAbstractDecisionProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract decision process to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractDecisionProcess" } } }, "description": "The abstract decision process was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract decision process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract decision process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a abstract decision process from the system by its ID.", "tags": [ "Abstract Decision Processes" ] }, "patch": { "description": "This method will patch an existing abstract decision process with the specified ID, using the HTTP PATCH specification.", "operationId": "patchAbstractDecisionProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract decision process to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractDecisionProcess" } } }, "description": "The abstract decision process was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract decision process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract decision process could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract decision process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a abstract decision process with the specified ID.", "tags": [ "Abstract Decision Processes" ] }, "put": { "description": "This method will update an existing abstract decision process with the specified ID.", "operationId": "updateAbstractDecisionProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract decision process to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractDecisionProcess" } } }, "description": "The updated abstract decision process that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractDecisionProcess" } } }, "description": "The abstract decision process was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The abstract decision process supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract decision process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract decision process could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract decision process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a abstract decision process with the specified ID.", "tags": [ "Abstract Decision Processes" ] } }, "/abstractReviewProcesses/{tenantId}": { "get": { "description": "This method will scan all abstract review processes and and return them to the caller.", "operationId": "listAbstractReviewProcesses", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key, if you're making a subsequent request", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AbstractReviewProcess" }, "type": "array" } } }, "description": "The abstract review processeswere retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add contact role based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Gets all of the abstract review processes in the system.", "tags": [ "Abstract Review Processes" ] }, "post": { "description": "This method will auto-generate an ID and create a new abstract review process. If an ID is specified for the abstract review process, an error will be thrown.", "operationId": "createAbstractReviewProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractReviewProcess" } } }, "description": "The abstract review process that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractReviewProcess" } } }, "description": "The abstract review process was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The abstract review process you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract review process could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add abstract review process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new abstract review process record that does not already exist.", "tags": [ "Abstract Review Processes" ] } }, "/abstractReviewProcesses/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract review process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract review process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Abstract Review Processes" ] } }, "/abstractReviewProcesses/{tenantId}/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listProcessesByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAbstractReviewProcessesResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_id", "tags": [ "Abstract Review Processes" ] } }, "/abstractReviewProcesses/{tenantId}/{id}": { "delete": { "description": "This method will delete a abstract review process with the specified ID.", "operationId": "deleteAbstractReviewProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract review process to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The abstract review process was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract review process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract review process could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete abstract review process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a abstract review process from the system by its ID.", "tags": [ "Abstract Review Processes" ] }, "get": { "description": "This method will look up a abstract review process by the specified ID and return it back.", "operationId": "getAbstractReviewProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract review process to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractReviewProcess" } } }, "description": "The abstract review process was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract review process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract review process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a abstract review process from the system by its ID.", "tags": [ "Abstract Review Processes" ] }, "patch": { "description": "This method will patch an existing abstract review process with the specified ID, using the HTTP PATCH specification.", "operationId": "patchAbstractReviewProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract review process to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractReviewProcess" } } }, "description": "The abstract review process was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract review process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract review process could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract review process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a abstract review process with the specified ID.", "tags": [ "Abstract Review Processes" ] }, "put": { "description": "This method will update an existing abstract review process with the specified ID.", "operationId": "updateAbstractReviewProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract review process to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractReviewProcess" } } }, "description": "The updated abstract review process that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractReviewProcess" } } }, "description": "The abstract review process was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The abstract review process supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract review process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract review process could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract review process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a abstract review process with the specified ID.", "tags": [ "Abstract Review Processes" ] } }, "/abstractReviewRounds/{tenantId}": { "get": { "description": "This method will scan all abstract review rounds and and return them to the caller.", "operationId": "listAbstractReviewRounds", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key, if you're making a subsequent request", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AbstractReviewRound" }, "type": "array" } } }, "description": "The abstract review roundswere retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add contact role based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Gets all of the abstract review rounds in the system.", "tags": [ "Abstract Review Rounds" ] }, "post": { "description": "This method will auto-generate an ID and create a new abstract review round. If an ID is specified for the abstract review round, an error will be thrown.", "operationId": "createAbstractReviewRound", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractReviewRound" } } }, "description": "The abstract review round that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractReviewRound" } } }, "description": "The abstract review round was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The abstract review round you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract review round could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add abstract review round based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new abstract review round record that does not already exist.", "tags": [ "Abstract Review Rounds" ] } }, "/abstractReviewRounds/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract review round could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract review round based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Abstract Review Rounds" ] } }, "/abstractReviewRounds/{tenantId}/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listRoundsByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAbstractReviewRoundsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_id", "tags": [ "Abstract Review Rounds" ] } }, "/abstractReviewRounds/{tenantId}/status/{processId}/{status}": { "get": { "description": "Returns a list of records with the specified status", "operationId": "listByProcessStatus", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "processId", "required": true, "description": "The review process for record lookup", "schema": { "type": "string" } }, { "in": "path", "name": "status", "required": true, "description": "The status to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAbstractReviewRoundsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified status", "tags": [ "Abstract Review Rounds" ] } }, "/abstractReviewRounds/{tenantId}/{id}": { "delete": { "description": "This method will delete a abstract review round with the specified ID.", "operationId": "deleteAbstractReviewRound", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract review round to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The abstract review round was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract review round could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract review round could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete abstract review round based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a abstract review round from the system by its ID.", "tags": [ "Abstract Review Rounds" ] }, "get": { "description": "This method will look up a abstract review round by the specified ID and return it back.", "operationId": "getAbstractReviewRound", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract review round to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractReviewRound" } } }, "description": "The abstract review round was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract review round could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract review round based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a abstract review round from the system by its ID.", "tags": [ "Abstract Review Rounds" ] }, "patch": { "description": "This method will patch an existing abstract review round with the specified ID, using the HTTP PATCH specification.", "operationId": "patchAbstractReviewRound", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract review round to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractReviewRound" } } }, "description": "The abstract review round was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract review round could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract review round could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract review round based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a abstract review round with the specified ID.", "tags": [ "Abstract Review Rounds" ] }, "put": { "description": "This method will update an existing abstract review round with the specified ID.", "operationId": "updateAbstractReviewRound", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract review round to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractReviewRound" } } }, "description": "The updated abstract review round that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractReviewRound" } } }, "description": "The abstract review round was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The abstract review round supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract review round could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract review round could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract review round based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a abstract review round with the specified ID.", "tags": [ "Abstract Review Rounds" ] } }, "/abstractReviews/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new abstract review. If an ID is specified for the abstract review, an error will be thrown.", "operationId": "createAbstractReview", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractReview" } } }, "description": "The abstract review that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractReview" } } }, "description": "The abstract review was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The abstract review you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract review could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add abstract review based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new abstract review record that does not already exist.", "tags": [ "Abstract Reviews" ] } }, "/abstractReviews/{tenantId}/abstract/{abstract_id}": { "get": { "description": "Returns a list of records with the specified abstract_id", "operationId": "listReviewsByAbstractId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "abstract_id", "required": true, "description": "The abstract_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAbstractReviewsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified abstract_id", "tags": [ "Abstract Reviews" ] } }, "/abstractReviews/{tenantId}/assignReviews": { "post": { "description": "Assign reviews for passed in abstracts to specific users", "operationId": "assignReviews", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignReviewsRequest" } } }, "description": "The The request payload to use to for record lookup", "required": true }, "responses": { "200": { "description": "The records were created successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate any records with the specified domain", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Assign reviews for passed in abstracts to specific users", "tags": [ "Abstract Reviews" ] } }, "/abstractReviews/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract review could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract review based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Abstract Reviews" ] } }, "/abstractReviews/{tenantId}/contact/{contactId}": { "get": { "description": "Returns a list of records with the specified contact_id", "operationId": "listAbstractReviewsByContactId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "contactId", "required": true, "description": "The contact", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAbstractReviewsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified contact_id", "tags": [ "Abstract Reviews" ] } }, "/abstractReviews/{tenantId}/event/round/{eventId}/{roundId}": { "get": { "description": "Returns a list of records with the specified event_id and review_round_id", "operationId": "listReviewsByEventRoundId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "eventId", "required": true, "description": "The review_round_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "path", "name": "roundId", "required": true, "description": "The review_round_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAbstractReviewsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_id and review_round_id", "tags": [ "Abstract Reviews" ] } }, "/abstractReviews/{tenantId}/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listReviewsByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAbstractReviewsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_id", "tags": [ "Abstract Reviews" ] } }, "/abstractReviews/{tenantId}/openRound/{typeId}/{roundId}": { "get": { "description": "This endpoint opens a review round for a process and closes the existing open round, it also generates reviews for all of the assignees defined in the matching assignment rules on the round being opened", "operationId": "openReviewRound", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "typeId", "required": true, "description": "The id of the abstract type that the round is on", "schema": { "type": "string" } }, { "in": "path", "name": "roundId", "required": true, "description": "The id of the round being opened", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The round was successfully opened", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate any records with the specified domain", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Open a review round generating reviews based on the round assignment rules", "tags": [ "Abstract Reviews" ] } }, "/abstractReviews/{tenantId}/previewEmail": { "post": { "description": "Sends out a preview of the CRC notification email", "operationId": "previewEmail", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PreviewEmailRequest" }, "responses": { "200": { "description": "The record was retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate any organizations with the specified domain", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Sends out a preview of the CRC notification email", "tags": [ "Abstract Reviews" ] } }, "/abstractReviews/{tenantId}/resendConfirmationEmail/{id}": { "post": { "description": "Resends the confirmation email for an abstract review submission", "operationId": "resendConfirmationEmail", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The review", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Resends the confirmation email for an abstract review submission", "tags": [ "Abstract Reviews" ] } }, "/abstractReviews/{tenantId}/resendReviewAssignmentEmail/{id}": { "post": { "description": "Resends the review assignment email for an abstract review submission", "operationId": "resendReviewAssignmentEmail", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The review", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Resends the review assignment email for an abstract review submission", "tags": [ "Abstract Reviews" ] } }, "/abstractReviews/{tenantId}/reviewRound/{review_round_id}": { "get": { "description": "Returns a list of records with the specified review_round_id", "operationId": "listReviewsByReviewRoundId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "review_round_id", "required": true, "description": "The review_round_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAbstractReviewsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified review_round_id", "tags": [ "Abstract Reviews" ] } }, "/abstractReviews/{tenantId}/search": { "post": { "description": "Searches for abstract reviews using predefined parameters", "operationId": "searchForAbstractReviews", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key for the search, for paging support", "schema": { "type": "string" } }, { "in": "query", "name": "fieldsToReturn", "required": false, "description": " The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractReviewSearchParameters" } } }, "description": "The abstract review that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedAbstractReviewSearchResults" } } }, "description": "The abstract review search was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The abstract review you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract review could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add abstract review based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Searches for abstract reviews using predefined parameters", "tags": [ "Abstract Reviews" ] } }, "/abstractReviews/{tenantId}/sendReviewAssignmentEmail": { "post": { "description": "Sends the review assignment email for an abstract review", "operationId": "sendReviewAssignmentEmail", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendAssignmentEmailRequest" } } }, "description": "The domain_name to use to for record lookup", "required": true }, "responses": { "200": { "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Sends the review assignment email for an abstract review", "tags": [ "Abstract Reviews" ] } }, "/abstractReviews/{tenantId}/submit": { "post": { "operationId": "submitAbstractReview", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractReview" } } }, "description": "Object definition of abstract", "required": true }, "responses": { "200": { "description": "The record was retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate any organizations with the specified domain", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Submit an abstract review", "tags": [ "Abstract Reviews" ] } }, "/abstractReviews/{tenantId}/{id}": { "delete": { "description": "This method will delete a abstract review with the specified ID.", "operationId": "deleteAbstractReview", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract review to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The abstract review was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract review could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract review could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete abstract review based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a abstract review from the system by its ID.", "tags": [ "Abstract Reviews" ] }, "get": { "description": "This method will look up a abstract review by the specified ID and return it back.", "operationId": "getAbstractReview", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract review to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractReview" } } }, "description": "The abstract review was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract review could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract review based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a abstract review from the system by its ID.", "tags": [ "Abstract Reviews" ] }, "patch": { "description": "This method will patch an existing abstract review with the specified ID, using the HTTP PATCH specification.", "operationId": "patchAbstractReview", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract review to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractReview" } } }, "description": "The abstract review was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract review could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract review could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract review based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a abstract review with the specified ID.", "tags": [ "Abstract Reviews" ] }, "put": { "description": "This method will update an existing abstract review with the specified ID.", "operationId": "updateAbstractReview", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract review to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractReview" } } }, "description": "The updated abstract review that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractReview" } } }, "description": "The abstract review was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The abstract review supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract review could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract review could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract review based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a abstract review with the specified ID.", "tags": [ "Abstract Reviews" ] } }, "/abstractSettings/{tenantId}": { "get": { "description": "This method will scan all abstract settings and and return them to the caller.", "operationId": "listAbstractSettings", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key, if you're making a subsequent request", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AbstractSetting" }, "type": "array" } } }, "description": "The abstract settingswere retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add contact role based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Gets all of the abstract settings in the system.", "tags": [ "Abstract Settings" ] }, "post": { "description": "This method will auto-generate an ID and create a new abstract setting. If an ID is specified for the abstract setting, an error will be thrown.", "operationId": "createAbstractSetting", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractSetting" } } }, "description": "The abstract setting that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractSetting" } } }, "description": "The abstract setting was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The abstract setting you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract setting could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add abstract setting based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new abstract setting record that does not already exist.", "tags": [ "Abstract Settings" ] } }, "/abstractSettings/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract setting could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract setting based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Abstract Settings" ] } }, "/abstractSettings/{tenantId}/{id}": { "delete": { "description": "This method will delete a abstract setting with the specified ID.", "operationId": "deleteAbstractSetting", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract setting to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The abstract setting was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract setting could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract setting could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete abstract setting based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a abstract setting from the system by its ID.", "tags": [ "Abstract Settings" ] }, "get": { "description": "This method will look up a abstract setting by the specified ID and return it back.", "operationId": "getAbstractSetting", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract setting to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractSetting" } } }, "description": "The abstract setting was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract setting could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract setting based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a abstract setting from the system by its ID.", "tags": [ "Abstract Settings" ] }, "patch": { "description": "This method will patch an existing abstract setting with the specified ID, using the HTTP PATCH specification.", "operationId": "patchAbstractSetting", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract setting to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractSetting" } } }, "description": "The abstract setting was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract setting could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract setting could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract setting based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a abstract setting with the specified ID.", "tags": [ "Abstract Settings" ] }, "put": { "description": "This method will update an existing abstract setting with the specified ID.", "operationId": "updateAbstractSetting", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract setting to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractSetting" } } }, "description": "The updated abstract setting that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractSetting" } } }, "description": "The abstract setting was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The abstract setting supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract setting could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract setting could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract setting based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a abstract setting with the specified ID.", "tags": [ "Abstract Settings" ] } }, "/abstractSubmissionProcesses/{tenantId}": { "get": { "description": "This method will scan all abstract submission processes and and return them to the caller.", "operationId": "listAbstractSubmissionProcesses", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key, if you're making a subsequent request", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AbstractSubmissionProcess" }, "type": "array" } } }, "description": "The abstract submission processeswere retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add contact role based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Gets all of the abstract submission processes in the system.", "tags": [ "Abstract Submission Processes" ] }, "post": { "description": "This method will auto-generate an ID and create a new abstract submission process. If an ID is specified for the abstract submission process, an error will be thrown.", "operationId": "createAbstractSubmissionProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractSubmissionProcess" } } }, "description": "The abstract submission process that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractSubmissionProcess" } } }, "description": "The abstract submission process was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The abstract submission process you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract submission process could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add abstract submission process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new abstract submission process record that does not already exist.", "tags": [ "Abstract Submission Processes" ] } }, "/abstractSubmissionProcesses/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract submission process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract submission process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Abstract Submission Processes" ] } }, "/abstractSubmissionProcesses/{tenantId}/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listProcessesByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAbstractSubmissionProcessesResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_id", "tags": [ "Abstract Submission Processes" ] } }, "/abstractSubmissionProcesses/{tenantId}/{id}": { "delete": { "description": "This method will delete a abstract submission process with the specified ID.", "operationId": "deleteAbstractSubmissionProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract submission process to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The abstract submission process was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract submission process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract submission process could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete abstract submission process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a abstract submission process from the system by its ID.", "tags": [ "Abstract Submission Processes" ] }, "get": { "description": "This method will look up a abstract submission process by the specified ID and return it back.", "operationId": "getAbstractSubmissionProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract submission process to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractSubmissionProcess" } } }, "description": "The abstract submission process was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract submission process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract submission process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a abstract submission process from the system by its ID.", "tags": [ "Abstract Submission Processes" ] }, "patch": { "description": "This method will patch an existing abstract submission process with the specified ID, using the HTTP PATCH specification.", "operationId": "patchAbstractSubmissionProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract submission process to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractSubmissionProcess" } } }, "description": "The abstract submission process was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract submission process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract submission process could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract submission process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a abstract submission process with the specified ID.", "tags": [ "Abstract Submission Processes" ] }, "put": { "description": "This method will update an existing abstract submission process with the specified ID.", "operationId": "updateAbstractSubmissionProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract submission process to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractSubmissionProcess" } } }, "description": "The updated abstract submission process that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractSubmissionProcess" } } }, "description": "The abstract submission process was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The abstract submission process supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract submission process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract submission process could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract submission process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a abstract submission process with the specified ID.", "tags": [ "Abstract Submission Processes" ] } }, "/abstractTypes/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new abstract type. If an ID is specified for the abstract type, an error will be thrown.", "operationId": "createAbstractType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractType" } } }, "description": "The abstract type that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractType" } } }, "description": "The abstract type was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The abstract type you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add abstract type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new abstract type record that does not already exist.", "tags": [ "Abstract Types" ] } }, "/abstractTypes/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Abstract Types" ] } }, "/abstractTypes/{tenantId}/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listTypesByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAbstractTypesResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_id", "tags": [ "Abstract Types" ] } }, "/abstractTypes/{tenantId}/reviewProcess/{review_process_id}": { "get": { "description": "Returns a list of records with the specified review_process_id", "operationId": "listTypesByReviewProcessId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "review_process_id", "required": true, "description": "The review_process_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAbstractTypesResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified review_process_id", "tags": [ "Abstract Types" ] } }, "/abstractTypes/{tenantId}/{id}": { "delete": { "description": "This method will delete a abstract type with the specified ID.", "operationId": "deleteAbstractType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract type to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The abstract type was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract type could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete abstract type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a abstract type from the system by its ID.", "tags": [ "Abstract Types" ] }, "get": { "description": "This method will look up a abstract type by the specified ID and return it back.", "operationId": "getAbstractType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract type to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractType" } } }, "description": "The abstract type was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a abstract type from the system by its ID.", "tags": [ "Abstract Types" ] }, "patch": { "description": "This method will patch an existing abstract type with the specified ID, using the HTTP PATCH specification.", "operationId": "patchAbstractType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract type to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractType" } } }, "description": "The abstract type was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a abstract type with the specified ID.", "tags": [ "Abstract Types" ] }, "put": { "description": "This method will update an existing abstract type with the specified ID.", "operationId": "updateAbstractType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract type to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractType" } } }, "description": "The updated abstract type that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractType" } } }, "description": "The abstract type was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The abstract type supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a abstract type with the specified ID.", "tags": [ "Abstract Types" ] } }, "/abstracts/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new abstract. If an ID is specified for the abstract, an error will be thrown.", "operationId": "createAbstract", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Abstract" } } }, "description": "The abstract that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Abstract" } } }, "description": "The abstract was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The abstract you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add abstract based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new abstract record that does not already exist.", "tags": [ "Abstracts" ] } }, "/abstracts/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Abstracts" ] } }, "/abstracts/{tenantId}/breakoutSessions": { "post": { "description": "Allows for bulk update of abstract statuses", "operationId": "breakoutSessions", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BreakoutSessionsRequestPayload" } } }, "description": "AbstractIDs and FormData for sessions step function", "required": true }, "responses": { "200": { "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Bulk update abstract statuses", "tags": [ "Abstracts" ] } }, "/abstracts/{tenantId}/calculateScore/{abstractId}": { "post": { "description": "Return the set of totals and calculations for an abstract based on the reviews and grouped by the rounds", "operationId": "calculateScore", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "abstractId", "required": true, "description": "The abstract", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The record was retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate any organizations with the specified domain", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Calculations for the reviews for an abstract", "tags": [ "Abstracts" ] } }, "/abstracts/{tenantId}/coAuthor/{co_author_contact_id}": { "get": { "description": "Returns a list of records with the specified co_author_id", "operationId": "listAbstractsByCoAuthorId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "co_author_contact_id", "required": true, "description": "The co_author_contact_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAbstractsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified co_author_id", "tags": [ "Abstracts" ] } }, "/abstracts/{tenantId}/confirm/{id}": { "post": { "description": "Allows a portal user to submit an abstract confirmation-approval form with additional information", "operationId": "confirmAbstract", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The id of the abstract", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Abstract" } } }, "description": "Abstract approval form payload", "required": true }, "responses": { "200": { "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "End user abstract confirmation form submission endpoint", "tags": [ "Abstracts" ] } }, "/abstracts/{tenantId}/eventContact/{eventId}/{contactId}": { "get": { "description": "Returns a list of records with the specified event_contact_id", "operationId": "listAbstractsByEventContactId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "eventId", "required": true, "description": "The event", "schema": { "type": "string" } }, { "in": "path", "name": "contactId", "required": true, "description": "The contact", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAbstractsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_contact_id", "tags": [ "Abstracts" ] } }, "/abstracts/{tenantId}/eventPresenter/{eventId}/{contactId}": { "get": { "description": "Returns a list of records with the specified event_presenter_id", "operationId": "listAbstractsByEventPresenterId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "eventId", "required": true, "description": "The event", "schema": { "type": "string" } }, { "in": "path", "name": "contactId", "required": true, "description": "The contact", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAbstractsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_presenter_id", "tags": [ "Abstracts" ] } }, "/abstracts/{tenantId}/getCoAuthorInfo/{contactId}": { "get": { "description": "Get CoAuthor info for Abstracts", "operationId": "getCoAuthorInfo", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "contactId", "required": true, "description": "The coAuthor contact ID", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCoAuthorInfoResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Get CoAuthor info for Abstracts", "tags": [ "Abstracts" ] } }, "/abstracts/{tenantId}/previewEmail": { "post": { "description": "Sends out a preview of the CRC notification email", "operationId": "previewEmail", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PreviewEmailRequest" }, "responses": { "200": { "description": "The record was retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate any organizations with the specified domain", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Sends out a preview of the CRC notification email", "tags": [ "Abstracts" ] } }, "/abstracts/{tenantId}/resendConfirmationEmail/{id}": { "get": { "description": "Resends the confirmation email for an abstract submission", "operationId": "resendConfirmationEmail", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The abstract", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Resends the confirmation email for an abstract submission", "tags": [ "Abstracts" ] } }, "/abstracts/{tenantId}/reviewProcess/{review_process_id}": { "get": { "description": "Returns a list of records with the specified review_process_id", "operationId": "listAbstractsByReviewProcessId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "review_process_id", "required": true, "description": "The review_process_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAbstractsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified review_process_id", "tags": [ "Abstracts" ] } }, "/abstracts/{tenantId}/reviewRound/{id}": { "post": { "description": "Returns a list of records with the specified review_round_id", "operationId": "listAbstractsByReviewRoundId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The review round", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListByRoundIdRequestPayload" } } }, "description": "The options for filtering the result set" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAbstractsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified review_round_id", "tags": [ "Abstracts" ] } }, "/abstracts/{tenantId}/search": { "post": { "description": "Searches for abstracts using predefined parameters", "operationId": "searchForAbstracts", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key for the search, for paging support", "schema": { "type": "string" } }, { "in": "query", "name": "fieldsToReturn", "required": false, "description": " The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbstractSearchParameters" } } }, "description": "The abstract that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedAbstractSearchResults" } } }, "description": "The abstract search was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The abstract you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add abstract based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Searches for abstracts using predefined parameters", "tags": [ "Abstracts" ] } }, "/abstracts/{tenantId}/status/{id}": { "put": { "description": "Updates the status and sends out the appropriate email", "operationId": "processStatusChange", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusChangeRequest" } } }, "description": "Object definition of abstract", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusChangeResponse" } } }, "description": "The record was retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate any organizations with the specified domain", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Process a Status Change Request", "tags": [ "Abstracts" ] } }, "/abstracts/{tenantId}/submit": { "post": { "operationId": "submitAbstracts", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Abstract" } } }, "description": "Object definition of abstract", "required": true }, "responses": { "200": { "description": "The record was retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate any organizations with the specified domain", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Submit an abstract", "tags": [ "Abstracts" ] } }, "/abstracts/{tenantId}/submitter/{submitter_id}": { "get": { "description": "Returns a list of records with the specified submitter_id", "operationId": "listAbstractsBySubmitterId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "submitter_id", "required": true, "description": "The submitter_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAbstractsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified submitter_id", "tags": [ "Abstracts" ] } }, "/abstracts/{tenantId}/type/{type_id}": { "get": { "description": "Returns a list of records with the specified type_id", "operationId": "listAbstractsByTypeId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "type_id", "required": true, "description": "The type_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAbstractsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified type_id", "tags": [ "Abstracts" ] } }, "/abstracts/{tenantId}/updateStatus/{status}": { "post": { "description": "Allows for bulk update of abstract statuses", "operationId": "updateAbstractStatuses", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "status", "required": true, "description": "The status to set", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateStatusRequestPayload" } } }, "description": "Array of abstract ids", "required": true }, "responses": { "200": { "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Bulk update abstract statuses", "tags": [ "Abstracts" ] } }, "/abstracts/{tenantId}/{id}": { "delete": { "description": "This method will delete a abstract with the specified ID.", "operationId": "deleteAbstract", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The abstract was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete abstract based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a abstract from the system by its ID.", "tags": [ "Abstracts" ] }, "get": { "description": "This method will look up a abstract by the specified ID and return it back.", "operationId": "getAbstract", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Abstract" } } }, "description": "The abstract was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a abstract from the system by its ID.", "tags": [ "Abstracts" ] }, "patch": { "description": "This method will patch an existing abstract with the specified ID, using the HTTP PATCH specification.", "operationId": "patchAbstract", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Abstract" } } }, "description": "The abstract was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a abstract with the specified ID.", "tags": [ "Abstracts" ] }, "put": { "description": "This method will update an existing abstract with the specified ID.", "operationId": "updateAbstract", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the abstract to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Abstract" } } }, "description": "The updated abstract that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Abstract" } } }, "description": "The abstract was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The abstract supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The abstract could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The abstract could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve abstract based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a abstract with the specified ID.", "tags": [ "Abstracts" ] } }, "/coupons/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new coupon. If an ID is specified for the coupon, an error will be thrown.", "operationId": "createCoupon", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Coupon" } } }, "description": "The coupon that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Coupon" } } }, "description": "The coupon was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The coupon you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The coupon could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add coupon based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new coupon record that does not already exist.", "tags": [ "Coupons" ] } }, "/coupons/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The coupon could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve coupon based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Coupons" ] } }, "/coupons/{tenantId}/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listCouponsByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCouponsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_id", "tags": [ "Coupons" ] } }, "/coupons/{tenantId}/{id}": { "delete": { "description": "This method will delete a coupon with the specified ID.", "operationId": "deleteCoupon", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the coupon to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The coupon was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The coupon could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The coupon could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete coupon based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a coupon from the system by its ID.", "tags": [ "Coupons" ] }, "get": { "description": "This method will look up a coupon by the specified ID and return it back.", "operationId": "getCoupon", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the coupon to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Coupon" } } }, "description": "The coupon was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The coupon could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve coupon based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a coupon from the system by its ID.", "tags": [ "Coupons" ] }, "patch": { "description": "This method will patch an existing coupon with the specified ID, using the HTTP PATCH specification.", "operationId": "patchCoupon", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the coupon to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Coupon" } } }, "description": "The coupon was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The coupon could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The coupon could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve coupon based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a coupon with the specified ID.", "tags": [ "Coupons" ] }, "put": { "description": "This method will update an existing coupon with the specified ID.", "operationId": "updateCoupon", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the coupon to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Coupon" } } }, "description": "The updated coupon that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Coupon" } } }, "description": "The coupon was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The coupon supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The coupon could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The coupon could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve coupon based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a coupon with the specified ID.", "tags": [ "Coupons" ] } }, "/events/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new event. If an ID is specified for the event, an error will be thrown.", "operationId": "createEvent", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event" } } }, "description": "The event that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event" } } }, "description": "The event was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The event you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The event could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add event based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new event record that does not already exist.", "tags": [ "Events" ] } }, "/events/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The event could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve event based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Events" ] } }, "/events/{tenantId}/chapter/{chapter_id}": { "get": { "description": "Returns a list of records with the specified chapter_id", "operationId": "listEventsByChapterId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "chapter_id", "required": true, "description": "The chapter_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEventsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified chapter_id", "tags": [ "Events" ] } }, "/events/{tenantId}/clone": { "post": { "description": "Creates a copy of an event, along with other associated records", "operationId": "cloneEvent", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloneEventRequest", "type": "string" } } }, "description": "The clone request", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a copy of an event, along with other associated records", "tags": [ "Events" ] } }, "/events/{tenantId}/guestEligibility/{id}": { "get": { "description": "Returns a list of records with the specified type_id", "operationId": "canAddGuest", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "isNewRegistration", "required": false, "description": "If true, this is a new registration", "schema": { "type": "string" } }, { "in": "query", "name": "guestNumber", "required": false, "description": "The guest number", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Can add guest", "tags": [ "Events" ] } }, "/events/{tenantId}/public/upcoming": { "get": { "description": "Returns a list of records that are upcoming", "operationId": "getUpcomingEvents", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicEventResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "summary": "Returns a list of records that are upcoming", "tags": [ "Events" ] } }, "/events/{tenantId}/public/{id}": { "get": { "description": "Gets the public event info", "operationId": "getPublicEventInfo", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The id of the event", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventPublic" } } }, "description": "The store was retrieved", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "summary": "Gets the public event info", "tags": [ "Events" ] } }, "/events/{tenantId}/search": { "post": { "description": "Searches for events using predefined parameters", "operationId": "searchForEvents", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key for the search, for paging support", "schema": { "type": "string" } }, { "in": "query", "name": "fieldsToReturn", "required": false, "description": " The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventSearchParameters" } } }, "description": "The event that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedEventSearchResults" } } }, "description": "The event search was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The event you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The event could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add event based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Searches for events using predefined parameters", "tags": [ "Events" ] } }, "/events/{tenantId}/startDate/{start_date}": { "get": { "description": "Returns a list of records with that start after the specified start_date", "operationId": "listEventsStartingAfter", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "start_date", "required": true, "description": "The start_date to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicEventResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records that start after specified start_date", "tags": [ "Events" ] } }, "/events/{tenantId}/type/{type_id}": { "get": { "description": "Returns a list of records with the specified type_id", "operationId": "listEventsByTypeId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "type_id", "required": true, "description": "The type_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEventsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified type_id", "tags": [ "Events" ] } }, "/events/{tenantId}/{id}": { "delete": { "description": "This method will delete a event with the specified ID.", "operationId": "deleteEvent", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the event to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The event was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The event could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The event could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete event based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a event from the system by its ID.", "tags": [ "Events" ] }, "get": { "description": "This method will look up a event by the specified ID and return it back.", "operationId": "getEvent", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the event to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event" } } }, "description": "The event was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The event could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve event based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a event from the system by its ID.", "tags": [ "Events" ] }, "patch": { "description": "This method will patch an existing event with the specified ID, using the HTTP PATCH specification.", "operationId": "patchEvent", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the event to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event" } } }, "description": "The event was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The event could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The event could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve event based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a event with the specified ID.", "tags": [ "Events" ] }, "put": { "description": "This method will update an existing event with the specified ID.", "operationId": "updateEvent", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the event to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event" } } }, "description": "The updated event that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event" } } }, "description": "The event was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The event supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The event could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The event could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve event based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a event with the specified ID.", "tags": [ "Events" ] } }, "/exhibitorAddOnProducts/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new exhibitor add on product. If an ID is specified for the exhibitor add on product, an error will be thrown.", "operationId": "createExhibitorAddOnProduct", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorAddOnProduct" } } }, "description": "The exhibitor add on product that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorAddOnProduct" } } }, "description": "The exhibitor add on product was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The exhibitor add on product you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor add on product could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add exhibitor add on product based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new exhibitor add on product record that does not already exist.", "tags": [ "Exhibitor Add On Products" ] } }, "/exhibitorAddOnProducts/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor add on product could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor add on product based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Exhibitor Add On Products" ] } }, "/exhibitorAddOnProducts/{tenantId}/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listProductsByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListExhibitorAddOnProductsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_id", "tags": [ "Exhibitor Add On Products" ] } }, "/exhibitorAddOnProducts/{tenantId}/{id}": { "delete": { "description": "This method will delete a exhibitor add on product with the specified ID.", "operationId": "deleteExhibitorAddOnProduct", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor add on product to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The exhibitor add on product was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor add on product could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor add on product could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete exhibitor add on product based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a exhibitor add on product from the system by its ID.", "tags": [ "Exhibitor Add On Products" ] }, "get": { "description": "This method will look up a exhibitor add on product by the specified ID and return it back.", "operationId": "getExhibitorAddOnProduct", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor add on product to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorAddOnProduct" } } }, "description": "The exhibitor add on product was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor add on product could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor add on product based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a exhibitor add on product from the system by its ID.", "tags": [ "Exhibitor Add On Products" ] }, "patch": { "description": "This method will patch an existing exhibitor add on product with the specified ID, using the HTTP PATCH specification.", "operationId": "patchExhibitorAddOnProduct", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor add on product to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorAddOnProduct" } } }, "description": "The exhibitor add on product was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor add on product could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor add on product could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor add on product based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a exhibitor add on product with the specified ID.", "tags": [ "Exhibitor Add On Products" ] }, "put": { "description": "This method will update an existing exhibitor add on product with the specified ID.", "operationId": "updateExhibitorAddOnProduct", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor add on product to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorAddOnProduct" } } }, "description": "The updated exhibitor add on product that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorAddOnProduct" } } }, "description": "The exhibitor add on product was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The exhibitor add on product supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor add on product could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor add on product could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor add on product based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a exhibitor add on product with the specified ID.", "tags": [ "Exhibitor Add On Products" ] } }, "/exhibitorBoothFees/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new exhibitor booth fee. If an ID is specified for the exhibitor booth fee, an error will be thrown.", "operationId": "createExhibitorBoothFee", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorBoothFee" } } }, "description": "The exhibitor booth fee that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorBoothFee" } } }, "description": "The exhibitor booth fee was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The exhibitor booth fee you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor booth fee could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add exhibitor booth fee based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new exhibitor booth fee record that does not already exist.", "tags": [ "Exhibitor Booth Fees" ] } }, "/exhibitorBoothFees/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor booth fee could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor booth fee based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Exhibitor Booth Fees" ] } }, "/exhibitorBoothFees/{tenantId}/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listFeesByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListExhibitorBoothFeesResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_id", "tags": [ "Exhibitor Booth Fees" ] } }, "/exhibitorBoothFees/{tenantId}/{id}": { "delete": { "description": "This method will delete a exhibitor booth fee with the specified ID.", "operationId": "deleteExhibitorBoothFee", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor booth fee to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The exhibitor booth fee was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor booth fee could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor booth fee could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete exhibitor booth fee based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a exhibitor booth fee from the system by its ID.", "tags": [ "Exhibitor Booth Fees" ] }, "get": { "description": "This method will look up a exhibitor booth fee by the specified ID and return it back.", "operationId": "getExhibitorBoothFee", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor booth fee to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorBoothFee" } } }, "description": "The exhibitor booth fee was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor booth fee could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor booth fee based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a exhibitor booth fee from the system by its ID.", "tags": [ "Exhibitor Booth Fees" ] }, "patch": { "description": "This method will patch an existing exhibitor booth fee with the specified ID, using the HTTP PATCH specification.", "operationId": "patchExhibitorBoothFee", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor booth fee to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorBoothFee" } } }, "description": "The exhibitor booth fee was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor booth fee could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor booth fee could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor booth fee based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a exhibitor booth fee with the specified ID.", "tags": [ "Exhibitor Booth Fees" ] }, "put": { "description": "This method will update an existing exhibitor booth fee with the specified ID.", "operationId": "updateExhibitorBoothFee", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor booth fee to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorBoothFee" } } }, "description": "The updated exhibitor booth fee that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorBoothFee" } } }, "description": "The exhibitor booth fee was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The exhibitor booth fee supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor booth fee could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor booth fee could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor booth fee based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a exhibitor booth fee with the specified ID.", "tags": [ "Exhibitor Booth Fees" ] } }, "/exhibitorBoothTypes/{tenantId}": { "get": { "description": "This method will scan all exhibitor booth types and and return them to the caller.", "operationId": "listExhibitorBoothTypes", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key, if you're making a subsequent request", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ExhibitorBoothType" }, "type": "array" } } }, "description": "The exhibitor booth typeswere retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add contact role based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Gets all of the exhibitor booth types in the system.", "tags": [ "Exhibitor Booth Types" ] }, "post": { "description": "This method will auto-generate an ID and create a new exhibitor booth type. If an ID is specified for the exhibitor booth type, an error will be thrown.", "operationId": "createExhibitorBoothType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorBoothType" } } }, "description": "The exhibitor booth type that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorBoothType" } } }, "description": "The exhibitor booth type was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The exhibitor booth type you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor booth type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add exhibitor booth type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new exhibitor booth type record that does not already exist.", "tags": [ "Exhibitor Booth Types" ] } }, "/exhibitorBoothTypes/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor booth type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor booth type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Exhibitor Booth Types" ] } }, "/exhibitorBoothTypes/{tenantId}/{id}": { "delete": { "description": "This method will delete a exhibitor booth type with the specified ID.", "operationId": "deleteExhibitorBoothType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor booth type to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The exhibitor booth type was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor booth type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor booth type could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete exhibitor booth type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a exhibitor booth type from the system by its ID.", "tags": [ "Exhibitor Booth Types" ] }, "get": { "description": "This method will look up a exhibitor booth type by the specified ID and return it back.", "operationId": "getExhibitorBoothType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor booth type to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorBoothType" } } }, "description": "The exhibitor booth type was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor booth type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor booth type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a exhibitor booth type from the system by its ID.", "tags": [ "Exhibitor Booth Types" ] }, "patch": { "description": "This method will patch an existing exhibitor booth type with the specified ID, using the HTTP PATCH specification.", "operationId": "patchExhibitorBoothType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor booth type to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorBoothType" } } }, "description": "The exhibitor booth type was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor booth type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor booth type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor booth type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a exhibitor booth type with the specified ID.", "tags": [ "Exhibitor Booth Types" ] }, "put": { "description": "This method will update an existing exhibitor booth type with the specified ID.", "operationId": "updateExhibitorBoothType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor booth type to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorBoothType" } } }, "description": "The updated exhibitor booth type that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorBoothType" } } }, "description": "The exhibitor booth type was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The exhibitor booth type supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor booth type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor booth type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor booth type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a exhibitor booth type with the specified ID.", "tags": [ "Exhibitor Booth Types" ] } }, "/exhibitorBooths/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new exhibitor booth. If an ID is specified for the exhibitor booth, an error will be thrown.", "operationId": "createExhibitorBooth", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorBooth" } } }, "description": "The exhibitor booth that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorBooth" } } }, "description": "The exhibitor booth was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The exhibitor booth you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor booth could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add exhibitor booth based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new exhibitor booth record that does not already exist.", "tags": [ "Exhibitor Booths" ] } }, "/exhibitorBooths/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor booth could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor booth based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Exhibitor Booths" ] } }, "/exhibitorBooths/{tenantId}/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listBoothsByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListExhibitorBoothsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_id", "tags": [ "Exhibitor Booths" ] } }, "/exhibitorBooths/{tenantId}/exhibitor/{exhibitor_id}": { "get": { "description": "Returns a list of records with the specified exhibitor_id", "operationId": "listBoothsByExhibitorId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "exhibitor_id", "required": true, "description": "The exhibitor_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListExhibitorBoothsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified exhibitor_id", "tags": [ "Exhibitor Booths" ] } }, "/exhibitorBooths/{tenantId}/holdingOrganization/{event_id}/{holding_organization_id}": { "get": { "description": "Returns a list of records with the specified holding_organization_id", "operationId": "listBoothsByHoldingOrganizationId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event", "schema": { "type": "string" } }, { "in": "path", "name": "holding_organization_id", "required": true, "description": "The holding_organization_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListExhibitorBoothsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified holding_organization_id", "tags": [ "Exhibitor Booths" ] } }, "/exhibitorBooths/{tenantId}/multiple/{numberToGenerate}": { "post": { "description": "Generates up to 250 booths", "operationId": "generateMultipleBooths", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "numberToGenerate", "required": true, "description": "The numbr of booths to generate", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorBooth" } } }, "description": "The event_id to use to for record lookup", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorBoothGenerationResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Generate multiple booths", "tags": [ "Exhibitor Booths" ] } }, "/exhibitorBooths/{tenantId}/organization/{organization_id}": { "get": { "description": "Returns a list of records with the specified organization_id", "operationId": "listBoothsByOrganizationId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "organization_id", "required": true, "description": "The organization_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListExhibitorBoothsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified organization_id", "tags": [ "Exhibitor Booths" ] } }, "/exhibitorBooths/{tenantId}/public/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listPublicBoothsByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListExhibitorBoothsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "summary": "Returns a list of records with the specified event_id", "tags": [ "Exhibitor Booths" ] } }, "/exhibitorBooths/{tenantId}/public/exhibitor/{exhibitor_id}": { "get": { "description": "Returns a list of records with the specified exhibitor_id", "operationId": "listPublicBoothsByExhibitorId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "exhibitor_id", "required": true, "description": "The exhibitor_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListExhibitorBoothsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "summary": "Returns a list of records with the specified exhibitor_id", "tags": [ "Exhibitor Booths" ] } }, "/exhibitorBooths/{tenantId}/{id}": { "delete": { "description": "This method will delete a exhibitor booth with the specified ID.", "operationId": "deleteExhibitorBooth", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor booth to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The exhibitor booth was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor booth could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor booth could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete exhibitor booth based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a exhibitor booth from the system by its ID.", "tags": [ "Exhibitor Booths" ] }, "get": { "description": "This method will look up a exhibitor booth by the specified ID and return it back.", "operationId": "getExhibitorBooth", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor booth to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorBooth" } } }, "description": "The exhibitor booth was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor booth could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor booth based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a exhibitor booth from the system by its ID.", "tags": [ "Exhibitor Booths" ] }, "patch": { "description": "This method will patch an existing exhibitor booth with the specified ID, using the HTTP PATCH specification.", "operationId": "patchExhibitorBooth", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor booth to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorBooth" } } }, "description": "The exhibitor booth was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor booth could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor booth could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor booth based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a exhibitor booth with the specified ID.", "tags": [ "Exhibitor Booths" ] }, "put": { "description": "This method will update an existing exhibitor booth with the specified ID.", "operationId": "updateExhibitorBooth", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor booth to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorBooth" } } }, "description": "The updated exhibitor booth that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorBooth" } } }, "description": "The exhibitor booth was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The exhibitor booth supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor booth could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor booth could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor booth based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a exhibitor booth with the specified ID.", "tags": [ "Exhibitor Booths" ] } }, "/exhibitorCategories/{tenantId}": { "get": { "description": "This method will scan all exhibitor categories and and return them to the caller.", "operationId": "listExhibitorCategories", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key, if you're making a subsequent request", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ExhibitorCategory" }, "type": "array" } } }, "description": "The exhibitor categorieswere retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add contact role based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Gets all of the exhibitor categories in the system.", "tags": [ "Exhibitor Categories" ] }, "post": { "description": "This method will auto-generate an ID and create a new exhibitor category. If an ID is specified for the exhibitor category, an error will be thrown.", "operationId": "createExhibitorCategory", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorCategory" } } }, "description": "The exhibitor category that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorCategory" } } }, "description": "The exhibitor category was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The exhibitor category you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor category could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add exhibitor category based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new exhibitor category record that does not already exist.", "tags": [ "Exhibitor Categories" ] } }, "/exhibitorCategories/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor category could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor category based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Exhibitor Categories" ] } }, "/exhibitorCategories/{tenantId}/{id}": { "delete": { "description": "This method will delete a exhibitor category with the specified ID.", "operationId": "deleteExhibitorCategory", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor category to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The exhibitor category was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor category could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor category could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete exhibitor category based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a exhibitor category from the system by its ID.", "tags": [ "Exhibitor Categories" ] }, "get": { "description": "This method will look up a exhibitor category by the specified ID and return it back.", "operationId": "getExhibitorCategory", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor category to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorCategory" } } }, "description": "The exhibitor category was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor category could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor category based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a exhibitor category from the system by its ID.", "tags": [ "Exhibitor Categories" ] }, "patch": { "description": "This method will patch an existing exhibitor category with the specified ID, using the HTTP PATCH specification.", "operationId": "patchExhibitorCategory", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor category to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorCategory" } } }, "description": "The exhibitor category was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor category could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor category could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor category based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a exhibitor category with the specified ID.", "tags": [ "Exhibitor Categories" ] }, "put": { "description": "This method will update an existing exhibitor category with the specified ID.", "operationId": "updateExhibitorCategory", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor category to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorCategory" } } }, "description": "The updated exhibitor category that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorCategory" } } }, "description": "The exhibitor category was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The exhibitor category supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor category could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor category could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor category based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a exhibitor category with the specified ID.", "tags": [ "Exhibitor Categories" ] } }, "/exhibitorContactTypes/{tenantId}": { "get": { "description": "This method will scan all exhibitor contact types and and return them to the caller.", "operationId": "listExhibitorContactTypes", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key, if you're making a subsequent request", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ExhibitorContactType" }, "type": "array" } } }, "description": "The exhibitor contact typeswere retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add contact role based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Gets all of the exhibitor contact types in the system.", "tags": [ "Exhibitor Contact Types" ] }, "post": { "description": "This method will auto-generate an ID and create a new exhibitor contact type. If an ID is specified for the exhibitor contact type, an error will be thrown.", "operationId": "createExhibitorContactType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorContactType" } } }, "description": "The exhibitor contact type that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorContactType" } } }, "description": "The exhibitor contact type was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The exhibitor contact type you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor contact type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add exhibitor contact type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new exhibitor contact type record that does not already exist.", "tags": [ "Exhibitor Contact Types" ] } }, "/exhibitorContactTypes/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor contact type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor contact type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Exhibitor Contact Types" ] } }, "/exhibitorContactTypes/{tenantId}/{id}": { "delete": { "description": "This method will delete a exhibitor contact type with the specified ID.", "operationId": "deleteExhibitorContactType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor contact type to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The exhibitor contact type was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor contact type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor contact type could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete exhibitor contact type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a exhibitor contact type from the system by its ID.", "tags": [ "Exhibitor Contact Types" ] }, "get": { "description": "This method will look up a exhibitor contact type by the specified ID and return it back.", "operationId": "getExhibitorContactType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor contact type to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorContactType" } } }, "description": "The exhibitor contact type was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor contact type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor contact type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a exhibitor contact type from the system by its ID.", "tags": [ "Exhibitor Contact Types" ] }, "patch": { "description": "This method will patch an existing exhibitor contact type with the specified ID, using the HTTP PATCH specification.", "operationId": "patchExhibitorContactType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor contact type to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorContactType" } } }, "description": "The exhibitor contact type was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor contact type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor contact type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor contact type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a exhibitor contact type with the specified ID.", "tags": [ "Exhibitor Contact Types" ] }, "put": { "description": "This method will update an existing exhibitor contact type with the specified ID.", "operationId": "updateExhibitorContactType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor contact type to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorContactType" } } }, "description": "The updated exhibitor contact type that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorContactType" } } }, "description": "The exhibitor contact type was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The exhibitor contact type supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor contact type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor contact type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor contact type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a exhibitor contact type with the specified ID.", "tags": [ "Exhibitor Contact Types" ] } }, "/exhibitorPriorityPointTypes/{tenantId}": { "get": { "description": "This method will scan all exhibitor priority point types and and return them to the caller.", "operationId": "listExhibitorPriorityPointTypes", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key, if you're making a subsequent request", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ExhibitorPriorityPointType" }, "type": "array" } } }, "description": "The exhibitor priority point typeswere retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add contact role based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Gets all of the exhibitor priority point types in the system.", "tags": [ "Exhibitor Priority Point Types" ] }, "post": { "description": "This method will auto-generate an ID and create a new exhibitor priority point type. If an ID is specified for the exhibitor priority point type, an error will be thrown.", "operationId": "createExhibitorPriorityPointType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorPriorityPointType" } } }, "description": "The exhibitor priority point type that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorPriorityPointType" } } }, "description": "The exhibitor priority point type was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The exhibitor priority point type you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor priority point type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add exhibitor priority point type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new exhibitor priority point type record that does not already exist.", "tags": [ "Exhibitor Priority Point Types" ] } }, "/exhibitorPriorityPointTypes/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor priority point type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor priority point type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Exhibitor Priority Point Types" ] } }, "/exhibitorPriorityPointTypes/{tenantId}/{id}": { "delete": { "description": "This method will delete a exhibitor priority point type with the specified ID.", "operationId": "deleteExhibitorPriorityPointType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor priority point type to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The exhibitor priority point type was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor priority point type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor priority point type could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete exhibitor priority point type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a exhibitor priority point type from the system by its ID.", "tags": [ "Exhibitor Priority Point Types" ] }, "get": { "description": "This method will look up a exhibitor priority point type by the specified ID and return it back.", "operationId": "getExhibitorPriorityPointType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor priority point type to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorPriorityPointType" } } }, "description": "The exhibitor priority point type was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor priority point type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor priority point type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a exhibitor priority point type from the system by its ID.", "tags": [ "Exhibitor Priority Point Types" ] }, "patch": { "description": "This method will patch an existing exhibitor priority point type with the specified ID, using the HTTP PATCH specification.", "operationId": "patchExhibitorPriorityPointType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor priority point type to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorPriorityPointType" } } }, "description": "The exhibitor priority point type was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor priority point type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor priority point type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor priority point type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a exhibitor priority point type with the specified ID.", "tags": [ "Exhibitor Priority Point Types" ] }, "put": { "description": "This method will update an existing exhibitor priority point type with the specified ID.", "operationId": "updateExhibitorPriorityPointType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor priority point type to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorPriorityPointType" } } }, "description": "The updated exhibitor priority point type that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorPriorityPointType" } } }, "description": "The exhibitor priority point type was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The exhibitor priority point type supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor priority point type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor priority point type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor priority point type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a exhibitor priority point type with the specified ID.", "tags": [ "Exhibitor Priority Point Types" ] } }, "/exhibitorRegProcesses/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new exhibitor reg process. If an ID is specified for the exhibitor reg process, an error will be thrown.", "operationId": "createExhibitorRegProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorRegProcess" } } }, "description": "The exhibitor reg process that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorRegProcess" } } }, "description": "The exhibitor reg process was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The exhibitor reg process you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor reg process could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add exhibitor reg process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new exhibitor reg process record that does not already exist.", "tags": [ "Exhibitor Reg Processes" ] } }, "/exhibitorRegProcesses/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor reg process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor reg process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Exhibitor Reg Processes" ] } }, "/exhibitorRegProcesses/{tenantId}/eligible/{eventId}/{organizationId}": { "get": { "operationId": "getEligibleProcesses", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed", "schema": { "type": "string" } }, { "in": "path", "name": "eventId", "required": true, "description": "The event", "schema": { "type": "string" } }, { "in": "path", "name": "organizationId", "required": true, "description": "The organization", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ExhibitorRegProcess" }, "type": "array" } } }, "description": "Processes were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The search you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add order based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Get eligible processes", "tags": [ "Exhibitor Reg Processes" ] } }, "/exhibitorRegProcesses/{tenantId}/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listProcessesByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListExhibitorRegProcessesResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_id", "tags": [ "Exhibitor Reg Processes" ] } }, "/exhibitorRegProcesses/{tenantId}/{id}": { "delete": { "description": "This method will delete a exhibitor reg process with the specified ID.", "operationId": "deleteExhibitorRegProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor reg process to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The exhibitor reg process was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor reg process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor reg process could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete exhibitor reg process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a exhibitor reg process from the system by its ID.", "tags": [ "Exhibitor Reg Processes" ] }, "get": { "description": "This method will look up a exhibitor reg process by the specified ID and return it back.", "operationId": "getExhibitorRegProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor reg process to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorRegProcess" } } }, "description": "The exhibitor reg process was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor reg process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor reg process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a exhibitor reg process from the system by its ID.", "tags": [ "Exhibitor Reg Processes" ] }, "patch": { "description": "This method will patch an existing exhibitor reg process with the specified ID, using the HTTP PATCH specification.", "operationId": "patchExhibitorRegProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor reg process to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorRegProcess" } } }, "description": "The exhibitor reg process was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor reg process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor reg process could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor reg process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a exhibitor reg process with the specified ID.", "tags": [ "Exhibitor Reg Processes" ] }, "put": { "description": "This method will update an existing exhibitor reg process with the specified ID.", "operationId": "updateExhibitorRegProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor reg process to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorRegProcess" } } }, "description": "The updated exhibitor reg process that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorRegProcess" } } }, "description": "The exhibitor reg process was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The exhibitor reg process supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor reg process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor reg process could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor reg process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a exhibitor reg process with the specified ID.", "tags": [ "Exhibitor Reg Processes" ] } }, "/exhibitorRegistrations/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new exhibitor registration. If an ID is specified for the exhibitor registration, an error will be thrown.", "operationId": "createExhibitorRegistration", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorRegistration" } } }, "description": "The exhibitor registration that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorRegistration" } } }, "description": "The exhibitor registration was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The exhibitor registration you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor registration could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add exhibitor registration based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new exhibitor registration record that does not already exist.", "tags": [ "Exhibitor Registrations" ] } }, "/exhibitorRegistrations/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor registration could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor registration based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Exhibitor Registrations" ] } }, "/exhibitorRegistrations/{tenantId}/exhibitor/{exhibitor_id}": { "get": { "description": "Returns a list of records with the specified exhibitor_id", "operationId": "listRegistrationsByExhibitorId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "exhibitor_id", "required": true, "description": "The exhibitor_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListExhibitorRegistrationsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified exhibitor_id", "tags": [ "Exhibitor Registrations" ] } }, "/exhibitorRegistrations/{tenantId}/generateOrder": { "post": { "description": "This method will examine an event registration and generate an appropriate order", "operationId": "generateOrder", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorRegistration" } } }, "description": "The application to generate an order", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorRegistration" } } }, "description": "Conflicts were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The search you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add order based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Generates an order from an exhibitor registration", "tags": [ "Exhibitor Registrations" ] } }, "/exhibitorRegistrations/{tenantId}/order/{order_id}": { "get": { "description": "Returns a list of records with the specified order_id", "operationId": "listRegistrationsByOrderId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "order_id", "required": true, "description": "The order_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListExhibitorRegistrationsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified order_id", "tags": [ "Exhibitor Registrations" ] } }, "/exhibitorRegistrations/{tenantId}/organization/{organization_id}": { "get": { "description": "Returns a list of records with the specified organization_id", "operationId": "listRegistrationsByOrganizationId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "organization_id", "required": true, "description": "The organization_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListExhibitorRegistrationsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified organization_id", "tags": [ "Exhibitor Registrations" ] } }, "/exhibitorRegistrations/{tenantId}/validateAddOns": { "post": { "description": "Returns a list of records with the specified organization_id", "operationId": "validateAddOns", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorRegistration" } } }, "description": "The organization_id to use to for record lookup", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateAddOnsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Validate Add Ons", "tags": [ "Exhibitor Registrations" ] } }, "/exhibitorRegistrations/{tenantId}/{id}": { "delete": { "description": "This method will delete a exhibitor registration with the specified ID.", "operationId": "deleteExhibitorRegistration", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor registration to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The exhibitor registration was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor registration could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor registration could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete exhibitor registration based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a exhibitor registration from the system by its ID.", "tags": [ "Exhibitor Registrations" ] }, "get": { "description": "This method will look up a exhibitor registration by the specified ID and return it back.", "operationId": "getExhibitorRegistration", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor registration to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorRegistration" } } }, "description": "The exhibitor registration was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor registration could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor registration based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a exhibitor registration from the system by its ID.", "tags": [ "Exhibitor Registrations" ] }, "patch": { "description": "This method will patch an existing exhibitor registration with the specified ID, using the HTTP PATCH specification.", "operationId": "patchExhibitorRegistration", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor registration to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorRegistration" } } }, "description": "The exhibitor registration was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor registration could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor registration could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor registration based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a exhibitor registration with the specified ID.", "tags": [ "Exhibitor Registrations" ] }, "put": { "description": "This method will update an existing exhibitor registration with the specified ID.", "operationId": "updateExhibitorRegistration", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor registration to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorRegistration" } } }, "description": "The updated exhibitor registration that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorRegistration" } } }, "description": "The exhibitor registration was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The exhibitor registration supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor registration could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor registration could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor registration based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a exhibitor registration with the specified ID.", "tags": [ "Exhibitor Registrations" ] } }, "/exhibitorSettings/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new exhibitor setting. If an ID is specified for the exhibitor setting, an error will be thrown.", "operationId": "createExhibitorSetting", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorSetting" } } }, "description": "The exhibitor setting that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorSetting" } } }, "description": "The exhibitor setting was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The exhibitor setting you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor setting could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add exhibitor setting based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new exhibitor setting record that does not already exist.", "tags": [ "Exhibitor Settings" ] } }, "/exhibitorSettings/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor setting could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor setting based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Exhibitor Settings" ] } }, "/exhibitorSettings/{tenantId}/{id}": { "delete": { "description": "This method will delete a exhibitor setting with the specified ID.", "operationId": "deleteExhibitorSetting", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor setting to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The exhibitor setting was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor setting could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor setting could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete exhibitor setting based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a exhibitor setting from the system by its ID.", "tags": [ "Exhibitor Settings" ] }, "get": { "description": "This method will look up a exhibitor setting by the specified ID and return it back.", "operationId": "getExhibitorSetting", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor setting to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorSetting" } } }, "description": "The exhibitor setting was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor setting could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor setting based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a exhibitor setting from the system by its ID.", "tags": [ "Exhibitor Settings" ] }, "patch": { "description": "This method will patch an existing exhibitor setting with the specified ID, using the HTTP PATCH specification.", "operationId": "patchExhibitorSetting", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor setting to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorSetting" } } }, "description": "The exhibitor setting was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor setting could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor setting could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor setting based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a exhibitor setting with the specified ID.", "tags": [ "Exhibitor Settings" ] }, "put": { "description": "This method will update an existing exhibitor setting with the specified ID.", "operationId": "updateExhibitorSetting", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor setting to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorSetting" } } }, "description": "The updated exhibitor setting that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorSetting" } } }, "description": "The exhibitor setting was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The exhibitor setting supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor setting could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor setting could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor setting based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a exhibitor setting with the specified ID.", "tags": [ "Exhibitor Settings" ] } }, "/exhibitorShowFloors/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new exhibitor show floor. If an ID is specified for the exhibitor show floor, an error will be thrown.", "operationId": "createExhibitorShowFloor", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorShowFloor" } } }, "description": "The exhibitor show floor that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorShowFloor" } } }, "description": "The exhibitor show floor was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The exhibitor show floor you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor show floor could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add exhibitor show floor based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new exhibitor show floor record that does not already exist.", "tags": [ "Exhibitor Show Floors" ] } }, "/exhibitorShowFloors/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor show floor could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor show floor based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Exhibitor Show Floors" ] } }, "/exhibitorShowFloors/{tenantId}/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listFloorsByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListExhibitorShowFloorsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_id", "tags": [ "Exhibitor Show Floors" ] } }, "/exhibitorShowFloors/{tenantId}/{id}": { "delete": { "description": "This method will delete a exhibitor show floor with the specified ID.", "operationId": "deleteExhibitorShowFloor", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor show floor to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The exhibitor show floor was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor show floor could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor show floor could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete exhibitor show floor based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a exhibitor show floor from the system by its ID.", "tags": [ "Exhibitor Show Floors" ] }, "get": { "description": "This method will look up a exhibitor show floor by the specified ID and return it back.", "operationId": "getExhibitorShowFloor", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor show floor to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorShowFloor" } } }, "description": "The exhibitor show floor was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor show floor could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor show floor based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a exhibitor show floor from the system by its ID.", "tags": [ "Exhibitor Show Floors" ] }, "patch": { "description": "This method will patch an existing exhibitor show floor with the specified ID, using the HTTP PATCH specification.", "operationId": "patchExhibitorShowFloor", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor show floor to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorShowFloor" } } }, "description": "The exhibitor show floor was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor show floor could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor show floor could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor show floor based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a exhibitor show floor with the specified ID.", "tags": [ "Exhibitor Show Floors" ] }, "put": { "description": "This method will update an existing exhibitor show floor with the specified ID.", "operationId": "updateExhibitorShowFloor", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor show floor to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorShowFloor" } } }, "description": "The updated exhibitor show floor that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhibitorShowFloor" } } }, "description": "The exhibitor show floor was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The exhibitor show floor supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor show floor could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor show floor could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor show floor based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a exhibitor show floor with the specified ID.", "tags": [ "Exhibitor Show Floors" ] } }, "/exhibitors/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new exhibitor. If an ID is specified for the exhibitor, an error will be thrown.", "operationId": "createExhibitor", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Exhibitor" } } }, "description": "The exhibitor that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Exhibitor" } } }, "description": "The exhibitor was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The exhibitor you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add exhibitor based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new exhibitor record that does not already exist.", "tags": [ "Exhibitors" ] } }, "/exhibitors/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Exhibitors" ] } }, "/exhibitors/{tenantId}/contactAllowance": { "post": { "description": "Applies the contact rule restrictions in exhibitor settings and determines how many contacts of each type an exhibitor is allowed to have", "operationId": "getContactAllowanceForExhibitorRegistration", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "The exhibitor registration", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactAllowanceResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Gets the allowed number of contacts for an exhibitor registration", "tags": [ "Exhibitors" ] } }, "/exhibitors/{tenantId}/contactAllowance/{id}": { "get": { "description": "Applies the contact rule restrictions in exhibitor settings and determines how many contacts of each type an exhibitor is allowed to have", "operationId": "getContactAllowance", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The exhibitor ID", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactAllowanceResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Gets the allowed number of contacts for an exhibitor", "tags": [ "Exhibitors" ] } }, "/exhibitors/{tenantId}/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listExhibitorsByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListExhibitorsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_id", "tags": [ "Exhibitors" ] } }, "/exhibitors/{tenantId}/organization/{organization_id}": { "get": { "description": "Returns a list of records with the specified organization_id", "operationId": "listExhibitorsByOrganizationId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "organization_id", "required": true, "description": "The organization_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListExhibitorsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified organization_id", "tags": [ "Exhibitors" ] } }, "/exhibitors/{tenantId}/public/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listPublicExhibitorsByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListExhibitorsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "summary": "Returns a list of records with the specified event_id", "tags": [ "Exhibitors" ] } }, "/exhibitors/{tenantId}/{id}": { "delete": { "description": "This method will delete a exhibitor with the specified ID.", "operationId": "deleteExhibitor", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The exhibitor was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete exhibitor based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a exhibitor from the system by its ID.", "tags": [ "Exhibitors" ] }, "get": { "description": "This method will look up a exhibitor by the specified ID and return it back.", "operationId": "getExhibitor", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Exhibitor" } } }, "description": "The exhibitor was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a exhibitor from the system by its ID.", "tags": [ "Exhibitors" ] }, "patch": { "description": "This method will patch an existing exhibitor with the specified ID, using the HTTP PATCH specification.", "operationId": "patchExhibitor", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Exhibitor" } } }, "description": "The exhibitor was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a exhibitor with the specified ID.", "tags": [ "Exhibitors" ] }, "put": { "description": "This method will update an existing exhibitor with the specified ID.", "operationId": "updateExhibitor", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the exhibitor to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Exhibitor" } } }, "description": "The updated exhibitor that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Exhibitor" } } }, "description": "The exhibitor was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The exhibitor supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The exhibitor could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The exhibitor could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve exhibitor based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a exhibitor with the specified ID.", "tags": [ "Exhibitors" ] } }, "/functionFees/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new function fee. If an ID is specified for the function fee, an error will be thrown.", "operationId": "createFunctionFee", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FunctionFee" } } }, "description": "The function fee that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FunctionFee" } } }, "description": "The function fee was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The function fee you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The function fee could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add function fee based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new function fee record that does not already exist.", "tags": [ "Function Fees" ] } }, "/functionFees/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The function fee could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve function fee based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Function Fees" ] } }, "/functionFees/{tenantId}/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listFeesByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListFunctionFeesResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_id", "tags": [ "Function Fees" ] } }, "/functionFees/{tenantId}/function/{function_id}": { "get": { "description": "Returns a list of records with the specified function_id", "operationId": "listFeesByFunctionId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "function_id", "required": true, "description": "The function_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListFunctionFeesResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified function_id", "tags": [ "Function Fees" ] } }, "/functionFees/{tenantId}/{id}": { "delete": { "description": "This method will delete a function fee with the specified ID.", "operationId": "deleteFunctionFee", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the function fee to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The function fee was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The function fee could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The function fee could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete function fee based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a function fee from the system by its ID.", "tags": [ "Function Fees" ] }, "get": { "description": "This method will look up a function fee by the specified ID and return it back.", "operationId": "getFunctionFee", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the function fee to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FunctionFee" } } }, "description": "The function fee was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The function fee could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve function fee based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a function fee from the system by its ID.", "tags": [ "Function Fees" ] }, "patch": { "description": "This method will patch an existing function fee with the specified ID, using the HTTP PATCH specification.", "operationId": "patchFunctionFee", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the function fee to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FunctionFee" } } }, "description": "The function fee was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The function fee could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The function fee could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve function fee based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a function fee with the specified ID.", "tags": [ "Function Fees" ] }, "put": { "description": "This method will update an existing function fee with the specified ID.", "operationId": "updateFunctionFee", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the function fee to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FunctionFee" } } }, "description": "The updated function fee that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FunctionFee" } } }, "description": "The function fee was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The function fee supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The function fee could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The function fee could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve function fee based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a function fee with the specified ID.", "tags": [ "Function Fees" ] } }, "/functionTickets/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new function ticket. If an ID is specified for the function ticket, an error will be thrown.", "operationId": "createFunctionTicket", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FunctionTicket" } } }, "description": "The function ticket that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FunctionTicket" } } }, "description": "The function ticket was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The function ticket you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The function ticket could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add function ticket based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new function ticket record that does not already exist.", "tags": [ "Function Tickets" ] } }, "/functionTickets/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The function ticket could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve function ticket based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Function Tickets" ] } }, "/functionTickets/{tenantId}/eventContact/{eventId}/{idOfContact}": { "get": { "description": "Returns a list of records with the specified event_contact_id", "operationId": "listTicketForContactAndEvent", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "eventId", "required": true, "description": "The event", "schema": { "type": "string" } }, { "in": "path", "name": "idOfContact", "required": true, "description": "The contact id", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListFunctionTicketsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_contact_id", "tags": [ "Function Tickets" ] } }, "/functionTickets/{tenantId}/function/{function_id}": { "get": { "description": "Returns a list of records with the specified function_id", "operationId": "listTicketsByFunctionId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "function_id", "required": true, "description": "The function_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListFunctionTicketsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified function_id", "tags": [ "Function Tickets" ] } }, "/functionTickets/{tenantId}/{id}": { "delete": { "description": "This method will delete a function ticket with the specified ID.", "operationId": "deleteFunctionTicket", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the function ticket to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The function ticket was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The function ticket could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The function ticket could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete function ticket based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a function ticket from the system by its ID.", "tags": [ "Function Tickets" ] }, "get": { "description": "This method will look up a function ticket by the specified ID and return it back.", "operationId": "getFunctionTicket", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the function ticket to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FunctionTicket" } } }, "description": "The function ticket was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The function ticket could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve function ticket based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a function ticket from the system by its ID.", "tags": [ "Function Tickets" ] }, "patch": { "description": "This method will patch an existing function ticket with the specified ID, using the HTTP PATCH specification.", "operationId": "patchFunctionTicket", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the function ticket to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FunctionTicket" } } }, "description": "The function ticket was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The function ticket could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The function ticket could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve function ticket based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a function ticket with the specified ID.", "tags": [ "Function Tickets" ] }, "put": { "description": "This method will update an existing function ticket with the specified ID.", "operationId": "updateFunctionTicket", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the function ticket to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FunctionTicket" } } }, "description": "The updated function ticket that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FunctionTicket" } } }, "description": "The function ticket was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The function ticket supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The function ticket could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The function ticket could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve function ticket based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a function ticket with the specified ID.", "tags": [ "Function Tickets" ] } }, "/functionTypes/{tenantId}": { "get": { "description": "This method will scan all function types and and return them to the caller.", "operationId": "listFunctionTypes", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key, if you're making a subsequent request", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/FunctionType" }, "type": "array" } } }, "description": "The function typeswere retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add contact role based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Gets all of the function types in the system.", "tags": [ "Function Types" ] }, "post": { "description": "This method will auto-generate an ID and create a new function type. If an ID is specified for the function type, an error will be thrown.", "operationId": "createFunctionType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FunctionType" } } }, "description": "The function type that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FunctionType" } } }, "description": "The function type was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The function type you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The function type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add function type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new function type record that does not already exist.", "tags": [ "Function Types" ] } }, "/functionTypes/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The function type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve function type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Function Types" ] } }, "/functionTypes/{tenantId}/public": { "get": { "description": "This method will scan all function types and and return them to the caller.", "operationId": "listFunctionTypesPublic", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key, if you're making a subsequent request", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/FunctionType" }, "type": "array" } } }, "description": "The function typeswere retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add contact role based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "summary": "Gets all of the function types in the system.", "tags": [ "Function Types" ] } }, "/functionTypes/{tenantId}/{id}": { "delete": { "description": "This method will delete a function type with the specified ID.", "operationId": "deleteFunctionType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the function type to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The function type was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The function type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The function type could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete function type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a function type from the system by its ID.", "tags": [ "Function Types" ] }, "get": { "description": "This method will look up a function type by the specified ID and return it back.", "operationId": "getFunctionType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the function type to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FunctionType" } } }, "description": "The function type was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The function type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve function type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a function type from the system by its ID.", "tags": [ "Function Types" ] }, "patch": { "description": "This method will patch an existing function type with the specified ID, using the HTTP PATCH specification.", "operationId": "patchFunctionType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the function type to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FunctionType" } } }, "description": "The function type was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The function type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The function type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve function type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a function type with the specified ID.", "tags": [ "Function Types" ] }, "put": { "description": "This method will update an existing function type with the specified ID.", "operationId": "updateFunctionType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the function type to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FunctionType" } } }, "description": "The updated function type that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FunctionType" } } }, "description": "The function type was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The function type supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The function type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The function type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve function type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a function type with the specified ID.", "tags": [ "Function Types" ] } }, "/functions/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new function. If an ID is specified for the function, an error will be thrown.", "operationId": "createFunction", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Function" } } }, "description": "The function that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Function" } } }, "description": "The function was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The function you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The function could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add function based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new function record that does not already exist.", "tags": [ "Functions" ] } }, "/functions/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The function could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve function based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Functions" ] } }, "/functions/{tenantId}/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listFunctionsByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListFunctionsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_id", "tags": [ "Functions" ] } }, "/functions/{tenantId}/public/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "describeFunctionsForEvent", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DescribeFunctionsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "summary": "Describes all of the functions for an event", "tags": [ "Functions" ] } }, "/functions/{tenantId}/public/{id}": { "get": { "description": "This method will look up a function by the specified ID and return it back.", "operationId": "publicGetFunction", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the function to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Function" } } }, "description": "The function was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The function could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve function based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "summary": "Returns a function from the system by its ID.", "tags": [ "Functions" ] } }, "/functions/{tenantId}/search": { "post": { "description": "Searches for functions using predefined parameters", "operationId": "searchForFunctions", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key for the search, for paging support", "schema": { "type": "string" } }, { "in": "query", "name": "fieldsToReturn", "required": false, "description": " The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FunctionSearchParameters" } } }, "description": "The function that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedFunctionSearchResults" } } }, "description": "The function search was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The function you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The function could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add function based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Searches for functions using predefined parameters", "tags": [ "Functions" ] } }, "/functions/{tenantId}/{id}": { "delete": { "description": "This method will delete a function with the specified ID.", "operationId": "deleteFunction", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the function to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The function was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The function could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The function could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete function based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a function from the system by its ID.", "tags": [ "Functions" ] }, "get": { "description": "This method will look up a function by the specified ID and return it back.", "operationId": "getFunction", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the function to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Function" } } }, "description": "The function was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The function could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve function based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a function from the system by its ID.", "tags": [ "Functions" ] }, "patch": { "description": "This method will patch an existing function with the specified ID, using the HTTP PATCH specification.", "operationId": "patchFunction", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the function to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Function" } } }, "description": "The function was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The function could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The function could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve function based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a function with the specified ID.", "tags": [ "Functions" ] }, "put": { "description": "This method will update an existing function with the specified ID.", "operationId": "updateFunction", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the function to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Function" } } }, "description": "The updated function that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Function" } } }, "description": "The function was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The function supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The function could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The function could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve function based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a function with the specified ID.", "tags": [ "Functions" ] } }, "/miscellaneousEvents/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new miscellaneous event. If an ID is specified for the miscellaneous event, an error will be thrown.", "operationId": "createMiscellaneousEvent", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MiscellaneousEvent" } } }, "description": "The miscellaneous event that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MiscellaneousEvent" } } }, "description": "The miscellaneous event was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The miscellaneous event you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The miscellaneous event could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add miscellaneous event based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new miscellaneous event record that does not already exist.", "tags": [ "Miscellaneous Events" ] } }, "/miscellaneousEvents/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The miscellaneous event could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve miscellaneous event based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Miscellaneous Events" ] } }, "/miscellaneousEvents/{tenantId}/public/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listMiscellaneousEventsByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListMiscellaneousEventsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "summary": "Returns a list of records with the specified event_id", "tags": [ "Miscellaneous Events" ] } }, "/miscellaneousEvents/{tenantId}/{id}": { "delete": { "description": "This method will delete a miscellaneous event with the specified ID.", "operationId": "deleteMiscellaneousEvent", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the miscellaneous event to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The miscellaneous event was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The miscellaneous event could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The miscellaneous event could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete miscellaneous event based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a miscellaneous event from the system by its ID.", "tags": [ "Miscellaneous Events" ] }, "get": { "description": "This method will look up a miscellaneous event by the specified ID and return it back.", "operationId": "getMiscellaneousEvent", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the miscellaneous event to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MiscellaneousEvent" } } }, "description": "The miscellaneous event was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The miscellaneous event could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve miscellaneous event based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a miscellaneous event from the system by its ID.", "tags": [ "Miscellaneous Events" ] }, "patch": { "description": "This method will patch an existing miscellaneous event with the specified ID, using the HTTP PATCH specification.", "operationId": "patchMiscellaneousEvent", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the miscellaneous event to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MiscellaneousEvent" } } }, "description": "The miscellaneous event was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The miscellaneous event could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The miscellaneous event could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve miscellaneous event based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a miscellaneous event with the specified ID.", "tags": [ "Miscellaneous Events" ] }, "put": { "description": "This method will update an existing miscellaneous event with the specified ID.", "operationId": "updateMiscellaneousEvent", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the miscellaneous event to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MiscellaneousEvent" } } }, "description": "The updated miscellaneous event that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MiscellaneousEvent" } } }, "description": "The miscellaneous event was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The miscellaneous event supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The miscellaneous event could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The miscellaneous event could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve miscellaneous event based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a miscellaneous event with the specified ID.", "tags": [ "Miscellaneous Events" ] } }, "/priorityPointAssignments/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new priority point assignment. If an ID is specified for the priority point assignment, an error will be thrown.", "operationId": "createPriorityPointAssignment", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriorityPointAssignment" } } }, "description": "The priority point assignment that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriorityPointAssignment" } } }, "description": "The priority point assignment was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The priority point assignment you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The priority point assignment could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add priority point assignment based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new priority point assignment record that does not already exist.", "tags": [ "Priority Point Assignments" ] } }, "/priorityPointAssignments/{tenantId}/accumulation/recalculate": { "post": { "description": "Returns a list of records with the specified organization_id", "operationId": "recalculateAccumulationRules", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Recaculate Priority Point Accumulation", "tags": [ "Priority Point Assignments" ] } }, "/priorityPointAssignments/{tenantId}/accumulation/test/{organization_id}": { "post": { "description": "Returns a list of records with the specified organization_id", "operationId": "testAccumulationRules", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "organization_id", "required": true, "description": "The organization_id to use to for record lookup", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriorityPointAssignment" } } }, "description": "If paging, this allows you to return the next set of results" }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/PriorityPointAssignment" }, "type": "array" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Tests Accumulation Rules", "tags": [ "Priority Point Assignments" ] } }, "/priorityPointAssignments/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The priority point assignment could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve priority point assignment based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Priority Point Assignments" ] } }, "/priorityPointAssignments/{tenantId}/organization/{organization_id}": { "get": { "description": "Returns a list of records with the specified organization_id", "operationId": "listAssignmentsByOrganizationId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "organization_id", "required": true, "description": "The organization_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPriorityPointAssignmentsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified organization_id", "tags": [ "Priority Point Assignments" ] } }, "/priorityPointAssignments/{tenantId}/{id}": { "delete": { "description": "This method will delete a priority point assignment with the specified ID.", "operationId": "deletePriorityPointAssignment", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the priority point assignment to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The priority point assignment was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The priority point assignment could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The priority point assignment could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete priority point assignment based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a priority point assignment from the system by its ID.", "tags": [ "Priority Point Assignments" ] }, "get": { "description": "This method will look up a priority point assignment by the specified ID and return it back.", "operationId": "getPriorityPointAssignment", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the priority point assignment to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriorityPointAssignment" } } }, "description": "The priority point assignment was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The priority point assignment could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve priority point assignment based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a priority point assignment from the system by its ID.", "tags": [ "Priority Point Assignments" ] }, "patch": { "description": "This method will patch an existing priority point assignment with the specified ID, using the HTTP PATCH specification.", "operationId": "patchPriorityPointAssignment", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the priority point assignment to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriorityPointAssignment" } } }, "description": "The priority point assignment was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The priority point assignment could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The priority point assignment could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve priority point assignment based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a priority point assignment with the specified ID.", "tags": [ "Priority Point Assignments" ] }, "put": { "description": "This method will update an existing priority point assignment with the specified ID.", "operationId": "updatePriorityPointAssignment", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the priority point assignment to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriorityPointAssignment" } } }, "description": "The updated priority point assignment that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriorityPointAssignment" } } }, "description": "The priority point assignment was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The priority point assignment supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The priority point assignment could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The priority point assignment could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve priority point assignment based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a priority point assignment with the specified ID.", "tags": [ "Priority Point Assignments" ] } }, "/queryDefinitions/{tenantId}": { "get": { "description": "Returns a list of records", "operationId": "getQueryDefinitions", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListStandardQueryDefinitionsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records", "tags": [ "Query Definitions" ] } }, "/registrantDirectories/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new registrant directory. If an ID is specified for the registrant directory, an error will be thrown.", "operationId": "createRegistrantDirectory", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrantDirectory" } } }, "description": "The registrant directory that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrantDirectory" } } }, "description": "The registrant directory was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The registrant directory you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registrant directory could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add registrant directory based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new registrant directory record that does not already exist.", "tags": [ "Registrant Directories" ] } }, "/registrantDirectories/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registrant directory could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registrant directory based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Registrant Directories" ] } }, "/registrantDirectories/{tenantId}/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listDirectoriesByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRegistrantDirectoriesResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_id", "tags": [ "Registrant Directories" ] } }, "/registrantDirectories/{tenantId}/public/entry/{id}/{entryId}": { "get": { "operationId": "getDirectoryEntry", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "Parameters to the query", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "directory", "schema": { "type": "string" } }, { "in": "path", "name": "entryId", "required": true, "description": "The id of the entry", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "The contact was merged successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The contact supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The contact could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The contact could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to merge contact based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "summary": "Gets an entry in the directory", "tags": [ "Registrant Directories" ] } }, "/registrantDirectories/{tenantId}/public/search/{id}": { "post": { "operationId": "searchPublicDirectory", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "Parameters to the query", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "directory", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/DirectorySearchCriteria" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectorySearchResults" } } }, "description": "The contact was merged successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The contact supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The contact could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The contact could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to merge contact based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "summary": "Searches the directory", "tags": [ "Registrant Directories" ] } }, "/registrantDirectories/{tenantId}/public/sendMessage/{directoryId}/{entryId}": { "post": { "operationId": "sendDirectoryMessage", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "Parameters to the query", "schema": { "type": "string" } }, { "in": "path", "name": "directoryId", "required": true, "description": "directory", "schema": { "type": "string" } }, { "in": "path", "name": "entryId", "required": true, "description": "The id of the entry", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectoryMessage" } } }, "description": "The message to send", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "The contact was merged successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The contact supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The contact could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The contact could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to merge contact based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "summary": "Sends a message to an entry in the directory", "tags": [ "Registrant Directories" ] } }, "/registrantDirectories/{tenantId}/public/{id}": { "get": { "description": "This method will look up a registrant directory by the specified ID and return it back.", "operationId": "getPublicDirectory", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registrant directory to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrantDirectory" } } }, "description": "The registrant directory was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registrant directory could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registrant directory based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "summary": "Returns a registrant directory from the system by its ID.", "tags": [ "Registrant Directories" ] } }, "/registrantDirectories/{tenantId}/search/{id}": { "post": { "operationId": "searchDirectory", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "Parameters to the query", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "directory", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/DirectorySearchCriteria" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectorySearchResults" } } }, "description": "The contact was merged successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The contact supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The contact could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The contact could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to merge contact based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Searches the directory", "tags": [ "Registrant Directories" ] } }, "/registrantDirectories/{tenantId}/{id}": { "delete": { "description": "This method will delete a registrant directory with the specified ID.", "operationId": "deleteRegistrantDirectory", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registrant directory to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The registrant directory was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registrant directory could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registrant directory could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete registrant directory based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a registrant directory from the system by its ID.", "tags": [ "Registrant Directories" ] }, "get": { "description": "This method will look up a registrant directory by the specified ID and return it back.", "operationId": "getRegistrantDirectory", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registrant directory to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrantDirectory" } } }, "description": "The registrant directory was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registrant directory could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registrant directory based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a registrant directory from the system by its ID.", "tags": [ "Registrant Directories" ] }, "patch": { "description": "This method will patch an existing registrant directory with the specified ID, using the HTTP PATCH specification.", "operationId": "patchRegistrantDirectory", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registrant directory to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrantDirectory" } } }, "description": "The registrant directory was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registrant directory could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registrant directory could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registrant directory based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a registrant directory with the specified ID.", "tags": [ "Registrant Directories" ] }, "put": { "description": "This method will update an existing registrant directory with the specified ID.", "operationId": "updateRegistrantDirectory", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registrant directory to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrantDirectory" } } }, "description": "The updated registrant directory that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrantDirectory" } } }, "description": "The registrant directory was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The registrant directory supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registrant directory could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registrant directory could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registrant directory based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a registrant directory with the specified ID.", "tags": [ "Registrant Directories" ] } }, "/registrationAddOnProducts/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new registration add on product. If an ID is specified for the registration add on product, an error will be thrown.", "operationId": "createRegistrationAddOnProduct", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationAddOnProduct" } } }, "description": "The registration add on product that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationAddOnProduct" } } }, "description": "The registration add on product was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The registration add on product you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration add on product could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add registration add on product based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new registration add on product record that does not already exist.", "tags": [ "Registration Add On Products" ] } }, "/registrationAddOnProducts/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration add on product could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration add on product based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Registration Add On Products" ] } }, "/registrationAddOnProducts/{tenantId}/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listProductsByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRegistrationAddOnProductsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_id", "tags": [ "Registration Add On Products" ] } }, "/registrationAddOnProducts/{tenantId}/{id}": { "delete": { "description": "This method will delete a registration add on product with the specified ID.", "operationId": "deleteRegistrationAddOnProduct", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration add on product to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The registration add on product was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration add on product could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration add on product could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete registration add on product based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a registration add on product from the system by its ID.", "tags": [ "Registration Add On Products" ] }, "get": { "description": "This method will look up a registration add on product by the specified ID and return it back.", "operationId": "getRegistrationAddOnProduct", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration add on product to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationAddOnProduct" } } }, "description": "The registration add on product was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration add on product could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration add on product based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a registration add on product from the system by its ID.", "tags": [ "Registration Add On Products" ] }, "patch": { "description": "This method will patch an existing registration add on product with the specified ID, using the HTTP PATCH specification.", "operationId": "patchRegistrationAddOnProduct", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration add on product to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationAddOnProduct" } } }, "description": "The registration add on product was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration add on product could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration add on product could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration add on product based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a registration add on product with the specified ID.", "tags": [ "Registration Add On Products" ] }, "put": { "description": "This method will update an existing registration add on product with the specified ID.", "operationId": "updateRegistrationAddOnProduct", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration add on product to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationAddOnProduct" } } }, "description": "The updated registration add on product that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationAddOnProduct" } } }, "description": "The registration add on product was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The registration add on product supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration add on product could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration add on product could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration add on product based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a registration add on product with the specified ID.", "tags": [ "Registration Add On Products" ] } }, "/registrationAddOnTypes/{tenantId}": { "get": { "description": "This method will scan all registration add on types and and return them to the caller.", "operationId": "listRegistrationAddOnTypes", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key, if you're making a subsequent request", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/RegistrationAddOnType" }, "type": "array" } } }, "description": "The registration add on typeswere retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add contact role based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Gets all of the registration add on types in the system.", "tags": [ "Registration Add On Types" ] }, "post": { "description": "This method will auto-generate an ID and create a new registration add on type. If an ID is specified for the registration add on type, an error will be thrown.", "operationId": "createRegistrationAddOnType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationAddOnType" } } }, "description": "The registration add on type that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationAddOnType" } } }, "description": "The registration add on type was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The registration add on type you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration add on type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add registration add on type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new registration add on type record that does not already exist.", "tags": [ "Registration Add On Types" ] } }, "/registrationAddOnTypes/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration add on type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration add on type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Registration Add On Types" ] } }, "/registrationAddOnTypes/{tenantId}/{id}": { "delete": { "description": "This method will delete a registration add on type with the specified ID.", "operationId": "deleteRegistrationAddOnType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration add on type to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The registration add on type was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration add on type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration add on type could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete registration add on type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a registration add on type from the system by its ID.", "tags": [ "Registration Add On Types" ] }, "get": { "description": "This method will look up a registration add on type by the specified ID and return it back.", "operationId": "getRegistrationAddOnType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration add on type to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationAddOnType" } } }, "description": "The registration add on type was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration add on type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration add on type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a registration add on type from the system by its ID.", "tags": [ "Registration Add On Types" ] }, "patch": { "description": "This method will patch an existing registration add on type with the specified ID, using the HTTP PATCH specification.", "operationId": "patchRegistrationAddOnType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration add on type to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationAddOnType" } } }, "description": "The registration add on type was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration add on type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration add on type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration add on type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a registration add on type with the specified ID.", "tags": [ "Registration Add On Types" ] }, "put": { "description": "This method will update an existing registration add on type with the specified ID.", "operationId": "updateRegistrationAddOnType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration add on type to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationAddOnType" } } }, "description": "The updated registration add on type that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationAddOnType" } } }, "description": "The registration add on type was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The registration add on type supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration add on type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration add on type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration add on type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a registration add on type with the specified ID.", "tags": [ "Registration Add On Types" ] } }, "/registrationCategories/{tenantId}": { "get": { "description": "This method will scan all registration categories and and return them to the caller.", "operationId": "listRegistrationCategories", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key, if you're making a subsequent request", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/RegistrationCategory" }, "type": "array" } } }, "description": "The registration categorieswere retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add contact role based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Gets all of the registration categories in the system.", "tags": [ "Registration Categories" ] }, "post": { "description": "This method will auto-generate an ID and create a new registration category. If an ID is specified for the registration category, an error will be thrown.", "operationId": "createRegistrationCategory", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationCategory" } } }, "description": "The registration category that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationCategory" } } }, "description": "The registration category was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The registration category you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration category could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add registration category based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new registration category record that does not already exist.", "tags": [ "Registration Categories" ] } }, "/registrationCategories/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration category could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration category based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Registration Categories" ] } }, "/registrationCategories/{tenantId}/{id}": { "delete": { "description": "This method will delete a registration category with the specified ID.", "operationId": "deleteRegistrationCategory", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration category to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The registration category was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration category could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration category could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete registration category based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a registration category from the system by its ID.", "tags": [ "Registration Categories" ] }, "get": { "description": "This method will look up a registration category by the specified ID and return it back.", "operationId": "getRegistrationCategory", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration category to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationCategory" } } }, "description": "The registration category was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration category could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration category based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a registration category from the system by its ID.", "tags": [ "Registration Categories" ] }, "patch": { "description": "This method will patch an existing registration category with the specified ID, using the HTTP PATCH specification.", "operationId": "patchRegistrationCategory", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration category to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationCategory" } } }, "description": "The registration category was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration category could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration category could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration category based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a registration category with the specified ID.", "tags": [ "Registration Categories" ] }, "put": { "description": "This method will update an existing registration category with the specified ID.", "operationId": "updateRegistrationCategory", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration category to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationCategory" } } }, "description": "The updated registration category that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationCategory" } } }, "description": "The registration category was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The registration category supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration category could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration category could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration category based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a registration category with the specified ID.", "tags": [ "Registration Categories" ] } }, "/registrationChangeFees/{tenantId}": { "get": { "description": "This method will scan all registration change fees and and return them to the caller.", "operationId": "listRegistrationChangeFees", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key, if you're making a subsequent request", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/RegistrationChangeFee" }, "type": "array" } } }, "description": "The registration change feeswere retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add contact role based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Gets all of the registration change fees in the system.", "tags": [ "Registration Change Fees" ] }, "post": { "description": "This method will auto-generate an ID and create a new registration change fee. If an ID is specified for the registration change fee, an error will be thrown.", "operationId": "createRegistrationChangeFee", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationChangeFee" } } }, "description": "The registration change fee that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationChangeFee" } } }, "description": "The registration change fee was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The registration change fee you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration change fee could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add registration change fee based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new registration change fee record that does not already exist.", "tags": [ "Registration Change Fees" ] } }, "/registrationChangeFees/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration change fee could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration change fee based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Registration Change Fees" ] } }, "/registrationChangeFees/{tenantId}/{id}": { "delete": { "description": "This method will delete a registration change fee with the specified ID.", "operationId": "deleteRegistrationChangeFee", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration change fee to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The registration change fee was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration change fee could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration change fee could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete registration change fee based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a registration change fee from the system by its ID.", "tags": [ "Registration Change Fees" ] }, "get": { "description": "This method will look up a registration change fee by the specified ID and return it back.", "operationId": "getRegistrationChangeFee", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration change fee to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationChangeFee" } } }, "description": "The registration change fee was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration change fee could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration change fee based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a registration change fee from the system by its ID.", "tags": [ "Registration Change Fees" ] }, "patch": { "description": "This method will patch an existing registration change fee with the specified ID, using the HTTP PATCH specification.", "operationId": "patchRegistrationChangeFee", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration change fee to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationChangeFee" } } }, "description": "The registration change fee was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration change fee could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration change fee could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration change fee based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a registration change fee with the specified ID.", "tags": [ "Registration Change Fees" ] }, "put": { "description": "This method will update an existing registration change fee with the specified ID.", "operationId": "updateRegistrationChangeFee", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration change fee to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationChangeFee" } } }, "description": "The updated registration change fee that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationChangeFee" } } }, "description": "The registration change fee was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The registration change fee supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration change fee could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration change fee could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration change fee based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a registration change fee with the specified ID.", "tags": [ "Registration Change Fees" ] } }, "/registrationDeadlines/{tenantId}": { "get": { "description": "This method will scan all registration deadlines and and return them to the caller.", "operationId": "listRegistrationDeadlines", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key, if you're making a subsequent request", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/RegistrationDeadline" }, "type": "array" } } }, "description": "The registration deadlineswere retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add contact role based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Gets all of the registration deadlines in the system.", "tags": [ "Registration Deadlines" ] }, "post": { "description": "This method will auto-generate an ID and create a new registration deadline. If an ID is specified for the registration deadline, an error will be thrown.", "operationId": "createRegistrationDeadline", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationDeadline" } } }, "description": "The registration deadline that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationDeadline" } } }, "description": "The registration deadline was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The registration deadline you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration deadline could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add registration deadline based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new registration deadline record that does not already exist.", "tags": [ "Registration Deadlines" ] } }, "/registrationDeadlines/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration deadline could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration deadline based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Registration Deadlines" ] } }, "/registrationDeadlines/{tenantId}/{id}": { "delete": { "description": "This method will delete a registration deadline with the specified ID.", "operationId": "deleteRegistrationDeadline", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration deadline to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The registration deadline was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration deadline could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration deadline could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete registration deadline based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a registration deadline from the system by its ID.", "tags": [ "Registration Deadlines" ] }, "get": { "description": "This method will look up a registration deadline by the specified ID and return it back.", "operationId": "getRegistrationDeadline", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration deadline to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationDeadline" } } }, "description": "The registration deadline was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration deadline could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration deadline based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a registration deadline from the system by its ID.", "tags": [ "Registration Deadlines" ] }, "patch": { "description": "This method will patch an existing registration deadline with the specified ID, using the HTTP PATCH specification.", "operationId": "patchRegistrationDeadline", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration deadline to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationDeadline" } } }, "description": "The registration deadline was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration deadline could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration deadline could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration deadline based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a registration deadline with the specified ID.", "tags": [ "Registration Deadlines" ] }, "put": { "description": "This method will update an existing registration deadline with the specified ID.", "operationId": "updateRegistrationDeadline", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration deadline to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationDeadline" } } }, "description": "The updated registration deadline that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationDeadline" } } }, "description": "The registration deadline was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The registration deadline supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration deadline could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration deadline could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration deadline based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a registration deadline with the specified ID.", "tags": [ "Registration Deadlines" ] } }, "/registrationGroups/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new registration group. If an ID is specified for the registration group, an error will be thrown.", "operationId": "createRegistrationGroup", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationGroup" } } }, "description": "The registration group that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationGroup" } } }, "description": "The registration group was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The registration group you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration group could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add registration group based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new registration group record that does not already exist.", "tags": [ "Registration Groups" ] } }, "/registrationGroups/{tenantId}/administrator/{event_id}/{administrator_id}": { "get": { "description": "Returns a list of records with the specified administrator_id", "operationId": "listGroupsByAdministratorId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "path", "name": "administrator_id", "required": true, "description": "The administrator_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRegistrationGroupsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified administrator_id", "tags": [ "Registration Groups" ] } }, "/registrationGroups/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration group could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration group based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Registration Groups" ] } }, "/registrationGroups/{tenantId}/contact/{groupId}/{administratorId}/{contactId}": { "get": { "description": "Returns a list of records with the specified administrator_id", "operationId": "getGroupContact", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "groupId", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "path", "name": "administratorId", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "path", "name": "contactId", "required": true, "description": "The administrator_id to use to for record lookup", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified administrator_id", "tags": [ "Registration Groups" ] } }, "/registrationGroups/{tenantId}/search": { "post": { "description": "Searches for registration groups using predefined parameters", "operationId": "searchForRegistrationGroups", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key for the search, for paging support", "schema": { "type": "string" } }, { "in": "query", "name": "fieldsToReturn", "required": false, "description": " The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationGroupSearchParameters" } } }, "description": "The registration group that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedRegistrationGroupSearchResults" } } }, "description": "The registration group search was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The registration group you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration group could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add registration group based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Searches for registration groups using predefined parameters", "tags": [ "Registration Groups" ] } }, "/registrationGroups/{tenantId}/{id}": { "delete": { "description": "This method will delete a registration group with the specified ID.", "operationId": "deleteRegistrationGroup", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration group to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The registration group was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration group could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration group could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete registration group based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a registration group from the system by its ID.", "tags": [ "Registration Groups" ] }, "get": { "description": "This method will look up a registration group by the specified ID and return it back.", "operationId": "getRegistrationGroup", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration group to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationGroup" } } }, "description": "The registration group was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration group could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration group based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a registration group from the system by its ID.", "tags": [ "Registration Groups" ] }, "patch": { "description": "This method will patch an existing registration group with the specified ID, using the HTTP PATCH specification.", "operationId": "patchRegistrationGroup", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration group to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationGroup" } } }, "description": "The registration group was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration group could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration group could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration group based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a registration group with the specified ID.", "tags": [ "Registration Groups" ] }, "put": { "description": "This method will update an existing registration group with the specified ID.", "operationId": "updateRegistrationGroup", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration group to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationGroup" } } }, "description": "The updated registration group that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationGroup" } } }, "description": "The registration group was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The registration group supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration group could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration group could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration group based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a registration group with the specified ID.", "tags": [ "Registration Groups" ] } }, "/registrationPackages/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new registration package. If an ID is specified for the registration package, an error will be thrown.", "operationId": "createRegistrationPackage", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationPackage" } } }, "description": "The registration package that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationPackage" } } }, "description": "The registration package was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The registration package you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration package could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add registration package based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new registration package record that does not already exist.", "tags": [ "Registration Packages" ] } }, "/registrationPackages/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration package could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration package based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Registration Packages" ] } }, "/registrationPackages/{tenantId}/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listPackagesByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRegistrationPackagesResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_id", "tags": [ "Registration Packages" ] } }, "/registrationPackages/{tenantId}/public/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listPackagesByEventIdPublic", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRegistrationPackagesResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "summary": "Returns a list of records with the specified event_id", "tags": [ "Registration Packages" ] } }, "/registrationPackages/{tenantId}/public/onlineStore": { "post": { "description": "Public endpoint that gets packages for use in the online store", "operationId": "getPackagesForOnlineStore", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicEventRegistrationPackagesRequest" } } }, "description": "Restrictions", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicEventRegistrationPackagesResponse" } } }, "description": "The store was retrieved", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "summary": "Get Packages for Online Store", "tags": [ "Registration Packages" ] } }, "/registrationPackages/{tenantId}/public/rateSchedule/{eventId}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "getRateSchedule", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "eventId", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "currencyCode", "required": false, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateSchedule" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "summary": "Returns a list of records with the specified event_id", "tags": [ "Registration Packages" ] } }, "/registrationPackages/{tenantId}/{id}": { "delete": { "description": "This method will delete a registration package with the specified ID.", "operationId": "deleteRegistrationPackage", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration package to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The registration package was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration package could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration package could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete registration package based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a registration package from the system by its ID.", "tags": [ "Registration Packages" ] }, "get": { "description": "This method will look up a registration package by the specified ID and return it back.", "operationId": "getRegistrationPackage", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration package to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationPackage" } } }, "description": "The registration package was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration package could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration package based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a registration package from the system by its ID.", "tags": [ "Registration Packages" ] }, "patch": { "description": "This method will patch an existing registration package with the specified ID, using the HTTP PATCH specification.", "operationId": "patchRegistrationPackage", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration package to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationPackage" } } }, "description": "The registration package was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration package could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration package could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration package based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a registration package with the specified ID.", "tags": [ "Registration Packages" ] }, "put": { "description": "This method will update an existing registration package with the specified ID.", "operationId": "updateRegistrationPackage", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration package to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationPackage" } } }, "description": "The updated registration package that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationPackage" } } }, "description": "The registration package was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The registration package supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration package could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration package could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration package based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a registration package with the specified ID.", "tags": [ "Registration Packages" ] } }, "/registrationProcesses/{tenantId}": { "get": { "description": "This method will scan all registration processes and and return them to the caller.", "operationId": "listRegistrationProcesses", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key, if you're making a subsequent request", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/RegistrationProcess" }, "type": "array" } } }, "description": "The registration processeswere retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add contact role based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Gets all of the registration processes in the system.", "tags": [ "Registration Processes" ] }, "post": { "description": "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.", "operationId": "createRegistrationProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationProcess" } } }, "description": "The registration process that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationProcess" } } }, "description": "The registration process was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The registration process you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration process could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add registration process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new registration process record that does not already exist.", "tags": [ "Registration Processes" ] } }, "/registrationProcesses/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Registration Processes" ] } }, "/registrationProcesses/{tenantId}/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listProcessesByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRegistrationProcessesResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_id", "tags": [ "Registration Processes" ] } }, "/registrationProcesses/{tenantId}/{id}": { "delete": { "description": "This method will delete a registration process with the specified ID.", "operationId": "deleteRegistrationProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration process to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The registration process was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration process could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete registration process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a registration process from the system by its ID.", "tags": [ "Registration Processes" ] }, "get": { "description": "This method will look up a registration process by the specified ID and return it back.", "operationId": "getRegistrationProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration process to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationProcess" } } }, "description": "The registration process was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a registration process from the system by its ID.", "tags": [ "Registration Processes" ] }, "patch": { "description": "This method will patch an existing registration process with the specified ID, using the HTTP PATCH specification.", "operationId": "patchRegistrationProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration process to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationProcess" } } }, "description": "The registration process was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration process could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a registration process with the specified ID.", "tags": [ "Registration Processes" ] }, "put": { "description": "This method will update an existing registration process with the specified ID.", "operationId": "updateRegistrationProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration process to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationProcess" } } }, "description": "The updated registration process that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationProcess" } } }, "description": "The registration process was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The registration process supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration process could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a registration process with the specified ID.", "tags": [ "Registration Processes" ] } }, "/registrationSettings/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new registration setting. If an ID is specified for the registration setting, an error will be thrown.", "operationId": "createRegistrationSetting", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationSetting" } } }, "description": "The registration setting that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationSetting" } } }, "description": "The registration setting was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The registration setting you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration setting could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add registration setting based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new registration setting record that does not already exist.", "tags": [ "Registration Settings" ] } }, "/registrationSettings/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration setting could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration setting based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Registration Settings" ] } }, "/registrationSettings/{tenantId}/public/{id}": { "get": { "description": "This method will look up a registration setting by the specified ID and return it back.", "operationId": "getRegistrationSettingPublic", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration setting to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationSetting" } } }, "description": "The registration setting was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration setting could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration setting based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "summary": "Returns a registration setting from the system by its ID.", "tags": [ "Registration Settings" ] } }, "/registrationSettings/{tenantId}/{id}": { "delete": { "description": "This method will delete a registration setting with the specified ID.", "operationId": "deleteRegistrationSetting", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration setting to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The registration setting was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration setting could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration setting could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete registration setting based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a registration setting from the system by its ID.", "tags": [ "Registration Settings" ] }, "get": { "description": "This method will look up a registration setting by the specified ID and return it back.", "operationId": "getRegistrationSetting", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration setting to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationSetting" } } }, "description": "The registration setting was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration setting could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration setting based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a registration setting from the system by its ID.", "tags": [ "Registration Settings" ] }, "patch": { "description": "This method will patch an existing registration setting with the specified ID, using the HTTP PATCH specification.", "operationId": "patchRegistrationSetting", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration setting to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationSetting" } } }, "description": "The registration setting was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration setting could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration setting could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration setting based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a registration setting with the specified ID.", "tags": [ "Registration Settings" ] }, "put": { "description": "This method will update an existing registration setting with the specified ID.", "operationId": "updateRegistrationSetting", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration setting to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationSetting" } } }, "description": "The updated registration setting that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationSetting" } } }, "description": "The registration setting was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The registration setting supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration setting could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration setting could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration setting based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a registration setting with the specified ID.", "tags": [ "Registration Settings" ] } }, "/registrationSubstitutions/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new registration substitution. If an ID is specified for the registration substitution, an error will be thrown.", "operationId": "createRegistrationSubstitution", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationSubstitution" } } }, "description": "The registration substitution that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationSubstitution" } } }, "description": "The registration substitution was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The registration substitution you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration substitution could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add registration substitution based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new registration substitution record that does not already exist.", "tags": [ "Registration Substitutions" ] } }, "/registrationSubstitutions/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration substitution could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration substitution based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Registration Substitutions" ] } }, "/registrationSubstitutions/{tenantId}/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listSubstitutionsByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRegistrationSubstitutionsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_id", "tags": [ "Registration Substitutions" ] } }, "/registrationSubstitutions/{tenantId}/newContact/{new_contact_id}": { "get": { "description": "Returns a list of records with the specified new_contact_id", "operationId": "listSubstitutionsByNewContactId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "new_contact_id", "required": true, "description": "The new_contact_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRegistrationSubstitutionsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified new_contact_id", "tags": [ "Registration Substitutions" ] } }, "/registrationSubstitutions/{tenantId}/previousContact/{previous_contact_id}": { "get": { "description": "Returns a list of records with the specified previous_contact_id", "operationId": "listSubstitutionsByPreviousContactId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "previous_contact_id", "required": true, "description": "The previous_contact_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRegistrationSubstitutionsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified previous_contact_id", "tags": [ "Registration Substitutions" ] } }, "/registrationSubstitutions/{tenantId}/registration/{registration_id}": { "get": { "description": "Returns a list of records with the specified registration_id", "operationId": "listSubstitutionsByRegistrationId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "registration_id", "required": true, "description": "The registration_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRegistrationSubstitutionsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified registration_id", "tags": [ "Registration Substitutions" ] } }, "/registrationSubstitutions/{tenantId}/{id}": { "delete": { "description": "This method will delete a registration substitution with the specified ID.", "operationId": "deleteRegistrationSubstitution", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration substitution to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The registration substitution was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration substitution could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration substitution could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete registration substitution based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a registration substitution from the system by its ID.", "tags": [ "Registration Substitutions" ] }, "get": { "description": "This method will look up a registration substitution by the specified ID and return it back.", "operationId": "getRegistrationSubstitution", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration substitution to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationSubstitution" } } }, "description": "The registration substitution was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration substitution could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration substitution based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a registration substitution from the system by its ID.", "tags": [ "Registration Substitutions" ] }, "patch": { "description": "This method will patch an existing registration substitution with the specified ID, using the HTTP PATCH specification.", "operationId": "patchRegistrationSubstitution", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration substitution to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationSubstitution" } } }, "description": "The registration substitution was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration substitution could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration substitution could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration substitution based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a registration substitution with the specified ID.", "tags": [ "Registration Substitutions" ] }, "put": { "description": "This method will update an existing registration substitution with the specified ID.", "operationId": "updateRegistrationSubstitution", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration substitution to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationSubstitution" } } }, "description": "The updated registration substitution that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationSubstitution" } } }, "description": "The registration substitution was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The registration substitution supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration substitution could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration substitution could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration substitution based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a registration substitution with the specified ID.", "tags": [ "Registration Substitutions" ] } }, "/registrationTypes/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new registration type. If an ID is specified for the registration type, an error will be thrown.", "operationId": "createRegistrationType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationType" } } }, "description": "The registration type that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationType" } } }, "description": "The registration type was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The registration type you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add registration type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new registration type record that does not already exist.", "tags": [ "Registration Types" ] } }, "/registrationTypes/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Registration Types" ] } }, "/registrationTypes/{tenantId}/couponAccess/{id}": { "get": { "description": "Checks to see whether or not a person can access a registration type with a coupon", "operationId": "checkCouponAccess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The registration type ID", "schema": { "type": "string" } }, { "in": "query", "name": "contactId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "couponCodeId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Check Coupon Access", "tags": [ "Registration Types" ] } }, "/registrationTypes/{tenantId}/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listTypesByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRegistrationTypesResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_id", "tags": [ "Registration Types" ] } }, "/registrationTypes/{tenantId}/event/{event_id}/portal/{contact_id}": { "get": { "description": "Returns a list of registration types for the specified contact", "operationId": "getApplicableTypesForContact", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "path", "name": "contact_id", "required": true, "description": "The contact ID", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRegistrationTypesResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of registration types for the specified contact", "tags": [ "Registration Types" ] } }, "/registrationTypes/{tenantId}/public/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listTypesByEventIdPublic", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRegistrationTypesResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "summary": "Returns a list of records with the specified event_id", "tags": [ "Registration Types" ] } }, "/registrationTypes/{tenantId}/{id}": { "delete": { "description": "This method will delete a registration type with the specified ID.", "operationId": "deleteRegistrationType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration type to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The registration type was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration type could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete registration type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a registration type from the system by its ID.", "tags": [ "Registration Types" ] }, "get": { "description": "This method will look up a registration type by the specified ID and return it back.", "operationId": "getRegistrationType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration type to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationType" } } }, "description": "The registration type was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a registration type from the system by its ID.", "tags": [ "Registration Types" ] }, "patch": { "description": "This method will patch an existing registration type with the specified ID, using the HTTP PATCH specification.", "operationId": "patchRegistrationType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration type to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationType" } } }, "description": "The registration type was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a registration type with the specified ID.", "tags": [ "Registration Types" ] }, "put": { "description": "This method will update an existing registration type with the specified ID.", "operationId": "updateRegistrationType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration type to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationType" } } }, "description": "The updated registration type that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationType" } } }, "description": "The registration type was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The registration type supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a registration type with the specified ID.", "tags": [ "Registration Types" ] } }, "/registrations/{tenantId}": { "post": { "description": "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.", "operationId": "createRegistration", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Registration" } } }, "description": "The registration that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Registration" } } }, "description": "The registration was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The registration you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add registration based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new registration record that does not already exist.", "tags": [ "Registrations" ] } }, "/registrations/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Registrations" ] } }, "/registrations/{tenantId}/certificate/{id}": { "get": { "description": "Returns the HTML for the certificate", "operationId": "downloadCertificate", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the certifications", "schema": { "type": "string" } }, { "in": "query", "name": "downloadAsHtml", "required": false, "description": "If true, return the receipt as HTML", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The certifications was downloaded successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The payment could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve payment based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Downloads a Certificate", "tags": [ "Registrations" ] } }, "/registrations/{tenantId}/contact/{contact_id}": { "get": { "description": "Returns a list of records with the specified contact_id", "operationId": "listRegistrationsByContactId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "contact_id", "required": true, "description": "The contact_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRegistrationsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified contact_id", "tags": [ "Registrations" ] } }, "/registrations/{tenantId}/describeSelfCancellation/{id}": { "get": { "description": "This method will examine an event registration and generate an appropriate order", "operationId": "describeSelfCancellation", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The registration ID", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelfCancellationDescription" } } }, "description": "Conflicts were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The search you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add order based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Self Cancel Registration", "tags": [ "Registrations" ] } }, "/registrations/{tenantId}/eventContact/{eventId}/{contactId}": { "get": { "description": "Returns a list of records with the specified event_contact_id", "operationId": "listRegistrationsByEventContactId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "eventId", "required": true, "description": "The event", "schema": { "type": "string" } }, { "in": "path", "name": "contactId", "required": true, "description": "The contact", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRegistrationsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_contact_id", "tags": [ "Registrations" ] } }, "/registrations/{tenantId}/eventOrganization/{eventId}/{organizationId}": { "get": { "description": "Returns a list of records with the specified event_organization_id", "operationId": "listRegistrationsByEventOrganizationId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "eventId", "required": true, "description": "The event", "schema": { "type": "string" } }, { "in": "path", "name": "organizationId", "required": true, "description": "The organization", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRegistrationsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_organization_id", "tags": [ "Registrations" ] } }, "/registrations/{tenantId}/generateGroupOrder/{groupId}": { "post": { "operationId": "generateGroupOrder", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed", "schema": { "type": "string" } }, { "in": "path", "name": "groupId", "required": true, "description": "The group id", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Registration" } } }, "description": "Conflicts were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The search you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add order based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Generates an order for a registration group", "tags": [ "Registrations" ] } }, "/registrations/{tenantId}/generateOrder": { "post": { "description": "This method will examine an event registration and generate an appropriate order", "operationId": "generateOrder", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Registration" } } }, "description": "The application to generate an order", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Registration" } } }, "description": "Conflicts were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The search you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add order based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Generates an order from an event registration", "tags": [ "Registrations" ] } }, "/registrations/{tenantId}/group/{group_id}": { "get": { "description": "Returns a list of records with the specified group_id", "operationId": "listRegistrationsByGroupId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "group_id", "required": true, "description": "The group_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRegistrationsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified group_id", "tags": [ "Registrations" ] } }, "/registrations/{tenantId}/order/{order_id}": { "get": { "description": "Returns a list of records with the specified order_id", "operationId": "listRegistrationsByOrderId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "order_id", "required": true, "description": "The order_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRegistrationsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified order_id", "tags": [ "Registrations" ] } }, "/registrations/{tenantId}/parentRegistration/{parent_registration_id}": { "get": { "description": "Returns a list of records with the specified parent_registration_id", "operationId": "listRegistrationsByParentRegistrationId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "parent_registration_id", "required": true, "description": "The parent_registration_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRegistrationsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified parent_registration_id", "tags": [ "Registrations" ] } }, "/registrations/{tenantId}/portal/detectSchedulingConflicts": { "post": { "description": "Examines a registration and detects any potential scheduling conflicts in the registration", "operationId": "detectSchedulingConflicts", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Registration" } } }, "description": "The registration to use for conflict detection", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchedulingConflictResponse" } } }, "description": "Conflicts were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The search you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add order based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Examines a registration and detects any potential scheduling conflicts in the registration", "tags": [ "Registrations" ] } }, "/registrations/{tenantId}/previewCertificate": { "post": { "description": "Sends out a preview of the CRC notification certificate", "operationId": "previewCertificate", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewCertificateRequest" } } }, "description": "The domain_name to use to for record lookup", "required": true }, "responses": { "200": { "description": "The record was retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate any organizations with the specified domain", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Sends out a preview of the CRC notification certificate", "tags": [ "Registrations" ] } }, "/registrations/{tenantId}/previewEmail": { "post": { "description": "Sends out a preview of the CRC notification email", "operationId": "previewEmail", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PreviewEmailRequest" }, "responses": { "200": { "description": "The record was retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate any organizations with the specified domain", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Sends out a preview of the CRC notification email", "tags": [ "Registrations" ] } }, "/registrations/{tenantId}/registrationModificationPayload/{id}": { "get": { "description": "This method will examine an event registration and generate an appropriate order", "operationId": "generateRegistrationModificationPayload", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The registration ID", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Registration" } } }, "description": "Conflicts were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The search you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add order based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Generates the payload necessary to edit a registration", "tags": [ "Registrations" ] } }, "/registrations/{tenantId}/resendConfirmationEmail/{registration_id}": { "post": { "description": "Resends the confirmation email for a registration", "operationId": "resendConfirmationEmail", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "registration_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Resends the confirmation email for a registration", "tags": [ "Registrations" ] } }, "/registrations/{tenantId}/search": { "post": { "description": "Searches for registrations using predefined parameters", "operationId": "searchForRegistrations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key for the search, for paging support", "schema": { "type": "string" } }, { "in": "query", "name": "fieldsToReturn", "required": false, "description": " The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationSearchParameters" } } }, "description": "The registration that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedRegistrationSearchResults" } } }, "description": "The registration search was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The registration you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add registration based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Searches for registrations using predefined parameters", "tags": [ "Registrations" ] } }, "/registrations/{tenantId}/selfCancelRegistration/{id}": { "post": { "description": "This method will examine an event registration and generate an appropriate order", "operationId": "performSelfCancellation", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The registration ID", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Registration" } } }, "description": "Conflicts were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The search you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add order based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Self Cancel Registration", "tags": [ "Registrations" ] } }, "/registrations/{tenantId}/transfer/{id}/{contactId}": { "put": { "description": "Transfers a registration registration from one contact to another, and updates downstream session, tickets, and course registrations", "operationId": "transferRegistration", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The registration id", "schema": { "type": "string" } }, { "in": "path", "name": "contactId", "required": true, "description": "The destination contact", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferRegistrationOptions" } } }, "description": "Options" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Registration" } } }, "description": "Conflicts were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The search you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add order based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Transfers a registration", "tags": [ "Registrations" ] } }, "/registrations/{tenantId}/{id}": { "delete": { "description": "This method will delete a registration with the specified ID.", "operationId": "deleteRegistration", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The registration was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete registration based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a registration from the system by its ID.", "tags": [ "Registrations" ] }, "get": { "description": "This method will look up a registration by the specified ID and return it back.", "operationId": "getRegistration", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Registration" } } }, "description": "The registration was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a registration from the system by its ID.", "tags": [ "Registrations" ] }, "patch": { "description": "This method will patch an existing registration with the specified ID, using the HTTP PATCH specification.", "operationId": "patchRegistration", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Registration" } } }, "description": "The registration was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a registration with the specified ID.", "tags": [ "Registrations" ] }, "put": { "description": "This method will update an existing registration with the specified ID.", "operationId": "updateRegistration", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the registration to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Registration" } } }, "description": "The updated registration that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Registration" } } }, "description": "The registration was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The registration supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The registration could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The registration could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve registration based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a registration with the specified ID.", "tags": [ "Registrations" ] } }, "/ribbonTypes/{tenantId}": { "get": { "description": "This method will scan all ribbon types and and return them to the caller.", "operationId": "listRibbonTypes", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key, if you're making a subsequent request", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/RibbonType" }, "type": "array" } } }, "description": "The ribbon typeswere retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add contact role based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Gets all of the ribbon types in the system.", "tags": [ "Ribbon Types" ] }, "post": { "description": "This method will auto-generate an ID and create a new ribbon type. If an ID is specified for the ribbon type, an error will be thrown.", "operationId": "createRibbonType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RibbonType" } } }, "description": "The ribbon type that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RibbonType" } } }, "description": "The ribbon type was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The ribbon type you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The ribbon type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add ribbon type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new ribbon type record that does not already exist.", "tags": [ "Ribbon Types" ] } }, "/ribbonTypes/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The ribbon type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve ribbon type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Ribbon Types" ] } }, "/ribbonTypes/{tenantId}/{id}": { "delete": { "description": "This method will delete a ribbon type with the specified ID.", "operationId": "deleteRibbonType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the ribbon type to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The ribbon type was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The ribbon type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The ribbon type could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete ribbon type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a ribbon type from the system by its ID.", "tags": [ "Ribbon Types" ] }, "get": { "description": "This method will look up a ribbon type by the specified ID and return it back.", "operationId": "getRibbonType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the ribbon type to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RibbonType" } } }, "description": "The ribbon type was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The ribbon type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve ribbon type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a ribbon type from the system by its ID.", "tags": [ "Ribbon Types" ] }, "patch": { "description": "This method will patch an existing ribbon type with the specified ID, using the HTTP PATCH specification.", "operationId": "patchRibbonType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the ribbon type to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RibbonType" } } }, "description": "The ribbon type was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The ribbon type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The ribbon type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve ribbon type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a ribbon type with the specified ID.", "tags": [ "Ribbon Types" ] }, "put": { "description": "This method will update an existing ribbon type with the specified ID.", "operationId": "updateRibbonType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the ribbon type to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RibbonType" } } }, "description": "The updated ribbon type that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RibbonType" } } }, "description": "The ribbon type was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The ribbon type supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The ribbon type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The ribbon type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve ribbon type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a ribbon type with the specified ID.", "tags": [ "Ribbon Types" ] } }, "/rooms/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new room. If an ID is specified for the room, an error will be thrown.", "operationId": "createRoom", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Room" } } }, "description": "The room that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Room" } } }, "description": "The room was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The room you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The room could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add room based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new room record that does not already exist.", "tags": [ "Rooms" ] } }, "/rooms/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The room could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve room based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Rooms" ] } }, "/rooms/{tenantId}/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listRoomsByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRoomsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_id", "tags": [ "Rooms" ] } }, "/rooms/{tenantId}/{id}": { "delete": { "description": "This method will delete a room with the specified ID.", "operationId": "deleteRoom", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the room to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The room was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The room could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The room could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete room based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a room from the system by its ID.", "tags": [ "Rooms" ] }, "get": { "description": "This method will look up a room by the specified ID and return it back.", "operationId": "getRoom", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the room to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Room" } } }, "description": "The room was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The room could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve room based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a room from the system by its ID.", "tags": [ "Rooms" ] }, "patch": { "description": "This method will patch an existing room with the specified ID, using the HTTP PATCH specification.", "operationId": "patchRoom", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the room to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Room" } } }, "description": "The room was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The room could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The room could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve room based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a room with the specified ID.", "tags": [ "Rooms" ] }, "put": { "description": "This method will update an existing room with the specified ID.", "operationId": "updateRoom", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the room to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Room" } } }, "description": "The updated room that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Room" } } }, "description": "The room was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The room supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The room could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The room could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve room based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a room with the specified ID.", "tags": [ "Rooms" ] } }, "/sessionFees/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new session fee. If an ID is specified for the session fee, an error will be thrown.", "operationId": "createSessionFee", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionFee" } } }, "description": "The session fee that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionFee" } } }, "description": "The session fee was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The session fee you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The session fee could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add session fee based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new session fee record that does not already exist.", "tags": [ "Session Fees" ] } }, "/sessionFees/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The session fee could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve session fee based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Session Fees" ] } }, "/sessionFees/{tenantId}/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listFeesByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSessionFeesResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_id", "tags": [ "Session Fees" ] } }, "/sessionFees/{tenantId}/session/{session_id}": { "get": { "description": "Returns a list of records with the specified session_id", "operationId": "listFeesBySessionId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "session_id", "required": true, "description": "The session_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSessionFeesResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified session_id", "tags": [ "Session Fees" ] } }, "/sessionFees/{tenantId}/{id}": { "delete": { "description": "This method will delete a session fee with the specified ID.", "operationId": "deleteSessionFee", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the session fee to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The session fee was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The session fee could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The session fee could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete session fee based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a session fee from the system by its ID.", "tags": [ "Session Fees" ] }, "get": { "description": "This method will look up a session fee by the specified ID and return it back.", "operationId": "getSessionFee", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the session fee to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionFee" } } }, "description": "The session fee was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The session fee could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve session fee based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a session fee from the system by its ID.", "tags": [ "Session Fees" ] }, "patch": { "description": "This method will patch an existing session fee with the specified ID, using the HTTP PATCH specification.", "operationId": "patchSessionFee", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the session fee to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionFee" } } }, "description": "The session fee was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The session fee could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The session fee could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve session fee based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a session fee with the specified ID.", "tags": [ "Session Fees" ] }, "put": { "description": "This method will update an existing session fee with the specified ID.", "operationId": "updateSessionFee", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the session fee to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionFee" } } }, "description": "The updated session fee that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionFee" } } }, "description": "The session fee was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The session fee supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The session fee could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The session fee could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve session fee based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a session fee with the specified ID.", "tags": [ "Session Fees" ] } }, "/sessionRegistrations/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new session registration. If an ID is specified for the session registration, an error will be thrown.", "operationId": "createSessionRegistration", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionRegistration" } } }, "description": "The session registration that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionRegistration" } } }, "description": "The session registration was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The session registration you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The session registration could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add session registration based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new session registration record that does not already exist.", "tags": [ "Session Registrations" ] } }, "/sessionRegistrations/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The session registration could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve session registration based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Session Registrations" ] } }, "/sessionRegistrations/{tenantId}/eventContact/{eventId}/{contactId}": { "get": { "description": "Returns a list of records with the specified event_contact_id", "operationId": "listRegistrationsByEventContactId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "eventId", "required": true, "description": "The eventId to use to for record lookup", "schema": { "type": "string" } }, { "in": "path", "name": "contactId", "required": true, "description": "The eventId to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSessionRegistrationsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_contact_id", "tags": [ "Session Registrations" ] } }, "/sessionRegistrations/{tenantId}/session/{session_id}": { "get": { "description": "Returns a list of records with the specified session_id", "operationId": "listRegistrationsBySessionId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "session_id", "required": true, "description": "The session_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "status", "required": false, "description": "Status filter (optional)", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSessionRegistrationsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified session_id", "tags": [ "Session Registrations" ] } }, "/sessionRegistrations/{tenantId}/{id}": { "delete": { "description": "This method will delete a session registration with the specified ID.", "operationId": "deleteSessionRegistration", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the session registration to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The session registration was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The session registration could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The session registration could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete session registration based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a session registration from the system by its ID.", "tags": [ "Session Registrations" ] }, "get": { "description": "This method will look up a session registration by the specified ID and return it back.", "operationId": "getSessionRegistration", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the session registration to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionRegistration" } } }, "description": "The session registration was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The session registration could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve session registration based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a session registration from the system by its ID.", "tags": [ "Session Registrations" ] }, "patch": { "description": "This method will patch an existing session registration with the specified ID, using the HTTP PATCH specification.", "operationId": "patchSessionRegistration", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the session registration to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionRegistration" } } }, "description": "The session registration was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The session registration could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The session registration could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve session registration based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a session registration with the specified ID.", "tags": [ "Session Registrations" ] }, "put": { "description": "This method will update an existing session registration with the specified ID.", "operationId": "updateSessionRegistration", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the session registration to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionRegistration" } } }, "description": "The updated session registration that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionRegistration" } } }, "description": "The session registration was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The session registration supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The session registration could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The session registration could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve session registration based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a session registration with the specified ID.", "tags": [ "Session Registrations" ] } }, "/sessionTracks/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new session track. If an ID is specified for the session track, an error will be thrown.", "operationId": "createSessionTrack", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionTrack" } } }, "description": "The session track that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionTrack" } } }, "description": "The session track was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The session track you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The session track could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add session track based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new session track record that does not already exist.", "tags": [ "Session Tracks" ] } }, "/sessionTracks/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The session track could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve session track based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Session Tracks" ] } }, "/sessionTracks/{tenantId}/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listTracksByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSessionTracksResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_id", "tags": [ "Session Tracks" ] } }, "/sessionTracks/{tenantId}/public/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "describeTracksByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSessionTracksResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "summary": "Returns a list of records with the specified event_id", "tags": [ "Session Tracks" ] } }, "/sessionTracks/{tenantId}/{id}": { "delete": { "description": "This method will delete a session track with the specified ID.", "operationId": "deleteSessionTrack", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the session track to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The session track was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The session track could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The session track could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete session track based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a session track from the system by its ID.", "tags": [ "Session Tracks" ] }, "get": { "description": "This method will look up a session track by the specified ID and return it back.", "operationId": "getSessionTrack", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the session track to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionTrack" } } }, "description": "The session track was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The session track could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve session track based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a session track from the system by its ID.", "tags": [ "Session Tracks" ] }, "patch": { "description": "This method will patch an existing session track with the specified ID, using the HTTP PATCH specification.", "operationId": "patchSessionTrack", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the session track to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionTrack" } } }, "description": "The session track was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The session track could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The session track could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve session track based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a session track with the specified ID.", "tags": [ "Session Tracks" ] }, "put": { "description": "This method will update an existing session track with the specified ID.", "operationId": "updateSessionTrack", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the session track to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionTrack" } } }, "description": "The updated session track that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionTrack" } } }, "description": "The session track was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The session track supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The session track could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The session track could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve session track based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a session track with the specified ID.", "tags": [ "Session Tracks" ] } }, "/sessionTypes/{tenantId}": { "get": { "description": "This method will scan all session types and and return them to the caller.", "operationId": "listSessionTypes", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key, if you're making a subsequent request", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SessionType" }, "type": "array" } } }, "description": "The session typeswere retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add contact role based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Gets all of the session types in the system.", "tags": [ "Session Types" ] }, "post": { "description": "This method will auto-generate an ID and create a new session type. If an ID is specified for the session type, an error will be thrown.", "operationId": "createSessionType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionType" } } }, "description": "The session type that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionType" } } }, "description": "The session type was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The session type you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The session type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add session type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new session type record that does not already exist.", "tags": [ "Session Types" ] } }, "/sessionTypes/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The session type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve session type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Session Types" ] } }, "/sessionTypes/{tenantId}/public": { "get": { "description": "This method will scan all session types and and return them to the caller.", "operationId": "listSessionTypesPublic", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key, if you're making a subsequent request", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SessionType" }, "type": "array" } } }, "description": "The session typeswere retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add contact role based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "summary": "Gets all of the session types in the system.", "tags": [ "Session Types" ] } }, "/sessionTypes/{tenantId}/{id}": { "delete": { "description": "This method will delete a session type with the specified ID.", "operationId": "deleteSessionType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the session type to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The session type was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The session type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The session type could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete session type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a session type from the system by its ID.", "tags": [ "Session Types" ] }, "get": { "description": "This method will look up a session type by the specified ID and return it back.", "operationId": "getSessionType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the session type to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionType" } } }, "description": "The session type was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The session type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve session type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a session type from the system by its ID.", "tags": [ "Session Types" ] }, "patch": { "description": "This method will patch an existing session type with the specified ID, using the HTTP PATCH specification.", "operationId": "patchSessionType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the session type to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionType" } } }, "description": "The session type was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The session type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The session type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve session type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a session type with the specified ID.", "tags": [ "Session Types" ] }, "put": { "description": "This method will update an existing session type with the specified ID.", "operationId": "updateSessionType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the session type to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionType" } } }, "description": "The updated session type that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionType" } } }, "description": "The session type was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The session type supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The session type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The session type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve session type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a session type with the specified ID.", "tags": [ "Session Types" ] } }, "/sessions/{tenantId}": { "post": { "description": "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.", "operationId": "createSession", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Session" } } }, "description": "The session that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Session" } } }, "description": "The session was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The session you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The session could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add session based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new session record that does not already exist.", "tags": [ "Sessions" ] } }, "/sessions/{tenantId}/abstract/{abstract_id}": { "get": { "description": "Returns a list of records with the specified abstract_id", "operationId": "listSessionsByAbstractId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "abstract_id", "required": true, "description": "The abstract_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSessionsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified abstract_id", "tags": [ "Sessions" ] }, "post": { "description": "Generates a session with speaker information from an abstract record", "operationId": "generateSessionFromAbstract", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "abstract_id", "required": true, "description": "The id of the abstract", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionGenerationRequest" } } }, "description": "AbstractIDs and FormData for sessions step function", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Session" } } }, "description": "The record was retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate any organizations with the specified domain", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Generate Session from Abstract", "tags": [ "Sessions" ] } }, "/sessions/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The session could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve session based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Sessions" ] } }, "/sessions/{tenantId}/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listSessionsByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSessionsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_id", "tags": [ "Sessions" ] } }, "/sessions/{tenantId}/privileges/{id}/{contactId}": { "get": { "description": "Returns things a person can do for a session", "operationId": "getPrivileges", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The session ID", "schema": { "type": "string" } }, { "in": "path", "name": "contactId", "required": true, "description": "The contact", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivilegesResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Get Privileges for a session", "tags": [ "Sessions" ] } }, "/sessions/{tenantId}/public/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "describeSessionsForEvent", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DescribeSessionsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "summary": "Describes all of the sessions for an event", "tags": [ "Sessions" ] } }, "/sessions/{tenantId}/public/search": { "post": { "description": "Searches for sessions using predefined parameters", "operationId": "publicSearchSessions", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key for the search, for paging support", "schema": { "type": "string" } }, { "in": "query", "name": "fieldsToReturn", "required": false, "description": " The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/SessionSearchParameters" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedSessionSearchResults" } } }, "description": "The session search was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The session you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The session could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add session based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "summary": "Searches for sessions using predefined parameters", "tags": [ "Sessions" ] } }, "/sessions/{tenantId}/public/{id}": { "get": { "description": "This method will look up a session by the specified ID and return it back.", "operationId": "publicGetSession", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the session to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Session" } } }, "description": "The session was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The session could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve session based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "summary": "Returns a session from the system by its ID.", "tags": [ "Sessions" ] } }, "/sessions/{tenantId}/search": { "post": { "description": "Searches for sessions using predefined parameters", "operationId": "searchForSessions", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key for the search, for paging support", "schema": { "type": "string" } }, { "in": "query", "name": "fieldsToReturn", "required": false, "description": " The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/SessionSearchParameters" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedSessionSearchResults" } } }, "description": "The session search was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The session you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The session could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add session based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Searches for sessions using predefined parameters", "tags": [ "Sessions" ] } }, "/sessions/{tenantId}/{id}": { "delete": { "description": "This method will delete a session with the specified ID.", "operationId": "deleteSession", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the session to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The session was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The session could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The session could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete session based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a session from the system by its ID.", "tags": [ "Sessions" ] }, "get": { "description": "This method will look up a session by the specified ID and return it back.", "operationId": "getSession", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the session to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Session" } } }, "description": "The session was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The session could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve session based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a session from the system by its ID.", "tags": [ "Sessions" ] }, "patch": { "description": "This method will patch an existing session with the specified ID, using the HTTP PATCH specification.", "operationId": "patchSession", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the session to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Session" } } }, "description": "The session was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The session could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The session could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve session based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a session with the specified ID.", "tags": [ "Sessions" ] }, "put": { "description": "This method will update an existing session with the specified ID.", "operationId": "updateSession", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the session to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Session" } } }, "description": "The updated session that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Session" } } }, "description": "The session was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The session supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The session could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The session could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve session based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a session with the specified ID.", "tags": [ "Sessions" ] } }, "/settings/{tenantId}": { "delete": { "description": "This method will delete a setting with the specified ID.", "operationId": "deleteSetting", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The setting was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The setting could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The setting could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete setting based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a setting from the system by its ID.", "tags": [ "Settings" ] }, "get": { "description": "This method will look up a setting by the specified ID and return it back.", "operationId": "getSetting", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Setting" } } }, "description": "The setting was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The setting could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve setting based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a setting from the system by its ID.", "tags": [ "Settings" ] }, "patch": { "description": "This method will patch an existing setting with the specified ID, using the HTTP PATCH specification.", "operationId": "patchSetting", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Setting" } } }, "description": "The setting was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The setting could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The setting could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve setting based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a setting with the specified ID.", "tags": [ "Settings" ] }, "post": { "description": "This method will auto-generate an ID and create a new setting. If an ID is specified for the setting, an error will be thrown.", "operationId": "createSetting", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Setting" } } }, "description": "The setting that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Setting" } } }, "description": "The setting was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The setting you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The setting could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add setting based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new setting record that does not already exist.", "tags": [ "Settings" ] }, "put": { "description": "This method will update an existing setting with the specified ID.", "operationId": "updateSetting", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Setting" } } }, "description": "The updated setting that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Setting" } } }, "description": "The setting was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The setting supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The setting could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The setting could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve setting based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a setting with the specified ID.", "tags": [ "Settings" ] } }, "/showFloors/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new show floor. If an ID is specified for the show floor, an error will be thrown.", "operationId": "createShowFloor", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShowFloor" } } }, "description": "The show floor that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShowFloor" } } }, "description": "The show floor was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The show floor you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The show floor could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add show floor based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new show floor record that does not already exist.", "tags": [ "Show Floors" ] } }, "/showFloors/{tenantId}/{id}": { "delete": { "description": "This method will delete a show floor with the specified ID.", "operationId": "deleteShowFloor", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the show floor to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The show floor was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The show floor could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The show floor could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete show floor based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a show floor from the system by its ID.", "tags": [ "Show Floors" ] }, "get": { "description": "This method will look up a show floor by the specified ID and return it back.", "operationId": "getShowFloor", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the show floor to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShowFloor" } } }, "description": "The show floor was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The show floor could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve show floor based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a show floor from the system by its ID.", "tags": [ "Show Floors" ] }, "patch": { "description": "This method will patch an existing show floor with the specified ID, using the HTTP PATCH specification.", "operationId": "patchShowFloor", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the show floor to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShowFloor" } } }, "description": "The show floor was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The show floor could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The show floor could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve show floor based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a show floor with the specified ID.", "tags": [ "Show Floors" ] }, "put": { "description": "This method will update an existing show floor with the specified ID.", "operationId": "updateShowFloor", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the show floor to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShowFloor" } } }, "description": "The updated show floor that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShowFloor" } } }, "description": "The show floor was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The show floor supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The show floor could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The show floor could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve show floor based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a show floor with the specified ID.", "tags": [ "Show Floors" ] } }, "/speakerProfiles/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new speaker profile. If an ID is specified for the speaker profile, an error will be thrown.", "operationId": "createSpeakerProfile", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeakerProfile" } } }, "description": "The speaker profile that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeakerProfile" } } }, "description": "The speaker profile was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The speaker profile you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The speaker profile could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add speaker profile based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new speaker profile record that does not already exist.", "tags": [ "Speaker Profiles" ] } }, "/speakerProfiles/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The speaker profile could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve speaker profile based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Speaker Profiles" ] } }, "/speakerProfiles/{tenantId}/search": { "post": { "description": "Searches for speaker profiles using predefined parameters", "operationId": "searchForSpeakerProfiles", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key for the search, for paging support", "schema": { "type": "string" } }, { "in": "query", "name": "fieldsToReturn", "required": false, "description": " The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeakerProfileSearchParameters" } } }, "description": "The speaker profile that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedSpeakerProfileSearchResults" } } }, "description": "The speaker profile search was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The speaker profile you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The speaker profile could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add speaker profile based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Searches for speaker profiles using predefined parameters", "tags": [ "Speaker Profiles" ] } }, "/speakerProfiles/{tenantId}/{id}": { "delete": { "description": "This method will delete a speaker profile with the specified ID.", "operationId": "deleteSpeakerProfile", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the speaker profile to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The speaker profile was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The speaker profile could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The speaker profile could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete speaker profile based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a speaker profile from the system by its ID.", "tags": [ "Speaker Profiles" ] }, "get": { "description": "This method will look up a speaker profile by the specified ID and return it back.", "operationId": "getSpeakerProfile", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the speaker profile to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeakerProfile" } } }, "description": "The speaker profile was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The speaker profile could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve speaker profile based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a speaker profile from the system by its ID.", "tags": [ "Speaker Profiles" ] }, "patch": { "description": "This method will patch an existing speaker profile with the specified ID, using the HTTP PATCH specification.", "operationId": "patchSpeakerProfile", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the speaker profile to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeakerProfile" } } }, "description": "The speaker profile was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The speaker profile could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The speaker profile could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve speaker profile based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a speaker profile with the specified ID.", "tags": [ "Speaker Profiles" ] }, "put": { "description": "This method will update an existing speaker profile with the specified ID.", "operationId": "updateSpeakerProfile", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the speaker profile to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeakerProfile" } } }, "description": "The updated speaker profile that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeakerProfile" } } }, "description": "The speaker profile was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The speaker profile supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The speaker profile could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The speaker profile could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve speaker profile based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a speaker profile with the specified ID.", "tags": [ "Speaker Profiles" ] } }, "/speakerTopics/{tenantId}": { "get": { "description": "This method will scan all speaker topics and and return them to the caller.", "operationId": "listSpeakerTopics", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key, if you're making a subsequent request", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SpeakerTopic" }, "type": "array" } } }, "description": "The speaker topicswere retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add contact role based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Gets all of the speaker topics in the system.", "tags": [ "Speaker Topics" ] }, "post": { "description": "This method will auto-generate an ID and create a new speaker topic. If an ID is specified for the speaker topic, an error will be thrown.", "operationId": "createSpeakerTopic", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeakerTopic" } } }, "description": "The speaker topic that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeakerTopic" } } }, "description": "The speaker topic was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The speaker topic you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The speaker topic could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add speaker topic based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new speaker topic record that does not already exist.", "tags": [ "Speaker Topics" ] } }, "/speakerTopics/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The speaker topic could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve speaker topic based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Speaker Topics" ] } }, "/speakerTopics/{tenantId}/{id}": { "delete": { "description": "This method will delete a speaker topic with the specified ID.", "operationId": "deleteSpeakerTopic", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the speaker topic to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The speaker topic was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The speaker topic could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The speaker topic could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete speaker topic based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a speaker topic from the system by its ID.", "tags": [ "Speaker Topics" ] }, "get": { "description": "This method will look up a speaker topic by the specified ID and return it back.", "operationId": "getSpeakerTopic", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the speaker topic to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeakerTopic" } } }, "description": "The speaker topic was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The speaker topic could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve speaker topic based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a speaker topic from the system by its ID.", "tags": [ "Speaker Topics" ] }, "patch": { "description": "This method will patch an existing speaker topic with the specified ID, using the HTTP PATCH specification.", "operationId": "patchSpeakerTopic", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the speaker topic to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeakerTopic" } } }, "description": "The speaker topic was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The speaker topic could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The speaker topic could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve speaker topic based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a speaker topic with the specified ID.", "tags": [ "Speaker Topics" ] }, "put": { "description": "This method will update an existing speaker topic with the specified ID.", "operationId": "updateSpeakerTopic", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the speaker topic to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeakerTopic" } } }, "description": "The updated speaker topic that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeakerTopic" } } }, "description": "The speaker topic was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The speaker topic supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The speaker topic could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The speaker topic could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve speaker topic based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a speaker topic with the specified ID.", "tags": [ "Speaker Topics" ] } }, "/speakerTypes/{tenantId}": { "get": { "description": "This method will scan all speaker types and and return them to the caller.", "operationId": "listSpeakerTypes", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key, if you're making a subsequent request", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SpeakerType" }, "type": "array" } } }, "description": "The speaker typeswere retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add contact role based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Gets all of the speaker types in the system.", "tags": [ "Speaker Types" ] }, "post": { "description": "This method will auto-generate an ID and create a new speaker type. If an ID is specified for the speaker type, an error will be thrown.", "operationId": "createSpeakerType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeakerType" } } }, "description": "The speaker type that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeakerType" } } }, "description": "The speaker type was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The speaker type you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The speaker type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add speaker type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new speaker type record that does not already exist.", "tags": [ "Speaker Types" ] } }, "/speakerTypes/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The speaker type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve speaker type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Speaker Types" ] } }, "/speakerTypes/{tenantId}/{id}": { "delete": { "description": "This method will delete a speaker type with the specified ID.", "operationId": "deleteSpeakerType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the speaker type to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The speaker type was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The speaker type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The speaker type could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete speaker type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a speaker type from the system by its ID.", "tags": [ "Speaker Types" ] }, "get": { "description": "This method will look up a speaker type by the specified ID and return it back.", "operationId": "getSpeakerType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the speaker type to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeakerType" } } }, "description": "The speaker type was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The speaker type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve speaker type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a speaker type from the system by its ID.", "tags": [ "Speaker Types" ] }, "patch": { "description": "This method will patch an existing speaker type with the specified ID, using the HTTP PATCH specification.", "operationId": "patchSpeakerType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the speaker type to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeakerType" } } }, "description": "The speaker type was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The speaker type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The speaker type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve speaker type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a speaker type with the specified ID.", "tags": [ "Speaker Types" ] }, "put": { "description": "This method will update an existing speaker type with the specified ID.", "operationId": "updateSpeakerType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the speaker type to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeakerType" } } }, "description": "The updated speaker type that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeakerType" } } }, "description": "The speaker type was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The speaker type supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The speaker type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The speaker type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve speaker type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a speaker type with the specified ID.", "tags": [ "Speaker Types" ] } }, "/speakers/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new speaker. If an ID is specified for the speaker, an error will be thrown.", "operationId": "createSpeaker", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Speaker" } } }, "description": "The speaker that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Speaker" } } }, "description": "The speaker was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The speaker you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The speaker could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add speaker based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new speaker record that does not already exist.", "tags": [ "Speakers" ] } }, "/speakers/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The speaker could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve speaker based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Speakers" ] } }, "/speakers/{tenantId}/contact/{contact_id}": { "get": { "description": "Returns a list of records with the specified contact_id", "operationId": "listSpeakersByContactId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "contact_id", "required": true, "description": "The contact_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSpeakersResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified contact_id", "tags": [ "Speakers" ] } }, "/speakers/{tenantId}/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listSpeakersByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSpeakersResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_id", "tags": [ "Speakers" ] } }, "/speakers/{tenantId}/public/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "describeSpeakersForEvent", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSpeakersResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "summary": "Returns a list of records with the specified event_id", "tags": [ "Speakers" ] } }, "/speakers/{tenantId}/public/{id}": { "get": { "description": "This method will look up a speaker by the specified ID and return it back.", "operationId": "publicGetSpeaker", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the speaker to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Speaker" } } }, "description": "The speaker was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The speaker could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve speaker based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "summary": "Returns a speaker from the system by its ID.", "tags": [ "Speakers" ] } }, "/speakers/{tenantId}/search": { "post": { "description": "Searches for speakers using predefined parameters", "operationId": "searchForSpeakers", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key for the search, for paging support", "schema": { "type": "string" } }, { "in": "query", "name": "fieldsToReturn", "required": false, "description": " The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeakerSearchParameters" } } }, "description": "The speaker that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedSpeakerSearchResults" } } }, "description": "The speaker search was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The speaker you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The speaker could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add speaker based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Searches for speakers using predefined parameters", "tags": [ "Speakers" ] } }, "/speakers/{tenantId}/{id}": { "delete": { "description": "This method will delete a speaker with the specified ID.", "operationId": "deleteSpeaker", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the speaker to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The speaker was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The speaker could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The speaker could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete speaker based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a speaker from the system by its ID.", "tags": [ "Speakers" ] }, "get": { "description": "This method will look up a speaker by the specified ID and return it back.", "operationId": "getSpeaker", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the speaker to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Speaker" } } }, "description": "The speaker was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The speaker could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve speaker based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a speaker from the system by its ID.", "tags": [ "Speakers" ] }, "patch": { "description": "This method will patch an existing speaker with the specified ID, using the HTTP PATCH specification.", "operationId": "patchSpeaker", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the speaker to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Speaker" } } }, "description": "The speaker was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The speaker could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The speaker could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve speaker based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a speaker with the specified ID.", "tags": [ "Speakers" ] }, "put": { "description": "This method will update an existing speaker with the specified ID.", "operationId": "updateSpeaker", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the speaker to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Speaker" } } }, "description": "The updated speaker that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Speaker" } } }, "description": "The speaker was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The speaker supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The speaker could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The speaker could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve speaker based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a speaker with the specified ID.", "tags": [ "Speakers" ] } }, "/sponsorLevels/{tenantId}": { "get": { "description": "This method will scan all sponsor levels and and return them to the caller.", "operationId": "listSponsorLevels", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key, if you're making a subsequent request", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SponsorLevel" }, "type": "array" } } }, "description": "The sponsor levelswere retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add contact role based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Gets all of the sponsor levels in the system.", "tags": [ "Sponsor Levels" ] }, "post": { "description": "This method will auto-generate an ID and create a new sponsor level. If an ID is specified for the sponsor level, an error will be thrown.", "operationId": "createSponsorLevel", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SponsorLevel" } } }, "description": "The sponsor level that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SponsorLevel" } } }, "description": "The sponsor level was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The sponsor level you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The sponsor level could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add sponsor level based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new sponsor level record that does not already exist.", "tags": [ "Sponsor Levels" ] } }, "/sponsorLevels/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The sponsor level could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve sponsor level based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Sponsor Levels" ] } }, "/sponsorLevels/{tenantId}/{id}": { "delete": { "description": "This method will delete a sponsor level with the specified ID.", "operationId": "deleteSponsorLevel", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the sponsor level to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The sponsor level was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The sponsor level could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The sponsor level could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete sponsor level based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a sponsor level from the system by its ID.", "tags": [ "Sponsor Levels" ] }, "get": { "description": "This method will look up a sponsor level by the specified ID and return it back.", "operationId": "getSponsorLevel", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the sponsor level to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SponsorLevel" } } }, "description": "The sponsor level was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The sponsor level could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve sponsor level based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a sponsor level from the system by its ID.", "tags": [ "Sponsor Levels" ] }, "patch": { "description": "This method will patch an existing sponsor level with the specified ID, using the HTTP PATCH specification.", "operationId": "patchSponsorLevel", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the sponsor level to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SponsorLevel" } } }, "description": "The sponsor level was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The sponsor level could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The sponsor level could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve sponsor level based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a sponsor level with the specified ID.", "tags": [ "Sponsor Levels" ] }, "put": { "description": "This method will update an existing sponsor level with the specified ID.", "operationId": "updateSponsorLevel", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the sponsor level to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SponsorLevel" } } }, "description": "The updated sponsor level that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SponsorLevel" } } }, "description": "The sponsor level was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The sponsor level supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The sponsor level could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The sponsor level could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve sponsor level based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a sponsor level with the specified ID.", "tags": [ "Sponsor Levels" ] } }, "/sponsors/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new sponsor. If an ID is specified for the sponsor, an error will be thrown.", "operationId": "createSponsor", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sponsor" } } }, "description": "The sponsor that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sponsor" } } }, "description": "The sponsor was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The sponsor you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The sponsor could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add sponsor based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new sponsor record that does not already exist.", "tags": [ "Sponsors" ] } }, "/sponsors/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The sponsor could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve sponsor based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Sponsors" ] } }, "/sponsors/{tenantId}/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listSponsorsByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSponsorsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_id", "tags": [ "Sponsors" ] } }, "/sponsors/{tenantId}/organization/{organization_id}": { "get": { "description": "Returns a list of records with the specified organization_id", "operationId": "listSponsorsByOrganizationId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "organization_id", "required": true, "description": "The organization_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSponsorsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified organization_id", "tags": [ "Sponsors" ] } }, "/sponsors/{tenantId}/{id}": { "delete": { "description": "This method will delete a sponsor with the specified ID.", "operationId": "deleteSponsor", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the sponsor to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The sponsor was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The sponsor could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The sponsor could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete sponsor based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a sponsor from the system by its ID.", "tags": [ "Sponsors" ] }, "get": { "description": "This method will look up a sponsor by the specified ID and return it back.", "operationId": "getSponsor", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the sponsor to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sponsor" } } }, "description": "The sponsor was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The sponsor could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve sponsor based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a sponsor from the system by its ID.", "tags": [ "Sponsors" ] }, "patch": { "description": "This method will patch an existing sponsor with the specified ID, using the HTTP PATCH specification.", "operationId": "patchSponsor", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the sponsor to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sponsor" } } }, "description": "The sponsor was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The sponsor could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The sponsor could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve sponsor based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a sponsor with the specified ID.", "tags": [ "Sponsors" ] }, "put": { "description": "This method will update an existing sponsor with the specified ID.", "operationId": "updateSponsor", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the sponsor to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sponsor" } } }, "description": "The updated sponsor that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sponsor" } } }, "description": "The sponsor was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The sponsor supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The sponsor could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The sponsor could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve sponsor based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a sponsor with the specified ID.", "tags": [ "Sponsors" ] } }, "/statistics/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The statistic could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve statistic based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Statistics" ] } }, "/statistics/{tenantId}/{id}": { "get": { "description": "This method will look up a statistic by the specified ID and return it back.", "operationId": "getStatistic", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the statistic to return.", "schema": { "type": "string" } }, { "in": "query", "name": "parameters", "required": false, "description": "Parameters to the query", "schema": { "type": "string" } }, { "in": "query", "name": "recalculate", "required": false, "description": "If true, the latest statistic will be calculated and the cache will be updated", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statistic" } } }, "description": "The statistic was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The statistic could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve statistic based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a statistic from the system by its ID.", "tags": [ "Statistics" ] } }, "/types/{tenantId}": { "get": { "description": "This method will scan all types and and return them to the caller.", "operationId": "listTypes", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key, if you're making a subsequent request", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Type" }, "type": "array" } } }, "description": "The typeswere retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add contact role based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Gets all of the types in the system.", "tags": [ "Types" ] }, "post": { "description": "This method will auto-generate an ID and create a new type. If an ID is specified for the type, an error will be thrown.", "operationId": "createType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Type" } } }, "description": "The type that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Type" } } }, "description": "The type was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The type you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new type record that does not already exist.", "tags": [ "Types" ] } }, "/types/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Types" ] } }, "/types/{tenantId}/{id}": { "delete": { "description": "This method will delete a type with the specified ID.", "operationId": "deleteType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the type to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The type was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The type could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a type from the system by its ID.", "tags": [ "Types" ] }, "get": { "description": "This method will look up a type by the specified ID and return it back.", "operationId": "getType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the type to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Type" } } }, "description": "The type was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a type from the system by its ID.", "tags": [ "Types" ] }, "patch": { "description": "This method will patch an existing type with the specified ID, using the HTTP PATCH specification.", "operationId": "patchType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the type to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Type" } } }, "description": "The type was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a type with the specified ID.", "tags": [ "Types" ] }, "put": { "description": "This method will update an existing type with the specified ID.", "operationId": "updateType", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the type to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Type" } } }, "description": "The updated type that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Type" } } }, "description": "The type was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The type supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The type could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The type could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve type based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a type with the specified ID.", "tags": [ "Types" ] } }, "/venues/{tenantId}": { "get": { "description": "This method will scan all venues and and return them to the caller.", "operationId": "listVenues", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key, if you're making a subsequent request", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Venue" }, "type": "array" } } }, "description": "The venueswere retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add contact role based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Gets all of the venues in the system.", "tags": [ "Venues" ] }, "post": { "description": "This method will auto-generate an ID and create a new venue. If an ID is specified for the venue, an error will be thrown.", "operationId": "createVenue", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Venue" } } }, "description": "The venue that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Venue" } } }, "description": "The venue was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The venue you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The venue could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add venue based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new venue record that does not already exist.", "tags": [ "Venues" ] } }, "/venues/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The venue could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve venue based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Venues" ] } }, "/venues/{tenantId}/{id}": { "delete": { "description": "This method will delete a venue with the specified ID.", "operationId": "deleteVenue", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the venue to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The venue was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The venue could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The venue could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete venue based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a venue from the system by its ID.", "tags": [ "Venues" ] }, "get": { "description": "This method will look up a venue by the specified ID and return it back.", "operationId": "getVenue", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the venue to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Venue" } } }, "description": "The venue was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The venue could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve venue based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a venue from the system by its ID.", "tags": [ "Venues" ] }, "patch": { "description": "This method will patch an existing venue with the specified ID, using the HTTP PATCH specification.", "operationId": "patchVenue", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the venue to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Venue" } } }, "description": "The venue was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The venue could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The venue could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve venue based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a venue with the specified ID.", "tags": [ "Venues" ] }, "put": { "description": "This method will update an existing venue with the specified ID.", "operationId": "updateVenue", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the venue to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Venue" } } }, "description": "The updated venue that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Venue" } } }, "description": "The venue was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The venue supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The venue could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "405": { "description": "The request method is not allowed.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The venue could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve venue based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a venue with the specified ID.", "tags": [ "Venues" ] } }, "/waitlistProcesses/{tenantId}": { "get": { "description": "This method will scan all waitlist processes and and return them to the caller.", "operationId": "listWaitlistProcesses", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "The start key, if you're making a subsequent request", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/WaitlistProcess" }, "type": "array" } } }, "description": "The waitlist processeswere retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add contact role based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Gets all of the waitlist processes in the system.", "tags": [ "Waitlist Processes" ] }, "post": { "description": "This method will auto-generate an ID and create a new waitlist process. If an ID is specified for the waitlist process, an error will be thrown.", "operationId": "createWaitlistProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitlistProcess" } } }, "description": "The waitlist process that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitlistProcess" } } }, "description": "The waitlist process was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The waitlist process you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The waitlist process could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add waitlist process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new waitlist process record that does not already exist.", "tags": [ "Waitlist Processes" ] } }, "/waitlistProcesses/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The waitlist process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve waitlist process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Waitlist Processes" ] } }, "/waitlistProcesses/{tenantId}/{id}": { "delete": { "description": "This method will delete a waitlist process with the specified ID.", "operationId": "deleteWaitlistProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the waitlist process to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The waitlist process was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The waitlist process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The waitlist process could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete waitlist process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a waitlist process from the system by its ID.", "tags": [ "Waitlist Processes" ] }, "get": { "description": "This method will look up a waitlist process by the specified ID and return it back.", "operationId": "getWaitlistProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the waitlist process to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitlistProcess" } } }, "description": "The waitlist process was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The waitlist process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve waitlist process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a waitlist process from the system by its ID.", "tags": [ "Waitlist Processes" ] }, "patch": { "description": "This method will patch an existing waitlist process with the specified ID, using the HTTP PATCH specification.", "operationId": "patchWaitlistProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the waitlist process to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitlistProcess" } } }, "description": "The waitlist process was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The waitlist process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The waitlist process could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve waitlist process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a waitlist process with the specified ID.", "tags": [ "Waitlist Processes" ] }, "put": { "description": "This method will update an existing waitlist process with the specified ID.", "operationId": "updateWaitlistProcess", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the waitlist process to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitlistProcess" } } }, "description": "The updated waitlist process that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitlistProcess" } } }, "description": "The waitlist process was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The waitlist process supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The waitlist process could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The waitlist process could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve waitlist process based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a waitlist process with the specified ID.", "tags": [ "Waitlist Processes" ] } }, "/waitlistedContacts/{tenantId}": { "post": { "description": "This method will auto-generate an ID and create a new waitlisted contact. If an ID is specified for the waitlisted contact, an error will be thrown.", "operationId": "createWaitlistedContact", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitlistedContact" } } }, "description": "The waitlisted contact that you would like to be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitlistedContact" } } }, "description": "The waitlisted contact was saved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The waitlisted contact you supplied was invalid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The resource could not be found", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The waitlisted contact could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to add waitlisted contact based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Creates a new waitlisted contact record that does not already exist.", "tags": [ "Waitlisted Contacts" ] } }, "/waitlistedContacts/{tenantId}/batch": { "post": { "description": "TAllows you to perform up to 100 parallel patch/delete operations", "operationId": "executeBatchOperations", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchOperationRequest" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOperationResponse" } } }, "description": "Request completed successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The waitlisted contact could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve waitlisted contact based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Execute Batch Operations", "tags": [ "Waitlisted Contacts" ] } }, "/waitlistedContacts/{tenantId}/contact/{contact_id}": { "get": { "description": "Returns a list of records with the specified contact_id", "operationId": "listWaitlistedEventsByContactId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "contact_id", "required": true, "description": "The contact_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "path", "name": "contact_id", "required": true, "description": "The contact_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListWaitlistedContactsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified contact_id", "tags": [ "Waitlisted Contacts" ] } }, "/waitlistedContacts/{tenantId}/event/{event_id}": { "get": { "description": "Returns a list of records with the specified event_id", "operationId": "listContactsByEventId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListWaitlistedContactsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_id", "tags": [ "Waitlisted Contacts" ] } }, "/waitlistedContacts/{tenantId}/eventContact/{event_id}/{contact_id}": { "get": { "description": "Returns a list of records with the specified event_contact_id", "operationId": "listContactsByEventContactId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "event_id", "required": true, "description": "The event_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "path", "name": "contact_id", "required": true, "description": "The contact_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListWaitlistedContactsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified event_contact_id", "tags": [ "Waitlisted Contacts" ] } }, "/waitlistedContacts/{tenantId}/function/{function_id}": { "get": { "description": "Returns a list of records with the specified function_id", "operationId": "listContactsByFunctionId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "function_id", "required": true, "description": "The function_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListWaitlistedContactsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified function_id", "tags": [ "Waitlisted Contacts" ] } }, "/waitlistedContacts/{tenantId}/previewNotification": { "post": { "description": "Sends out a preview of the gift receipt email", "operationId": "previewNotification", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewNotification" } } }, "description": "The domain_name to use to for record lookup", "required": true }, "responses": { "200": { "description": "The record was retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate any organizations with the specified domain", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Preview Notification", "tags": [ "Waitlisted Contacts" ] } }, "/waitlistedContacts/{tenantId}/session/{session_id}": { "get": { "description": "Returns a list of records with the specified session_id", "operationId": "listContactsBySessionId", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The tenant", "schema": { "type": "string" } }, { "in": "path", "name": "session_id", "required": true, "description": "The session_id to use to for record lookup", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned", "schema": { "type": "string" } }, { "in": "query", "name": "exclusiveStartKey", "required": false, "description": "If paging, this allows you to return the next set of results", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListWaitlistedContactsResponse" } } }, "description": "The records were retrieved successfully", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "Unable to locate records", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve records based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a list of records with the specified session_id", "tags": [ "Waitlisted Contacts" ] } }, "/waitlistedContacts/{tenantId}/{id}": { "delete": { "description": "This method will delete a waitlisted contact with the specified ID.", "operationId": "deleteWaitlistedContact", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the waitlisted contact to delete.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The waitlisted contact was deleted successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The waitlisted contact could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The waitlisted contact could not be deleted because other objects refers to/depends on this one.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to delete waitlisted contact based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a waitlisted contact from the system by its ID.", "tags": [ "Waitlisted Contacts" ] }, "get": { "description": "This method will look up a waitlisted contact by the specified ID and return it back.", "operationId": "getWaitlistedContact", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the waitlisted contact to return.", "schema": { "type": "string" } }, { "in": "query", "name": "fields", "required": false, "description": "The fields that you want to retrieve; if omitted, the entire object is returned.", "schema": { "type": "string" } }, { "in": "query", "name": "consistentRead", "required": false, "description": "Indicates the API should force a consistent read on the data source.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitlistedContact" } } }, "description": "The waitlisted contact was retrieved successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The request was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The waitlisted contact could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve waitlisted contact based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Returns a waitlisted contact from the system by its ID.", "tags": [ "Waitlisted Contacts" ] }, "patch": { "description": "This method will patch an existing waitlisted contact with the specified ID, using the HTTP PATCH specification.", "operationId": "patchWaitlistedContact", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the waitlisted contact to patch.", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PatchDirectiveArray" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitlistedContact" } } }, "description": "The waitlisted contact was patched successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The JSON patch directive you supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The waitlisted contact could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The waitlisted contact could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve waitlisted contact based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Partially updates a waitlisted contact with the specified ID.", "tags": [ "Waitlisted Contacts" ] }, "put": { "description": "This method will update an existing waitlisted contact with the specified ID.", "operationId": "updateWaitlistedContact", "parameters": [ { "in": "path", "name": "tenantId", "required": true, "description": "The id of the tenant being accessed.", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "description": "The ID of the waitlisted contact to update.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitlistedContact" } } }, "description": "The updated waitlisted contact that will be saved.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitlistedContact" } } }, "description": "The waitlisted contact was updated successfully.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "400": { "description": "The waitlisted contact supplied was not valid.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "404": { "description": "The waitlisted contact could not be found.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "409": { "description": "The waitlisted contact could not be saved because it refers to/depends on a non-existent object.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "429": { "description": "Limit exceeded... unable to retrieve waitlisted contact based on tenant limits.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } }, "500": { "description": "General server error.", "headers": { "Access-Control-Allow-Headers": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } } } } }, "security": [ { "knox-authorizer": [] } ], "summary": "Updates a waitlisted contact with the specified ID.", "tags": [ "Waitlisted Contacts" ] } } }, "servers": [ { "url": "https://events.api.rhythmsoftware.com" } ], "tags": [ { "name": "Abstract Approval Processes", "description": "Abstract Approval Processes" }, { "name": "Abstract Decision Processes", "description": "Abstract Decision Processes" }, { "name": "Abstract Review Processes", "description": "Abstract Review Processes" }, { "name": "Abstract Review Rounds", "description": "Abstract Review Rounds" }, { "name": "Abstract Reviews", "description": "Abstract Reviews" }, { "name": "Abstract Settings", "description": "Abstract Settings" }, { "name": "Abstract Submission Processes", "description": "Abstract Submission Processes" }, { "name": "Abstract Types", "description": "Abstract Types" }, { "name": "Abstracts", "description": "Abstracts" }, { "name": "Coupons", "description": "Coupons" }, { "name": "Events", "description": "Events" }, { "name": "Exhibitor Add On Products", "description": "Exhibitor Add On Products" }, { "name": "Exhibitor Booth Fees", "description": "Exhibitor Booth Fees" }, { "name": "Exhibitor Booth Types", "description": "Exhibitor Booth Types" }, { "name": "Exhibitor Booths", "description": "Exhibitor Booths" }, { "name": "Exhibitor Categories", "description": "Exhibitor Categories" }, { "name": "Exhibitor Contact Types", "description": "Exhibitor Contact Types" }, { "name": "Exhibitor Priority Point Types", "description": "Exhibitor Priority Point Types" }, { "name": "Exhibitor Reg Processes", "description": "Exhibitor Reg Processes" }, { "name": "Exhibitor Registrations", "description": "Exhibitor Registrations" }, { "name": "Exhibitor Settings", "description": "Exhibitor Settings" }, { "name": "Exhibitor Show Floors", "description": "Exhibitor Show Floors" }, { "name": "Exhibitors", "description": "Exhibitors" }, { "name": "Function Fees", "description": "Function Fees" }, { "name": "Function Tickets", "description": "Function Tickets" }, { "name": "Function Types", "description": "Function Types" }, { "name": "Functions", "description": "Functions" }, { "name": "Miscellaneous Events", "description": "Miscellaneous Events" }, { "name": "Priority Point Assignments", "description": "Priority Point Assignments" }, { "name": "Query Definitions", "description": "Query Definitions" }, { "name": "Registrant Directories", "description": "Registrant Directories" }, { "name": "Registration Add On Products", "description": "Registration Add On Products" }, { "name": "Registration Add On Types", "description": "Registration Add On Types" }, { "name": "Registration Categories", "description": "Registration Categories" }, { "name": "Registration Change Fees", "description": "Registration Change Fees" }, { "name": "Registration Deadlines", "description": "Registration Deadlines" }, { "name": "Registration Groups", "description": "Registration Groups" }, { "name": "Registration Packages", "description": "Registration Packages" }, { "name": "Registration Processes", "description": "Registration Processes" }, { "name": "Registration Settings", "description": "Registration Settings" }, { "name": "Registration Substitutions", "description": "Registration Substitutions" }, { "name": "Registration Types", "description": "Registration Types" }, { "name": "Registrations", "description": "Registrations" }, { "name": "Ribbon Types", "description": "Ribbon Types" }, { "name": "Rooms", "description": "Rooms" }, { "name": "Session Fees", "description": "Session Fees" }, { "name": "Session Registrations", "description": "Session Registrations" }, { "name": "Session Tracks", "description": "Session Tracks" }, { "name": "Session Types", "description": "Session Types" }, { "name": "Sessions", "description": "Sessions" }, { "name": "Settings", "description": "Settings" }, { "name": "Show Floors", "description": "Show Floors" }, { "name": "Speaker Profiles", "description": "Speaker Profiles" }, { "name": "Speaker Topics", "description": "Speaker Topics" }, { "name": "Speaker Types", "description": "Speaker Types" }, { "name": "Speakers", "description": "Speakers" }, { "name": "Sponsor Levels", "description": "Sponsor Levels" }, { "name": "Sponsors", "description": "Sponsors" }, { "name": "Statistics", "description": "Statistics" }, { "name": "Types", "description": "Types" }, { "name": "Venues", "description": "Venues" }, { "name": "Waitlist Processes", "description": "Waitlist Processes" }, { "name": "Waitlisted Contacts", "description": "Waitlisted Contacts" } ] }