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/README.html
ADDED
@@ -0,0 +1,1382 @@
|
|
1
|
+
|
2
|
+
<style type="text/css">
|
3
|
+
.highlight .hll { background-color: #ffffcc }
|
4
|
+
.highlight { background: #dddddd; }
|
5
|
+
.highlight .c { color: #408080; font-style: italic } /* Comment */
|
6
|
+
.highlight .err { border: 1px solid #FF0000 } /* Error */
|
7
|
+
.highlight .k { color: #008000; font-weight: bold } /* Keyword */
|
8
|
+
.highlight .o { color: #666666 } /* Operator */
|
9
|
+
.highlight .cm { color: #408080; font-style: italic } /* Comment.Multiline */
|
10
|
+
.highlight .cp { color: #BC7A00 } /* Comment.Preproc */
|
11
|
+
.highlight .c1 { color: #408080; font-style: italic } /* Comment.Single */
|
12
|
+
.highlight .cs { color: #408080; font-style: italic } /* Comment.Special */
|
13
|
+
.highlight .gd { color: #A00000 } /* Generic.Deleted */
|
14
|
+
.highlight .ge { font-style: italic } /* Generic.Emph */
|
15
|
+
.highlight .gr { color: #FF0000 } /* Generic.Error */
|
16
|
+
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
|
17
|
+
.highlight .gi { color: #00A000 } /* Generic.Inserted */
|
18
|
+
.highlight .go { color: #808080 } /* Generic.Output */
|
19
|
+
.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
|
20
|
+
.highlight .gs { font-weight: bold } /* Generic.Strong */
|
21
|
+
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
|
22
|
+
.highlight .gt { color: #0040D0 } /* Generic.Traceback */
|
23
|
+
.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
|
24
|
+
.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
|
25
|
+
.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
|
26
|
+
.highlight .kp { color: #008000 } /* Keyword.Pseudo */
|
27
|
+
.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
|
28
|
+
.highlight .kt { color: #B00040 } /* Keyword.Type */
|
29
|
+
.highlight .m { color: #666666 } /* Literal.Number */
|
30
|
+
.highlight .s { color: #BA2121 } /* Literal.String */
|
31
|
+
.highlight .na { color: #7D9029 } /* Name.Attribute */
|
32
|
+
.highlight .nb { color: #008000 } /* Name.Builtin */
|
33
|
+
.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */
|
34
|
+
.highlight .no { color: #880000 } /* Name.Constant */
|
35
|
+
.highlight .nd { color: #AA22FF } /* Name.Decorator */
|
36
|
+
.highlight .ni { color: #999999; font-weight: bold } /* Name.Entity */
|
37
|
+
.highlight .ne { color: #D2413A; font-weight: bold } /* Name.Exception */
|
38
|
+
.highlight .nf { color: #0000FF } /* Name.Function */
|
39
|
+
.highlight .nl { color: #A0A000 } /* Name.Label */
|
40
|
+
.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
|
41
|
+
.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */
|
42
|
+
.highlight .nv { color: #19177C } /* Name.Variable */
|
43
|
+
.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
|
44
|
+
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
|
45
|
+
.highlight .mf { color: #666666 } /* Literal.Number.Float */
|
46
|
+
.highlight .mh { color: #666666 } /* Literal.Number.Hex */
|
47
|
+
.highlight .mi { color: #666666 } /* Literal.Number.Integer */
|
48
|
+
.highlight .mo { color: #666666 } /* Literal.Number.Oct */
|
49
|
+
.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */
|
50
|
+
.highlight .sc { color: #BA2121 } /* Literal.String.Char */
|
51
|
+
.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
|
52
|
+
.highlight .s2 { color: #BA2121 } /* Literal.String.Double */
|
53
|
+
.highlight .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */
|
54
|
+
.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */
|
55
|
+
.highlight .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */
|
56
|
+
.highlight .sx { color: #008000 } /* Literal.String.Other */
|
57
|
+
.highlight .sr { color: #BB6688 } /* Literal.String.Regex */
|
58
|
+
.highlight .s1 { color: #BA2121 } /* Literal.String.Single */
|
59
|
+
.highlight .ss { color: #19177C } /* Literal.String.Symbol */
|
60
|
+
.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */
|
61
|
+
.highlight .vc { color: #19177C } /* Name.Variable.Class */
|
62
|
+
.highlight .vg { color: #19177C } /* Name.Variable.Global */
|
63
|
+
.highlight .vi { color: #19177C } /* Name.Variable.Instance */
|
64
|
+
.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */
|
65
|
+
</style><h1>Thrillcall API</h1>
|
66
|
+
|
67
|
+
<p>This document describes the Thrillcall API v2, and usage for the provided Ruby API wrapper gem.</p>
|
68
|
+
|
69
|
+
<h1>Ruby API Wrapper</h1>
|
70
|
+
|
71
|
+
<h3>Usage:</h3>
|
72
|
+
|
73
|
+
<div class="highlight">
|
74
|
+
<pre> <span class="c1">#---------------------------------------------------------------#</span>
|
75
|
+
<span class="c1"># First, require the gem:</span>
|
76
|
+
<span class="c1">#---------------------------------------------------------------#</span>
|
77
|
+
<span class="nb">require</span> <span class="s1">'rubygems'</span>
|
78
|
+
<span class="nb">require</span> <span class="s1">'thrillcall-api'</span>
|
79
|
+
|
80
|
+
<span class="c1">#---------------------------------------------------------------#</span>
|
81
|
+
<span class="c1"># Instantiate with your Thrillcall API key:</span>
|
82
|
+
<span class="c1">#---------------------------------------------------------------#</span>
|
83
|
+
<span class="no">MY_API_KEY</span> <span class="o">=</span> <span class="s2">"1234567890abcdef"</span>
|
84
|
+
<span class="n">tc</span> <span class="o">=</span> <span class="no">ThrillcallAPI</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="no">MY_API_KEY</span><span class="p">)</span>
|
85
|
+
|
86
|
+
<span class="c1">#---------------------------------------------------------------#</span>
|
87
|
+
<span class="c1"># Access any endpoint directly from the instance</span>
|
88
|
+
<span class="c1">#---------------------------------------------------------------#</span>
|
89
|
+
<span class="c1"># This is like calling GET "/events"</span>
|
90
|
+
<span class="n">tc</span><span class="o">.</span><span class="n">events</span>
|
91
|
+
<span class="c1"># => [ {"id" => ... }, {...}, ...]</span>
|
92
|
+
|
93
|
+
<span class="c1">#---------------------------------------------------------------#</span>
|
94
|
+
<span class="c1"># Provide IDs as arguments</span>
|
95
|
+
<span class="c1">#---------------------------------------------------------------#</span>
|
96
|
+
<span class="c1"># GET "/event/1"</span>
|
97
|
+
<span class="n">tc</span><span class="o">.</span><span class="n">event</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
|
98
|
+
<span class="c1"># => {"id" => 1, ...}</span>
|
99
|
+
|
100
|
+
<span class="c1">#---------------------------------------------------------------#</span>
|
101
|
+
<span class="c1"># Provide parameters as arguments</span>
|
102
|
+
<span class="c1">#---------------------------------------------------------------#</span>
|
103
|
+
<span class="c1"># GET "/events?limit=5"</span>
|
104
|
+
<span class="n">events</span> <span class="o">=</span> <span class="n">tc</span><span class="o">.</span><span class="n">events</span><span class="p">(</span><span class="ss">:limit</span> <span class="o">=></span> <span class="mi">5</span><span class="p">)</span>
|
105
|
+
<span class="c1"># => [ {"id" => ... }, {...}, ...]</span>
|
106
|
+
<span class="n">events</span><span class="o">.</span><span class="n">length</span>
|
107
|
+
<span class="c1"># => 5</span>
|
108
|
+
|
109
|
+
<span class="c1">#---------------------------------------------------------------#</span>
|
110
|
+
<span class="c1"># Chain methods together for nested routes</span>
|
111
|
+
<span class="c1">#---------------------------------------------------------------#</span>
|
112
|
+
<span class="c1"># GET "/search/venues/warfield?postalcode=94101&radius=20"</span>
|
113
|
+
<span class="n">venues</span> <span class="o">=</span> <span class="n">tc</span><span class="o">.</span><span class="n">search</span><span class="o">.</span><span class="n">venues</span><span class="p">(</span><span class="s2">"warfield"</span><span class="p">,</span> <span class="ss">:postalcode</span> <span class="o">=></span> <span class="s2">"94101"</span><span class="p">,</span> <span class="ss">:radius</span> <span class="o">=></span> <span class="mi">20</span><span class="p">)</span>
|
114
|
+
<span class="c1"># => [{"name" => "The Warfield", ...}]</span>
|
115
|
+
</pre>
|
116
|
+
</div>
|
117
|
+
|
118
|
+
|
119
|
+
<h3>Advanced Usage:</h3>
|
120
|
+
|
121
|
+
<p>Provide additional instantiation options:</p>
|
122
|
+
|
123
|
+
<div class="highlight">
|
124
|
+
<pre> <span class="c1">#---------------------------------------------------------------#</span>
|
125
|
+
<span class="c1"># The default SSL endpoint is "https://api.thrillcall.com/api/".</span>
|
126
|
+
<span class="c1"># The default API version is 2.</span>
|
127
|
+
<span class="c1"># By default, Faraday access logging is turned off.</span>
|
128
|
+
<span class="c1"># Override if necessary:</span>
|
129
|
+
<span class="c1">#---------------------------------------------------------------#</span>
|
130
|
+
<span class="n">tc</span> <span class="o">=</span> <span class="no">ThrillcallAPI</span><span class="o">.</span><span class="n">new</span><span class="p">(</span>
|
131
|
+
<span class="no">MY_API_KEY</span><span class="p">,</span>
|
132
|
+
<span class="ss">:base_url</span> <span class="o">=></span> <span class="s2">"https://api.thrillcall.com/custom/"</span><span class="p">,</span>
|
133
|
+
<span class="ss">:version</span> <span class="o">=></span> <span class="mi">3</span><span class="p">,</span>
|
134
|
+
<span class="ss">:logger</span> <span class="o">=></span> <span class="kp">true</span>
|
135
|
+
<span class="p">)</span>
|
136
|
+
</pre>
|
137
|
+
</div>
|
138
|
+
|
139
|
+
|
140
|
+
<p>Internally, the wrapper returns a ThrillcallAPI::Result class for any call. Data for the request is fetched only when used. This allows you to build requests piecemeal before executing them.</p>
|
141
|
+
|
142
|
+
<div class="highlight">
|
143
|
+
<pre> <span class="c1">#---------------------------------------------------------------#</span>
|
144
|
+
<span class="c1"># Build a partial request, add on to it later</span>
|
145
|
+
<span class="c1">#---------------------------------------------------------------#</span>
|
146
|
+
<span class="n">request</span> <span class="o">=</span> <span class="n">tc</span><span class="o">.</span><span class="n">artist</span><span class="p">(</span><span class="mi">22210</span><span class="p">)</span> <span class="c1"># Lady Gaga</span>
|
147
|
+
|
148
|
+
<span class="c1"># GET "/artist/22210/events?limit=2"</span>
|
149
|
+
<span class="n">artist_events</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">events</span><span class="p">(</span><span class="ss">:limit</span> <span class="o">=></span> <span class="mi">2</span><span class="p">)</span>
|
150
|
+
|
151
|
+
<span class="n">artist_events</span><span class="o">.</span><span class="n">length</span>
|
152
|
+
<span class="c1"># => 2</span>
|
153
|
+
</pre>
|
154
|
+
</div>
|
155
|
+
|
156
|
+
|
157
|
+
<p>This gem is a convenience wrapper around the excellent Faraday project. If more complicated use cases are necessary, consider using Faraday directly.</p>
|
158
|
+
|
159
|
+
<div class="highlight">
|
160
|
+
<pre> <span class="nb">require</span> <span class="s1">'faraday'</span>
|
161
|
+
<span class="nb">require</span> <span class="s1">'json'</span>
|
162
|
+
|
163
|
+
<span class="no">MY_API_KEY</span> <span class="o">=</span> <span class="s2">"1234567890abcdef"</span>
|
164
|
+
<span class="no">BASE_URL</span> <span class="o">=</span> <span class="s2">"https://api.thrillcall.com/api/v2/"</span>
|
165
|
+
<span class="no">HEADERS</span> <span class="o">=</span> <span class="p">{</span> <span class="ss">:accept</span> <span class="o">=></span> <span class="s1">'application/json'</span> <span class="p">}</span>
|
166
|
+
|
167
|
+
<span class="n">connection</span> <span class="o">=</span> <span class="no">Faraday</span><span class="o">.</span><span class="n">new</span><span class="p">(</span> <span class="ss">:url</span> <span class="o">=></span> <span class="no">BASE_URL</span><span class="p">,</span> <span class="ss">:headers</span> <span class="o">=></span> <span class="no">HEADERS</span> <span class="p">)</span> <span class="k">do</span> <span class="o">|</span><span class="n">builder</span><span class="o">|</span>
|
168
|
+
<span class="n">builder</span><span class="o">.</span><span class="n">adapter</span> <span class="no">Faraday</span><span class="o">.</span><span class="n">default_adapter</span>
|
169
|
+
<span class="n">builder</span><span class="o">.</span><span class="n">response</span> <span class="ss">:logger</span>
|
170
|
+
<span class="n">builder</span><span class="o">.</span><span class="n">response</span> <span class="ss">:raise_error</span>
|
171
|
+
<span class="k">end</span>
|
172
|
+
|
173
|
+
<span class="n">request</span> <span class="o">=</span> <span class="n">connection</span><span class="o">.</span><span class="n">get</span> <span class="k">do</span> <span class="o">|</span><span class="n">req</span><span class="o">|</span>
|
174
|
+
<span class="n">req</span><span class="o">.</span><span class="n">url</span> <span class="s2">"artist/22210"</span><span class="p">,</span> <span class="p">{</span> <span class="ss">:api_key</span> <span class="o">=></span> <span class="no">MY_API_KEY</span> <span class="p">}</span>
|
175
|
+
<span class="k">end</span>
|
176
|
+
|
177
|
+
<span class="n">artist</span> <span class="o">=</span> <span class="no">JSON</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="n">request</span><span class="o">.</span><span class="n">body</span><span class="p">)</span>
|
178
|
+
|
179
|
+
<span class="n">artist</span><span class="o">[</span><span class="s2">"name"</span><span class="o">]</span>
|
180
|
+
<span class="c1"># => "Lady Gaga"</span>
|
181
|
+
</pre>
|
182
|
+
</div>
|
183
|
+
|
184
|
+
|
185
|
+
<h1>HTTPS Endpoints</h1>
|
186
|
+
|
187
|
+
<h3>SSL/TLS Endpoints Required:</h3>
|
188
|
+
|
189
|
+
<p>All API access must use the secure HTTPS endpoint : https://api.thrillcall.com:443
|
190
|
+
Access over an insecure HTTP (port 80) endpoint is now deprecated and will be disabled.</p>
|
191
|
+
|
192
|
+
<h3>Parameters</h3>
|
193
|
+
|
194
|
+
<p>These are valid parameters for any endpoint, however, they will only be used by the server where applicable.</p>
|
195
|
+
|
196
|
+
<p><strong>api_key</strong> MUST BE SUPPLIED for every endpoint.</p>
|
197
|
+
|
198
|
+
<ul>
|
199
|
+
<li>
|
200
|
+
<p><a name="api_key"></a><strong>api_key</strong> <em>string: (format: length == 16)</em></p>
|
201
|
+
|
202
|
+
<p>Your API key. Required for access to any endpoint.</p>
|
203
|
+
</li>
|
204
|
+
<li>
|
205
|
+
<p><a name="limit"></a><strong>limit</strong> <em>integer</em></p>
|
206
|
+
|
207
|
+
<p><em>Default: 100</em></p>
|
208
|
+
|
209
|
+
<p>Sets the maximum number of results to return. Cannot be above 100.</p>
|
210
|
+
</li>
|
211
|
+
<li>
|
212
|
+
<p><a name="page"></a><strong>page</strong> <em>integer</em></p>
|
213
|
+
|
214
|
+
<p><em>Default: 0</em></p>
|
215
|
+
|
216
|
+
<p>Used in conjunction with <strong><a href="#limit">limit</a></strong>.</p>
|
217
|
+
|
218
|
+
<p>Specifies the page number. If limit is 10, then page = 2 will return results #20 through #29</p>
|
219
|
+
</li>
|
220
|
+
<li>
|
221
|
+
<p><a name="min_date"></a><strong>min_date</strong> <em>string (format: "YYYY-MM-DD")</em></p>
|
222
|
+
|
223
|
+
<p><em>Default: Today</em></p>
|
224
|
+
|
225
|
+
<p>Results before this date will not be returned.</p>
|
226
|
+
</li>
|
227
|
+
<li>
|
228
|
+
<p><a name="max_date"></a><strong>max_date</strong> <em>string (format: "YYYY-MM-DD")</em></p>
|
229
|
+
|
230
|
+
<p><em>Default: 1 year from Today</em></p>
|
231
|
+
|
232
|
+
<p>Results after this date will not be returned.</p>
|
233
|
+
</li>
|
234
|
+
<li>
|
235
|
+
<p><a name="lat"></a><strong>lat</strong> <em>float</em></p>
|
236
|
+
|
237
|
+
<p><em>Default: none</em></p>
|
238
|
+
|
239
|
+
<p>If latitude (<strong><a href="#lat">lat</a></strong>) and longitude (<strong><a href="#long">long</a></strong>) if both are specified, results will be within <strong><a href="#radius">radius</a></strong> of this location.</p>
|
240
|
+
</li>
|
241
|
+
<li>
|
242
|
+
<p><a name="long"></a><strong>long</strong> <em>float</em></p>
|
243
|
+
|
244
|
+
<p><em>Default: none</em></p>
|
245
|
+
|
246
|
+
<p>If latitude (<strong><a href="#lat">lat</a></strong>) and longitude (<strong><a href="#long">long</a></strong>) if both are specified, results will be within <strong><a href="#radius">radius</a></strong> of this location.</p>
|
247
|
+
</li>
|
248
|
+
<li>
|
249
|
+
<p><a name="postalcode"></a><strong>postalcode</strong> <em>string (format: length >= 5)</em></p>
|
250
|
+
|
251
|
+
<p><em>Default: none</em></p>
|
252
|
+
|
253
|
+
<p>Results will be within the <strong><a href="#radius">radius</a></strong> of this postal code.
|
254
|
+
If latitude (<strong><a href="#lat">lat</a></strong>) and longitude (<strong><a href="#long">long</a></strong>) if both are specified, this will be ignored.</p>
|
255
|
+
</li>
|
256
|
+
<li>
|
257
|
+
<p><a name="radius"></a><strong>radius</strong> <em>float</em></p>
|
258
|
+
|
259
|
+
<p><em>Default: 100.0</em></p>
|
260
|
+
|
261
|
+
<p>Used in conjunction with <strong><a href="#postalcode">postalcode</a></strong></p>
|
262
|
+
</li>
|
263
|
+
<li>
|
264
|
+
<p><a name="use_partner_id"></a><strong>use_partner_id</strong> <em>boolean</em></p>
|
265
|
+
|
266
|
+
<p><em>Default: false</em></p>
|
267
|
+
|
268
|
+
<p>If set to <em>true</em> or <em>1</em>, instead of using Thrillcall internal IDs, treat any IDs in a request as belonging to your partner definition.</p>
|
269
|
+
|
270
|
+
<p>Contact us to set up a list of definitions.</p>
|
271
|
+
</li>
|
272
|
+
<li>
|
273
|
+
<p><a name="ticket_type"></a><strong>ticket_type</strong> <em>string (format: "primary" or "resale")</em></p>
|
274
|
+
|
275
|
+
<p><em>Default: both</em></p>
|
276
|
+
|
277
|
+
<p>If specified, will only return tickets from Primary or Resale merchants.</p>
|
278
|
+
</li>
|
279
|
+
<li>
|
280
|
+
<p><a name="must_have_tickets"></a><strong>must_have_tickets</strong> <em>boolean</em></p>
|
281
|
+
|
282
|
+
<p><em>Default: false</em></p>
|
283
|
+
|
284
|
+
<p>If set to <em>true</em> or <em>1</em>, will only return results that have tickets associated with them.</p>
|
285
|
+
</li>
|
286
|
+
<li>
|
287
|
+
<p><a name="show_unconfirmed_events"></a><strong>show_unconfirmed_events</strong> <em>boolean</em></p>
|
288
|
+
|
289
|
+
<p><em>Default: false</em></p>
|
290
|
+
|
291
|
+
<p>If set to <em>true</em> or <em>1</em>, will not filter out events with unconfirmed locations.</p>
|
292
|
+
</li>
|
293
|
+
<li>
|
294
|
+
<p><a name="show_rumor_events"></a><strong>show_rumor_events</strong> <em>boolean</em></p>
|
295
|
+
|
296
|
+
<p><em>Default: false</em></p>
|
297
|
+
|
298
|
+
<p>If set to <em>true</em> or <em>1</em>, will not filter out events marked as rumored.</p>
|
299
|
+
</li>
|
300
|
+
<li>
|
301
|
+
<p><a name="primary_genre_id"></a><strong>primary_genre_id</strong> <em>integer</em></p>
|
302
|
+
|
303
|
+
<p><em>Default: none</em></p>
|
304
|
+
|
305
|
+
<p>If set, will filter Artist results to only those with the specified <strong><a href="#primary_genre_id">primary_genre_id</a></strong></p>
|
306
|
+
</li>
|
307
|
+
<li>
|
308
|
+
<p><a name="login"></a><strong>login</strong> <em>string</em></p>
|
309
|
+
|
310
|
+
<p>Required to authenticate/register a user.</p>
|
311
|
+
</li>
|
312
|
+
<li>
|
313
|
+
<p><a name="password"></a><strong>password</strong> <em>string (format: 40 >= length >= 5)</em></p>
|
314
|
+
|
315
|
+
<p>Required to authenticate/register a user.</p>
|
316
|
+
</li>
|
317
|
+
<li>
|
318
|
+
<p><a name="first_name"></a><strong>first_name</strong> <em>string (format: 50 >= length >= 2)</em></p>
|
319
|
+
|
320
|
+
<p>Required to register a user.</p>
|
321
|
+
</li>
|
322
|
+
<li>
|
323
|
+
<p><a name="last_name"></a><strong>last_name</strong> <em>string (format: 50 >= length >= 2)</em></p>
|
324
|
+
|
325
|
+
<p>Optional for registering a user.</p>
|
326
|
+
</li>
|
327
|
+
<li>
|
328
|
+
<p><a name="email"></a><strong>email</strong> <em>string</em></p>
|
329
|
+
|
330
|
+
<p>Required to register a user.</p>
|
331
|
+
</li>
|
332
|
+
<li>
|
333
|
+
<p><a name="gender"></a><strong>gender</strong> <em>string (format: length == 1)</em></p>
|
334
|
+
|
335
|
+
<p>Optional for registering a user.</p>
|
336
|
+
</li>
|
337
|
+
</ul><h2>Artists</h2>
|
338
|
+
|
339
|
+
<p>Fields:</p>
|
340
|
+
|
341
|
+
<ul>
|
342
|
+
<li>
|
343
|
+
<strong>created_at</strong> <em>string</em> ISO 8601 representation the time this object was created</li>
|
344
|
+
<li>
|
345
|
+
<strong>genre_tags</strong> <em>string</em> Semicolon separated list of Genre names</li>
|
346
|
+
<li>
|
347
|
+
<strong>id</strong> <em>integer</em> Thrillcall ID</li>
|
348
|
+
<li>
|
349
|
+
<strong>name</strong> <em>string</em> Artist / Band Name</li>
|
350
|
+
<li>
|
351
|
+
<strong>primary_genre_id</strong> <em>integer</em> The Thrillcall ID for this artist's primary Genre</li>
|
352
|
+
<li>
|
353
|
+
<strong>upcoming_events_count</strong> <em>integer</em> Number of upcoming events associated with this object</li>
|
354
|
+
<li>
|
355
|
+
<strong>updated_at</strong> <em>string</em> ISO 8601 representation of last time this object was updated</li>
|
356
|
+
<li>
|
357
|
+
<strong>url</strong> <em>string</em> URL for this object on Thrillcall</li>
|
358
|
+
</ul><h3>GET /artists</h3>
|
359
|
+
|
360
|
+
<p>Params:</p>
|
361
|
+
|
362
|
+
<ul>
|
363
|
+
<li><strong><a href="#limit">limit</a></strong></li>
|
364
|
+
<li><strong><a href="#page">page</a></strong></li>
|
365
|
+
<li><strong><a href="#primary_genre_id">primary_genre_id</a></strong></li>
|
366
|
+
</ul><p>Returns: <em>Array</em> of Artists <em>Hash</em></p>
|
367
|
+
|
368
|
+
<div class="highlight">
|
369
|
+
<pre> <span class="c1">// Example: GET /api/v2/artists?limit=14&api_key=1234567890abcdef</span>
|
370
|
+
|
371
|
+
<span class="p">[</span>
|
372
|
+
<span class="p">{</span>
|
373
|
+
<span class="s2">"created_at"</span><span class="o">:</span> <span class="s2">"2008-04-29T10:19:45Z"</span><span class="p">,</span>
|
374
|
+
<span class="s2">"genre_tags"</span><span class="o">:</span> <span class="s2">"O"</span><span class="p">,</span>
|
375
|
+
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">1</span><span class="p">,</span>
|
376
|
+
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Hyler Jones Proteges"</span><span class="p">,</span>
|
377
|
+
<span class="s2">"primary_genre_id"</span><span class="o">:</span> <span class="mi">61</span><span class="p">,</span>
|
378
|
+
<span class="s2">"upcoming_events_count"</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
|
379
|
+
<span class="s2">"updated_at"</span><span class="o">:</span> <span class="s2">"2010-03-26T16:49:20Z"</span><span class="p">,</span>
|
380
|
+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"http://thrillcall.com/artist/Hyler_Jones_Proteges"</span>
|
381
|
+
<span class="p">},</span>
|
382
|
+
<span class="p">{</span>
|
383
|
+
<span class="p">...</span>
|
384
|
+
<span class="p">},</span>
|
385
|
+
<span class="p">...</span>
|
386
|
+
<span class="p">]</span>
|
387
|
+
</pre>
|
388
|
+
</div>
|
389
|
+
|
390
|
+
|
391
|
+
<h3>GET /artist/:id</h3>
|
392
|
+
|
393
|
+
<p><strong>:id</strong> <em>integer</em> Thrillcall or Partner ID</p>
|
394
|
+
|
395
|
+
<p>Params:</p>
|
396
|
+
|
397
|
+
<ul>
|
398
|
+
<li><strong><a href="#use_partner_id">use_partner_id</a></strong></li>
|
399
|
+
</ul><p>Returns: Artist <em>Hash</em></p>
|
400
|
+
|
401
|
+
<div class="highlight">
|
402
|
+
<pre> <span class="c1">// Example: GET /api/v2/artist/4802?api_key=1234567890abcdef</span>
|
403
|
+
|
404
|
+
<span class="p">{</span>
|
405
|
+
<span class="s2">"created_at"</span><span class="o">:</span> <span class="s2">"2008-04-28T18:56:09Z"</span><span class="p">,</span>
|
406
|
+
<span class="s2">"genre_tags"</span><span class="o">:</span> <span class="s2">"Rock"</span><span class="p">,</span>
|
407
|
+
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">4802</span><span class="p">,</span>
|
408
|
+
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"The Sea and Cake"</span><span class="p">,</span>
|
409
|
+
<span class="s2">"primary_genre_id"</span><span class="o">:</span> <span class="mi">27</span><span class="p">,</span>
|
410
|
+
<span class="s2">"upcoming_events_count"</span><span class="o">:</span> <span class="mi">8</span><span class="p">,</span>
|
411
|
+
<span class="s2">"updated_at"</span><span class="o">:</span> <span class="s2">"2011-09-20T19:12:57Z"</span><span class="p">,</span>
|
412
|
+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"http://thrillcall.com/artist/The_Sea_and_Cake"</span>
|
413
|
+
<span class="p">}</span>
|
414
|
+
</pre>
|
415
|
+
</div>
|
416
|
+
|
417
|
+
|
418
|
+
<h3>GET /artist/:id/events</h3>
|
419
|
+
|
420
|
+
<p><strong>:id</strong> <em>integer</em> Thrillcall or Partner ID</p>
|
421
|
+
|
422
|
+
<p>Params:</p>
|
423
|
+
|
424
|
+
<ul>
|
425
|
+
<li><strong><a href="#limit">limit</a></strong></li>
|
426
|
+
<li><strong><a href="#page">page</a></strong></li>
|
427
|
+
<li><strong><a href="#min_date">min_date</a></strong></li>
|
428
|
+
<li><strong><a href="#max_date">max_date</a></strong></li>
|
429
|
+
<li><strong><a href="#lat">lat</a></strong></li>
|
430
|
+
<li><strong><a href="#long">long</a></strong></li>
|
431
|
+
<li><strong><a href="#postalcode">postalcode</a></strong></li>
|
432
|
+
<li><strong><a href="#radius">radius</a></strong></li>
|
433
|
+
<li><strong><a href="#use_partner_id">use_partner_id</a></strong></li>
|
434
|
+
<li><strong><a href="#ticket_type">ticket_type</a></strong></li>
|
435
|
+
<li><strong><a href="#must_have_tickets">must_have_tickets</a></strong></li>
|
436
|
+
<li><strong><a href="#show_unconfirmed_events">show_unconfirmed_events</a></strong></li>
|
437
|
+
<li><strong><a href="#show_rumor_events">show_rumor_events</a></strong></li>
|
438
|
+
</ul><p>Returns: <em>Array</em> of Events <em>Hash</em></p>
|
439
|
+
|
440
|
+
<div class="highlight">
|
441
|
+
<pre> <span class="c1">// Example: GET /api/v2/artist/4802/events?api_key=1234567890abcdef</span>
|
442
|
+
|
443
|
+
<span class="p">[</span>
|
444
|
+
<span class="p">{</span>
|
445
|
+
<span class="s2">"created_at"</span><span class="o">:</span> <span class="s2">"2011-06-23T23:10:31Z"</span><span class="p">,</span>
|
446
|
+
<span class="s2">"end_date"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
447
|
+
<span class="s2">"festival"</span><span class="o">:</span> <span class="kc">false</span><span class="p">,</span>
|
448
|
+
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">862618</span><span class="p">,</span>
|
449
|
+
<span class="s2">"latitude"</span><span class="o">:</span> <span class="mf">30.2729</span><span class="p">,</span>
|
450
|
+
<span class="s2">"longitude"</span><span class="o">:</span> <span class="o">-</span><span class="mf">97.7405</span><span class="p">,</span>
|
451
|
+
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"The Sea and Cake @ The Mohawk"</span><span class="p">,</span>
|
452
|
+
<span class="s2">"num_cancelled_bookings"</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
|
453
|
+
<span class="s2">"num_confirmed_bookings"</span><span class="o">:</span> <span class="mi">1</span><span class="p">,</span>
|
454
|
+
<span class="s2">"num_disabled_bookings"</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
|
455
|
+
<span class="s2">"num_unconfirmed_bookings"</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
|
456
|
+
<span class="s2">"on_sale_date"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
457
|
+
<span class="s2">"rumor"</span><span class="o">:</span> <span class="kc">false</span><span class="p">,</span>
|
458
|
+
<span class="s2">"start_date"</span><span class="o">:</span> <span class="s2">"2011-12-09T05:59:00Z"</span><span class="p">,</span>
|
459
|
+
<span class="s2">"unconfirmed_location"</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
|
460
|
+
<span class="s2">"updated_at"</span><span class="o">:</span> <span class="s2">"2011-09-28T04:01:56Z"</span><span class="p">,</span>
|
461
|
+
<span class="s2">"venue_id"</span><span class="o">:</span> <span class="mi">10116</span><span class="p">,</span>
|
462
|
+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"http://thrillcall.com/event/862618"</span>
|
463
|
+
<span class="p">},</span>
|
464
|
+
<span class="p">{</span>
|
465
|
+
<span class="p">...</span>
|
466
|
+
<span class="p">},</span>
|
467
|
+
<span class="p">...</span>
|
468
|
+
<span class="p">]</span>
|
469
|
+
</pre>
|
470
|
+
</div>
|
471
|
+
|
472
|
+
|
473
|
+
<h3>GET /search/artists/:term</h3>
|
474
|
+
|
475
|
+
<p><strong>:term</strong> <em>string</em> Arbitrary search string on the <strong>name</strong> field. (alphanumerics only, underscore matches underscore, use '+' for space)</p>
|
476
|
+
|
477
|
+
<p>Params:</p>
|
478
|
+
|
479
|
+
<ul>
|
480
|
+
<li><strong><a href="#limit">limit</a></strong></li>
|
481
|
+
<li><strong><a href="#page">page</a></strong></li>
|
482
|
+
</ul><p>Returns: <em>Array</em> of Artists <em>Hash</em></p>
|
483
|
+
|
484
|
+
<div class="highlight">
|
485
|
+
<pre> <span class="c1">// Example: GET /api/v2/search/artists/The%20Sea%20and%20Cake?api_key=1234567890abcdef</span>
|
486
|
+
|
487
|
+
<span class="p">[</span>
|
488
|
+
<span class="p">{</span>
|
489
|
+
<span class="s2">"created_at"</span><span class="o">:</span> <span class="s2">"2008-04-28T18:56:09Z"</span><span class="p">,</span>
|
490
|
+
<span class="s2">"genre_tags"</span><span class="o">:</span> <span class="s2">"Rock"</span><span class="p">,</span>
|
491
|
+
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">4802</span><span class="p">,</span>
|
492
|
+
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"The Sea and Cake"</span><span class="p">,</span>
|
493
|
+
<span class="s2">"primary_genre_id"</span><span class="o">:</span> <span class="mi">27</span><span class="p">,</span>
|
494
|
+
<span class="s2">"upcoming_events_count"</span><span class="o">:</span> <span class="mi">8</span><span class="p">,</span>
|
495
|
+
<span class="s2">"updated_at"</span><span class="o">:</span> <span class="s2">"2011-09-20T19:12:57Z"</span><span class="p">,</span>
|
496
|
+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"http://thrillcall.com/artist/The_Sea_and_Cake"</span>
|
497
|
+
<span class="p">},</span>
|
498
|
+
<span class="p">{</span>
|
499
|
+
<span class="p">...</span>
|
500
|
+
<span class="p">},</span>
|
501
|
+
<span class="p">...</span>
|
502
|
+
<span class="p">]</span>
|
503
|
+
</pre>
|
504
|
+
</div>
|
505
|
+
|
506
|
+
|
507
|
+
<h2>Events</h2>
|
508
|
+
|
509
|
+
<p>Fields:</p>
|
510
|
+
|
511
|
+
<ul>
|
512
|
+
<li>
|
513
|
+
<strong>created_at</strong> <em>string</em> ISO 8601 representation the time this object was created</li>
|
514
|
+
<li>
|
515
|
+
<strong>end_date</strong> <em>string</em> ISO 8601 representation of the end of the Event</li>
|
516
|
+
<li>
|
517
|
+
<strong>festival</strong> <em>boolean</em> Is this event a festival?</li>
|
518
|
+
<li>
|
519
|
+
<strong>id</strong> <em>integer</em> Thrillcall ID</li>
|
520
|
+
<li>
|
521
|
+
<strong>latitude</strong> <em>float</em> Approximate latitude for the Event</li>
|
522
|
+
<li>
|
523
|
+
<strong>longitude</strong> <em>float</em> Approximate longitude for the Event</li>
|
524
|
+
<li>
|
525
|
+
<strong>name</strong> <em>string</em> Name of the Event</li>
|
526
|
+
<li>
|
527
|
+
<strong>num_confirmed_bookings</strong> <em>integer</em> The number of confirmed Artist bookings for this event. Only Artists with a confirmed booking are returned when requesting artists for an event.</li>
|
528
|
+
<li>
|
529
|
+
<strong>num_unconfirmed_bookings</strong> <em>integer</em> The number of unconfirmed Artist bookings for this event</li>
|
530
|
+
<li>
|
531
|
+
<strong>num_disabled_bookings</strong> <em>integer</em> The number of disabled Artist bookings for this event</li>
|
532
|
+
<li>
|
533
|
+
<strong>num_cancelled_bookings</strong> <em>integer</em> The number of cancelled Artist bookings for this event</li>
|
534
|
+
<li>
|
535
|
+
<strong>on_sale_date</strong> <em>string</em> ISO 8601 representation of the date when tickets go on sale</li>
|
536
|
+
<li>
|
537
|
+
<strong>rumor</strong> <em>boolean</em> Are the details for this event based on a rumor?</li>
|
538
|
+
<li>
|
539
|
+
<strong>start_date</strong> <em>string</em> YYYY-MM-DD or, if time of day is known, ISO 8601 representation of the start of the Event</li>
|
540
|
+
<li>
|
541
|
+
<strong>unconfirmed_location</strong> <em>integer</em> If 1, the location if this event is unconfirmed</li>
|
542
|
+
<li>
|
543
|
+
<strong>updated_at</strong> <em>string</em> ISO 8601 representation of last time this object was updated</li>
|
544
|
+
<li>
|
545
|
+
<strong>venue_id</strong> <em>integer</em> Thrillcall Venue ID</li>
|
546
|
+
<li>
|
547
|
+
<strong>url</strong> <em>string</em> URL for this object on Thrillcall</li>
|
548
|
+
</ul><h3>GET /events</h3>
|
549
|
+
|
550
|
+
<p>Params:</p>
|
551
|
+
|
552
|
+
<ul>
|
553
|
+
<li><strong><a href="#limit">limit</a></strong></li>
|
554
|
+
<li><strong><a href="#page">page</a></strong></li>
|
555
|
+
<li><strong><a href="#min_date">min_date</a></strong></li>
|
556
|
+
<li><strong><a href="#max_date">max_date</a></strong></li>
|
557
|
+
<li><strong><a href="#lat">lat</a></strong></li>
|
558
|
+
<li><strong><a href="#long">long</a></strong></li>
|
559
|
+
<li><strong><a href="#postalcode">postalcode</a></strong></li>
|
560
|
+
<li><strong><a href="#radius">radius</a></strong></li>
|
561
|
+
<li><strong><a href="#ticket_type">ticket_type</a></strong></li>
|
562
|
+
<li><strong><a href="#must_have_tickets">must_have_tickets</a></strong></li>
|
563
|
+
<li><strong><a href="#show_unconfirmed_events">show_unconfirmed_events</a></strong></li>
|
564
|
+
<li><strong><a href="#show_rumor_events">show_rumor_events</a></strong></li>
|
565
|
+
</ul><p>Returns: <em>Array</em> of Events <em>Hash</em></p>
|
566
|
+
|
567
|
+
<div class="highlight">
|
568
|
+
<pre> <span class="c1">// Example: GET /api/v2/events?must_have_tickets=true&postalcode=94108&radius=10&limit=3&api_key=1234567890abcdef</span>
|
569
|
+
|
570
|
+
<span class="p">[</span>
|
571
|
+
<span class="p">{</span>
|
572
|
+
<span class="s2">"created_at"</span><span class="o">:</span> <span class="s2">"2011-06-14T00:09:13Z"</span><span class="p">,</span>
|
573
|
+
<span class="s2">"end_date"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
574
|
+
<span class="s2">"festival"</span><span class="o">:</span> <span class="kc">false</span><span class="p">,</span>
|
575
|
+
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">858707</span><span class="p">,</span>
|
576
|
+
<span class="s2">"latitude"</span><span class="o">:</span> <span class="mf">37.7951</span><span class="p">,</span>
|
577
|
+
<span class="s2">"longitude"</span><span class="o">:</span> <span class="o">-</span><span class="mf">122.421</span><span class="p">,</span>
|
578
|
+
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"The Sea and Cake @ Great American Music Hall"</span><span class="p">,</span>
|
579
|
+
<span class="s2">"num_cancelled_bookings"</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
|
580
|
+
<span class="s2">"num_confirmed_bookings"</span><span class="o">:</span> <span class="mi">1</span><span class="p">,</span>
|
581
|
+
<span class="s2">"num_disabled_bookings"</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
|
582
|
+
<span class="s2">"num_unconfirmed_bookings"</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
|
583
|
+
<span class="s2">"on_sale_date"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
584
|
+
<span class="s2">"rumor"</span><span class="o">:</span> <span class="kc">false</span><span class="p">,</span>
|
585
|
+
<span class="s2">"start_date"</span><span class="o">:</span> <span class="s2">"2011-12-06T07:59:00Z"</span><span class="p">,</span>
|
586
|
+
<span class="s2">"unconfirmed_location"</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
|
587
|
+
<span class="s2">"updated_at"</span><span class="o">:</span> <span class="s2">"2011-09-28T04:00:41Z"</span><span class="p">,</span>
|
588
|
+
<span class="s2">"venue_id"</span><span class="o">:</span> <span class="mi">27418</span><span class="p">,</span>
|
589
|
+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"http://thrillcall.com/event/858707"</span>
|
590
|
+
<span class="p">},</span>
|
591
|
+
<span class="p">{</span>
|
592
|
+
<span class="p">...</span>
|
593
|
+
<span class="p">},</span>
|
594
|
+
<span class="p">...</span>
|
595
|
+
<span class="p">]</span>
|
596
|
+
</pre>
|
597
|
+
</div>
|
598
|
+
|
599
|
+
|
600
|
+
<h3>GET /event/:id</h3>
|
601
|
+
|
602
|
+
<p><strong>:id</strong> <em>integer</em> Thrillcall ID</p>
|
603
|
+
|
604
|
+
<p>Params:</p>
|
605
|
+
|
606
|
+
<ul>
|
607
|
+
<li>None</li>
|
608
|
+
</ul><p>Returns: Event <em>Hash</em></p>
|
609
|
+
|
610
|
+
<div class="highlight">
|
611
|
+
<pre> <span class="c1">// Example: GET /api/v2/event/858707?api_key=1234567890abcdef</span>
|
612
|
+
|
613
|
+
<span class="p">{</span>
|
614
|
+
<span class="s2">"created_at"</span><span class="o">:</span> <span class="s2">"2011-06-14T00:09:13Z"</span><span class="p">,</span>
|
615
|
+
<span class="s2">"end_date"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
616
|
+
<span class="s2">"festival"</span><span class="o">:</span> <span class="kc">false</span><span class="p">,</span>
|
617
|
+
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">858707</span><span class="p">,</span>
|
618
|
+
<span class="s2">"latitude"</span><span class="o">:</span> <span class="mf">37.7951</span><span class="p">,</span>
|
619
|
+
<span class="s2">"longitude"</span><span class="o">:</span> <span class="o">-</span><span class="mf">122.421</span><span class="p">,</span>
|
620
|
+
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"The Sea and Cake @ Great American Music Hall"</span><span class="p">,</span>
|
621
|
+
<span class="s2">"num_cancelled_bookings"</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
|
622
|
+
<span class="s2">"num_confirmed_bookings"</span><span class="o">:</span> <span class="mi">1</span><span class="p">,</span>
|
623
|
+
<span class="s2">"num_disabled_bookings"</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
|
624
|
+
<span class="s2">"num_unconfirmed_bookings"</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
|
625
|
+
<span class="s2">"on_sale_date"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
626
|
+
<span class="s2">"rumor"</span><span class="o">:</span> <span class="kc">false</span><span class="p">,</span>
|
627
|
+
<span class="s2">"start_date"</span><span class="o">:</span> <span class="s2">"2011-12-06T07:59:00Z"</span><span class="p">,</span>
|
628
|
+
<span class="s2">"unconfirmed_location"</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
|
629
|
+
<span class="s2">"updated_at"</span><span class="o">:</span> <span class="s2">"2011-09-28T04:00:41Z"</span><span class="p">,</span>
|
630
|
+
<span class="s2">"venue_id"</span><span class="o">:</span> <span class="mi">27418</span><span class="p">,</span>
|
631
|
+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"http://thrillcall.com/event/858707"</span>
|
632
|
+
<span class="p">}</span>
|
633
|
+
</pre>
|
634
|
+
</div>
|
635
|
+
|
636
|
+
|
637
|
+
<h3>GET /event/:id/artists</h3>
|
638
|
+
|
639
|
+
<p><strong>:id</strong> <em>integer</em> Thrillcall ID</p>
|
640
|
+
|
641
|
+
<p>Params:</p>
|
642
|
+
|
643
|
+
<ul>
|
644
|
+
<li><strong><a href="#limit">limit</a></strong></li>
|
645
|
+
<li><strong><a href="#page">page</a></strong></li>
|
646
|
+
</ul><p>Returns: <em>Array</em> of Artists <em>Hash</em></p>
|
647
|
+
|
648
|
+
<div class="highlight">
|
649
|
+
<pre> <span class="c1">// Example: GET /api/v2/event/858707/artists?api_key=1234567890abcdef</span>
|
650
|
+
|
651
|
+
<span class="p">[</span>
|
652
|
+
<span class="p">{</span>
|
653
|
+
<span class="s2">"created_at"</span><span class="o">:</span> <span class="s2">"2008-04-28T18:56:09Z"</span><span class="p">,</span>
|
654
|
+
<span class="s2">"genre_tags"</span><span class="o">:</span> <span class="s2">"Rock"</span><span class="p">,</span>
|
655
|
+
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">4802</span><span class="p">,</span>
|
656
|
+
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"The Sea and Cake"</span><span class="p">,</span>
|
657
|
+
<span class="s2">"primary_genre_id"</span><span class="o">:</span> <span class="mi">27</span><span class="p">,</span>
|
658
|
+
<span class="s2">"upcoming_events_count"</span><span class="o">:</span> <span class="mi">8</span><span class="p">,</span>
|
659
|
+
<span class="s2">"updated_at"</span><span class="o">:</span> <span class="s2">"2011-09-20T19:12:57Z"</span><span class="p">,</span>
|
660
|
+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"http://thrillcall.com/artist/The_Sea_and_Cake"</span>
|
661
|
+
<span class="p">},</span>
|
662
|
+
<span class="p">{</span>
|
663
|
+
<span class="p">...</span>
|
664
|
+
<span class="p">},</span>
|
665
|
+
<span class="p">...</span>
|
666
|
+
<span class="p">]</span>
|
667
|
+
</pre>
|
668
|
+
</div>
|
669
|
+
|
670
|
+
|
671
|
+
<h3>GET /event/:id/venue</h3>
|
672
|
+
|
673
|
+
<p><strong>:id</strong> <em>integer</em> Thrillcall ID</p>
|
674
|
+
|
675
|
+
<p>Params:</p>
|
676
|
+
|
677
|
+
<ul>
|
678
|
+
<li>None</li>
|
679
|
+
</ul><p>Returns: Venue <em>Hash</em></p>
|
680
|
+
|
681
|
+
<div class="highlight">
|
682
|
+
<pre> <span class="c1">// Example: GET /api/v2/event/858707/venue?api_key=1234567890abcdef</span>
|
683
|
+
|
684
|
+
<span class="p">{</span>
|
685
|
+
<span class="s2">"address1"</span><span class="o">:</span> <span class="s2">"859 O'Farrell St."</span><span class="p">,</span>
|
686
|
+
<span class="s2">"address2"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
687
|
+
<span class="s2">"city"</span><span class="o">:</span> <span class="s2">"San Francisco"</span><span class="p">,</span>
|
688
|
+
<span class="s2">"country"</span><span class="o">:</span> <span class="s2">"US"</span><span class="p">,</span>
|
689
|
+
<span class="s2">"created_at"</span><span class="o">:</span> <span class="s2">"2008-04-21T16:52:31Z"</span><span class="p">,</span>
|
690
|
+
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">27418</span><span class="p">,</span>
|
691
|
+
<span class="s2">"latitude"</span><span class="o">:</span> <span class="mf">37.784796</span><span class="p">,</span>
|
692
|
+
<span class="s2">"longitude"</span><span class="o">:</span> <span class="o">-</span><span class="mf">122.418819</span><span class="p">,</span>
|
693
|
+
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Great American Music Hall"</span><span class="p">,</span>
|
694
|
+
<span class="s2">"state"</span><span class="o">:</span> <span class="s2">"CA"</span><span class="p">,</span>
|
695
|
+
<span class="s2">"upcoming_events_count"</span><span class="o">:</span> <span class="mi">34</span><span class="p">,</span>
|
696
|
+
<span class="s2">"updated_at"</span><span class="o">:</span> <span class="s2">"2011-01-20T21:04:37Z"</span><span class="p">,</span>
|
697
|
+
<span class="s2">"postalcode"</span><span class="o">:</span> <span class="s2">"94109"</span><span class="p">,</span>
|
698
|
+
<span class="s2">"metro_area_id"</span><span class="o">:</span> <span class="mi">105</span><span class="p">,</span>
|
699
|
+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"http://thrillcall.com/venue/Great_American_Music_Hall_in_San_Francisco_CA"</span>
|
700
|
+
<span class="p">}</span>
|
701
|
+
</pre>
|
702
|
+
</div>
|
703
|
+
|
704
|
+
|
705
|
+
<h3>GET /event/:id/tickets</h3>
|
706
|
+
|
707
|
+
<p><strong>:id</strong> <em>integer</em> Thrillcall ID</p>
|
708
|
+
|
709
|
+
<p>Params:</p>
|
710
|
+
|
711
|
+
<ul>
|
712
|
+
<li><strong><a href="#limit">limit</a></strong></li>
|
713
|
+
<li><strong><a href="#page">page</a></strong></li>
|
714
|
+
<li><strong><a href="#ticket_type">ticket_type</a></strong></li>
|
715
|
+
</ul><p>Returns: <em>Array</em> of Tickets <em>Hash</em></p>
|
716
|
+
|
717
|
+
<div class="highlight">
|
718
|
+
<pre> <span class="c1">// Example: GET /api/v2/event/858707/tickets?api_key=1234567890abcdef</span>
|
719
|
+
|
720
|
+
<span class="p">[</span>
|
721
|
+
<span class="p">{</span>
|
722
|
+
<span class="s2">"created_at"</span><span class="o">:</span> <span class="s2">"2011-06-14T00:09:16Z"</span><span class="p">,</span>
|
723
|
+
<span class="s2">"description"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
724
|
+
<span class="s2">"event_id"</span><span class="o">:</span> <span class="mi">858707</span><span class="p">,</span>
|
725
|
+
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">599794</span><span class="p">,</span>
|
726
|
+
<span class="s2">"marketing_text"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
727
|
+
<span class="s2">"max_ticket_price"</span><span class="o">:</span> <span class="mi">21</span><span class="p">,</span>
|
728
|
+
<span class="s2">"min_ticket_price"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
729
|
+
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Gen. Admission Seating Limited"</span><span class="p">,</span>
|
730
|
+
<span class="s2">"on_sale_end_date"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
731
|
+
<span class="s2">"on_sale_start_date"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
732
|
+
<span class="s2">"seat_info"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
733
|
+
<span class="s2">"updated_at"</span><span class="o">:</span> <span class="s2">"2011-06-14T00:09:16Z"</span><span class="p">,</span>
|
734
|
+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"http://tickets.gamh.com/evinfo.php?eventid=154723&amp;r=affi&amp;u=210785"</span>
|
735
|
+
<span class="p">},</span>
|
736
|
+
<span class="p">{</span>
|
737
|
+
<span class="p">...</span>
|
738
|
+
<span class="p">},</span>
|
739
|
+
<span class="p">...</span>
|
740
|
+
<span class="p">]</span>
|
741
|
+
</pre>
|
742
|
+
</div>
|
743
|
+
|
744
|
+
|
745
|
+
<h2>Genre</h2>
|
746
|
+
|
747
|
+
<p>Fields:</p>
|
748
|
+
|
749
|
+
<ul>
|
750
|
+
<li>
|
751
|
+
<strong>created_at</strong> <em>string</em> ISO 8601 representation the time this object was created</li>
|
752
|
+
<li>
|
753
|
+
<strong>description</strong> <em>string</em> Description of the Genre</li>
|
754
|
+
<li>
|
755
|
+
<strong>id</strong> <em>integer</em> Thrillcall ID</li>
|
756
|
+
<li>
|
757
|
+
<strong>name</strong> <em>string</em> Name of the Genre</li>
|
758
|
+
<li>
|
759
|
+
<strong>updated_at</strong> <em>string</em> ISO 8601 representation of last time this object was updated</li>
|
760
|
+
</ul><h3>GET /genres</h3>
|
761
|
+
|
762
|
+
<p>Params:</p>
|
763
|
+
|
764
|
+
<ul>
|
765
|
+
<li><strong><a href="#limit">limit</a></strong></li>
|
766
|
+
<li><strong><a href="#page">page</a></strong></li>
|
767
|
+
</ul><p>Returns: <em>Array</em> of Genres <em>Hash</em></p>
|
768
|
+
|
769
|
+
<div class="highlight">
|
770
|
+
<pre> <span class="c1">// Example: GET /api/v2/genres?limit=14&api_key=1234567890abcdef</span>
|
771
|
+
|
772
|
+
<span class="p">[</span>
|
773
|
+
<span class="p">{</span>
|
774
|
+
<span class="s2">"created_at"</span><span class="o">:</span> <span class="s2">"2008-07-09T19:17:45Z"</span><span class="p">,</span>
|
775
|
+
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"Shawn Colvin, Loudon Wainwright III etc..."</span><span class="p">,</span>
|
776
|
+
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">6</span><span class="p">,</span>
|
777
|
+
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Folk"</span><span class="p">,</span>
|
778
|
+
<span class="s2">"updated_at"</span><span class="o">:</span> <span class="s2">"2010-03-25T23:51:55Z"</span>
|
779
|
+
<span class="p">},</span>
|
780
|
+
<span class="p">{</span>
|
781
|
+
<span class="p">...</span>
|
782
|
+
<span class="p">},</span>
|
783
|
+
<span class="p">...</span>
|
784
|
+
<span class="p">]</span>
|
785
|
+
</pre>
|
786
|
+
</div>
|
787
|
+
|
788
|
+
|
789
|
+
<h3>GET /genre/:id</h3>
|
790
|
+
|
791
|
+
<p><strong>:id</strong> <em>integer</em> Thrillcall ID</p>
|
792
|
+
|
793
|
+
<p>Params:</p>
|
794
|
+
|
795
|
+
<ul>
|
796
|
+
<li>None</li>
|
797
|
+
</ul><p>Returns: Genre <em>Hash</em></p>
|
798
|
+
|
799
|
+
<div class="highlight">
|
800
|
+
<pre> <span class="c1">// Example: GET /api/v2/genre/27?api_key=1234567890abcdef</span>
|
801
|
+
|
802
|
+
<span class="p">{</span>
|
803
|
+
<span class="s2">"created_at"</span><span class="o">:</span> <span class="s2">"2008-07-09T19:17:45Z"</span><span class="p">,</span>
|
804
|
+
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"U2, 30 Seconds To Mars etc..."</span><span class="p">,</span>
|
805
|
+
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">27</span><span class="p">,</span>
|
806
|
+
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Rock"</span><span class="p">,</span>
|
807
|
+
<span class="s2">"updated_at"</span><span class="o">:</span> <span class="s2">"2010-03-25T23:52:21Z"</span>
|
808
|
+
<span class="p">}</span>
|
809
|
+
</pre>
|
810
|
+
</div>
|
811
|
+
|
812
|
+
|
813
|
+
<h3>GET /genre/:id/artists</h3>
|
814
|
+
|
815
|
+
<p><strong>:id</strong> <em>integer</em> Thrillcall ID</p>
|
816
|
+
|
817
|
+
<p>Params:</p>
|
818
|
+
|
819
|
+
<ul>
|
820
|
+
<li><strong><a href="#limit">limit</a></strong></li>
|
821
|
+
<li><strong><a href="#page">page</a></strong></li>
|
822
|
+
</ul><p>Returns: <em>Array</em> of Artists <em>Hash</em></p>
|
823
|
+
|
824
|
+
<div class="highlight">
|
825
|
+
<pre> <span class="c1">// Example: GET /api/v2/genre/27/artists?api_key=1234567890abcdef</span>
|
826
|
+
|
827
|
+
<span class="p">[</span>
|
828
|
+
<span class="p">{</span>
|
829
|
+
<span class="s2">"created_at"</span><span class="o">:</span> <span class="s2">"2008-04-29T10:06:05Z"</span><span class="p">,</span>
|
830
|
+
<span class="s2">"genre_tags"</span><span class="o">:</span> <span class="s2">"Folk;Other;psychedelic"</span><span class="p">,</span>
|
831
|
+
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">2</span><span class="p">,</span>
|
832
|
+
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Espers"</span><span class="p">,</span>
|
833
|
+
<span class="s2">"primary_genre_id"</span><span class="o">:</span> <span class="mi">27</span><span class="p">,</span>
|
834
|
+
<span class="s2">"upcoming_events_count"</span><span class="o">:</span> <span class="mi">1</span><span class="p">,</span>
|
835
|
+
<span class="s2">"updated_at"</span><span class="o">:</span> <span class="s2">"2011-01-03T22:14:36Z"</span><span class="p">,</span>
|
836
|
+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"http://thrillcall.com/artist/Espers"</span>
|
837
|
+
<span class="p">},</span>
|
838
|
+
<span class="p">{</span>
|
839
|
+
<span class="p">...</span>
|
840
|
+
<span class="p">},</span>
|
841
|
+
<span class="p">...</span>
|
842
|
+
<span class="p">]</span>
|
843
|
+
</pre>
|
844
|
+
</div>
|
845
|
+
|
846
|
+
|
847
|
+
<h2>Metro Area</h2>
|
848
|
+
|
849
|
+
<p>Fields:</p>
|
850
|
+
|
851
|
+
<ul>
|
852
|
+
<li>
|
853
|
+
<strong>city</strong> <em>string</em> City of the Metro Area</li>
|
854
|
+
<li>
|
855
|
+
<strong>country</strong> <em>string</em> Country of the Metro Area</li>
|
856
|
+
<li>
|
857
|
+
<strong>created_at</strong> <em>string</em> ISO 8601 representation the time this object was created</li>
|
858
|
+
<li>
|
859
|
+
<strong>id</strong> <em>integer</em> Thrillcall ID</li>
|
860
|
+
<li>
|
861
|
+
<strong>latitude</strong> <em>float</em> Latitude of the Metro Area</li>
|
862
|
+
<li>
|
863
|
+
<strong>longitude</strong> <em>float</em> Longitude of the Metro Area</li>
|
864
|
+
<li>
|
865
|
+
<strong>radius</strong> <em>integer</em> Radius of the Metro Area from the Lat/Long center</li>
|
866
|
+
<li>
|
867
|
+
<strong>state</strong> <em>string</em> State of the Metro Area</li>
|
868
|
+
<li>
|
869
|
+
<strong>updated_at</strong> <em>string</em> ISO 8601 representation of last time this object was updated</li>
|
870
|
+
<li>
|
871
|
+
<strong>url</strong> <em>string</em> URL for this object on Thrillcall</li>
|
872
|
+
</ul><h3>GET /metro_areas</h3>
|
873
|
+
|
874
|
+
<p>Params:</p>
|
875
|
+
|
876
|
+
<ul>
|
877
|
+
<li><strong><a href="#limit">limit</a></strong></li>
|
878
|
+
<li><strong><a href="#page">page</a></strong></li>
|
879
|
+
</ul><p>Returns: <em>Array</em> of Metro Areas <em>Hash</em></p>
|
880
|
+
|
881
|
+
<div class="highlight">
|
882
|
+
<pre> <span class="c1">// Example: GET /api/v2/metro_areas?limit=14&api_key=1234567890abcdef</span>
|
883
|
+
|
884
|
+
<span class="p">[</span>
|
885
|
+
<span class="p">{</span>
|
886
|
+
<span class="s2">"city"</span><span class="o">:</span> <span class="s2">"Chicago"</span><span class="p">,</span>
|
887
|
+
<span class="s2">"country"</span><span class="o">:</span> <span class="s2">"US"</span><span class="p">,</span>
|
888
|
+
<span class="s2">"created_at"</span><span class="o">:</span> <span class="s2">"2011-06-24T03:23:57Z"</span><span class="p">,</span>
|
889
|
+
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">104</span><span class="p">,</span>
|
890
|
+
<span class="s2">"latitude"</span><span class="o">:</span> <span class="mf">41.8842</span><span class="p">,</span>
|
891
|
+
<span class="s2">"longitude"</span><span class="o">:</span> <span class="o">-</span><span class="mf">87.6324</span><span class="p">,</span>
|
892
|
+
<span class="s2">"radius"</span><span class="o">:</span> <span class="mi">50</span><span class="p">,</span>
|
893
|
+
<span class="s2">"state"</span><span class="o">:</span> <span class="s2">"IL"</span><span class="p">,</span>
|
894
|
+
<span class="s2">"updated_at"</span><span class="o">:</span> <span class="s2">"2011-07-05T23:11:24Z"</span><span class="p">,</span>
|
895
|
+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"http://thrillcall.com/live-music/chicago"</span>
|
896
|
+
<span class="p">},</span>
|
897
|
+
<span class="p">{</span>
|
898
|
+
<span class="p">...</span>
|
899
|
+
<span class="p">},</span>
|
900
|
+
<span class="p">...</span>
|
901
|
+
<span class="p">]</span>
|
902
|
+
</pre>
|
903
|
+
</div>
|
904
|
+
|
905
|
+
|
906
|
+
<h3>GET /metro_area/:id</h3>
|
907
|
+
|
908
|
+
<p><strong>:id</strong> <em>integer</em> Thrillcall ID</p>
|
909
|
+
|
910
|
+
<p>Params:</p>
|
911
|
+
|
912
|
+
<ul>
|
913
|
+
<li>None</li>
|
914
|
+
</ul><p>Returns: Metro Area <em>Hash</em></p>
|
915
|
+
|
916
|
+
<div class="highlight">
|
917
|
+
<pre> <span class="c1">// Example: GET /api/v2/metro_area/105?api_key=1234567890abcdef</span>
|
918
|
+
|
919
|
+
<span class="p">{</span>
|
920
|
+
<span class="s2">"city"</span><span class="o">:</span> <span class="s2">"San Francisco"</span><span class="p">,</span>
|
921
|
+
<span class="s2">"country"</span><span class="o">:</span> <span class="s2">"US"</span><span class="p">,</span>
|
922
|
+
<span class="s2">"created_at"</span><span class="o">:</span> <span class="s2">"2011-06-24T03:23:57Z"</span><span class="p">,</span>
|
923
|
+
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">105</span><span class="p">,</span>
|
924
|
+
<span class="s2">"latitude"</span><span class="o">:</span> <span class="mf">37.7771</span><span class="p">,</span>
|
925
|
+
<span class="s2">"longitude"</span><span class="o">:</span> <span class="o">-</span><span class="mf">122.42</span><span class="p">,</span>
|
926
|
+
<span class="s2">"radius"</span><span class="o">:</span> <span class="mi">50</span><span class="p">,</span>
|
927
|
+
<span class="s2">"state"</span><span class="o">:</span> <span class="s2">"CA"</span><span class="p">,</span>
|
928
|
+
<span class="s2">"updated_at"</span><span class="o">:</span> <span class="s2">"2011-07-05T23:11:24Z"</span><span class="p">,</span>
|
929
|
+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"http://thrillcall.com/live-music/san-francisco"</span>
|
930
|
+
<span class="p">}</span>
|
931
|
+
</pre>
|
932
|
+
</div>
|
933
|
+
|
934
|
+
|
935
|
+
<h3>GET /metro_area/:id/events</h3>
|
936
|
+
|
937
|
+
<p><strong>:id</strong> <em>integer</em> Thrillcall ID</p>
|
938
|
+
|
939
|
+
<p>Params:</p>
|
940
|
+
|
941
|
+
<ul>
|
942
|
+
<li><strong><a href="#limit">limit</a></strong></li>
|
943
|
+
<li><strong><a href="#page">page</a></strong></li>
|
944
|
+
<li><strong><a href="#min_date">min_date</a></strong></li>
|
945
|
+
<li><strong><a href="#max_date">max_date</a></strong></li>
|
946
|
+
<li><strong><a href="#radius">radius</a></strong></li>
|
947
|
+
<li><strong><a href="#ticket_type">ticket_type</a></strong></li>
|
948
|
+
<li><strong><a href="#must_have_tickets">must_have_tickets</a></strong></li>
|
949
|
+
<li><strong><a href="#show_unconfirmed_events">show_unconfirmed_events</a></strong></li>
|
950
|
+
<li><strong><a href="#show_rumor_events">show_rumor_events</a></strong></li>
|
951
|
+
</ul><p>Returns: <em>Array</em> of Metro Areas <em>Hash</em></p>
|
952
|
+
|
953
|
+
<div class="highlight">
|
954
|
+
<pre> <span class="c1">// Example: GET /api/v2/metro_area/105/events?api_key=1234567890abcdef</span>
|
955
|
+
|
956
|
+
<span class="p">[</span>
|
957
|
+
<span class="p">{</span>
|
958
|
+
<span class="s2">"created_at"</span><span class="o">:</span> <span class="s2">"2011-04-24T02:12:09Z"</span><span class="p">,</span>
|
959
|
+
<span class="s2">"end_date"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
960
|
+
<span class="s2">"festival"</span><span class="o">:</span> <span class="kc">false</span><span class="p">,</span>
|
961
|
+
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">831330</span><span class="p">,</span>
|
962
|
+
<span class="s2">"latitude"</span><span class="o">:</span> <span class="mf">37.7794</span><span class="p">,</span>
|
963
|
+
<span class="s2">"longitude"</span><span class="o">:</span> <span class="o">-</span><span class="mf">122.418</span><span class="p">,</span>
|
964
|
+
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Philadelphia Orchestra @ Davies Symphony Hall"</span><span class="p">,</span>
|
965
|
+
<span class="s2">"num_cancelled_bookings"</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
|
966
|
+
<span class="s2">"num_confirmed_bookings"</span><span class="o">:</span> <span class="mi">1</span><span class="p">,</span>
|
967
|
+
<span class="s2">"num_disabled_bookings"</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
|
968
|
+
<span class="s2">"num_unconfirmed_bookings"</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
|
969
|
+
<span class="s2">"on_sale_date"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
970
|
+
<span class="s2">"rumor"</span><span class="o">:</span> <span class="kc">false</span><span class="p">,</span>
|
971
|
+
<span class="s2">"start_date"</span><span class="o">:</span> <span class="s2">"2012-06-11T06:59:00Z"</span><span class="p">,</span>
|
972
|
+
<span class="s2">"unconfirmed_location"</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
|
973
|
+
<span class="s2">"updated_at"</span><span class="o">:</span> <span class="s2">"2011-09-28T03:51:22Z"</span><span class="p">,</span>
|
974
|
+
<span class="s2">"venue_id"</span><span class="o">:</span> <span class="mi">51886</span><span class="p">,</span>
|
975
|
+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"http://thrillcall.com/event/831330"</span>
|
976
|
+
<span class="p">},</span>
|
977
|
+
<span class="p">{</span>
|
978
|
+
<span class="p">...</span>
|
979
|
+
<span class="p">},</span>
|
980
|
+
<span class="p">...</span>
|
981
|
+
<span class="p">]</span>
|
982
|
+
</pre>
|
983
|
+
</div>
|
984
|
+
|
985
|
+
|
986
|
+
<h2>Person</h2>
|
987
|
+
|
988
|
+
<p>Fields:</p>
|
989
|
+
|
990
|
+
<ul>
|
991
|
+
<li>
|
992
|
+
<strong>created_at</strong> <em>string</em> ISO 8601 representation the time this object was created</li>
|
993
|
+
<li>
|
994
|
+
<strong>first_name</strong> <em>string</em> First name of the Person</li>
|
995
|
+
<li>
|
996
|
+
<strong>gender</strong> <em>string</em> Gender of the Person</li>
|
997
|
+
<li>
|
998
|
+
<strong>id</strong> <em>integer</em> Thrillcall ID</li>
|
999
|
+
<li>
|
1000
|
+
<strong>last_name</strong> <em>string</em> Last name of the Person</li>
|
1001
|
+
<li>
|
1002
|
+
<strong>login</strong> <em>string</em> Login of the Person</li>
|
1003
|
+
<li>
|
1004
|
+
<strong>updated_at</strong> <em>string</em> ISO 8601 representation of last time this object was updated</li>
|
1005
|
+
<li>
|
1006
|
+
<strong>referral_code</strong> <em>string</em> Referral code of the Person</li>
|
1007
|
+
<li>
|
1008
|
+
<strong>referral_code_count</strong> <em>integer</em> Number of Referral code used for the Person</li>
|
1009
|
+
<li>
|
1010
|
+
<strong>postalcode</strong> <em>string</em> Postalcode of the Person</li>
|
1011
|
+
<li>
|
1012
|
+
<strong>postalcode</strong> <em>string</em> Postalcode of the Person</li>
|
1013
|
+
</ul><h3>POST /person/signin</h3>
|
1014
|
+
|
1015
|
+
<p>Params:</p>
|
1016
|
+
|
1017
|
+
<ul>
|
1018
|
+
<li><strong><a href="#login">login</a></strong></li>
|
1019
|
+
<li><strong><a href="#password">password</a></strong></li>
|
1020
|
+
</ul><p>Returns: Person <em>Hash</em></p>
|
1021
|
+
|
1022
|
+
<div class="highlight">
|
1023
|
+
<pre> <span class="c1">// Example: POST /api/v2/person/signin</span>
|
1024
|
+
|
1025
|
+
<span class="p">{</span>
|
1026
|
+
<span class="s2">"created_at"</span><span class="o">:</span> <span class="s2">"2000-11-09T19:09:23Z"</span><span class="p">,</span>
|
1027
|
+
<span class="s2">"first_name"</span><span class="o">:</span> <span class="s2">"John"</span><span class="p">,</span>
|
1028
|
+
<span class="s2">"gender"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
1029
|
+
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">49</span><span class="p">,</span>
|
1030
|
+
<span class="s2">"last_name"</span><span class="o">:</span> <span class="s2">"Doe"</span><span class="p">,</span>
|
1031
|
+
<span class="s2">"login"</span><span class="o">:</span> <span class="s2">"john@example.com"</span><span class="p">,</span>
|
1032
|
+
<span class="s2">"updated_at"</span><span class="o">:</span> <span class="s2">"2011-11-09T19:09:23Z"</span><span class="p">,</span>
|
1033
|
+
<span class="s2">"referral_code"</span><span class="o">:</span> <span class="s2">"fhskjfhk3j43h43hjkh"</span><span class="p">,</span>
|
1034
|
+
<span class="s2">"referral_code_count"</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
|
1035
|
+
<span class="s2">"postalcode"</span><span class="o">:</span> <span class="s2">"94104"</span>
|
1036
|
+
<span class="p">}</span>
|
1037
|
+
</pre>
|
1038
|
+
</div>
|
1039
|
+
|
1040
|
+
|
1041
|
+
<h3>POST /person/signup</h3>
|
1042
|
+
|
1043
|
+
<p>Params:</p>
|
1044
|
+
|
1045
|
+
<ul>
|
1046
|
+
<li><strong><a href="#first_name">first_name</a></strong></li>
|
1047
|
+
<li><strong><a href="#last_name">last_name</a></strong></li>
|
1048
|
+
<li><strong><a href="#gender">gender</a></strong></li>
|
1049
|
+
<li><strong><a href="#email">email</a></strong></li>
|
1050
|
+
<li><strong><a href="#password">password</a></strong></li>
|
1051
|
+
<li><strong><a href="#postalcode">postalcode</a></strong></li>
|
1052
|
+
</ul><p>Returns: Person <em>Hash</em></p>
|
1053
|
+
|
1054
|
+
<div class="highlight">
|
1055
|
+
<pre> <span class="c1">// Example: POST /api/v2/person/signup</span>
|
1056
|
+
|
1057
|
+
<span class="p">{</span>
|
1058
|
+
<span class="s2">"created_at"</span><span class="o">:</span> <span class="s2">"2000-11-09T19:09:23Z"</span><span class="p">,</span>
|
1059
|
+
<span class="s2">"first_name"</span><span class="o">:</span> <span class="s2">"John"</span><span class="p">,</span>
|
1060
|
+
<span class="s2">"gender"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
1061
|
+
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">49</span><span class="p">,</span>
|
1062
|
+
<span class="s2">"last_name"</span><span class="o">:</span> <span class="s2">"Doe"</span><span class="p">,</span>
|
1063
|
+
<span class="s2">"login"</span><span class="o">:</span> <span class="s2">"john@example.com"</span><span class="p">,</span>
|
1064
|
+
<span class="s2">"updated_at"</span><span class="o">:</span> <span class="s2">"2011-11-09T19:09:23Z"</span><span class="p">,</span>
|
1065
|
+
<span class="s2">"referral_code"</span><span class="o">:</span> <span class="s2">"fhskjfhk3j43h43hjkh"</span><span class="p">,</span>
|
1066
|
+
<span class="s2">"referral_code_count"</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
|
1067
|
+
<span class="s2">"postalcode"</span><span class="o">:</span> <span class="s2">"94104"</span>
|
1068
|
+
<span class="p">}</span>
|
1069
|
+
</pre>
|
1070
|
+
</div>
|
1071
|
+
|
1072
|
+
|
1073
|
+
<h2>Venues</h2>
|
1074
|
+
|
1075
|
+
<p>Fields:</p>
|
1076
|
+
|
1077
|
+
<ul>
|
1078
|
+
<li>
|
1079
|
+
<strong>address1</strong> <em>string</em> First address field for the Venue</li>
|
1080
|
+
<li>
|
1081
|
+
<strong>address2</strong> <em>string</em> Second address field for the Venue</li>
|
1082
|
+
<li>
|
1083
|
+
<strong>city</strong> <em>string</em> City the Venue is in</li>
|
1084
|
+
<li>
|
1085
|
+
<strong>country</strong> <em>string</em> Country the Venue is in</li>
|
1086
|
+
<li>
|
1087
|
+
<strong>created_at</strong> <em>string</em> ISO 8601 representation the time this object was created</li>
|
1088
|
+
<li>
|
1089
|
+
<strong>id</strong> <em>integer</em> Thrillcall ID</li>
|
1090
|
+
<li>
|
1091
|
+
<strong>latitude</strong> <em>float</em> Approximate Latitude for the Venue</li>
|
1092
|
+
<li>
|
1093
|
+
<strong>longitude</strong> <em>float</em> Approximate Longitude for the Venue</li>
|
1094
|
+
<li>
|
1095
|
+
<strong>name</strong> <em>string</em> Name of the Venue</li>
|
1096
|
+
<li>
|
1097
|
+
<strong>metro_area_id</strong> <em>integer</em> Thrillcall ID of the Metro Area this Venue is in, if any</li>
|
1098
|
+
<li>
|
1099
|
+
<strong>state</strong> <em>string</em> State the Venue is in</li>
|
1100
|
+
<li>
|
1101
|
+
<strong>upcoming_events_count</strong> <em>integer</em> Number of upcoming events associated with this object</li>
|
1102
|
+
<li>
|
1103
|
+
<strong>updated_at</strong> <em>string</em> ISO 8601 representation of last time this object was updated</li>
|
1104
|
+
<li>
|
1105
|
+
<strong>postalcode</strong> <em>string</em> Postal code for the Venue</li>
|
1106
|
+
<li>
|
1107
|
+
<strong>url</strong> <em>string</em> URL for this object on Thrillcall</li>
|
1108
|
+
</ul><h3>GET /venues</h3>
|
1109
|
+
|
1110
|
+
<p>Params:</p>
|
1111
|
+
|
1112
|
+
<ul>
|
1113
|
+
<li><strong><a href="#limit">limit</a></strong></li>
|
1114
|
+
<li><strong><a href="#page">page</a></strong></li>
|
1115
|
+
<li><strong><a href="#lat">lat</a></strong></li>
|
1116
|
+
<li><strong><a href="#long">long</a></strong></li>
|
1117
|
+
<li><strong><a href="#postalcode">postalcode</a></strong></li>
|
1118
|
+
<li><strong><a href="#radius">radius</a></strong></li>
|
1119
|
+
</ul><p>Returns: <em>Array</em> of Venues <em>Hash</em></p>
|
1120
|
+
|
1121
|
+
<div class="highlight">
|
1122
|
+
<pre> <span class="c1">// Example: GET /api/v2/venues?limit=14&api_key=1234567890abcdef</span>
|
1123
|
+
|
1124
|
+
<span class="p">[</span>
|
1125
|
+
<span class="p">{</span>
|
1126
|
+
<span class="s2">"address1"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
1127
|
+
<span class="s2">"address2"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
1128
|
+
<span class="s2">"city"</span><span class="o">:</span> <span class="s2">"Guadalajara"</span><span class="p">,</span>
|
1129
|
+
<span class="s2">"country"</span><span class="o">:</span> <span class="s2">"MX"</span><span class="p">,</span>
|
1130
|
+
<span class="s2">"created_at"</span><span class="o">:</span> <span class="s2">"2000-11-09T19:09:23Z"</span><span class="p">,</span>
|
1131
|
+
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">1</span><span class="p">,</span>
|
1132
|
+
<span class="s2">"latitude"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
1133
|
+
<span class="s2">"longitude"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
1134
|
+
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Fbolko"</span><span class="p">,</span>
|
1135
|
+
<span class="s2">"state"</span><span class="o">:</span> <span class="s2">"MX"</span><span class="p">,</span>
|
1136
|
+
<span class="s2">"upcoming_events_count"</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
|
1137
|
+
<span class="s2">"updated_at"</span><span class="o">:</span> <span class="s2">"2010-03-28T17:24:20Z"</span><span class="p">,</span>
|
1138
|
+
<span class="s2">"postalcode"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
1139
|
+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"http://thrillcall.com/venue/Fbolko_in_Guadalajara_MX"</span>
|
1140
|
+
<span class="p">},</span>
|
1141
|
+
<span class="p">{</span>
|
1142
|
+
<span class="p">...</span>
|
1143
|
+
<span class="p">},</span>
|
1144
|
+
<span class="p">...</span>
|
1145
|
+
<span class="p">]</span>
|
1146
|
+
</pre>
|
1147
|
+
</div>
|
1148
|
+
|
1149
|
+
|
1150
|
+
<h3>GET /venue/:id</h3>
|
1151
|
+
|
1152
|
+
<p><strong>:id</strong> <em>integer</em> Thrillcall or Partner ID</p>
|
1153
|
+
|
1154
|
+
<p>Params:</p>
|
1155
|
+
|
1156
|
+
<ul>
|
1157
|
+
<li><strong><a href="#use_partner_id">use_partner_id</a></strong></li>
|
1158
|
+
</ul><p>Returns: Venue <em>Hash</em></p>
|
1159
|
+
|
1160
|
+
<div class="highlight">
|
1161
|
+
<pre> <span class="c1">// Example: GET /api/v2/venue/27418?api_key=1234567890abcdef</span>
|
1162
|
+
|
1163
|
+
<span class="p">{</span>
|
1164
|
+
<span class="s2">"address1"</span><span class="o">:</span> <span class="s2">"859 O'Farrell St."</span><span class="p">,</span>
|
1165
|
+
<span class="s2">"address2"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
1166
|
+
<span class="s2">"city"</span><span class="o">:</span> <span class="s2">"San Francisco"</span><span class="p">,</span>
|
1167
|
+
<span class="s2">"country"</span><span class="o">:</span> <span class="s2">"US"</span><span class="p">,</span>
|
1168
|
+
<span class="s2">"created_at"</span><span class="o">:</span> <span class="s2">"2008-04-21T16:52:31Z"</span><span class="p">,</span>
|
1169
|
+
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">27418</span><span class="p">,</span>
|
1170
|
+
<span class="s2">"latitude"</span><span class="o">:</span> <span class="mf">37.784796</span><span class="p">,</span>
|
1171
|
+
<span class="s2">"longitude"</span><span class="o">:</span> <span class="o">-</span><span class="mf">122.418819</span><span class="p">,</span>
|
1172
|
+
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Great American Music Hall"</span><span class="p">,</span>
|
1173
|
+
<span class="s2">"state"</span><span class="o">:</span> <span class="s2">"CA"</span><span class="p">,</span>
|
1174
|
+
<span class="s2">"upcoming_events_count"</span><span class="o">:</span> <span class="mi">34</span><span class="p">,</span>
|
1175
|
+
<span class="s2">"updated_at"</span><span class="o">:</span> <span class="s2">"2011-01-20T21:04:37Z"</span><span class="p">,</span>
|
1176
|
+
<span class="s2">"postalcode"</span><span class="o">:</span> <span class="s2">"94109"</span><span class="p">,</span>
|
1177
|
+
<span class="s2">"metro_area_id"</span><span class="o">:</span> <span class="mi">105</span><span class="p">,</span>
|
1178
|
+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"http://thrillcall.com/venue/Great_American_Music_Hall_in_San_Francisco_CA"</span>
|
1179
|
+
<span class="p">}</span>
|
1180
|
+
</pre>
|
1181
|
+
</div>
|
1182
|
+
|
1183
|
+
|
1184
|
+
<h3>GET /venue/:id/events</h3>
|
1185
|
+
|
1186
|
+
<p><strong>:id</strong> <em>integer</em> Thrillcall or Partner ID</p>
|
1187
|
+
|
1188
|
+
<p>Params:</p>
|
1189
|
+
|
1190
|
+
<ul>
|
1191
|
+
<li><strong><a href="#limit">limit</a></strong></li>
|
1192
|
+
<li><strong><a href="#page">page</a></strong></li>
|
1193
|
+
<li><strong><a href="#min_date">min_date</a></strong></li>
|
1194
|
+
<li><strong><a href="#max_date">max_date</a></strong></li>
|
1195
|
+
<li><strong><a href="#use_partner_id">use_partner_id</a></strong></li>
|
1196
|
+
<li><strong><a href="#ticket_type">ticket_type</a></strong></li>
|
1197
|
+
<li><strong><a href="#must_have_tickets">must_have_tickets</a></strong></li>
|
1198
|
+
<li><strong><a href="#show_unconfirmed_events">show_unconfirmed_events</a></strong></li>
|
1199
|
+
<li><strong><a href="#show_rumor_events">show_rumor_events</a></strong></li>
|
1200
|
+
</ul><p>Returns: <em>Array</em> of Events <em>Hash</em></p>
|
1201
|
+
|
1202
|
+
<div class="highlight">
|
1203
|
+
<pre> <span class="c1">// Example: GET /api/v2/venue/32065/events?api_key=1234567890abcdef</span>
|
1204
|
+
|
1205
|
+
<span class="p">[</span>
|
1206
|
+
<span class="p">{</span>
|
1207
|
+
<span class="s2">"created_at"</span><span class="o">:</span> <span class="s2">"2000-11-09T19:09:23Z"</span><span class="p">,</span>
|
1208
|
+
<span class="s2">"end_date"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
1209
|
+
<span class="s2">"festival"</span><span class="o">:</span> <span class="kc">false</span><span class="p">,</span>
|
1210
|
+
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">824614</span><span class="p">,</span>
|
1211
|
+
<span class="s2">"latitude"</span><span class="o">:</span> <span class="mf">37.8016</span><span class="p">,</span>
|
1212
|
+
<span class="s2">"longitude"</span><span class="o">:</span> <span class="o">-</span><span class="mf">80.4462</span><span class="p">,</span>
|
1213
|
+
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Colt Ford @ West Virginia State Fair"</span><span class="p">,</span>
|
1214
|
+
<span class="s2">"on_sale_date"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
1215
|
+
<span class="s2">"rumor"</span><span class="o">:</span> <span class="kc">false</span><span class="p">,</span>
|
1216
|
+
<span class="s2">"start_date"</span><span class="o">:</span> <span class="s2">"2011-08-21T03:59:00Z"</span><span class="p">,</span>
|
1217
|
+
<span class="s2">"unconfirmed_location"</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
|
1218
|
+
<span class="s2">"updated_at"</span><span class="o">:</span> <span class="s2">"2011-06-24T05:10:05Z"</span><span class="p">,</span>
|
1219
|
+
<span class="s2">"venue_id"</span><span class="o">:</span> <span class="mi">32065</span><span class="p">,</span>
|
1220
|
+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"http://thrillcall.com/event/824614"</span>
|
1221
|
+
<span class="p">},</span>
|
1222
|
+
<span class="p">{</span>
|
1223
|
+
<span class="p">...</span>
|
1224
|
+
<span class="p">},</span>
|
1225
|
+
<span class="p">...</span>
|
1226
|
+
<span class="p">]</span>
|
1227
|
+
</pre>
|
1228
|
+
</div>
|
1229
|
+
|
1230
|
+
|
1231
|
+
<h3>GET /search/venues/:term</h3>
|
1232
|
+
|
1233
|
+
<p><strong>:term</strong> <em>string</em> Arbitrary search string on the <strong>name</strong> field. (alphanumerics only, underscore matches underscore, use '+' for space)</p>
|
1234
|
+
|
1235
|
+
<p>Params:</p>
|
1236
|
+
|
1237
|
+
<ul>
|
1238
|
+
<li><strong><a href="#limit">limit</a></strong></li>
|
1239
|
+
<li><strong><a href="#page">page</a></strong></li>
|
1240
|
+
<li><strong><a href="#lat">lat</a></strong></li>
|
1241
|
+
<li><strong><a href="#long">long</a></strong></li>
|
1242
|
+
<li><strong><a href="#postalcode">postalcode</a></strong></li>
|
1243
|
+
<li><strong><a href="#radius">radius</a></strong></li>
|
1244
|
+
</ul><p>Returns: <em>Array</em> of Venues <em>Hash</em></p>
|
1245
|
+
|
1246
|
+
<div class="highlight">
|
1247
|
+
<pre> <span class="c1">// Example: GET /api/v2/search/venues/Great%20American%20Music%20Hall?api_key=1234567890abcdef</span>
|
1248
|
+
|
1249
|
+
<span class="p">[</span>
|
1250
|
+
<span class="p">{</span>
|
1251
|
+
<span class="s2">"address1"</span><span class="o">:</span> <span class="s2">"859 O'Farrell St."</span><span class="p">,</span>
|
1252
|
+
<span class="s2">"address2"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
1253
|
+
<span class="s2">"city"</span><span class="o">:</span> <span class="s2">"San Francisco"</span><span class="p">,</span>
|
1254
|
+
<span class="s2">"country"</span><span class="o">:</span> <span class="s2">"US"</span><span class="p">,</span>
|
1255
|
+
<span class="s2">"created_at"</span><span class="o">:</span> <span class="s2">"2008-04-21T16:52:31Z"</span><span class="p">,</span>
|
1256
|
+
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">27418</span><span class="p">,</span>
|
1257
|
+
<span class="s2">"latitude"</span><span class="o">:</span> <span class="mf">37.784796</span><span class="p">,</span>
|
1258
|
+
<span class="s2">"longitude"</span><span class="o">:</span> <span class="o">-</span><span class="mf">122.418819</span><span class="p">,</span>
|
1259
|
+
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Great American Music Hall"</span><span class="p">,</span>
|
1260
|
+
<span class="s2">"state"</span><span class="o">:</span> <span class="s2">"CA"</span><span class="p">,</span>
|
1261
|
+
<span class="s2">"upcoming_events_count"</span><span class="o">:</span> <span class="mi">34</span><span class="p">,</span>
|
1262
|
+
<span class="s2">"updated_at"</span><span class="o">:</span> <span class="s2">"2011-01-20T21:04:37Z"</span><span class="p">,</span>
|
1263
|
+
<span class="s2">"postalcode"</span><span class="o">:</span> <span class="s2">"94109"</span><span class="p">,</span>
|
1264
|
+
<span class="s2">"metro_area_id"</span><span class="o">:</span> <span class="mi">105</span><span class="p">,</span>
|
1265
|
+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"http://thrillcall.com/venue/Great_American_Music_Hall_in_San_Francisco_CA"</span>
|
1266
|
+
<span class="p">},</span>
|
1267
|
+
<span class="p">{</span>
|
1268
|
+
<span class="p">...</span>
|
1269
|
+
<span class="p">},</span>
|
1270
|
+
<span class="p">...</span>
|
1271
|
+
<span class="p">]</span>
|
1272
|
+
</pre>
|
1273
|
+
</div>
|
1274
|
+
|
1275
|
+
|
1276
|
+
<h2>Tickets</h2>
|
1277
|
+
|
1278
|
+
<p>Fields:</p>
|
1279
|
+
|
1280
|
+
<ul>
|
1281
|
+
<li>
|
1282
|
+
<strong>created_at</strong> <em>string</em> ISO 8601 representation the time this object was created</li>
|
1283
|
+
<li>
|
1284
|
+
<strong>description</strong> <em>string</em> Long form description of the ticket</li>
|
1285
|
+
<li>
|
1286
|
+
<strong>event_id</strong> <em>integer</em> Thrillcall Event ID</li>
|
1287
|
+
<li>
|
1288
|
+
<strong>id</strong> <em>integer</em> Thrillcall ID</li>
|
1289
|
+
<li>
|
1290
|
+
<strong>marketing_text</strong> <em>string</em> Long form description of the ticket</li>
|
1291
|
+
<li>
|
1292
|
+
<strong>max_ticket_price</strong> <em>float</em> Maximum price for this ticket</li>
|
1293
|
+
<li>
|
1294
|
+
<strong>min_ticket_price</strong> <em>float</em> Minimum price for this ticket</li>
|
1295
|
+
<li>
|
1296
|
+
<strong>name</strong> <em>string</em> Name of this ticket</li>
|
1297
|
+
<li>
|
1298
|
+
<strong>on_sale_end_date</strong> <em>string</em> YYYY-MM-DD date when the ticket goes off sale</li>
|
1299
|
+
<li>
|
1300
|
+
<strong>on_sale_start_date</strong> <em>string</em> YYYY-MM-DD date when the ticket goes on sale</li>
|
1301
|
+
<li>
|
1302
|
+
<strong>seat_info</strong> <em>string</em> Additional info about the seat</li>
|
1303
|
+
<li>
|
1304
|
+
<strong>updated_at</strong> <em>string</em> ISO 8601 representation of last time this object was updated</li>
|
1305
|
+
<li>
|
1306
|
+
<strong>url</strong> <em>string</em> URL for this object on Thrillcall</li>
|
1307
|
+
</ul><h3>GET /tickets</h3>
|
1308
|
+
|
1309
|
+
<p>Params:</p>
|
1310
|
+
|
1311
|
+
<ul>
|
1312
|
+
<li><strong><a href="#limit">limit</a></strong></li>
|
1313
|
+
<li><strong><a href="#page">page</a></strong></li>
|
1314
|
+
<li><strong><a href="#min_date">min_date</a></strong></li>
|
1315
|
+
<li><strong><a href="#max_date">max_date</a></strong></li>
|
1316
|
+
<li><strong><a href="#lat">lat</a></strong></li>
|
1317
|
+
<li><strong><a href="#long">long</a></strong></li>
|
1318
|
+
<li><strong><a href="#postalcode">postalcode</a></strong></li>
|
1319
|
+
<li><strong><a href="#radius">radius</a></strong></li>
|
1320
|
+
<li><strong><a href="#ticket_type">ticket_type</a></strong></li>
|
1321
|
+
<li><strong><a href="#show_unconfirmed_events">show_unconfirmed_events</a></strong></li>
|
1322
|
+
<li><strong><a href="#show_rumor_events">show_rumor_events</a></strong></li>
|
1323
|
+
</ul><p>Returns: <em>Array</em> of Tickets <em>Hash</em></p>
|
1324
|
+
|
1325
|
+
<div class="highlight">
|
1326
|
+
<pre> <span class="c1">// Example: GET /api/v2/tickets?limit=14&api_key=1234567890abcdef</span>
|
1327
|
+
|
1328
|
+
<span class="p">[</span>
|
1329
|
+
<span class="p">{</span>
|
1330
|
+
<span class="s2">"created_at"</span><span class="o">:</span> <span class="s2">"2008-12-06T00:19:59Z"</span><span class="p">,</span>
|
1331
|
+
<span class="s2">"description"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
1332
|
+
<span class="s2">"event_id"</span><span class="o">:</span> <span class="mi">455646</span><span class="p">,</span>
|
1333
|
+
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">1</span><span class="p">,</span>
|
1334
|
+
<span class="s2">"marketing_text"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
1335
|
+
<span class="s2">"max_ticket_price"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
1336
|
+
<span class="s2">"min_ticket_price"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
1337
|
+
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"General Onsale"</span><span class="p">,</span>
|
1338
|
+
<span class="s2">"on_sale_end_date"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
1339
|
+
<span class="s2">"on_sale_start_date"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
1340
|
+
<span class="s2">"seat_info"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
1341
|
+
<span class="s2">"updated_at"</span><span class="o">:</span> <span class="s2">"2009-09-22T22:58:37Z"</span><span class="p">,</span>
|
1342
|
+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"http://www.livenation.com/edp/eventId/335800/?c=api-000157"</span>
|
1343
|
+
<span class="p">},</span>
|
1344
|
+
<span class="p">{</span>
|
1345
|
+
<span class="p">...</span>
|
1346
|
+
<span class="p">},</span>
|
1347
|
+
<span class="p">...</span>
|
1348
|
+
<span class="p">]</span>
|
1349
|
+
</pre>
|
1350
|
+
</div>
|
1351
|
+
|
1352
|
+
|
1353
|
+
<h3>GET /ticket/:id</h3>
|
1354
|
+
|
1355
|
+
<p><strong>:id</strong> <em>integer</em> Thrillcall ID</p>
|
1356
|
+
|
1357
|
+
<p>Params:</p>
|
1358
|
+
|
1359
|
+
<ul>
|
1360
|
+
<li>None</li>
|
1361
|
+
</ul><p>Returns: Ticket <em>Hash</em></p>
|
1362
|
+
|
1363
|
+
<div class="highlight">
|
1364
|
+
<pre> <span class="c1">// Example: GET /api/v2/ticket/599794?api_key=1234567890abcdef</span>
|
1365
|
+
|
1366
|
+
<span class="p">{</span>
|
1367
|
+
<span class="s2">"created_at"</span><span class="o">:</span> <span class="s2">"2011-06-14T00:09:16Z"</span><span class="p">,</span>
|
1368
|
+
<span class="s2">"description"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
1369
|
+
<span class="s2">"event_id"</span><span class="o">:</span> <span class="mi">858707</span><span class="p">,</span>
|
1370
|
+
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">599794</span><span class="p">,</span>
|
1371
|
+
<span class="s2">"marketing_text"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
1372
|
+
<span class="s2">"max_ticket_price"</span><span class="o">:</span> <span class="mi">21</span><span class="p">,</span>
|
1373
|
+
<span class="s2">"min_ticket_price"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
1374
|
+
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Gen. Admission Seating Limited"</span><span class="p">,</span>
|
1375
|
+
<span class="s2">"on_sale_end_date"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
1376
|
+
<span class="s2">"on_sale_start_date"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
1377
|
+
<span class="s2">"seat_info"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
|
1378
|
+
<span class="s2">"updated_at"</span><span class="o">:</span> <span class="s2">"2011-06-14T00:09:16Z"</span><span class="p">,</span>
|
1379
|
+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"http://tickets.gamh.com/evinfo.php?eventid=154723&amp;r=affi&amp;u=210785"</span>
|
1380
|
+
<span class="p">}</span>
|
1381
|
+
</pre>
|
1382
|
+
</div>
|