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 Parameters


Returns a paginated list of Event Object



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 Parameters


Returns a paginated list of Event Summary Object (see below)



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 Parameters


Returns a paginated list of Event Summary Object (see below)



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 Parameters


Returns a paginated list of Event Statement Object (see below)



Get Event Statements (Advanced)


POST /v2/b2b/event/instances/statements


Request Body


An Event Summary Filter Object (see below)


Sample Request


See Get Event Summaries (Advanced)


Response Parameters


Returns a paginated list of Event Statement Object (see below)



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/abc123 


Response Parameters


A single Event Object



Event Summary 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.
nameThe name of the event.
soldThe number of tickets sold for this event.
availableTrue if the event template is available based on the membership provided. If false the visitor doesn't meet the required membership level.
checkedInThe number of tickets that have been checked in for this event.
typeEither 'standard' or 'private'.
admissionTypeEither standard or generalAdmission depending on the admission type.
fieldStatusList of fields and their status, whether they've been modified or are locked.
originalFieldsThe values of the event when it was last synched with the template.
flexPaysA list of flex pays available to this event.
state
  • active
  • cancelled
  • suspended

cancellationDateThe date the event was cancelled.
eventResourceSummaryVo

scheduleNameThe name of the schedule that this event belongs to.
customFieldsCustom fields associated with this event.
offScheduleBoolean if this event was created with a schedule or off schedule.
organizationInformation about the organization that created this event. If the event was created as an order request or private order.
organization.idThe id of the organization that created this event.
organization.nameThe name of the organization that created this event.


Event Statement 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.
nameThe name of the event.
soldThe number of tickets sold for this event.
availableTrue if the event template is available based on the membership provided. If false the visitor doesn't meet the required membership level.
checkedInThe number of tickets that have been checked in for this event.
typeEither 'standard' or 'private'.
admissionTypeEither standard or generalAdmission depending on the admission type.
fieldStatusList of fields and their status, whether they've been modified or are locked.
state
  • active
  • cancelled
  • suspended

cancellationDateThe date the event was cancelled.
scheduleNameThe name of the schedule that this event belongs to.
customFieldsCustom fields associated with this event.
offScheduleBoolean if this event was created with a schedule or off schedule.
organizationInformation about the organization that created this event. If the event was created as an order request or private order.
organization.idThe id of the organization that created this event.
organization.nameThe name of the organization that created this event.


Event Summaries Filter


Field
Description
Notes
startTimeThe start time you want event summaries after.required
endTimeThe end time you want event summaries after.required
templateIdThe id of the template you want to limit events to.
saleChannelThe sale channel that the events must support.
typeOne of 'standard', 'private' or 'all'
resourceRequest

filterOne of 'active', 'cancelled' or 'any'
searchThe string you want to search for. This will search
pagination

pagination.pagethe page of event summaries you're looking for.
pagination.pageSizeThe maximum number of event summaries to return.
pagination.sortDirectionEither 'asc' or 'desc' for ascending or descending.
pagination.sortFieldThe field to sort the entries by.
customFields

customFields.operatorEither 'and' or 'or'. If 'and' then only those events where all of the custom fields match will be returned. If 'or' then those events where any of the custom fields match.
customFields.fieldsAn array of fields to filter on.
customFields.fields[x].nameThe name of the field to filter on.
customFields.field[x].valuesAn array of values that should be filtered.
customFields.field[x].values[y]A value to filter on.




Known Issues


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