TABLE OF CONTENTS |
Get Event
GET /v2/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 /v2/b2c/events/{templateId}/nextAvailableParameters
- 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 |
|---|---|---|---|
| id | The unique id of the event. Read-Only | X | X |
| templateId | The id of the parent template, which created this event instance through its schedule. Read-Only | X | X |
| 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 if the event is canceled. | ||
| emailConfirmationMessage | The message that is sent out with the order confirmation email for purchases. | ||
| type | Defines public or private event. Values:
Read-Only | X | X |
| resourceIds | List of ids for resources assigned to this event. In ACME, resources can be people, places or equipment. | ||
| scheduleId | The schedule that created this event. A schedule defines the dates and timeslots for an event. Read-Only | ||
| resources | The list of resources assigned to this event. | ||
| resources[x].type | The type of resource, e.g. Tour Guide, Classroom, or A/V Projector | ||
| 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. (e.g. Language=French) | ||
| resources[x].fields[y].name | Label for the filter, e.g. 'language' | ||
| resources[x].fields[y].value | Value for the filter, e.g. '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, e.g. 'Adult'. | ||
| priceList[x].personType.description | Description of the person type, e.g. 'ages 18-64'. Can be updated. But only updates the description for the specific event not the original person type description | ||
| priceList[x].personType.type | The type of ticket:
| ||
| 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. Read-Only | X | X |
| available | Defines if the event template is available based on the membership provided. If false the visitor doesn't meet the required membership level. Values:
Read-Only | X | X |
| admissionType | Defines whether the event is general admission or standard (time specific) Values:
Read-Only | X | X |
customFields | List of custom fields set for this event instance Read-Only | X | X |
| customFields.name | name of the custom field Read-Only | X | X |
| customFields.value | value of the custom field Read-Only | X | X |
| state | Defines the status of the event. Values:
| X | X |