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 SummaryIn Statement 
Notes
idThe unique id of the event.XX
Read Only
templateIdThe id of the parent template, which created this event through its schedule.XXRead Only
startTimeThe time that the event starts.XX
endTimeThe time that the event ends.XX




nameThe name of the eventXX
descriptionThe description of the event


capacityThe 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.


emailCancellationMessageThe message that is sent out with the event cancellation email when the event is canceled.


emailConfirmationMessageThe message that is sent out with the order confirmation email


templateIdThe id of the template that created this event.

Read Only
type'private' if this is a private event otherwise 'standard'XXRead Only
resourceIdsList of ids for resources assigned to this event.


scheduleIdThe schedule that created this event.

Read Only
resourcesThe list of resources assigned to this event.


resources[x].typeThe type of resource, like Tour Guide


resources[x].resourceTemplateIdThe id of the resource template.


resources[x].resourceIdThe id of the resource assigned to this event.


resources[x].quantityThe number of these resources required.


resources[x].fieldsList of Name Value pairs that this resource needs to satisfy. Like Language=French


resources[x].fields[y].nameLabel for the filter, like 'language'


resources[x].fields[y].valueValue for the filter, like 'French'


priceListThe price list for this event.


priceList.personTypeArray of person types (ticket types).


priceList[x].personType.idId of the person type.


priceList[x].personType.nameName of the person type, like 'Adult'.


priceList[x].personType.descriptionDescription 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.typeThe type of ticket, either Group or Individual.


priceList[x].personType.displayOrderThe order that you want the price to be displayed.


priceList[x].priceThe price for this person type.


checkInCountThe number of people that have checked in to this event.XXRead Only
availableTrue if the event template is available based on the membership provided. If false the visitor doesn't meet the required membership level.XXRead Only
admissionTypeEither standard or generalAdmission depending on the admission type.X
X

Read Only

customFields

List of custom fields set for this event instanceXXRead Only
customFields.namename of the custom field XXRead Only
customFields.valuevalue of the custom fieldXXRead Only
state
  • active
  • cancelled
  • suspended
X
X