Get a list of events

Content

Resource URL

https://apps.ticketmatic.com/api/1/{accountname}/events

Example

Request

 1use Ticketmatic\Endpoints\Events;
 2
 3$result = Events::getlist($client, array(
 4    "context" => array(
 5        "saleschannelid" => 3,
 6    ),
 7    "filter" => "select id from tm.event where locationid=1",
 8    "lastupdatesince" => "2014-09-26 15:24:36",
 9    "limit" => 100,
10    "offset" => 100,
11    "orderby" => "name",
12    "output" => "withlookup",
13    "searchterm" => "Live",
14    "simplefilter" => array(
15        "productionid" => 4,
16    ),
17));
18
19// The parameters array is optional, it can be omitted when empty.
20$result = Events::getlist($client);

Response

  1object(Ticketmatic\Endpoints\EventsList) (1) {
  2  ["data"]=>
  3  array(1) {
  4    [0]=>
  5    object(\Ticketmatic\Model\Event) (40) {
  6      ["id"]=>
  7      int(0)
  8      ["name"]=>
  9      string(11) "Bonobo Live"
 10      ["audiopreviewurl"]=>
 11      string(92) "https://s3-eu-west-1.amazonaws.com/filestore-ticketmatic-com/test/9876/events/1234/image.jpg"
 12      ["availability"]=>
 13      array(1) {
 14        [0]=>
 15        object(\Ticketmatic\Model\EventContingentAvailability) (10) {
 16          ["complimentary"]=>
 17          int(0)
 18          ["free"]=>
 19          int(0)
 20          ["locked_hard"]=>
 21          int(0)
 22          ["locked_soft"]=>
 23          int(0)
 24          ["reserved"]=>
 25          int(0)
 26          ["sold_paid"]=>
 27          int(0)
 28          ["sold_unpaid"]=>
 29          int(0)
 30          ["tickettypeid"]=>
 31          int(0)
 32          ["total"]=>
 33          int(0)
 34          ["lastupdatets"]=>
 35          object(\DateTime) (3) {
 36            ["date"]=>
 37            string(26) "2015-05-29 09:21:10.38252.000000"
 38            ["timezone_type"]=>
 39            int(3)
 40            ["timezone"]=>
 41            string(3) "UTC"
 42          }
 43        }
 44      }
 45      ["code"]=>
 46      string(12) "864056970700"
 47      ["contingents"]=>
 48      array(1) {
 49        [0]=>
 50        object(\Ticketmatic\Model\EventContingent) (8) {
 51          ["id"]=>
 52          int(0)
 53          ["name"]=>
 54          string(7) "Tickets"
 55          ["amount"]=>
 56          int(0)
 57          ["eventid"]=>
 58          int(0)
 59          ["eventspecificprices"]=>
 60          NULL
 61          ["locks"]=>
 62          array(0) {
 63          }
 64          ["pricelistid"]=>
 65          int(0)
 66          ["withimportedbarcodes"]=>
 67          bool(false)
 68        }
 69      }
 70      ["currentstatus"]=>
 71      int(0)
 72      ["description"]=>
 73      string(84) "Panda Dub, leading man of the french dub scene returns with a new show: Circle Live!"
 74      ["endts"]=>
 75      object(\DateTime) (3) {
 76        ["date"]=>
 77        string(26) "2014-09-26 15:24:36.000000"
 78        ["timezone_type"]=>
 79        int(3)
 80        ["timezone"]=>
 81        string(3) "UTC"
 82      }
 83      ["externalcode"]=>
 84      string(11) "56975647832"
 85      ["image"]=>
 86      string(92) "https://s3-eu-west-1.amazonaws.com/filestore-ticketmatic-com/test/9876/events/1234/image.jpg"
 87      ["info"]=>
 88      string(34) "Lockers available in the basement."
 89      ["locationid"]=>
 90      int(0)
 91      ["locationname"]=>
 92      string(12) "Concert hall"
 93      ["maxnbrofticketsperbasket"]=>
 94      int(0)
 95      ["previews"]=>
 96      array(3) {
 97        [0]=>
 98        object(\Ticketmatic\Model\EventPreview) (2) {
 99          ["type"]=>
100          int(0)
101          ["url"]=>
102          string(43) "https://www.youtube.com/watch?v=RIGgn1s3AvI"
103        }
104        [1]=>
105        object(\Ticketmatic\Model\EventPreview) (2) {
106          ["type"]=>
107          int(0)
108          ["url"]=>
109          string(43) "https://www.youtube.com/watch?v=6VrqR_GfvzE"
110        }
111        [2]=>
112        object(\Ticketmatic\Model\EventPreview) (2) {
113          ["type"]=>
114          int(0)
115          ["url"]=>
116          string(215) "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"
117        }
118      }
119      ["prices"]=>
120      object(\Ticketmatic\Model\EventPrices) (1) {
121        ["contingents"]=>
122        array(1) {
123          [0]=>
124          object(\Ticketmatic\Model\EventPricesContingent) (2) {
125            ["contingentid"]=>
126            int(0)
127            ["pricetypes"]=>
128            array(1) {
129              [0]=>
130              object(\Ticketmatic\Model\EventPricesPricetype) (2) {
131                ["pricetypeid"]=>
132                int(0)
133                ["saleschannels"]=>
134                array(1) {
135                  [0]=>
136                  object(\Ticketmatic\Model\EventPricesSaleschannel) (5) {
137                    ["costs"]=>
138                    array(1) {
139                      [0]=>
140                      object(\Ticketmatic\Model\EventPricesCost) (2) {
141                        ["cost"]=>
142                        float(5.000000)
143                        ["costid"]=>
144                        int(0)
145                      }
146                    }
147                    ["price"]=>
148                    float(30.500000)
149                    ["saleschannelid"]=>
150                    int(0)
151                    ["servicecharge"]=>
152                    float(1.500000)
153                    ["tickettypepriceid"]=>
154                    int(0)
155                  }
156                }
157              }
158            }
159          }
160        }
161      }
162      ["productionid"]=>
163      int(0)
164      ["publishedts"]=>
165      object(\DateTime) (3) {
166        ["date"]=>
167        string(26) "2014-09-26 15:24:36.000000"
168        ["timezone_type"]=>
169        int(3)
170        ["timezone"]=>
171        string(3) "UTC"
172      }
173      ["queuetoken"]=>
174      int(0)
175      ["revenuesplitid"]=>
176      int(0)
177      ["saleendts"]=>
178      object(\DateTime) (3) {
179        ["date"]=>
180        string(26) "2014-09-26 15:24:36.000000"
181        ["timezone_type"]=>
182        int(3)
183        ["timezone"]=>
184        string(3) "UTC"
185      }
186      ["saleschannels"]=>
187      array(1) {
188        [0]=>
189        object(\Ticketmatic\Model\EventSalesChannel) (6) {
190          ["eventid"]=>
191          int(0)
192          ["haswaitinglist"]=>
193          bool(false)
194          ["isactive"]=>
195          bool(true)
196          ["saleendts"]=>
197          object(\DateTime) (3) {
198            ["date"]=>
199            string(26) "2014-09-26 15:24:36.000000"
200            ["timezone_type"]=>
201            int(3)
202            ["timezone"]=>
203            string(3) "UTC"
204          }
205          ["saleschannelid"]=>
206          int(0)
207          ["salestartts"]=>
208          NULL
209        }
210      }
211      ["salestartts"]=>
212      object(\DateTime) (3) {
213        ["date"]=>
214        string(26) "2014-09-26 15:24:36.000000"
215        ["timezone_type"]=>
216        int(3)
217        ["timezone"]=>
218        string(3) "UTC"
219      }
220      ["schedule"]=>
221      string(38) "20:00 support act
22221:00 show
22322:30 end"
224      ["seatingplancontingents"]=>
225      array(2) {
226        [0]=>
227        object(\Ticketmatic\Model\EventSeatingplanContingent) (5) {
228          ["id"]=>
229          int(0)
230          ["name"]=>
231          string(6) "Name A"
232          ["amount"]=>
233          int(0)
234          ["eventid"]=>
235          int(0)
236          ["seatrankid"]=>
237          int(0)
238        }
239        [1]=>
240        object(\Ticketmatic\Model\EventSeatingplanContingent) (5) {
241          ["id"]=>
242          int(0)
243          ["name"]=>
244          string(6) "Name B"
245          ["amount"]=>
246          int(0)
247          ["eventid"]=>
248          int(0)
249          ["seatrankid"]=>
250          int(0)
251        }
252      }
253      ["seatingplaneventspecificprices"]=>
254      object(\Ticketmatic\Model\PricelistPrices) (2) {
255        ["prices"]=>
256        array(2) {
257          [0]=>
258          object(\Ticketmatic\Model\PricelistPrice) (5) {
259            ["availabilities"]=>
260            array(1) {
261              [0]=>
262              bool(true)
263            }
264            ["position"]=>
265            int(0)
266            ["prices"]=>
267            array(1) {
268              [0]=>
269              float(25.000000)
270            }
271            ["pricetypeid"]=>
272            int(0)
273            ["saleschannels"]=>
274            array(2) {
275              [0]=>
276              int(0)
277              [1]=>
278              int(0)
279            }
280          }
281          [1]=>
282          object(\Ticketmatic\Model\PricelistPrice) (6) {
283            ["availabilities"]=>
284            array(1) {
285              [0]=>
286              bool(true)
287            }
288            ["conditions"]=>
289            array(1) {
290              [0]=>
291              object(\Ticketmatic\Model\PricelistPriceCondition) (2) {
292                ["type"]=>
293                string(9) "promocode"
294                ["value"]=>
295                string(9) "UGENT2013"
296              }
297            }
298            ["position"]=>
299            int(0)
300            ["prices"]=>
301            array(1) {
302              [0]=>
303              float(30.000000)
304            }
305            ["pricetypeid"]=>
306            int(0)
307            ["saleschannels"]=>
308            array(2) {
309              [0]=>
310              int(0)
311              [1]=>
312              int(0)
313            }
314          }
315        }
316        ["seatrankids"]=>
317        NULL
318      }
319      ["seatingplanid"]=>
320      int(0)
321      ["seatingplanpricelistid"]=>
322      int(0)
323      ["seatselection"]=>
324      bool(false)
325      ["startts"]=>
326      object(\DateTime) (3) {
327        ["date"]=>
328        string(26) "2014-09-26 15:24:36.000000"
329        ["timezone_type"]=>
330        int(3)
331        ["timezone"]=>
332        string(3) "UTC"
333      }
334      ["subtitle"]=>
335      string(14) "With live band"
336      ["subtitle2"]=>
337      string(17) "Exclusive concert"
338      ["ticketfeeid"]=>
339      int(0)
340      ["ticketlayoutid"]=>
341      int(0)
342      ["translations"]=>
343      array(2) {
344        ["nameen"]=>
345        string(12) "English name"
346        ["namefr"]=>
347        string(12) "Nom francais"
348      }
349      ["waitinglisttype"]=>
350      int(0)
351      ["webremark"]=>
352      string(35) "Age will be checked at the entrance"
353      ["createdts"]=>
354      object(\DateTime) (3) {
355        ["date"]=>
356        string(26) "2014-09-26 15:24:36.000000"
357        ["timezone_type"]=>
358        int(3)
359        ["timezone"]=>
360        string(3) "UTC"
361      }
362      ["lastupdatets"]=>
363      object(\DateTime) (3) {
364        ["date"]=>
365        string(26) "2014-09-26 15:24:36.000000"
366        ["timezone_type"]=>
367        int(3)
368        ["timezone"]=>
369        string(3) "UTC"
370      }
371    }
372  }
373}

