Event
A single Event.
Status
The currentstatus field of an event can have any of the following values:
- Draft (
19001) - Active (
19002) - Closed (
19003)
Fields
| Field | Description |
|---|---|
id int | Event ID Example value:1269434 |
name mlstring (required) | Event name Example value:"Bonobo Live" |
audiopreviewurl string | The audio preview url for the event Example value:"https://s3-eu-west-1.amazonaws.com/filestore-ticketmatic-com/test/9876/events/1234/image.jpg" |
availability | Information on the availability of tickets per contingent. Read-only. Example value:[ { "complimentary": 0, "free": 815, "locked_hard": 10, "locked_soft": 15, "reserved": 0, "sold_paid": 0, "sold_unpaid": 0, "tickettypeid": 89, "total": 840, "lastupdatets": "2015-05-29 09:21:10.38252" } ] |
code string | Event code. Used as a unique identifier in web sales. Example value:"864056970700" |
contingents | Information about the contingents in the Event that are not in the seatingplan Example value:[ { "id": 98, "name": "Tickets", "amount": 100, "eventid": 777701, "eventspecificprices": null, "locks": [], "pricelistid": 6, "withimportedbarcodes": false } ] |
currentstatus int | Event status The available values for this field can be found on the Event page. Example value:19001 |
description | Description of the event, visible for ticket buyers Example value:"Panda Dub, leading man of the french dub scene returns with a new show: Circle Live!" |
endts timestamp (required) | Event end time Example value:"2014-09-26 15:24:36" |
externalcode string | External event code. This field is typically set when importing data from other systems. Example value:"56975647832" |
image string (required) | The image url for the event display image Example value:"https://s3-eu-west-1.amazonaws.com/filestore-ticketmatic-com/test/9876/events/1234/image.jpg" |
info | Practical info for the event, visible for ticket buyers Example value:"Lockers available in the basement." |
layout | Layout parameters for the event Example value:{ "color": "#112233", "maxImage": true } |
locationid int | Event location ID See event locations for more information. Example value:125 |
locationname string | Event location name Automatically derived using "Concert hall" |
maxnbrofticketsperbasket int | Maximum number of tickets for this event that can be added to a basket Example value:5 |
optinsetid int | Opt-in set id Example value:125 |
previews | Preview urls for the event. Example value:[ { "type": 30002, "url": "https://www.youtube.com/watch?v=RIGgn1s3AvI" }, { "type": 30002, "url": "https://www.youtube.com/watch?v=6VrqR_GfvzE" }, { "type": 30003, "url": "https://w.soundcloud.com/player/?url=https%3A//api.soundcloud.com/tracks/356544932&color=%23ff5500&auto_play=false&hide_related=false&show_comments=true&show_user=true&show_reposts=false&show_teaser=true&visual=true" } ] |
prices EventPrices (required) | Information on the available prices for the event Example value:{ "contingents": [ { "contingentid": 1, "pricetypes": [ { "pricetypeid": 2, "saleschannels": [ { "costs": [ { "cost": 5.000000, "costid": 0 } ], "price": 30.500000, "saleschannelid": 3, "servicecharge": 1.500000, "tickettypepriceid": 4 } ] } ] } ] } |
productionid int | Production ID Example value:1256975647 |
publishedts timestamp | Event publish time Example value:"2014-09-26 15:24:36" |
queuetoken int | Queue ID Example value:421 |
revenuesplitid int | DEPRECATED Example value:125 |
saleendts timestamp | Time of end of sales. Used for all sales channels for which no specific sales period has been defined. Example value:"2014-09-26 15:24:36" |
saleschannels | Per-sales channel information about when this event is for sale. Example value:[ { "eventid": 123, "haswaitinglist": false, "isactive": true, "saleendts": "2014-09-26 15:24:36", "saleschannelid": 1, "salestartts": null } ] |
salestartts timestamp | Time of start of sales. Used for all sales channels for which no specific sales period has been defined. Example value:"2014-09-26 15:24:36" |
salestatusmessagesid int | Salestatus messages id Example value:125 |
schedule | Schedule for the event, visible for ticket buyers Example value:"20:00 support act 21:00 show 22:30 end" |
seatallowsingle bool | Allow or disallow leaving single seats on their own. |
seated_chartkey string (required) | |
seated_contingents | Seated contingents Example value:[ { "id": 98, "name": "Tickets", "amount": 100, "eventid": 777701, "eventspecificprices": null, "locks": [], "pricelistid": 6, "withimportedbarcodes": false } ] |
seatingplancontingents | Information about the contingents defined in the seatingplan. Read-only. Example value:[ { "id": 99, "name": "Name A", "amount": 50, "eventid": 777702, "seatrankid": 1 }, { "id": 100, "name": "Name B", "amount": 50, "eventid": 777702, "seatrankid": 2 } ] |
seatingplaneventspecificprices | Event specific prices in addition to the prices defined in the field { "prices": [ { "availabilities": [ true ], "position": 3, "prices": [ 25.000000 ], "pricetypeid": 1, "saleschannels": [ 1, 2 ] }, { "availabilities": [ true ], "conditions": [ { "type": "promocode", "value": "UGENT2013" } ], "position": 7, "prices": [ 30.000000 ], "pricetypeid": 2, "saleschannels": [ 1, 2 ] } ], "seatrankids": null } |
seatingplanid int | Seating plan ID Only set for events with fixed seats. Example value:125 |
seatingplanlocktemplate string | Name of the seatingplanlocktemplate to apply linking a seatingplanid to this event. This is not a numeric id but the name of the lock template as specified in the seatingplan’s logicalplan. Example value:"Default" |
seatingplanpricelistid int | Price list ID for fixed seats. Only set for events with fixed seats. See price lists for more information. Example value:125 |
seatselection bool | Enable or disable seat selection for customers. |
segmentationtags string[] | Segmentation tags Example value:[ "tag1", "tag2" ] |
servicemailids int[] | servicemailids Example value:[ 1, 2 ] |
shortdescription | Short description of the event, visible for ticket buyers Example value:"Panda Dub, leading man of the french dub scene returns with a new show: Circle Live!" |
socialdistance int | Social distance type. Determines if social distance must be practiced. Example value:50001 |
startts timestamp (required) | Event start time Example value:"2014-09-26 15:24:36" |
subtitle | Event subtitle Example value:"With live band" |
subtitle2 | Event subtitle (2) Example value:"Exclusive concert" |
tags string[] | Event tags Example value:[ "event tag1", "event tag2" ] |
ticketfeeid int | Ticket fee ID Determines which ticket fee rules are used for this event. See ticket fees for more information. Example value:125 |
ticketinfoid int | Ticketinfo id Example value:125 |
ticketlayoutid int | Ticket layout ID See ticket layouts for more information. Example value:125 |
totalmaxtickets int | Determines the total maximum amount of tickets that can be sold for event. Example value:1000 |
translations map<string, string> | Translation of event fields Example value:{ "nameen": "English name", "namefr": "Nom francais" } |
upsellid int | Upsell id Example value:125 |
waitinglisttype int | The type of the waiting list the event uses Example value:29001 |
webremark | Small description that will be shown on the sales pages of this event Example value:"Age will be checked at the entrance" |
createdts timestamp (required) | Created timestamp Example value:"2014-09-26 15:24:36" |
lastupdatets timestamp (required) | Last updated timestamp Example value:"2014-09-26 15:24:36" |
This type can have custom fields
Example
1{
2 "id": 1269434,
3 "name": "Bonobo Live",
4 "audiopreviewurl": "https://s3-eu-west-1.amazonaws.com/filestore-ticketmatic-com/test/9876/events/1234/image.jpg",
5 "availability": [
6 {
7 "complimentary": 0,
8 "free": 815,
9 "locked_hard": 10,
10 "locked_soft": 15,
11 "reserved": 0,
12 "sold_paid": 0,
13 "sold_unpaid": 0,
14 "tickettypeid": 89,
15 "total": 840,
16 "lastupdatets": "2015-05-29 09:21:10.38252"
17 }
18 ],
19 "code": "864056970700",
20 "contingents": [
21 {
22 "id": 98,
23 "name": "Tickets",
24 "amount": 100,
25 "eventid": 777701,
26 "eventspecificprices": null,
27 "locks": [],
28 "pricelistid": 6,
29 "withimportedbarcodes": false
30 }
31 ],
32 "currentstatus": 19001,
33 "description": "Panda Dub, leading man of the french dub scene returns with a new show: Circle Live!",
34 "endts": "2014-09-26 15:24:36",
35 "externalcode": "56975647832",
36 "image": "https://s3-eu-west-1.amazonaws.com/filestore-ticketmatic-com/test/9876/events/1234/image.jpg",
37 "info": "Lockers available in the basement.",
38 "layout": {
39 "color": "#112233",
40 "maxImage": true
41 },
42 "locationid": 125,
43 "locationname": "Concert hall",
44 "maxnbrofticketsperbasket": 5,
45 "optinsetid": 125,
46 "previews": [
47 {
48 "type": 30002,
49 "url": "https://www.youtube.com/watch?v=RIGgn1s3AvI"
50 },
51 {
52 "type": 30002,
53 "url": "https://www.youtube.com/watch?v=6VrqR_GfvzE"
54 },
55 {
56 "type": 30003,
57 "url": "https://w.soundcloud.com/player/?url=https%3A//api.soundcloud.com/tracks/356544932&color=%23ff5500&auto_play=false&hide_related=false&show_comments=true&show_user=true&show_reposts=false&show_teaser=true&visual=true"
58 }
59 ],
60 "prices": {
61 "contingents": [
62 {
63 "contingentid": 1,
64 "pricetypes": [
65 {
66 "pricetypeid": 2,
67 "saleschannels": [
68 {
69 "costs": [
70 {
71 "cost": 5.000000,
72 "costid": 0
73 }
74 ],
75 "price": 30.500000,
76 "saleschannelid": 3,
77 "servicecharge": 1.500000,
78 "tickettypepriceid": 4
79 }
80 ]
81 }
82 ]
83 }
84 ]
85 },
86 "productionid": 1256975647,
87 "publishedts": "2014-09-26 15:24:36",
88 "queuetoken": 421,
89 "revenuesplitid": 125,
90 "saleendts": "2014-09-26 15:24:36",
91 "saleschannels": [
92 {
93 "eventid": 123,
94 "haswaitinglist": false,
95 "isactive": true,
96 "saleendts": "2014-09-26 15:24:36",
97 "saleschannelid": 1,
98 "salestartts": null
99 }
100 ],
101 "salestartts": "2014-09-26 15:24:36",
102 "salestatusmessagesid": 125,
103 "schedule": "20:00 support act
10421:00 show
10522:30 end",
106 "seatallowsingle": false,
107 "seated_chartkey": "",
108 "seated_contingents": [
109 {
110 "id": 98,
111 "name": "Tickets",
112 "amount": 100,
113 "eventid": 777701,
114 "eventspecificprices": null,
115 "locks": [],
116 "pricelistid": 6,
117 "withimportedbarcodes": false
118 }
119 ],
120 "seatingplancontingents": [
121 {
122 "id": 99,
123 "name": "Name A",
124 "amount": 50,
125 "eventid": 777702,
126 "seatrankid": 1
127 },
128 {
129 "id": 100,
130 "name": "Name B",
131 "amount": 50,
132 "eventid": 777702,
133 "seatrankid": 2
134 }
135 ],
136 "seatingplaneventspecificprices": {
137 "prices": [
138 {
139 "availabilities": [
140 true
141 ],
142 "position": 3,
143 "prices": [ 25.000000 ],
144 "pricetypeid": 1,
145 "saleschannels": [ 1, 2 ]
146 },
147 {
148 "availabilities": [
149 true
150 ],
151 "conditions": [
152 {
153 "type": "promocode",
154 "value": "UGENT2013"
155 }
156 ],
157 "position": 7,
158 "prices": [ 30.000000 ],
159 "pricetypeid": 2,
160 "saleschannels": [ 1, 2 ]
161 }
162 ],
163 "seatrankids": null
164 },
165 "seatingplanid": 125,
166 "seatingplanlocktemplate": "Default",
167 "seatingplanpricelistid": 125,
168 "seatselection": false,
169 "segmentationtags": [
170 "tag1",
171 "tag2"
172 ],
173 "servicemailids": [ 1, 2 ],
174 "shortdescription": "Panda Dub, leading man of the french dub scene returns with a new show: Circle Live!",
175 "socialdistance": 50001,
176 "startts": "2014-09-26 15:24:36",
177 "subtitle": "With live band",
178 "subtitle2": "Exclusive concert",
179 "tags": [
180 "event tag1",
181 "event tag2"
182 ],
183 "ticketfeeid": 125,
184 "ticketinfoid": 125,
185 "ticketlayoutid": 125,
186 "totalmaxtickets": 1000,
187 "translations": {
188 "nameen": "English name",
189 "namefr": "Nom francais"
190 },
191 "upsellid": 125,
192 "waitinglisttype": 29001,
193 "webremark": "Age will be checked at the entrance",
194 "createdts": "2014-09-26 15:24:36",
195 "lastupdatets": "2014-09-26 15:24:36"
196}