TABLE OF CONTENTS


Get Event Instances


GET /v2/b2b/event/instances


Request Parameters



Field
Type
Description
Required
startTimedateISO8601 date of events you want after this time with the client timezoneno
endTimedateISO8601 date of events you want before this time with the client timezone no
saleChannelstringLimit events to those that support the specified sale channel. Valid sale channels are:
  • online
  • pointOfSale
  • insideSalesIndividual 
  • customerRep
  • salesForce
no
templateIdstringthe id of the event template you want the events for. Only used if there is a startTimeno
typestringIf left off or standard then will not return events that were made for private event templates. Valid types are
  • private
  • standard
  • all
no



startTime/endTime Offset


TimezoneOffset
EST-05:00
CST-06:00
PST-08:00
EDT-04:00
CDT-05:00
PDT-07:00



Sample Request


GET /v2/b2b/event/instances?startTime=2014-09-01T00:00:00-07:00&endTime=2014-09-02T00:00:00-07:00&templateId=abc

This will return all event instances for template "abc" that are happening on September 1st 2014. The call should be made with the tenant's timezone. It is not recommended to use a date range larger than a day. 


Response 


Returns a paginated list of Event Object



Get Event Instance


GET /v2/b2b/event/instances/{id}


Request Parameters


No additional request parameters. The instance id is in the path.


Sample Request


GET /v2/b2b/event/instances/5423a4b4e4b55hd228b00729 


Response 


A single Event Object



Update Event Instance

PUT /v2/b2b/event/instances/


Request Parameters


No additional request parameters. The instance id is in the path.


Sample Request


PUT /v2/b2b/event/instances/


Payload 

A single  Event Object


Response

A single Event Object



Field
Description
Notes
idThe unique id of the event.
templateIdThe id of the parent template, which created this event through its schedule.
startTimeThe time that the event starts.
endTimeThe time that the event ends.
resourceIdsList of ids for resources assigned to this event.
scheduleIdThe schedule that created this event.
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'.Will reflect the recent value in 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.Read Only
availableTrue if the event template is available based on the membership provided. If false the visitor doesn't meet the required membership level.Read Only
admissionTypeEither standard or generalAdmission depending on the admission type.

Read Only

customFields

List of custom fields set for this event instanceRead Only
customFields.namename of the custom field Read Only
customFields.valuevalue of the custom fieldRead Only
state
  • active
  • cancelled
  • suspended


Create Event Instance


POST /v2/b2b/event/instances/


Request Parameters


No additional request parameters. The instance id is in the path.


Sample Request

POST /v2/b2b/event/instances/5dfece6dfe98de6e87


Payload 

A single  Event Object


Response


Field
Description
Notes
idThe unique id of the event.
templateIdThe id of the parent template, which created this event through its schedule.
startTimeThe time that the event starts.
endTimeThe time that the event ends.
resourceIdsList of ids for resources assigned to this event.
scheduleIdThe schedule that created this event.
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'
salesRestrictionsCan contain any or all of the values

"online",
"customerRep",
"pointOfSale",
"manualEntry",
"reseller",
"insideSalesIndividual",
"kiosk",
"salesforce",
"collaborator"
There could be duplicate values
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.description
Description of the person type, like '13 years old and older'.

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.Read Only
availableTrue if the event template is available based on the membership provided. If false the visitor doesn't meet the required membership level.Read Only
admissionTypeEither standard or generalAdmission depending on the admission type.

Read Only

customFields

List of custom fields set for this event instanceRead Only
customFields.namename of the custom field Read Only
customFields.valuevalue of the custom fieldRead Only
state
  • active
  • cancelled
  • suspended


Get Event Summaries


GET /v2/b2b/event/instances/summaries


Request Parameters