Request

 1import (
 2    "github.com/ticketmatic/tm-go/ticketmatic"
 3    "github.com/ticketmatic/tm-go/ticketmatic/events"
 4)
 5
 6result, err := events.Getlist(client, &ticketmatic.EventQuery{
 7    Context: &ticketmatic.EventContext{
 8        Saleschannelid: 3,
 9    },
10    Filter: "select id from tm.event where locationid=1",
11    Lastupdatesince: ticketmatic.NewTime(ticketmatic.MustParseTime("2014-09-26 15:24:36")),
12    Limit: 100,
13    Offset: 100,
14    Orderby: "name",
15    Output: "withlookup",
16    Searchterm: "Live",
17    Simplefilter: &ticketmatic.EventFilter{
18        Productionid: 4,
19    },
20})
21
22// The query object is optional, it can be omitted when empty.
23result, err := events.Getlist(client, nil)

Response

  1result := events.&List{
  2    Data: []*ticketmatic.Event{
  3        &ticketmatic.Event{
  4            Id: 1269434,
  5            Name: "Bonobo Live",
  6            Audiopreviewurl: "https://s3-eu-west-1.amazonaws.com/filestore-ticketmatic-com/test/9876/events/1234/image.jpg",
  7            Availability: []*ticketmatic.EventContingentAvailability{
  8                &ticketmatic.EventContingentAvailability{
  9                    Complimentary: 0,
 10                    Free: 815,
 11                    LockedHard: 10,
 12                    LockedSoft: 15,
 13                    Reserved: 0,
 14                    SoldPaid: 0,
 15                    SoldUnpaid: 0,
 16                    Tickettypeid: 89,
 17                    Total: 840,
 18                    Lastupdatets: ticketmatic.NewTime(ticketmatic.MustParseTime("2015-05-29 09:21:10.38252")),
 19                },
 20            },
 21            Code: "864056970700",
 22            Contingents: []*ticketmatic.EventContingent{
 23                &ticketmatic.EventContingent{
 24                    Id: 98,
 25                    Name: "Tickets",
 26                    Amount: 100,
 27                    Eventid: 777701,
 28                    Eventspecificprices: nil,
 29                    Locks: []*ticketmatic.EventContingentLock{
 30                    },
 31                    Pricelistid: 6,
 32                    Withimportedbarcodes: false,
 33                },
 34            },
 35            Currentstatus: 19001,
 36            Description: "Panda Dub, leading man of the french dub scene returns with a new show: Circle Live!",
 37            Endts: ticketmatic.NewTime(ticketmatic.MustParseTime("2014-09-26 15:24:36")),
 38            Externalcode: "56975647832",
 39            Image: "https://s3-eu-west-1.amazonaws.com/filestore-ticketmatic-com/test/9876/events/1234/image.jpg",
 40            Info: "Lockers available in the basement.",
 41            Locationid: 125,
 42            Locationname: "Concert hall",
 43            Maxnbrofticketsperbasket: 5,
 44            Previews: []*ticketmatic.EventPreview{
 45                &ticketmatic.EventPreview{
 46                    Type: 30002,
 47                    Url: "https://www.youtube.com/watch?v=RIGgn1s3AvI",
 48                },
 49                &ticketmatic.EventPreview{
 50                    Type: 30002,
 51                    Url: "https://www.youtube.com/watch?v=6VrqR_GfvzE",
 52                },
 53                &ticketmatic.EventPreview{
 54                    Type: 30003,
 55                    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",
 56                },
 57            },
 58            Prices: &ticketmatic.EventPrices{
 59                Contingents: []*ticketmatic.EventPricesContingent{
 60                    &ticketmatic.EventPricesContingent{
 61                        Contingentid: 1,
 62                        Pricetypes: []*ticketmatic.EventPricesPricetype{
 63                            &ticketmatic.EventPricesPricetype{
 64                                Pricetypeid: 2,
 65                                Saleschannels: []*ticketmatic.EventPricesSaleschannel{
 66                                    &ticketmatic.EventPricesSaleschannel{
 67                                        Costs: []*ticketmatic.EventPricesCost{
 68                                            &ticketmatic.EventPricesCost{
 69                                                Cost: 5,
 70                                                Costid: 0,
 71                                            },
 72                                        },
 73                                        Price: 30.5,
 74                                        Saleschannelid: 3,
 75                                        Servicecharge: 1.5,
 76                                        Tickettypepriceid: 4,
 77                                    },
 78                                },
 79                            },
 80                        },
 81                    },
 82                },
 83            },
 84            Productionid: 1256975647,
 85            Publishedts: ticketmatic.NewTime(ticketmatic.MustParseTime("2014-09-26 15:24:36")),
 86            Queuetoken: 421,
 87            Revenuesplitid: 125,
 88            Saleendts: ticketmatic.NewTime(ticketmatic.MustParseTime("2014-09-26 15:24:36")),
 89            Saleschannels: []*ticketmatic.EventSalesChannel{
 90                &ticketmatic.EventSalesChannel{
 91                    Eventid: 123,
 92                    Haswaitinglist: false,
 93                    Isactive: true,
 94                    Saleendts: ticketmatic.NewTime(ticketmatic.MustParseTime("2014-09-26 15:24:36")),
 95                    Saleschannelid: 1,
 96                    Salestartts: ticketmatic.NewTime(ticketmatic.MustParseTime(<nil>)),
 97                },
 98            },
 99            Salestartts: ticketmatic.NewTime(ticketmatic.MustParseTime("2014-09-26 15:24:36")),
100            Schedule: "20:00 support act\n21:00 show\n22:30 end",
101            Seatingplancontingents: []*ticketmatic.EventSeatingplanContingent{
102                &ticketmatic.EventSeatingplanContingent{
103                    Id: 99,
104                    Name: "Name A",
105                    Amount: 50,
106                    Eventid: 777702,
107                    Seatrankid: 1,
108                },
109                &ticketmatic.EventSeatingplanContingent{
110                    Id: 100,
111                    Name: "Name B",
112                    Amount: 50,
113                    Eventid: 777702,
114                    Seatrankid: 2,
115                },
116            },
117            Seatingplaneventspecificprices: &ticketmatic.PricelistPrices{
118                Prices: []*ticketmatic.PricelistPrice{
119                    &ticketmatic.PricelistPrice{
120                        Availabilities: []bool{
121                            true,
122                        },
123                        Position: 3,
124                        Prices: []float64{
125                            25,
126                        },
127                        Pricetypeid: 1,
128                        Saleschannels: []int64{
129                            1,
130                            2,
131                        },
132                    },
133                    &ticketmatic.PricelistPrice{
134                        Availabilities: []bool{
135                            true,
136                        },
137                        Conditions: []*ticketmatic.PricelistPriceCondition{
138                            &ticketmatic.PricelistPriceCondition{
139                                Type: "promocode",
140                                Value: "UGENT2013",
141                            },
142                        },
143                        Position: 7,
144                        Prices: []float64{
145                            30,
146                        },
147                        Pricetypeid: 2,
148                        Saleschannels: []int64{
149                            1,
150                            2,
151                        },
152                    },
153                },
154                Seatrankids: nil,
155            },
156            Seatingplanid: 125,
157            Seatingplanpricelistid: 125,
158            Seatselection: false,
159            Startts: ticketmatic.NewTime(ticketmatic.MustParseTime("2014-09-26 15:24:36")),
160            Subtitle: "With live band",
161            Subtitle2: "Exclusive concert",
162            Ticketfeeid: 125,
163            Ticketlayoutid: 125,
164            Translations: map[string]string{
165                "nameen": "English name",
166                "namefr": "Nom francais",
167            },
168            Waitinglisttype: 29001,
169            Webremark: "Age will be checked at the entrance",
170            Createdts: ticketmatic.NewTime(ticketmatic.MustParseTime("2014-09-26 15:24:36")),
171            Lastupdatets: ticketmatic.NewTime(ticketmatic.MustParseTime("2014-09-26 15:24:36")),
172        },
173    },
174}

