1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Receiving Responses — Battelrite 0.2 documentation</title>
<link rel="stylesheet" href="../_static/css/battlerite.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Matches" href="../matches/matches.html" />
<link rel="prev" title="Making Requests" href="../makingrequests/makingrequests.html" />
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
</head>
<body>
<header id="BTT" role="banner">
<div class="menu-top-outer clearfix">
<div class="wrapper clearfix">
<a href="/" id="site-logo"></a>
<span id="logSignBtn" class="btn">Login / Signup</span>
<nav id="mainMenu" class="main-menu-con">
<ul class="main-menu clearfix">
<li><a class="active" href="guides.html">Documentation</a></li>
<li><a href="faq.html">Faqs</a></li>
<li><a href="creations.html">Creations</a></li>
</ul>
</nav>
</div>
</div>
</header>
<div class="related top">
<nav id="rellinks">
<ul>
<li>
←
<a href="../makingrequests/makingrequests.html" title="Previous document">Making Requests</a>
</li>
<li>
<a href="../matches/matches.html" title="Next document">Matches</a>
→
</li>
</ul>
</nav>
<nav id="breadcrumbs">
<ul>
<li><a href="../index.html">Battelrite 0.2 documentation</a></li>
</ul>
</nav>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="receiving-responses">
<span id="receivingresponses"></span><h1>Receiving Responses<a class="headerlink" href="#receiving-responses" title="Permalink to this headline">¶</a></h1>
<div class="section" id="payload">
<h2>Payload<a class="headerlink" href="#payload" title="Permalink to this headline">¶</a></h2>
<p>All Server responses contain a root JSON object.</p>
<p>A response will contain at least one of the following top-level members:</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">data</span></code> : the response’s “primary data”</li>
<li><code class="docutils literal"><span class="pre">errors</span></code> : an array of error objects</li>
</ul>
<p>A response may contain any of these top-level members:</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">links</span></code>: a links object related to the primary data.</li>
<li><code class="docutils literal"><span class="pre">included</span></code>: an array of resource objects that are related to the primary data and/or each other (“included resources”).</li>
</ul>
<p>If a document does not contain a top-level data key, the included member will not be present either.</p>
<p>Primary data will be either:</p>
<ul class="simple">
<li>a single [resource object][resource objects], a single [resource identifier object], or <code class="docutils literal"><span class="pre">null</span></code></li>
<li>an array of [resource objects], an array of [resource identifier objects][resource identifier object], or an empty array <code class="docutils literal"><span class="pre">([])</span></code></li>
</ul>
<p>For example, the following primary data is a single resource object. It’s primary data is a single [resource identifier object] that references the same resource. A logical collection of resources will always be represented as an array, even if it only contains one item or is empty.</p>
<p><strong>Javascript:</strong></p>
<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"data"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"type"</span><span class="o">:</span> <span class="s2">"match"</span><span class="p">,</span>
<span class="s2">"id"</span><span class="o">:</span> <span class="s2">"skarn"</span><span class="p">,</span>
<span class="s2">"attributes"</span><span class="o">:</span> <span class="p">{</span>
<span class="c1">// ... this matches attributes</span>
<span class="p">},</span>
<span class="s2">"relationships"</span><span class="o">:</span> <span class="p">{</span>
<span class="c1">// ... this matches relationships</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">{</span>
<span class="s2">"data"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"type"</span><span class="o">:</span> <span class="s2">"match"</span><span class="p">,</span>
<span class="s2">"id"</span><span class="o">:</span> <span class="s2">"1"</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="rate-limits">
<h2>Rate Limits<a class="headerlink" href="#rate-limits" title="Permalink to this headline">¶</a></h2>
<p>Be nice. If you’re sending too many requests too quickly, we’ll send back a
<code class="docutils literal"><span class="pre">429</span></code> error code (server unavailable).</p>
<p><strong>Please note: Free for non-commercial use for up to 10 requests per minute! To increase your rate limit, log into your admin dashboard, find the app you would like a higher rate limit for, and click “request a higher rate limit”</strong></p>
<p><strong>Shell:</strong></p>
<div class="highlight-shell"><div class="highlight"><pre><span></span>The rate limit headers are defined as follows:
X-RateLimit-Limit - Request limit per day / per minute
X-RateLimit-Remaining - The number of requests left <span class="k">for</span> the <span class="nb">time</span> window
X-RateLimit-Reset - The remaining window before the rate limit is refilled in UTC epoch nanoseconds.
* Limit tokens are incrementally filled by <span class="m">60</span><span class="o">(</span>sec<span class="o">)</span>/ rate limit. ex: <span class="m">60</span><span class="o">(</span>sec<span class="o">)</span>/10<span class="o">(</span>rate<span class="o">)</span> gets rate token every <span class="m">6</span> seconds up to max rate limit.
</pre></div>
</div>
<div class="toctree-wrapper compound">
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../datacenters/datacenters.html">Datacenters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../authorization/authorization.html">Authorization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../titles/titles.html">Titles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../makingrequests/makingrequests.html">Making Requests</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Receiving Responses</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#payload">Payload</a></li>
<li class="toctree-l2"><a class="reference internal" href="#rate-limits">Rate Limits</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../matches/matches.html">Matches</a></li>
<li class="toctree-l1"><a class="reference internal" href="../match_data_summary/match_data_summary.html">Match Data Summary</a></li>
<li class="toctree-l1"><a class="reference internal" href="../players/players.html">Players</a></li>
<li class="toctree-l1"><a class="reference internal" href="../samples/samples.html">Samples</a></li>
<li class="toctree-l1"><a class="reference internal" href="../telemetry/telemetry.html">Telemetry</a></li>
<li class="toctree-l1"><a class="reference internal" href="../teams/teams.html">Teams</a></li>
<li class="toctree-l1"><a class="reference internal" href="../links/links.html">Links</a></li>
<li class="toctree-l1"><a class="reference internal" href="../community_sdks/community_sdks.html">Community SDKs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../errors/errors.html">Errors</a></li>
<li class="toctree-l1"><a class="reference internal" href="../changelog/changelog.html">Changelog</a></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related bottom">
<nav id="rellinks">
<ul>
<li>
←
<a href="../makingrequests/makingrequests.html" title="Previous document">Making Requests</a>
</li>
<li>
<a href="../matches/matches.html" title="Next document">Matches</a>
→
</li>
</ul>
</nav>
<nav id="breadcrumbs">
<ul>
<li><a href="../index.html">Battelrite 0.2 documentation</a></li>
</ul>
</nav>
</div>
</body>
</html>
|