Field
Type
Description
Required
startTimedateISO8601 date of events you want after this time with the client timezoneno
endTimedateISO8601 date of events you want before this time with the client timezone no
saleChannelstringLimit events to those that support the specified sale channel. Valid sale channels are:
  • online
  • pointOfSale
  • insideSalesIndividual 
  • customerRep
  • salesForce


no
typestringIf left off or standard then will not return events that were made for private event templates. Valid types are
  • private
  • standard
  • all
no


startTime/endTime Offset


TimezoneOffset
EST-05:00
CST-06:00
PST-08:00
EDT-04:00
CDT-05:00
PDT-07:00


Sample Request


GET /v2/b2b/event/instances/summaries?startTime=2014-09-01T00:00:00-07:00&endTime=2014-09-02T00:00:00-07:00


This will return all event instances for the tenant that are happening on September 1st 2014. The call should be made with the tenant's timezone. It is not recommended to use a date range larger than a day.


Response 


Returns a paginated list of Event Summary Object



Get Event Summaries (Advanced)

This is a post endpoint that is used used to get a list of event summaries filtered by custom field.


POST /v2/b2b/event/instances/summaries


Request Body


An Event Summary Filter Object (see below)


Sample Requests


Event Summaries Filter Sample 1: AND Operator
{
    "startTime" "2017-05-01T12:00:00-07:00"
    "endTime" "2017-06-15T12:00:00-07:00",
    "saleChannel" "pointOfSale",
    "search" "advanced",
    "customFields": {
        "operator""and",
        "fields": [
            {
                "name""customField3",
                "values": ["Green""Red"]
            },
            {
                "name""customField4",
                "values": ["small""medium"]
            }
        ]
    }
}


The name of the custom field must be "customField[x]".  To understand which number you should be using in the custom field name go to Back Office Settings -> Custom Fields.  The number in the table is the number you should be using in this variable. 


Given an event template that has color, size, firstName and lastName custom fields, sample 1 will return all events that contain a custom field color of Green or Red and size small or medium



Green
Red
Blue
SmallYesYesNo
MediumYesYesNo
LargeNoNoNo



Event Summaries Filter Sample 2: OR Operator
{
    "startTime" "2017-05-01T12:00:00-07:00",
    "endTime" "2017-06-15T12:00:00-07:00",
    "saleChannel" "pointOfSale",
    "search" "advanced",
    "customFields": {
        "operator""or",
        "fields": [
            {
                "name""customField3",
                "values": ["Green""Red"]
            },
            {
                "name""customField4",
                "values": ["small""medium"]
            }
        ]
    }

    "pagination": {

        "sortDirection": "desc",

        "sortField": "startTime"

    }

}



Given an event template that has color, size, firstName and lastName custom fields, sample 2 will return all events that contain a custom field color of Green or Red or size small or medium



Green
Red
Blue
SmallYesYesYes
MediumYesYesYes
LargeYesYesNo


Response 


Returns a paginated list of Event Summary Object



Get Event Statements


GET /v2/b2b/event/instances/statements


Request Parameters


Field
Type
Description
Required
startTimedateISO8601 date of events you want after this time with the client timezoneno
endTimedateISO8601 date of events you want before this time with the client timezone no
saleChannelstringLimit events to those that support the specified sale channel. Valid sale channels are:
  • online
  • pointOfSale
  • insideSalesIndividual 
  • customerRep
  • salesForce


no
typestringIf left off or standard then will not return events that were made for private event templates. Valid types are
  • private
  • standard
  • all
no


startTime/endTime Offset


TimezoneOffset
EST-05:00
CST-06:00
PST-08:00
EDT-04:00
CDT-5:00
PDT-7:00


Response 


Returns a paginated list of Event Statement Object



Get Event Statements (Advanced)


POST /v2/b2b/event/instances/statements


Request Body


An Event Summary Filter Object


Sample Request


See Get Event Summaries (Advanced)


Response 


Returns a paginated list of Event Statement Object



Known Issues


  • Pagination currently does not work for Event Instances and Event Summaries