Request

1GET /api/1/{accountname}/events HTTP/1.1

Response

  1HTTP/1.1 200 OK
  2Content-Type: application/json
  3
  4{
  5    "data": [
  6        {
  7            "id": 1269434,
  8            "name": "Bonobo Live",
  9            "audiopreviewurl": "https://s3-eu-west-1.amazonaws.com/filestore-ticketmatic-com/test/9876/events/1234/image.jpg",
 10            "availability": [
 11                {
 12                    "complimentary": 0,
 13                    "free": 815,
 14                    "locked_hard": 10,
 15                    "locked_soft": 15,
 16                    "reserved": 0,
 17                    "sold_paid": 0,
 18                    "sold_unpaid": 0,
 19                    "tickettypeid": 89,
 20                    "total": 840,
 21                    "lastupdatets": "2015-05-29 09:21:10.38252"
 22                }
 23            ],
 24            "code": "864056970700",
 25            "contingents": [
 26                {
 27                    "id": 98,
 28                    "name": "Tickets",
 29                    "amount": 100,
 30                    "eventid": 777701,
 31                    "eventspecificprices": null,
 32                    "locks": [],
 33                    "pricelistid": 6,
 34                    "withimportedbarcodes": false
 35                }
 36            ],
 37            "currentstatus": 19001,
 38            "description": "Panda Dub, leading man of the french dub scene returns with a new show: Circle Live!",
 39            "endts": "2014-09-26 15:24:36",
 40            "externalcode": "56975647832",
 41            "image": "https://s3-eu-west-1.amazonaws.com/filestore-ticketmatic-com/test/9876/events/1234/image.jpg",
 42            "info": "Lockers available in the basement.",
 43            "locationid": 125,
 44            "locationname": "Concert hall",
 45            "maxnbrofticketsperbasket": 5,
 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            "schedule": "20:00 support act
10321:00 show
10422:30 end",
105            "seatingplancontingents": [
106                {
107                    "id": 99,
108                    "name": "Name A",
109                    "amount": 50,
110                    "eventid": 777702,
111                    "seatrankid": 1
112                },
113                {
114                    "id": 100,
115                    "name": "Name B",
116                    "amount": 50,
117                    "eventid": 777702,
118                    "seatrankid": 2
119                }
120            ],
121            "seatingplaneventspecificprices": {
122                "prices": [
123                    {
124                        "availabilities": [
125                            true
126                        ],
127                        "position": 3,
128                        "prices": [ 25.000000 ],
129                        "pricetypeid": 1,
130                        "saleschannels": [ 1, 2 ]
131                    },
132                    {
133                        "availabilities": [
134                            true
135                        ],
136                        "conditions": [
137                            {
138                                "type": "promocode",
139                                "value": "UGENT2013"
140                            }
141                        ],
142                        "position": 7,
143                        "prices": [ 30.000000 ],
144                        "pricetypeid": 2,
145                        "saleschannels": [ 1, 2 ]
146                    }
147                ],
148                "seatrankids": null
149            },
150            "seatingplanid": 125,
151            "seatingplanpricelistid": 125,
152            "seatselection": false,
153            "startts": "2014-09-26 15:24:36",
154            "subtitle": "With live band",
155            "subtitle2": "Exclusive concert",
156            "ticketfeeid": 125,
157            "ticketlayoutid": 125,
158            "translations": {
159                "nameen": "English name",
160                "namefr": "Nom francais"
161            },
162            "waitinglisttype": 29001,
163            "webremark": "Age will be checked at the entrance",
164            "createdts": "2014-09-26 15:24:36",
165            "lastupdatets": "2014-09-26 15:24:36"
166        }
167    ]
168}

