thrillcall-api 0.0.3
Sign up to get free protection for your applications and to get access to all the features.
- data/.autotest +10 -0
- data/.gitignore +10 -0
- data/.rspec +4 -0
- data/.rvmrc +2 -0
- data/Gemfile +4 -0
- data/Gemfile.lock +58 -0
- data/README.md +1141 -0
- data/Rakefile +2 -0
- data/autotest/discover.rb +1 -0
- data/docs/API.html +1262 -0
- data/docs/API.md +1024 -0
- data/docs/README.html +1382 -0
- data/docs/WRAPPER.html +182 -0
- data/docs/WRAPPER.md +115 -0
- data/lib/thrillcall-api.rb +76 -0
- data/lib/thrillcall-api/exceptions.rb +7 -0
- data/lib/thrillcall-api/result.rb +142 -0
- data/lib/thrillcall-api/version.rb +3 -0
- data/script/convert_readme.rb +119 -0
- data/spec/spec_helper.rb +11 -0
- data/spec/thrillcall-api/thrillcall-api_spec.rb +477 -0
- data/thrillcall-api.gemspec +34 -0
- metadata +201 -0
data/docs/API.md
ADDED
@@ -0,0 +1,1024 @@
|
|
1
|
+
# HTTPS Endpoints
|
2
|
+
|
3
|
+
### SSL/TLS Endpoints Required:
|
4
|
+
All API access must use the secure HTTPS endpoint : https://api.thrillcall.com:443
|
5
|
+
Access over an insecure HTTP (port 80) endpoint is now deprecated and will be disabled.
|
6
|
+
|
7
|
+
### Parameters
|
8
|
+
These are valid parameters for any endpoint, however, they will only be used by the server where applicable.
|
9
|
+
|
10
|
+
**api\_key** MUST BE SUPPLIED for every endpoint.
|
11
|
+
|
12
|
+
- <a name="api_key" />**api\_key** _string: (format: length == 16)_
|
13
|
+
|
14
|
+
Your API key. Required for access to any endpoint.
|
15
|
+
|
16
|
+
- <a name="limit" />**limit** _integer_
|
17
|
+
|
18
|
+
_Default: 100_
|
19
|
+
|
20
|
+
Sets the maximum number of results to return. Cannot be above 100.
|
21
|
+
|
22
|
+
- <a name="page" />**page** _integer_
|
23
|
+
|
24
|
+
_Default: 0_
|
25
|
+
|
26
|
+
Used in conjunction with **[limit](#limit)**.
|
27
|
+
|
28
|
+
Specifies the page number. If limit is 10, then page = 2 will return results #20 through #29
|
29
|
+
|
30
|
+
- <a name="min_date" />**min\_date** _string (format: "YYYY-MM-DD")_
|
31
|
+
|
32
|
+
_Default: Today_
|
33
|
+
|
34
|
+
Results before this date will not be returned.
|
35
|
+
|
36
|
+
- <a name="max_date" />**max\_date** _string (format: "YYYY-MM-DD")_
|
37
|
+
|
38
|
+
_Default: 1 year from Today_
|
39
|
+
|
40
|
+
Results after this date will not be returned.
|
41
|
+
|
42
|
+
- <a name="lat" />**lat** _float_
|
43
|
+
|
44
|
+
_Default: none_
|
45
|
+
|
46
|
+
If latitude (**[lat](#lat)**) and longitude (**[long](#long)**) if both are specified, results will be within **[radius](#radius)** of this location.
|
47
|
+
|
48
|
+
- <a name="long" />**long** _float_
|
49
|
+
|
50
|
+
_Default: none_
|
51
|
+
|
52
|
+
If latitude (**[lat](#lat)**) and longitude (**[long](#long)**) if both are specified, results will be within **[radius](#radius)** of this location.
|
53
|
+
|
54
|
+
- <a name="postalcode" />**postalcode** _string (format: length >= 5)_
|
55
|
+
|
56
|
+
_Default: none_
|
57
|
+
|
58
|
+
Results will be within the **[radius](#radius)** of this postal code.
|
59
|
+
If latitude (**[lat](#lat)**) and longitude (**[long](#long)**) if both are specified, this will be ignored.
|
60
|
+
|
61
|
+
- <a name="radius" />**radius** _float_
|
62
|
+
|
63
|
+
_Default: 100.0_
|
64
|
+
|
65
|
+
Used in conjunction with **[postalcode](#postalcode)**
|
66
|
+
|
67
|
+
- <a name="use_partner_id" />**use\_partner\_id** _boolean_
|
68
|
+
|
69
|
+
_Default: false_
|
70
|
+
|
71
|
+
If set to _true_ or _1_, instead of using Thrillcall internal IDs, treat any IDs in a request as belonging to your partner definition.
|
72
|
+
|
73
|
+
Contact us to set up a list of definitions.
|
74
|
+
|
75
|
+
- <a name="ticket_type" />**ticket\_type** _string (format: "primary" or "resale")_
|
76
|
+
|
77
|
+
_Default: both_
|
78
|
+
|
79
|
+
If specified, will only return tickets from Primary or Resale merchants.
|
80
|
+
|
81
|
+
- <a name="must_have_tickets" />**must\_have\_tickets** _boolean_
|
82
|
+
|
83
|
+
_Default: false_
|
84
|
+
|
85
|
+
If set to _true_ or _1_, will only return results that have tickets associated with them.
|
86
|
+
|
87
|
+
- <a name="show_unconfirmed_events" />**show\_unconfirmed\_events** _boolean_
|
88
|
+
|
89
|
+
_Default: false_
|
90
|
+
|
91
|
+
If set to _true_ or _1_, will not filter out events with unconfirmed locations.
|
92
|
+
|
93
|
+
- <a name="show_rumor_events" />**show\_rumor\_events** _boolean_
|
94
|
+
|
95
|
+
_Default: false_
|
96
|
+
|
97
|
+
If set to _true_ or _1_, will not filter out events marked as rumored.
|
98
|
+
|
99
|
+
- <a name="primary_genre_id" />**primary\_genre\_id** _integer_
|
100
|
+
|
101
|
+
_Default: none_
|
102
|
+
|
103
|
+
If set, will filter Artist results to only those with the specified **[primary\_genre\_id](#primary_genre_id)**
|
104
|
+
|
105
|
+
- <a name="login" />**login** _string_
|
106
|
+
|
107
|
+
Required to authenticate/register a user.
|
108
|
+
|
109
|
+
- <a name="password" />**password** _string (format: 40 >= length >= 5)_
|
110
|
+
|
111
|
+
Required to authenticate/register a user.
|
112
|
+
|
113
|
+
- <a name="first_name" />**first\_name** _string (format: 50 >= length >= 2)_
|
114
|
+
|
115
|
+
Required to register a user.
|
116
|
+
|
117
|
+
- <a name="last_name" />**last\_name** _string (format: 50 >= length >= 2)_
|
118
|
+
|
119
|
+
Optional for registering a user.
|
120
|
+
|
121
|
+
- <a name="email" />**email** _string_
|
122
|
+
|
123
|
+
Required to register a user.
|
124
|
+
|
125
|
+
- <a name="gender" />**gender** _string (format: length == 1)_
|
126
|
+
|
127
|
+
Optional for registering a user.
|
128
|
+
|
129
|
+
## Artists
|
130
|
+
Fields:
|
131
|
+
|
132
|
+
- **created\_at** _string_ ISO 8601 representation the time this object was created
|
133
|
+
- **genre\_tags** _string_ Semicolon separated list of Genre names
|
134
|
+
- **id** _integer_ Thrillcall ID
|
135
|
+
- **name** _string_ Artist / Band Name
|
136
|
+
- **primary\_genre\_id** _integer_ The Thrillcall ID for this artist's primary Genre
|
137
|
+
- **upcoming\_events\_count** _integer_ Number of upcoming events associated with this object
|
138
|
+
- **updated\_at** _string_ ISO 8601 representation of last time this object was updated
|
139
|
+
- **url** _string_ URL for this object on Thrillcall
|
140
|
+
|
141
|
+
|
142
|
+
### GET /artists
|
143
|
+
Params:
|
144
|
+
|
145
|
+
- **[limit](#limit)**
|
146
|
+
- **[page](#page)**
|
147
|
+
- **[primary\_genre\_id](#primary_genre_id)**
|
148
|
+
|
149
|
+
Returns: _Array_ of Artists _Hash_
|
150
|
+
|
151
|
+
``` js
|
152
|
+
// Example: GET /api/v2/artists?limit=14&api_key=1234567890abcdef
|
153
|
+
|
154
|
+
[
|
155
|
+
{
|
156
|
+
"created_at": "2008-04-29T10:19:45Z",
|
157
|
+
"genre_tags": "O",
|
158
|
+
"id": 1,
|
159
|
+
"name": "Hyler Jones Proteges",
|
160
|
+
"primary_genre_id": 61,
|
161
|
+
"upcoming_events_count": 0,
|
162
|
+
"updated_at": "2010-03-26T16:49:20Z",
|
163
|
+
"url": "http://thrillcall.com/artist/Hyler_Jones_Proteges"
|
164
|
+
},
|
165
|
+
{
|
166
|
+
...
|
167
|
+
},
|
168
|
+
...
|
169
|
+
]
|
170
|
+
```
|
171
|
+
|
172
|
+
### GET /artist/:id
|
173
|
+
**:id** _integer_ Thrillcall or Partner ID
|
174
|
+
|
175
|
+
Params:
|
176
|
+
|
177
|
+
- **[use\_partner\_id](#use_partner_id)**
|
178
|
+
|
179
|
+
Returns: Artist _Hash_
|
180
|
+
|
181
|
+
``` js
|
182
|
+
// Example: GET /api/v2/artist/4802?api_key=1234567890abcdef
|
183
|
+
|
184
|
+
{
|
185
|
+
"created_at": "2008-04-28T18:56:09Z",
|
186
|
+
"genre_tags": "Rock",
|
187
|
+
"id": 4802,
|
188
|
+
"name": "The Sea and Cake",
|
189
|
+
"primary_genre_id": 27,
|
190
|
+
"upcoming_events_count": 8,
|
191
|
+
"updated_at": "2011-09-20T19:12:57Z",
|
192
|
+
"url": "http://thrillcall.com/artist/The_Sea_and_Cake"
|
193
|
+
}
|
194
|
+
```
|
195
|
+
|
196
|
+
### GET /artist/:id/events
|
197
|
+
**:id** _integer_ Thrillcall or Partner ID
|
198
|
+
|
199
|
+
Params:
|
200
|
+
|
201
|
+
- **[limit](#limit)**
|
202
|
+
- **[page](#page)**
|
203
|
+
- **[min\_date](#min_date)**
|
204
|
+
- **[max\_date](#max_date)**
|
205
|
+
- **[lat](#lat)**
|
206
|
+
- **[long](#long)**
|
207
|
+
- **[postalcode](#postalcode)**
|
208
|
+
- **[radius](#radius)**
|
209
|
+
- **[use\_partner\_id](#use_partner_id)**
|
210
|
+
- **[ticket\_type](#ticket_type)**
|
211
|
+
- **[must\_have\_tickets](#must_have_tickets)**
|
212
|
+
- **[show\_unconfirmed\_events](#show_unconfirmed_events)**
|
213
|
+
- **[show\_rumor\_events](#show_rumor_events)**
|
214
|
+
|
215
|
+
Returns: _Array_ of Events _Hash_
|
216
|
+
|
217
|
+
``` js
|
218
|
+
// Example: GET /api/v2/artist/4802/events?api_key=1234567890abcdef
|
219
|
+
|
220
|
+
[
|
221
|
+
{
|
222
|
+
"created_at": "2011-06-23T23:10:31Z",
|
223
|
+
"end_date": null,
|
224
|
+
"festival": false,
|
225
|
+
"id": 862618,
|
226
|
+
"latitude": 30.2729,
|
227
|
+
"longitude": -97.7405,
|
228
|
+
"name": "The Sea and Cake @ The Mohawk",
|
229
|
+
"num_cancelled_bookings": 0,
|
230
|
+
"num_confirmed_bookings": 1,
|
231
|
+
"num_disabled_bookings": 0,
|
232
|
+
"num_unconfirmed_bookings": 0,
|
233
|
+
"on_sale_date": null,
|
234
|
+
"rumor": false,
|
235
|
+
"start_date": "2011-12-09T05:59:00Z",
|
236
|
+
"unconfirmed_location": 0,
|
237
|
+
"updated_at": "2011-09-28T04:01:56Z",
|
238
|
+
"venue_id": 10116,
|
239
|
+
"url": "http://thrillcall.com/event/862618"
|
240
|
+
},
|
241
|
+
{
|
242
|
+
...
|
243
|
+
},
|
244
|
+
...
|
245
|
+
]
|
246
|
+
```
|
247
|
+
|
248
|
+
### GET /search/artists/:term
|
249
|
+
**:term** _string_ Arbitrary search string on the **name** field. (alphanumerics only, underscore matches underscore, use '+' for space)
|
250
|
+
|
251
|
+
Params:
|
252
|
+
|
253
|
+
- **[limit](#limit)**
|
254
|
+
- **[page](#page)**
|
255
|
+
|
256
|
+
Returns: _Array_ of Artists _Hash_
|
257
|
+
|
258
|
+
``` js
|
259
|
+
// Example: GET /api/v2/search/artists/The%20Sea%20and%20Cake?api_key=1234567890abcdef
|
260
|
+
|
261
|
+
[
|
262
|
+
{
|
263
|
+
"created_at": "2008-04-28T18:56:09Z",
|
264
|
+
"genre_tags": "Rock",
|
265
|
+
"id": 4802,
|
266
|
+
"name": "The Sea and Cake",
|
267
|
+
"primary_genre_id": 27,
|
268
|
+
"upcoming_events_count": 8,
|
269
|
+
"updated_at": "2011-09-20T19:12:57Z",
|
270
|
+
"url": "http://thrillcall.com/artist/The_Sea_and_Cake"
|
271
|
+
},
|
272
|
+
{
|
273
|
+
...
|
274
|
+
},
|
275
|
+
...
|
276
|
+
]
|
277
|
+
```
|
278
|
+
|
279
|
+
## Events
|
280
|
+
Fields:
|
281
|
+
|
282
|
+
- **created\_at** _string_ ISO 8601 representation the time this object was created
|
283
|
+
- **end\_date** _string_ ISO 8601 representation of the end of the Event
|
284
|
+
- **festival** _boolean_ Is this event a festival?
|
285
|
+
- **id** _integer_ Thrillcall ID
|
286
|
+
- **latitude** _float_ Approximate latitude for the Event
|
287
|
+
- **longitude** _float_ Approximate longitude for the Event
|
288
|
+
- **name** _string_ Name of the Event
|
289
|
+
- **num\_confirmed\_bookings** _integer_ The number of confirmed Artist bookings for this event. Only Artists with a confirmed booking are returned when requesting artists for an event.
|
290
|
+
- **num\_unconfirmed\_bookings** _integer_ The number of unconfirmed Artist bookings for this event
|
291
|
+
- **num\_disabled\_bookings** _integer_ The number of disabled Artist bookings for this event
|
292
|
+
- **num\_cancelled\_bookings** _integer_ The number of cancelled Artist bookings for this event
|
293
|
+
- **on\_sale\_date** _string_ ISO 8601 representation of the date when tickets go on sale
|
294
|
+
- **rumor** _boolean_ Are the details for this event based on a rumor?
|
295
|
+
- **start\_date** _string_ YYYY-MM-DD or, if time of day is known, ISO 8601 representation of the start of the Event
|
296
|
+
- **unconfirmed\_location** _integer_ If 1, the location if this event is unconfirmed
|
297
|
+
- **updated\_at** _string_ ISO 8601 representation of last time this object was updated
|
298
|
+
- **venue\_id** _integer_ Thrillcall Venue ID
|
299
|
+
- **url** _string_ URL for this object on Thrillcall
|
300
|
+
|
301
|
+
|
302
|
+
### GET /events
|
303
|
+
Params:
|
304
|
+
|
305
|
+
- **[limit](#limit)**
|
306
|
+
- **[page](#page)**
|
307
|
+
- **[min\_date](#min_date)**
|
308
|
+
- **[max\_date](#max_date)**
|
309
|
+
- **[lat](#lat)**
|
310
|
+
- **[long](#long)**
|
311
|
+
- **[postalcode](#postalcode)**
|
312
|
+
- **[radius](#radius)**
|
313
|
+
- **[ticket\_type](#ticket_type)**
|
314
|
+
- **[must\_have\_tickets](#must_have_tickets)**
|
315
|
+
- **[show\_unconfirmed\_events](#show_unconfirmed_events)**
|
316
|
+
- **[show\_rumor\_events](#show_rumor_events)**
|
317
|
+
|
318
|
+
Returns: _Array_ of Events _Hash_
|
319
|
+
|
320
|
+
``` js
|
321
|
+
// Example: GET /api/v2/events?must_have_tickets=true&postalcode=94108&radius=10&limit=3&api_key=1234567890abcdef
|
322
|
+
|
323
|
+
[
|
324
|
+
{
|
325
|
+
"created_at": "2011-06-14T00:09:13Z",
|
326
|
+
"end_date": null,
|
327
|
+
"festival": false,
|
328
|
+
"id": 858707,
|
329
|
+
"latitude": 37.7951,
|
330
|
+
"longitude": -122.421,
|
331
|
+
"name": "The Sea and Cake @ Great American Music Hall",
|
332
|
+
"num_cancelled_bookings": 0,
|
333
|
+
"num_confirmed_bookings": 1,
|
334
|
+
"num_disabled_bookings": 0,
|
335
|
+
"num_unconfirmed_bookings": 0,
|
336
|
+
"on_sale_date": null,
|
337
|
+
"rumor": false,
|
338
|
+
"start_date": "2011-12-06T07:59:00Z",
|
339
|
+
"unconfirmed_location": 0,
|
340
|
+
"updated_at": "2011-09-28T04:00:41Z",
|
341
|
+
"venue_id": 27418,
|
342
|
+
"url": "http://thrillcall.com/event/858707"
|
343
|
+
},
|
344
|
+
{
|
345
|
+
...
|
346
|
+
},
|
347
|
+
...
|
348
|
+
]
|
349
|
+
```
|
350
|
+
|
351
|
+
### GET /event/:id
|
352
|
+
**:id** _integer_ Thrillcall ID
|
353
|
+
|
354
|
+
Params:
|
355
|
+
|
356
|
+
- None
|
357
|
+
|
358
|
+
Returns: Event _Hash_
|
359
|
+
|
360
|
+
``` js
|
361
|
+
// Example: GET /api/v2/event/858707?api_key=1234567890abcdef
|
362
|
+
|
363
|
+
{
|
364
|
+
"created_at": "2011-06-14T00:09:13Z",
|
365
|
+
"end_date": null,
|
366
|
+
"festival": false,
|
367
|
+
"id": 858707,
|
368
|
+
"latitude": 37.7951,
|
369
|
+
"longitude": -122.421,
|
370
|
+
"name": "The Sea and Cake @ Great American Music Hall",
|
371
|
+
"num_cancelled_bookings": 0,
|
372
|
+
"num_confirmed_bookings": 1,
|
373
|
+
"num_disabled_bookings": 0,
|
374
|
+
"num_unconfirmed_bookings": 0,
|
375
|
+
"on_sale_date": null,
|
376
|
+
"rumor": false,
|
377
|
+
"start_date": "2011-12-06T07:59:00Z",
|
378
|
+
"unconfirmed_location": 0,
|
379
|
+
"updated_at": "2011-09-28T04:00:41Z",
|
380
|
+
"venue_id": 27418,
|
381
|
+
"url": "http://thrillcall.com/event/858707"
|
382
|
+
}
|
383
|
+
```
|
384
|
+
|
385
|
+
### GET /event/:id/artists
|
386
|
+
**:id** _integer_ Thrillcall ID
|
387
|
+
|
388
|
+
Params:
|
389
|
+
|
390
|
+
- **[limit](#limit)**
|
391
|
+
- **[page](#page)**
|
392
|
+
|
393
|
+
Returns: _Array_ of Artists _Hash_
|
394
|
+
|
395
|
+
``` js
|
396
|
+
// Example: GET /api/v2/event/858707/artists?api_key=1234567890abcdef
|
397
|
+
|
398
|
+
[
|
399
|
+
{
|
400
|
+
"created_at": "2008-04-28T18:56:09Z",
|
401
|
+
"genre_tags": "Rock",
|
402
|
+
"id": 4802,
|
403
|
+
"name": "The Sea and Cake",
|
404
|
+
"primary_genre_id": 27,
|
405
|
+
"upcoming_events_count": 8,
|
406
|
+
"updated_at": "2011-09-20T19:12:57Z",
|
407
|
+
"url": "http://thrillcall.com/artist/The_Sea_and_Cake"
|
408
|
+
},
|
409
|
+
{
|
410
|
+
...
|
411
|
+
},
|
412
|
+
...
|
413
|
+
]
|
414
|
+
```
|
415
|
+
|
416
|
+
### GET /event/:id/venue
|
417
|
+
**:id** _integer_ Thrillcall ID
|
418
|
+
|
419
|
+
Params:
|
420
|
+
|
421
|
+
- None
|
422
|
+
|
423
|
+
Returns: Venue _Hash_
|
424
|
+
|
425
|
+
``` js
|
426
|
+
// Example: GET /api/v2/event/858707/venue?api_key=1234567890abcdef
|
427
|
+
|
428
|
+
{
|
429
|
+
"address1": "859 O'Farrell St.",
|
430
|
+
"address2": null,
|
431
|
+
"city": "San Francisco",
|
432
|
+
"country": "US",
|
433
|
+
"created_at": "2008-04-21T16:52:31Z",
|
434
|
+
"id": 27418,
|
435
|
+
"latitude": 37.784796,
|
436
|
+
"longitude": -122.418819,
|
437
|
+
"name": "Great American Music Hall",
|
438
|
+
"state": "CA",
|
439
|
+
"upcoming_events_count": 34,
|
440
|
+
"updated_at": "2011-01-20T21:04:37Z",
|
441
|
+
"postalcode": "94109",
|
442
|
+
"metro_area_id": 105,
|
443
|
+
"url": "http://thrillcall.com/venue/Great_American_Music_Hall_in_San_Francisco_CA"
|
444
|
+
}
|
445
|
+
```
|
446
|
+
|
447
|
+
### GET /event/:id/tickets
|
448
|
+
**:id** _integer_ Thrillcall ID
|
449
|
+
|
450
|
+
Params:
|
451
|
+
|
452
|
+
- **[limit](#limit)**
|
453
|
+
- **[page](#page)**
|
454
|
+
- **[ticket\_type](#ticket_type)**
|
455
|
+
|
456
|
+
Returns: _Array_ of Tickets _Hash_
|
457
|
+
|
458
|
+
``` js
|
459
|
+
// Example: GET /api/v2/event/858707/tickets?api_key=1234567890abcdef
|
460
|
+
|
461
|
+
[
|
462
|
+
{
|
463
|
+
"created_at": "2011-06-14T00:09:16Z",
|
464
|
+
"description": null,
|
465
|
+
"event_id": 858707,
|
466
|
+
"id": 599794,
|
467
|
+
"marketing_text": null,
|
468
|
+
"max_ticket_price": 21,
|
469
|
+
"min_ticket_price": null,
|
470
|
+
"name": "Gen. Admission Seating Limited",
|
471
|
+
"on_sale_end_date": null,
|
472
|
+
"on_sale_start_date": null,
|
473
|
+
"seat_info": null,
|
474
|
+
"updated_at": "2011-06-14T00:09:16Z",
|
475
|
+
"url": "http://tickets.gamh.com/evinfo.php?eventid=154723&r=affi&u=210785"
|
476
|
+
},
|
477
|
+
{
|
478
|
+
...
|
479
|
+
},
|
480
|
+
...
|
481
|
+
]
|
482
|
+
```
|
483
|
+
|
484
|
+
## Genre
|
485
|
+
Fields:
|
486
|
+
|
487
|
+
- **created\_at** _string_ ISO 8601 representation the time this object was created
|
488
|
+
- **description** _string_ Description of the Genre
|
489
|
+
- **id** _integer_ Thrillcall ID
|
490
|
+
- **name** _string_ Name of the Genre
|
491
|
+
- **updated\_at** _string_ ISO 8601 representation of last time this object was updated
|
492
|
+
|
493
|
+
### GET /genres
|
494
|
+
Params:
|
495
|
+
|
496
|
+
- **[limit](#limit)**
|
497
|
+
- **[page](#page)**
|
498
|
+
|
499
|
+
Returns: _Array_ of Genres _Hash_
|
500
|
+
|
501
|
+
``` js
|
502
|
+
// Example: GET /api/v2/genres?limit=14&api_key=1234567890abcdef
|
503
|
+
|
504
|
+
[
|
505
|
+
{
|
506
|
+
"created_at": "2008-07-09T19:17:45Z",
|
507
|
+
"description": "Shawn Colvin, Loudon Wainwright III etc...",
|
508
|
+
"id": 6,
|
509
|
+
"name": "Folk",
|
510
|
+
"updated_at": "2010-03-25T23:51:55Z"
|
511
|
+
},
|
512
|
+
{
|
513
|
+
...
|
514
|
+
},
|
515
|
+
...
|
516
|
+
]
|
517
|
+
```
|
518
|
+
|
519
|
+
### GET /genre/:id
|
520
|
+
**:id** _integer_ Thrillcall ID
|
521
|
+
|
522
|
+
Params:
|
523
|
+
|
524
|
+
- None
|
525
|
+
|
526
|
+
Returns: Genre _Hash_
|
527
|
+
|
528
|
+
``` js
|
529
|
+
// Example: GET /api/v2/genre/27?api_key=1234567890abcdef
|
530
|
+
|
531
|
+
{
|
532
|
+
"created_at": "2008-07-09T19:17:45Z",
|
533
|
+
"description": "U2, 30 Seconds To Mars etc...",
|
534
|
+
"id": 27,
|
535
|
+
"name": "Rock",
|
536
|
+
"updated_at": "2010-03-25T23:52:21Z"
|
537
|
+
}
|
538
|
+
```
|
539
|
+
|
540
|
+
### GET /genre/:id/artists
|
541
|
+
**:id** _integer_ Thrillcall ID
|
542
|
+
|
543
|
+
Params:
|
544
|
+
|
545
|
+
- **[limit](#limit)**
|
546
|
+
- **[page](#page)**
|
547
|
+
|
548
|
+
Returns: _Array_ of Artists _Hash_
|
549
|
+
|
550
|
+
``` js
|
551
|
+
// Example: GET /api/v2/genre/27/artists?api_key=1234567890abcdef
|
552
|
+
|
553
|
+
[
|
554
|
+
{
|
555
|
+
"created_at": "2008-04-29T10:06:05Z",
|
556
|
+
"genre_tags": "Folk;Other;psychedelic",
|
557
|
+
"id": 2,
|
558
|
+
"name": "Espers",
|
559
|
+
"primary_genre_id": 27,
|
560
|
+
"upcoming_events_count": 1,
|
561
|
+
"updated_at": "2011-01-03T22:14:36Z",
|
562
|
+
"url": "http://thrillcall.com/artist/Espers"
|
563
|
+
},
|
564
|
+
{
|
565
|
+
...
|
566
|
+
},
|
567
|
+
...
|
568
|
+
]
|
569
|
+
```
|
570
|
+
|
571
|
+
## Metro Area
|
572
|
+
Fields:
|
573
|
+
|
574
|
+
- **city** _string_ City of the Metro Area
|
575
|
+
- **country** _string_ Country of the Metro Area
|
576
|
+
- **created\_at** _string_ ISO 8601 representation the time this object was created
|
577
|
+
- **id** _integer_ Thrillcall ID
|
578
|
+
- **latitude** _float_ Latitude of the Metro Area
|
579
|
+
- **longitude** _float_ Longitude of the Metro Area
|
580
|
+
- **radius** _integer_ Radius of the Metro Area from the Lat/Long center
|
581
|
+
- **state** _string_ State of the Metro Area
|
582
|
+
- **updated\_at** _string_ ISO 8601 representation of last time this object was updated
|
583
|
+
- **url** _string_ URL for this object on Thrillcall
|
584
|
+
|
585
|
+
### GET /metro_areas
|
586
|
+
Params:
|
587
|
+
|
588
|
+
- **[limit](#limit)**
|
589
|
+
- **[page](#page)**
|
590
|
+
|
591
|
+
Returns: _Array_ of Metro Areas _Hash_
|
592
|
+
|
593
|
+
``` js
|
594
|
+
// Example: GET /api/v2/metro_areas?limit=14&api_key=1234567890abcdef
|
595
|
+
|
596
|
+
[
|
597
|
+
{
|
598
|
+
"city": "Chicago",
|
599
|
+
"country": "US",
|
600
|
+
"created_at": "2011-06-24T03:23:57Z",
|
601
|
+
"id": 104,
|
602
|
+
"latitude": 41.8842,
|
603
|
+
"longitude": -87.6324,
|
604
|
+
"radius": 50,
|
605
|
+
"state": "IL",
|
606
|
+
"updated_at": "2011-07-05T23:11:24Z",
|
607
|
+
"url": "http://thrillcall.com/live-music/chicago"
|
608
|
+
},
|
609
|
+
{
|
610
|
+
...
|
611
|
+
},
|
612
|
+
...
|
613
|
+
]
|
614
|
+
```
|
615
|
+
|
616
|
+
### GET /metro_area/:id
|
617
|
+
**:id** _integer_ Thrillcall ID
|
618
|
+
|
619
|
+
Params:
|
620
|
+
|
621
|
+
- None
|
622
|
+
|
623
|
+
Returns: Metro Area _Hash_
|
624
|
+
|
625
|
+
``` js
|
626
|
+
// Example: GET /api/v2/metro_area/105?api_key=1234567890abcdef
|
627
|
+
|
628
|
+
{
|
629
|
+
"city": "San Francisco",
|
630
|
+
"country": "US",
|
631
|
+
"created_at": "2011-06-24T03:23:57Z",
|
632
|
+
"id": 105,
|
633
|
+
"latitude": 37.7771,
|
634
|
+
"longitude": -122.42,
|
635
|
+
"radius": 50,
|
636
|
+
"state": "CA",
|
637
|
+
"updated_at": "2011-07-05T23:11:24Z",
|
638
|
+
"url": "http://thrillcall.com/live-music/san-francisco"
|
639
|
+
}
|
640
|
+
```
|
641
|
+
|
642
|
+
### GET /metro_area/:id/events
|
643
|
+
**:id** _integer_ Thrillcall ID
|
644
|
+
|
645
|
+
Params:
|
646
|
+
|
647
|
+
- **[limit](#limit)**
|
648
|
+
- **[page](#page)**
|
649
|
+
- **[min\_date](#min_date)**
|
650
|
+
- **[max\_date](#max_date)**
|
651
|
+
- **[radius](#radius)**
|
652
|
+
- **[ticket\_type](#ticket_type)**
|
653
|
+
- **[must\_have\_tickets](#must_have_tickets)**
|
654
|
+
- **[show\_unconfirmed\_events](#show_unconfirmed_events)**
|
655
|
+
- **[show\_rumor\_events](#show_rumor_events)**
|
656
|
+
|
657
|
+
Returns: _Array_ of Metro Areas _Hash_
|
658
|
+
|
659
|
+
``` js
|
660
|
+
// Example: GET /api/v2/metro_area/105/events?api_key=1234567890abcdef
|
661
|
+
|
662
|
+
[
|
663
|
+
{
|
664
|
+
"created_at": "2011-04-24T02:12:09Z",
|
665
|
+
"end_date": null,
|
666
|
+
"festival": false,
|
667
|
+
"id": 831330,
|
668
|
+
"latitude": 37.7794,
|
669
|
+
"longitude": -122.418,
|
670
|
+
"name": "Philadelphia Orchestra @ Davies Symphony Hall",
|
671
|
+
"num_cancelled_bookings": 0,
|
672
|
+
"num_confirmed_bookings": 1,
|
673
|
+
"num_disabled_bookings": 0,
|
674
|
+
"num_unconfirmed_bookings": 0,
|
675
|
+
"on_sale_date": null,
|
676
|
+
"rumor": false,
|
677
|
+
"start_date": "2012-06-11T06:59:00Z",
|
678
|
+
"unconfirmed_location": 0,
|
679
|
+
"updated_at": "2011-09-28T03:51:22Z",
|
680
|
+
"venue_id": 51886,
|
681
|
+
"url": "http://thrillcall.com/event/831330"
|
682
|
+
},
|
683
|
+
{
|
684
|
+
...
|
685
|
+
},
|
686
|
+
...
|
687
|
+
]
|
688
|
+
```
|
689
|
+
|
690
|
+
## Person
|
691
|
+
Fields:
|
692
|
+
|
693
|
+
- **created\_at** _string_ ISO 8601 representation the time this object was created
|
694
|
+
- **first\_name** _string_ First name of the Person
|
695
|
+
- **gender** _string_ Gender of the Person
|
696
|
+
- **id** _integer_ Thrillcall ID
|
697
|
+
- **last\_name** _string_ Last name of the Person
|
698
|
+
- **login** _string_ Login of the Person
|
699
|
+
- **updated\_at** _string_ ISO 8601 representation of last time this object was updated
|
700
|
+
- **referral\_code** _string_ Referral code of the Person
|
701
|
+
- **referral\_code\_count** _integer_ Number of Referral code used for the Person
|
702
|
+
- **postalcode** _string_ Postalcode of the Person
|
703
|
+
- **postalcode** _string_ Postalcode of the Person
|
704
|
+
|
705
|
+
### POST /person/signin
|
706
|
+
Params:
|
707
|
+
|
708
|
+
- **[login](#login)**
|
709
|
+
- **[password](#password)**
|
710
|
+
|
711
|
+
Returns: Person _Hash_
|
712
|
+
|
713
|
+
``` js
|
714
|
+
// Example: POST /api/v2/person/signin
|
715
|
+
|
716
|
+
{
|
717
|
+
"created_at": "2000-11-09T19:09:23Z",
|
718
|
+
"first_name": "John",
|
719
|
+
"gender": null,
|
720
|
+
"id": 49,
|
721
|
+
"last_name": "Doe",
|
722
|
+
"login": "john@example.com",
|
723
|
+
"updated_at": "2011-11-09T19:09:23Z",
|
724
|
+
"referral_code": "fhskjfhk3j43h43hjkh",
|
725
|
+
"referral_code_count": 0,
|
726
|
+
"postalcode": "94104"
|
727
|
+
}
|
728
|
+
```
|
729
|
+
|
730
|
+
### POST /person/signup
|
731
|
+
Params:
|
732
|
+
|
733
|
+
- **[first\_name](#first_name)**
|
734
|
+
- **[last\_name](#last_name)**
|
735
|
+
- **[gender](#gender)**
|
736
|
+
- **[email](#email)**
|
737
|
+
- **[password](#password)**
|
738
|
+
- **[postalcode](#postalcode)**
|
739
|
+
|
740
|
+
Returns: Person _Hash_
|
741
|
+
|
742
|
+
``` js
|
743
|
+
// Example: POST /api/v2/person/signup
|
744
|
+
|
745
|
+
{
|
746
|
+
"created_at": "2000-11-09T19:09:23Z",
|
747
|
+
"first_name": "John",
|
748
|
+
"gender": null,
|
749
|
+
"id": 49,
|
750
|
+
"last_name": "Doe",
|
751
|
+
"login": "john@example.com",
|
752
|
+
"updated_at": "2011-11-09T19:09:23Z",
|
753
|
+
"referral_code": "fhskjfhk3j43h43hjkh",
|
754
|
+
"referral_code_count": 0,
|
755
|
+
"postalcode": "94104"
|
756
|
+
}
|
757
|
+
```
|
758
|
+
|
759
|
+
|
760
|
+
## Venues
|
761
|
+
Fields:
|
762
|
+
|
763
|
+
- **address1** _string_ First address field for the Venue
|
764
|
+
- **address2** _string_ Second address field for the Venue
|
765
|
+
- **city** _string_ City the Venue is in
|
766
|
+
- **country** _string_ Country the Venue is in
|
767
|
+
- **created\_at** _string_ ISO 8601 representation the time this object was created
|
768
|
+
- **id** _integer_ Thrillcall ID
|
769
|
+
- **latitude** _float_ Approximate Latitude for the Venue
|
770
|
+
- **longitude** _float_ Approximate Longitude for the Venue
|
771
|
+
- **name** _string_ Name of the Venue
|
772
|
+
- **metro\_area\_id** _integer_ Thrillcall ID of the Metro Area this Venue is in, if any
|
773
|
+
- **state** _string_ State the Venue is in
|
774
|
+
- **upcoming\_events\_count** _integer_ Number of upcoming events associated with this object
|
775
|
+
- **updated\_at** _string_ ISO 8601 representation of last time this object was updated
|
776
|
+
- **postalcode** _string_ Postal code for the Venue
|
777
|
+
- **url** _string_ URL for this object on Thrillcall
|
778
|
+
|
779
|
+
|
780
|
+
### GET /venues
|
781
|
+
Params:
|
782
|
+
|
783
|
+
- **[limit](#limit)**
|
784
|
+
- **[page](#page)**
|
785
|
+
- **[lat](#lat)**
|
786
|
+
- **[long](#long)**
|
787
|
+
- **[postalcode](#postalcode)**
|
788
|
+
- **[radius](#radius)**
|
789
|
+
|
790
|
+
Returns: _Array_ of Venues _Hash_
|
791
|
+
|
792
|
+
``` js
|
793
|
+
// Example: GET /api/v2/venues?limit=14&api_key=1234567890abcdef
|
794
|
+
|
795
|
+
[
|
796
|
+
{
|
797
|
+
"address1": null,
|
798
|
+
"address2": null,
|
799
|
+
"city": "Guadalajara",
|
800
|
+
"country": "MX",
|
801
|
+
"created_at": "2000-11-09T19:09:23Z",
|
802
|
+
"id": 1,
|
803
|
+
"latitude": null,
|
804
|
+
"longitude": null,
|
805
|
+
"name": "Fbolko",
|
806
|
+
"state": "MX",
|
807
|
+
"upcoming_events_count": 0,
|
808
|
+
"updated_at": "2010-03-28T17:24:20Z",
|
809
|
+
"postalcode": null,
|
810
|
+
"url": "http://thrillcall.com/venue/Fbolko_in_Guadalajara_MX"
|
811
|
+
},
|
812
|
+
{
|
813
|
+
...
|
814
|
+
},
|
815
|
+
...
|
816
|
+
]
|
817
|
+
```
|
818
|
+
|
819
|
+
|
820
|
+
### GET /venue/:id
|
821
|
+
**:id** _integer_ Thrillcall or Partner ID
|
822
|
+
|
823
|
+
Params:
|
824
|
+
|
825
|
+
- **[use\_partner\_id](#use_partner_id)**
|
826
|
+
|
827
|
+
Returns: Venue _Hash_
|
828
|
+
|
829
|
+
``` js
|
830
|
+
// Example: GET /api/v2/venue/27418?api_key=1234567890abcdef
|
831
|
+
|
832
|
+
{
|
833
|
+
"address1": "859 O'Farrell St.",
|
834
|
+
"address2": null,
|
835
|
+
"city": "San Francisco",
|
836
|
+
"country": "US",
|
837
|
+
"created_at": "2008-04-21T16:52:31Z",
|
838
|
+
"id": 27418,
|
839
|
+
"latitude": 37.784796,
|
840
|
+
"longitude": -122.418819,
|
841
|
+
"name": "Great American Music Hall",
|
842
|
+
"state": "CA",
|
843
|
+
"upcoming_events_count": 34,
|
844
|
+
"updated_at": "2011-01-20T21:04:37Z",
|
845
|
+
"postalcode": "94109",
|
846
|
+
"metro_area_id": 105,
|
847
|
+
"url": "http://thrillcall.com/venue/Great_American_Music_Hall_in_San_Francisco_CA"
|
848
|
+
}
|
849
|
+
```
|
850
|
+
|
851
|
+
### GET /venue/:id/events
|
852
|
+
**:id** _integer_ Thrillcall or Partner ID
|
853
|
+
|
854
|
+
Params:
|
855
|
+
|
856
|
+
- **[limit](#limit)**
|
857
|
+
- **[page](#page)**
|
858
|
+
- **[min\_date](#min_date)**
|
859
|
+
- **[max\_date](#max_date)**
|
860
|
+
- **[use\_partner\_id](#use_partner_id)**
|
861
|
+
- **[ticket\_type](#ticket_type)**
|
862
|
+
- **[must\_have\_tickets](#must_have_tickets)**
|
863
|
+
- **[show\_unconfirmed\_events](#show_unconfirmed_events)**
|
864
|
+
- **[show\_rumor\_events](#show_rumor_events)**
|
865
|
+
|
866
|
+
Returns: _Array_ of Events _Hash_
|
867
|
+
|
868
|
+
``` js
|
869
|
+
// Example: GET /api/v2/venue/32065/events?api_key=1234567890abcdef
|
870
|
+
|
871
|
+
[
|
872
|
+
{
|
873
|
+
"created_at": "2000-11-09T19:09:23Z",
|
874
|
+
"end_date": null,
|
875
|
+
"festival": false,
|
876
|
+
"id": 824614,
|
877
|
+
"latitude": 37.8016,
|
878
|
+
"longitude": -80.4462,
|
879
|
+
"name": "Colt Ford @ West Virginia State Fair",
|
880
|
+
"on_sale_date": null,
|
881
|
+
"rumor": false,
|
882
|
+
"start_date": "2011-08-21T03:59:00Z",
|
883
|
+
"unconfirmed_location": 0,
|
884
|
+
"updated_at": "2011-06-24T05:10:05Z",
|
885
|
+
"venue_id": 32065,
|
886
|
+
"url": "http://thrillcall.com/event/824614"
|
887
|
+
},
|
888
|
+
{
|
889
|
+
...
|
890
|
+
},
|
891
|
+
...
|
892
|
+
]
|
893
|
+
```
|
894
|
+
|
895
|
+
### GET /search/venues/:term
|
896
|
+
**:term** _string_ Arbitrary search string on the **name** field. (alphanumerics only, underscore matches underscore, use '+' for space)
|
897
|
+
|
898
|
+
Params:
|
899
|
+
|
900
|
+
- **[limit](#limit)**
|
901
|
+
- **[page](#page)**
|
902
|
+
- **[lat](#lat)**
|
903
|
+
- **[long](#long)**
|
904
|
+
- **[postalcode](#postalcode)**
|
905
|
+
- **[radius](#radius)**
|
906
|
+
|
907
|
+
Returns: _Array_ of Venues _Hash_
|
908
|
+
|
909
|
+
``` js
|
910
|
+
// Example: GET /api/v2/search/venues/Great%20American%20Music%20Hall?api_key=1234567890abcdef
|
911
|
+
|
912
|
+
[
|
913
|
+
{
|
914
|
+
"address1": "859 O'Farrell St.",
|
915
|
+
"address2": null,
|
916
|
+
"city": "San Francisco",
|
917
|
+
"country": "US",
|
918
|
+
"created_at": "2008-04-21T16:52:31Z",
|
919
|
+
"id": 27418,
|
920
|
+
"latitude": 37.784796,
|
921
|
+
"longitude": -122.418819,
|
922
|
+
"name": "Great American Music Hall",
|
923
|
+
"state": "CA",
|
924
|
+
"upcoming_events_count": 34,
|
925
|
+
"updated_at": "2011-01-20T21:04:37Z",
|
926
|
+
"postalcode": "94109",
|
927
|
+
"metro_area_id": 105,
|
928
|
+
"url": "http://thrillcall.com/venue/Great_American_Music_Hall_in_San_Francisco_CA"
|
929
|
+
},
|
930
|
+
{
|
931
|
+
...
|
932
|
+
},
|
933
|
+
...
|
934
|
+
]
|
935
|
+
```
|
936
|
+
|
937
|
+
## Tickets
|
938
|
+
Fields:
|
939
|
+
|
940
|
+
- **created\_at** _string_ ISO 8601 representation the time this object was created
|
941
|
+
- **description** _string_ Long form description of the ticket
|
942
|
+
- **event\_id** _integer_ Thrillcall Event ID
|
943
|
+
- **id** _integer_ Thrillcall ID
|
944
|
+
- **marketing\_text** _string_ Long form description of the ticket
|
945
|
+
- **max\_ticket\_price** _float_ Maximum price for this ticket
|
946
|
+
- **min\_ticket\_price** _float_ Minimum price for this ticket
|
947
|
+
- **name** _string_ Name of this ticket
|
948
|
+
- **on\_sale\_end\_date** _string_ YYYY-MM-DD date when the ticket goes off sale
|
949
|
+
- **on\_sale\_start\_date** _string_ YYYY-MM-DD date when the ticket goes on sale
|
950
|
+
- **seat\_info** _string_ Additional info about the seat
|
951
|
+
- **updated\_at** _string_ ISO 8601 representation of last time this object was updated
|
952
|
+
- **url** _string_ URL for this object on Thrillcall
|
953
|
+
|
954
|
+
### GET /tickets
|
955
|
+
Params:
|
956
|
+
|
957
|
+
- **[limit](#limit)**
|
958
|
+
- **[page](#page)**
|
959
|
+
- **[min\_date](#min_date)**
|
960
|
+
- **[max\_date](#max_date)**
|
961
|
+
- **[lat](#lat)**
|
962
|
+
- **[long](#long)**
|
963
|
+
- **[postalcode](#postalcode)**
|
964
|
+
- **[radius](#radius)**
|
965
|
+
- **[ticket\_type](#ticket_type)**
|
966
|
+
- **[show\_unconfirmed\_events](#show_unconfirmed_events)**
|
967
|
+
- **[show\_rumor\_events](#show_rumor_events)**
|
968
|
+
|
969
|
+
Returns: _Array_ of Tickets _Hash_
|
970
|
+
|
971
|
+
``` js
|
972
|
+
// Example: GET /api/v2/tickets?limit=14&api_key=1234567890abcdef
|
973
|
+
|
974
|
+
[
|
975
|
+
{
|
976
|
+
"created_at": "2008-12-06T00:19:59Z",
|
977
|
+
"description": null,
|
978
|
+
"event_id": 455646,
|
979
|
+
"id": 1,
|
980
|
+
"marketing_text": null,
|
981
|
+
"max_ticket_price": null,
|
982
|
+
"min_ticket_price": null,
|
983
|
+
"name": "General Onsale",
|
984
|
+
"on_sale_end_date": null,
|
985
|
+
"on_sale_start_date": null,
|
986
|
+
"seat_info": null,
|
987
|
+
"updated_at": "2009-09-22T22:58:37Z",
|
988
|
+
"url": "http://www.livenation.com/edp/eventId/335800/?c=api-000157"
|
989
|
+
},
|
990
|
+
{
|
991
|
+
...
|
992
|
+
},
|
993
|
+
...
|
994
|
+
]
|
995
|
+
```
|
996
|
+
|
997
|
+
### GET /ticket/:id
|
998
|
+
**:id** _integer_ Thrillcall ID
|
999
|
+
|
1000
|
+
Params:
|
1001
|
+
|
1002
|
+
- None
|
1003
|
+
|
1004
|
+
Returns: Ticket _Hash_
|
1005
|
+
|
1006
|
+
``` js
|
1007
|
+
// Example: GET /api/v2/ticket/599794?api_key=1234567890abcdef
|
1008
|
+
|
1009
|
+
{
|
1010
|
+
"created_at": "2011-06-14T00:09:16Z",
|
1011
|
+
"description": null,
|
1012
|
+
"event_id": 858707,
|
1013
|
+
"id": 599794,
|
1014
|
+
"marketing_text": null,
|
1015
|
+
"max_ticket_price": 21,
|
1016
|
+
"min_ticket_price": null,
|
1017
|
+
"name": "Gen. Admission Seating Limited",
|
1018
|
+
"on_sale_end_date": null,
|
1019
|
+
"on_sale_start_date": null,
|
1020
|
+
"seat_info": null,
|
1021
|
+
"updated_at": "2011-06-14T00:09:16Z",
|
1022
|
+
"url": "http://tickets.gamh.com/evinfo.php?eventid=154723&r=affi&u=210785"
|
1023
|
+
}
|
1024
|
+
```
|