ticketmaster-api-explorer.github.io/apidescription.xml at master · ticketmaster-api-staging/ticketmaster-api-explorer.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
<?xml version="1.0" encoding="UTF-8"?>
<application xmlns="http://wadl.dev.java.net/2009/02" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:apigee="http://api.apigee.com/wadl/2010/07/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://wadl.dev.java.net/2009/02 http://apigee.com/schemas/wadl-schema.xsd http://api.apigee.com/wadl/2010/07/ http://apigee.com/schemas/apigee-wadl-extensions.xsd">
  <!-- Discovery REST API Version 1 -->
  <resources base="https://app.ticketmaster.com">
    <!-- Search Events -->
    <resource path="discovery/{version}/events.{format}">
      <param name="version" required="true" type="xsd:string" style="template" default="v1">
        <doc>The API Version</doc>
      </param>
      <param name="format" required="true" type="xsd:string" style="template" default="json">
        <doc>API Response Format</doc>
      </param>
      <param name="keyword" required="false" style="query" type="xsd:string">
        <doc>A string to search against events, attractions and venues. The keyword will be checked against titles, descriptions, names and other logical fields that describe any of these data objects.
                </doc>
      </param>
      <param name="attractionId" required="false" style="query" type="xsd:string" default="768011">
        <doc>Attraction ID(s) separated by comma.
                </doc>
      </param>
      <param name="venueId" required="false" style="query" type="xsd:string" default="115378">
        <doc>Venue ID(s) separated by comma.
                </doc>
      </param>
      <param name="promoterId" required="false" style="query" type="xsd:string" default="494">
        <doc>Promoter ID(s) separated by comma.
                </doc>
      </param>
      <param name="postalCode" required="false" style="query" type="xsd:string" default="90069">
        <doc>Zipcode or Postal Code of the venue in which the event is taking place.
                </doc>
      </param>
      <param name="latlong" required="false" style="query" type="xsd:string" default="34.0928090,-118.3286610">
        <doc>The longitude/Latitude coordinates for the venue in which this event is taking place.
                </doc>
      </param>
      <param name="radius" required="false" style="query" type="xsd:integer" default="25">
        <doc>The radius of the area in which we want to search for events.
                </doc>
      </param>
      <param name="size" required="false" style="query" type="xsd:integer" default="10">
        <doc>The number of events returned in the API response.
                </doc>
      </param>
      <param name="page" required="false" style="query" type="xsd:integer" default="1">
        <doc>The page for paginating through the results.
                </doc>
      </param>
      <param name="sort" required="false" style="query" type="xsd:string">
        <doc>The search sort criteria.
                </doc>
        <option value=""/>
        <option value="eventDate,desc"/>
        <option value="eventDate,asc"/>
        <option value="name,desc"/>
        <option value="name,asc"/>
      </param>
      <param name="locale" required="false" type="xsd:string" style="query">
        <doc>The event locale, including country and localization.</doc>
        <option value=""/>
        <option value="en-us"/>
        <option value="en-gb"/>
        <option value="en-ca"/>
        <option value="es-us"/>
        <option value="en-mx"/>
        <option value="es-mx"/>
        <option value="en-au"/>
        <option value="en-nz"/>
        <option value="fr-fr"/>
        <option value="fr-ca"/>
      </param>
      <param name="marketId" required="false" style="query" type="xsd:integer" default="27">
        <doc>The city/area in which this event takes place.
                </doc>
      </param>
      <param name="deviceId" required="false" style="query" type="xsd:integer" default="1">
        <doc>The device making the API call.
                </doc>
      </param>
      <param name="domain" required="false" style="query" type="xsd:integer" default="ticketmaster.com">
        <doc>The entity interested in this event (special use case).
                </doc>
      </param>
      <method id="discovery.events.get" name="GET" apigee:displayName="Search Events">
        <apigee:tags>
          <apigee:tag primary="true">Discovery API</apigee:tag>
          <apigee:tag>Events</apigee:tag>
        </apigee:tags>
        <apigee:authentication required="true"/>
        <apigee:example url="discovery/v1/events.json"/>
        <doc apigee:url="http://ticketmaster-api.github.io/products-and-docs/apis/discovery/#srch-events">Returns the 20
                    most recent events for the authenticating user.
                </doc>
      </method>
    </resource>
    <!-- Event Details -->
    <resource path="discovery/{version}/events/{id}.{format}">
      <param name="version" required="true" type="xsd:string" style="template" default="v1">
        <doc>The API Version</doc>
      </param>
      <param name="id" required="true" type="xsd:string" style="template" default="29004F223C406ABF">
        <doc>Event ID</doc>
      </param>
      <param name="format" required="true" type="xsd:string" style="template" default="json">
        <doc>API Response Format</doc>
      </param>
      <param name="domain" required="false" style="query" type="xsd:string" default="ticketmaster.com">
        <doc>The entity interested in this event (special use case).
                </doc>
      </param>
      <param name="locale" required="false" type="xsd:string" style="query">
        <doc>The event locale, including country and localization.</doc>
        <option value=""/>
        <option value="en-us"/>
        <option value="en-gb"/>
        <option value="en-ca"/>
        <option value="es-us"/>
        <option value="en-mx"/>
        <option value="es-mx"/>
        <option value="en-au"/>
        <option value="en-nz"/>
        <option value="fr-fr"/>
        <option value="fr-ca"/>
      </param>
      <method id="discovery.events.id.get" name="GET" apigee:displayName="Get Event Details">
        <apigee:tags>
          <apigee:tag primary="true">Discovery API</apigee:tag>
          <apigee:tag>Events</apigee:tag>
        </apigee:tags>
        <apigee:authentication required="true"/>
        <apigee:example url="discovery/v1/events/29004F223C406ABF.json"/>
        <doc apigee:url="http://ticketmaster-api.github.io/products-and-docs/apis/discovery/#event-details">Returns the event detail by event ID.
                </doc>
      </method>
    </resource>
    <!-- Event Images -->
    <resource path="discovery/{version}/events/{id}/images.{format}">
      <param name="version" required="true" type="xsd:string" style="template" default="v1">
        <doc>The API Version</doc>
      </param>
      <param name="id" required="true" type="xsd:string" style="template" default="0B004F0401BD55E5">
        <doc>Event ID</doc>
      </param>
      <param name="format" required="true" type="xsd:string" style="template" default="json">
        <doc>API Response Format</doc>
      </param>
      <method id="discovery.events.id.images.get" name="GET" apigee:displayName="Search Event Images">
        <apigee:tags>
          <apigee:tag primary="true">Discovery API</apigee:tag>
          <apigee:tag>Events</apigee:tag>
        </apigee:tags>
        <apigee:authentication required="true"/>
        <apigee:example url="discovery/v1/events/29004F223C406ABF/images.json"/>
        <doc apigee:url="http://ticketmaster-api.github.io/products-and-docs/apis/discovery/#event-img">Returns all the images for an event by ID. If an event does not have an image for a supported resolution, the event's major category image will be returned instead.
                </doc>
      </method>
    </resource>
    <!-- Search Attractions -->
    <resource path="discovery/{version}/attractions.{format}">
      <param name="version" required="true" type="xsd:string" style="template" default="v1">
        <doc>The API Version</doc>
      </param>
      <param name="format" required="true" type="xsd:string" style="template" default="json">
        <doc>API Response Format</doc>
      </param>
      <param name="keyword" required="false" style="query" type="xsd:string">
        <doc>A string to search against attractions. The keyword will be checked against titles, descriptions, names and other logical fields.
                </doc>
      </param>
      <param name="domain" required="false" style="query" type="xsd:string" default="ticketmaster.com">
        <doc>The entity interested in this event (special use case).
                </doc>
      </param>
      <param name="locale" required="false" type="xsd:string" style="query">
        <doc>The attraction locale, including country and localization.</doc>
        <option value=""/>
        <option value="en-us"/>
        <option value="en-gb"/>
        <option value="en-ca"/>
        <option value="es-us"/>
        <option value="en-mx"/>
        <option value="es-mx"/>
        <option value="en-au"/>
        <option value="en-nz"/>
        <option value="fr-fr"/>
        <option value="fr-ca"/>
      </param>
      <param name="size" required="false" style="query" type="xsd:integer" default="10">
        <doc>The number of attractions returned in the API response.
                </doc>
      </param>
      <param name="page" required="false" style="query" type="xsd:integer" default="1">
        <doc>The page for paginating through the results.
                </doc>
      </param>
      <param name="sort" required="false" style="query" type="xsd:string">
        <doc>The search sort criteria.
                </doc>
        <option value=""/>
        <option value="name,desc"/>
        <option value="name,asc"/>
      </param>
      <method id="discovery.attractions.get" name="GET" apigee:displayName="Search Attractions">
        <apigee:tags>
          <apigee:tag primary="true">Discovery API</apigee:tag>
          <apigee:tag>Attractions</apigee:tag>
        </apigee:tags>
        <apigee:authentication required="true"/>
        <apigee:example url="discovery/v1/attractions.json"/>
        <doc apigee:url="http://ticketmaster-api.github.io/products-and-docs/apis/discovery/#search-attractions">Search Attractions!
                </doc>
      </method>
    </resource>
    <!-- Attraction Details -->
    <resource path="discovery/{version}/attractions/{id}.{format}">
      <param name="version" required="true" type="xsd:string" style="template" default="v1">
        <doc>The API Version</doc>
      </param>
      <param name="id" required="true" type="xsd:string" style="template" default="768011">
        <doc>Attraction ID</doc>
      </param>
      <param name="format" required="true" type="xsd:string" style="template" default="json">
        <doc>API Response Format</doc>
      </param>
      <param name="domain" required="false" style="query" type="xsd:string" default="ticketmaster.com">
        <doc>The entity interested in this attraction (special use case).
                </doc>
      </param>
      <param name="locale" required="false" type="xsd:string" style="query">
        <doc>The attraction locale, including country and localization.</doc>
        <option value=""/>
        <option value="en-us"/>
        <option value="en-gb"/>
        <option value="en-ca"/>
        <option value="es-us"/>
        <option value="en-mx"/>
        <option value="es-mx"/>
        <option value="en-au"/>
        <option value="en-nz"/>
        <option value="fr-fr"/>
        <option value="fr-ca"/>
      </param>
      <method id="discovery.attractions.id.get" name="GET" apigee:displayName="Get Attraction Details">
        <apigee:tags>
          <apigee:tag primary="true">Discovery API</apigee:tag>
          <apigee:tag>Events</apigee:tag>
        </apigee:tags>
        <apigee:authentication required="true"/>
        <apigee:example url="discovery/v1/attractions/768011.json"/>
        <doc apigee:url="http://ticketmaster-api.github.io/products-and-docs/apis/discovery/#attraction-details">Returns the attraction detail by ID.
                </doc>
      </method>
    </resource>
    <!-- Search Categories -->
    <resource path="discovery/{version}/categories.{format}">
      <param name="version" required="true" type="xsd:string" style="template" default="v1">
        <doc>The API Version</doc>
      </param>
      <param name="format" required="true" type="xsd:string" style="template" default="json">
        <doc>API Response Format</doc>
      </param>
      <param name="keyword" required="false" style="query" type="xsd:string">
        <doc>A string to search against categories. The keyword will be checked against titles, descriptions, names and other logical fields.
                </doc>
      </param>
      <param name="domain" required="false" style="query" type="xsd:string" default="ticketmaster.com">
        <doc>The entity interested in this event (special use case).
                </doc>
      </param>
      <param name="locale" required="false" type="xsd:string" style="query">
        <doc>The category locale, including country and localization.</doc>
        <option value=""/>
        <option value="en-us"/>
        <option value="en-gb"/>
        <option value="en-ca"/>
        <option value="es-us"/>
        <option value="en-mx"/>
        <option value="es-mx"/>
        <option value="en-au"/>
        <option value="en-nz"/>
        <option value="fr-fr"/>
        <option value="fr-ca"/>
      </param>
      <param name="size" required="false" style="query" type="xsd:integer" default="10">
        <doc>The number of categories returned in the API response.
                </doc>
      </param>
      <param name="page" required="false" style="query" type="xsd:integer" default="1">
        <doc>The page for paginating through the results.
                </doc>
      </param>
      <param name="sort" required="false" style="query" type="xsd:string">
        <doc>The search sort criteria.
                </doc>
        <option value=""/>
        <option value="name,desc"/>
        <option value="name,asc"/>
      </param>
      <method id="discovery.categories.get" name="GET" apigee:displayName="Search Categories">
        <apigee:tags>
          <apigee:tag primary="true">Discovery API</apigee:tag>
          <apigee:tag>Attractions</apigee:tag>
        </apigee:tags>
        <apigee:authentication required="true"/>
        <apigee:example url="discovery/v1/categories.json"/>
        <doc apigee:url="http://ticketmaster-api.github.io/products-and-docs/apis/discovery/#search-categories">Search Categories!
                </doc>
      </method>
    </resource>
    <!-- Category Details -->
    <resource path="discovery/{version}/categories/{id}.{format}">
      <param name="version" required="true" type="xsd:string" style="template" default="v1">
        <doc>The API Version</doc>
      </param>
      <param name="id" required="true" type="xsd:string" style="template" default="203">
        <doc>Category ID</doc>
      </param>
      <param name="format" required="true" type="xsd:string" style="template" default="json">
        <doc>API Response Format</doc>
      </param>
      <param name="domain" required="false" style="query" type="xsd:string" default="ticketmaster.com">
        <doc>The entity interested in this attraction (special use case).
                </doc>
      </param>
      <param name="locale" required="false" type="xsd:string" style="query">
        <doc>The attraction locale, including country and localization.</doc>
        <option value=""/>
        <option value="en-us"/>
        <option value="en-gb"/>
        <option value="en-ca"/>
        <option value="es-us"/>
        <option value="en-mx"/>
        <option value="es-mx"/>
        <option value="en-au"/>
        <option value="en-nz"/>
        <option value="fr-fr"/>
        <option value="fr-ca"/>
      </param>
      <method id="discovery.categories.id.get" name="GET" apigee:displayName="Get Category Details">
        <apigee:tags>
          <apigee:tag primary="true">Discovery API</apigee:tag>
          <apigee:tag>Events</apigee:tag>
        </apigee:tags>
        <apigee:authentication required="true"/>
        <apigee:example url="discovery/v1/categories/203.json"/>
        <doc apigee:url="http://ticketmaster-api.github.io/products-and-docs/apis/discovery/#category-details">Returns the category detail by ID.
                </doc>
      </method>
    </resource>
    <!-- Search Venues -->
    <resource path="discovery/{version}/venues.{format}">
      <param name="version" required="true" type="xsd:string" style="template" default="v1">
        <doc>The API Version</doc>
      </param>
      <param name="format" required="true" type="xsd:string" style="template" default="json">
        <doc>API Response Format</doc>
      </param>
      <param name="keyword" required="false" style="query" type="xsd:string">
        <doc>A string to search against venues. The keyword will be checked against titles, descriptions, names and other logical fields.
                </doc>
      </param>
      <param name="domain" required="false" style="query" type="xsd:string" default="ticketmaster.com">
        <doc>The entity interested in this event (special use case).
                </doc>
      </param>
      <param name="locale" required="false" type="xsd:string" style="query">
        <doc>The category locale, including country and localization.</doc>
        <option value=""/>
        <option value="en-us"/>
        <option value="en-gb"/>
        <option value="en-ca"/>
        <option value="es-us"/>
        <option value="en-mx"/>
        <option value="es-mx"/>
        <option value="en-au"/>
        <option value="en-nz"/>
        <option value="fr-fr"/>
        <option value="fr-ca"/>
      </param>
      <param name="size" required="false" style="query" type="xsd:integer" default="10">
        <doc>The number of categories returned in the API response.
                </doc>
      </param>
      <param name="page" required="false" style="query" type="xsd:integer" default="1">
        <doc>The page for paginating through the results.
                </doc>
      </param>
      <param name="sort" required="false" style="query" type="xsd:string">
        <doc>The search sort criteria.
                </doc>
        <option value=""/>
        <option value="name,desc"/>
        <option value="name,asc"/>
      </param>
      <method id="discovery.venues.get" name="GET" apigee:displayName="Search Venues">
        <apigee:tags>
          <apigee:tag primary="true">Discovery API</apigee:tag>
          <apigee:tag>Attractions</apigee:tag>
        </apigee:tags>
        <apigee:authentication required="true"/>
        <apigee:example url="discovery/v1/venues.json"/>
        <doc apigee:url="http://ticketmaster-api.github.io/products-and-docs/apis/discovery/#search-venues">Search Venues!
                </doc>
      </method>
    </resource>
    <!-- Venue Details -->
    <resource path="discovery/{version}/venues/{id}.{format}">
      <param name="version" required="true" type="xsd:string" style="template" default="v1">
        <doc>The API Version</doc>
      </param>
      <param name="id" required="true" type="xsd:string" style="template" default="90150">
        <doc>Venue ID</doc>
      </param>
      <param name="format" required="true" type="xsd:string" style="template" default="json">
        <doc>API Response Format</doc>
      </param>
      <param name="domain" required="false" style="query" type="xsd:string" default="ticketmaster.com">
        <doc>The entity interested in this attraction (special use case).
                </doc>
      </param>
      <param name="locale" required="false" type="xsd:string" style="query">
        <doc>The attraction locale, including country and localization.</doc>
        <option value=""/>
        <option value="en-us"/>
        <option value="en-gb"/>
        <option value="en-ca"/>
        <option value="es-us"/>
        <option value="en-mx"/>
        <option value="es-mx"/>
        <option value="en-au"/>
        <option value="en-nz"/>
        <option value="fr-fr"/>
        <option value="fr-ca"/>
      </param>
      <method id="discovery.venues.id.get" name="GET" apigee:displayName="Get Venue Details">
        <apigee:tags>
          <apigee:tag primary="true">Discovery API</apigee:tag>
          <apigee:tag>Events</apigee:tag>
        </apigee:tags>
        <apigee:authentication required="true"/>
        <apigee:example url="discovery/v1/venues/90150.json"/>
        <doc apigee:url="http://ticketmaster-api.github.io/products-and-docs/apis/discovery/#venue-details">Returns the venue detail by ID.
                </doc>
      </method>
    </resource>
    <!-- Event Offers -->
    <resource path="commerce/{version}/events/{id}/offers.{format}">
      <param name="version" required="true" type="xsd:string" style="template" default="v2">
        <doc>The API Version</doc>
      </param>
      <param name="id" required="true" type="xsd:string" style="template" default="05004F24E0B864B3">
        <doc>Event ID</doc>
      </param>
      <param name="format" required="true" type="xsd:string" style="template" default="json">
        <doc>API Response Format</doc>
      </param>
      <method id="commerce.events.offers" name="GET" apigee:displayName="Event Offers">
        <apigee:tags>
          <apigee:tag primary="true">Commerce API</apigee:tag>
          <apigee:tag>Commerce</apigee:tag>
        </apigee:tags>
        <apigee:authentication required="true"/>
        <apigee:example url="purchase/v2/events/00004F70F3D1C21D/offers.json"/>
        <doc apigee:url="http://ticketmaster-api.github.io/products-and-docs/apis/commerce/#event-offers">Event Offers!
                </doc>
      </method>
    </resource>
  </resources>
  <!-- UWD API -->
  <resources base="https://uapi.ticketmaster.com/">
    <!-- Get info about access token -->
    <resource path="tap/endpoint/restv1/events">
      <method id="tap.events" name="GET" apigee:displayName="Get Events">
        <apigee:tags>
          <apigee:tag primary="true">TAP</apigee:tag>
          <apigee:tag>Events</apigee:tag>
        </apigee:tags>
        <apigee:authentication required="true"/>
      </method>
    </resource>
  </resources>
</application>