Parameters

FieldDescription
context
        </td>
        <td class="description">
            <p>Restrict the event information to a specific context.</p>  <p>Currently allows you to filter the event information (both the events and the pricing information within each event) to a specific saleschannel. This makes it very easy to show the correct information on a website.</p> 
            <strong>Example value:</strong><code>{ &#34;saleschannelid&#34;: 3 }</code>
        </td>
    </tr><tr>
        <td class="field">
            <div class="name">filter</div>
            
        </td>
        <td class="description">
            <p>A SQL query that returns event IDs</p>  <p>Can be used to do arbitrary filtering. See the <a href="db/event">database documentation for event</a> for more information.</p> 
            <strong>Example value:</strong><code>&#34;select id from tm.event where locationid=1&#34;</code>
        </td>
    </tr><tr>
        <td class="field">
            <div class="name">lastupdatesince</div>
            
        </td>
        <td class="description">
            <p>Only include events that have been updated since the given timestamp.</p> 
            <strong>Example value:</strong><code>&#34;2014-09-26 15:24:36&#34;</code>
        </td>
    </tr><tr>
        <td class="field">
            <div class="name">limit</div>
            
        </td>
        <td class="description">
            <p>Limit results to at most the given amount of events.</p> 
            <strong>Example value:</strong><code>100</code>
        </td>
    </tr><tr>
        <td class="field">
            <div class="name">offset</div>
            
        </td>
        <td class="description">
            <p>Skip the first X events.</p> 
            <strong>Example value:</strong><code>100</code>
        </td>
    </tr><tr>
        <td class="field">
            <div class="name">orderby</div>
            
        </td>
        <td class="description">
            <p>Order by the given field.</p>  <p>Supported values: <code>name</code>, <code>startts</code>.</p> 
            <strong>Example value:</strong><code>&#34;name&#34;</code>
        </td>
    </tr><tr>
        <td class="field">
            <div class="name">output</div>
            
        </td>
        <td class="description">
            <p>Output format.</p>  <p>Possible values:</p>  <ul> <li><strong>ids</strong>: Only fill the ID field</li> <li><strong>default</strong>: Return all event fields (also used when the output parameter is omitted)</li> <li><strong>withlookup</strong>: Returns all event fields and an additional <code>lookup</code> field which contains all dependent objects</li> </ul> 
            <strong>Example value:</strong><code>&#34;withlookup&#34;</code>
        </td>
    </tr><tr>
        <td class="field">
            <div class="name">searchterm</div>
            
        </td>
        <td class="description">
            <p>A text filter string.</p>  <p>Matches against the start of the event name, the production name or the subtitle.</p> 
            <strong>Example value:</strong><code>&#34;Live&#34;</code>
        </td>
    </tr><tr>
        <td class="field">
            <div class="name">simplefilter</div>
            
        </td>
        <td class="description">
            <p>Filters the events based on a given set of fields. Currently supports: <code>productionid</code>, <code>status</code> and <code>pricetypeids</code>.</p> 
            <strong>Example value:</strong><code>{ &#34;productionid&#34;: 4 }</code>
        </td>
    </tr>
</tbody>

Type reference: EventQuery

Result fields

This call returns an object with an array of objects in the data field.

FieldDescription
id
int

Event ID

Example value:1269434
name

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

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

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."
locationid
int

Event location ID

See event locations for more information.

Example value:125
locationname
string

Event location name

Automatically derived using locationid.

Example value:"Concert hall"
maxnbrofticketsperbasket
int

Maximum number of tickets for this event that can be added to a basket

Example value:5
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

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

See rate limiting for more information.

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"
schedule

Schedule for the event, visible for ticket buyers

Example value:"20:00 support act 21:00 show 22:30 end"
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 seatingplanpricelistid. Prices from the pricelist and the event specific prices are combined in one pricelist for the event. The optional position attribute defines where the event specific prices will be positioned in the resulting pricelist

Example value:{ "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
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.

startts
timestamp

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"
ticketfeeid
int

Ticket fee ID

Determines which ticket fee rules are used for this event. See ticket fees for more information.

Example value:125
ticketlayoutid
int

Ticket layout ID

See ticket layouts for more information.

Example value:125
translations
map<string, string>

Translation of event fields

Example value:{ "nameen": "English name", "namefr": "Nom francais" }
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

Created timestamp

Example value:"2014-09-26 15:24:36"
lastupdatets
timestamp

Last updated timestamp

Example value:"2014-09-26 15:24:36"

This type can have custom fields.

Type reference: Event[]

Lookup fields

When requested with an output parameter of withlookup, the following info will be available:

FieldDescription
locations
map<string, EventLocation>

Event locations

pricetypes
map<string, PriceType>

Price types

seatranks
map<string, SeatRank>

Seat ranks