TABLE OF CONTENTS
Get Event
GET /v1/b2c/events/{id}
Parameters
- id: (Required) the id of the event you want.
membershipId: (Optional) The current user's membership id. This allows to include membership discounts.
- membershipCategoryId: (Optional) The current user's membership category. This allows for event templates that are only accessible to memberships to be returned, also allows for price list of the event to include membership discounts.
- barcode: (Optional) The barcode from the membership card.
Returns
The requested Event Object (see below)
Get Next Available Event
GET /v1/b2c/events/{templateId}/nextAvailable
Parameters
- id: (Required) the template Id for which the next available event is to be found.
startTime: (Optional) The start time for the next available event.
- salesChannel: (Optional) The sales channel for the next available event.
membershipId: (Optional) The current user's membership id. This allows to include membership discounts.
- membershipCategoryId: (Optional) The current user's membership category. This allows for event templates that are only accessible to memberships to be returned, also allows for price list of the event to include membership discounts.
Returns
Event Object (see below). The next available event based on the request parameters.
Event Object
Field | Description | In Summary | In Statement | Notes |
|---|---|---|---|---|
| id | The unique id of the event. | X | X | Read Only |
| templateId | The id of the parent template, which created this event through its schedule. | X | X | Read Only |
| startTime | The time that the event starts. | X | X | |
| endTime | The time that the event ends. | X | X | |
| name | The name of the event | X | X | |
| description | The description of the event | |||
| capacity | The maximum number of tickets that can be sold to the event. An error will be thrown if updating to a number less than the sold quantity. | |||
| emailCancellationMessage | The message that is sent out with the event cancellation email when the event is canceled. | |||
| emailConfirmationMessage | The message that is sent out with the order confirmation email | |||
| templateId | The id of the template that created this event. | Read Only | ||
| type | 'private' if this is a private event otherwise 'standard' | X | X | Read Only |
| resourceIds | List of ids for resources assigned to this event. | |||
| scheduleId | The schedule that created this event. | Read Only | ||
| resources | The list of resources assigned to this event. | |||
| resources[x].type | The type of resource, like Tour Guide | |||
| resources[x].resourceTemplateId | The id of the resource template. | |||
| resources[x].resourceId | The id of the resource assigned to this event. | |||
| resources[x].quantity | The number of these resources required. | |||
| resources[x].fields | List of Name Value pairs that this resource needs to satisfy. Like Language=French | |||
| resources[x].fields[y].name | Label for the filter, like 'language' | |||
| resources[x].fields[y].value | Value for the filter, like 'French' | |||
| priceList | The price list for this event. | |||
| priceList.personType | Array of person types (ticket types). | |||
| priceList[x].personType.id | Id of the person type. | |||
| priceList[x].personType.name | Name of the person type, like 'Adult'. | |||
| priceList[x].personType.description | Description of the person type, like '13 years old and older'. | Can be updated. But only updates the description of the event not the original person type description | ||
| priceList[x].personType.type | The type of ticket, either Group or Individual. | |||
| priceList[x].personType.displayOrder | The order that you want the price to be displayed. | |||
| priceList[x].price | The price for this person type. | |||
| checkInCount | The number of people that have checked in to this event. | X | X | Read Only |
| available | True if the event template is available based on the membership provided. If false the visitor doesn't meet the required membership level. | X | X | Read Only |
| admissionType | Either standard or generalAdmission depending on the admission type. | X | X | Read Only |
customFields | List of custom fields set for this event instance | X | X | Read Only |
| customFields.name | name of the custom field | X | X | Read Only |
| customFields.value | value of the custom field | X | X | Read Only |
| state |
| X | X |