blob: 46cef0abcfd47e7140ae727c23f30356fe9c7c30 (
plain)
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
|
<!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>Errors — 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="Changelog" href="../changelog/changelog.html" />
<link rel="prev" title="Community SDKs" href="../community_sdks/community_sdks.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="../community_sdks/community_sdks.html" title="Previous document">Community SDKs</a>
</li>
<li>
<a href="../changelog/changelog.html" title="Next document">Changelog</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="errors">
<span id="id1"></span><h1>Errors<a class="headerlink" href="#errors" title="Permalink to this headline">¶</a></h1>
<p>The server will stop processing if a problem is encountered and return the correct HTTP error status code. Errors may additionally include error objects, which are returned as an array keyed by errors in the top level of a JSON API document.</p>
<p>An error objects have the following members:</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">title:</span></code> (Required) the HTTP status code applicable to this problem, expressed as a string value.</li>
<li><code class="docutils literal"><span class="pre">description:</span></code> (Optional) a short summary of the problem</li>
</ul>
<p>The Server uses the following error codes:</p>
<table border="1" class="docutils">
<colgroup>
<col width="19%" />
<col width="81%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Error Code</th>
<th class="head">Meaning</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>400</td>
<td>Bad Request – Your request sucks</td>
</tr>
<tr class="row-odd"><td>401</td>
<td>Unauthorized – Your API key is wrong</td>
</tr>
<tr class="row-even"><td>403</td>
<td>Forbidden – The object requested is hidden for administrators only</td>
</tr>
<tr class="row-odd"><td>404</td>
<td>Not Found – The specified object could not be found</td>
</tr>
<tr class="row-even"><td>405</td>
<td>Method Not Allowed – You tried to access a object with an invalid method</td>
</tr>
<tr class="row-odd"><td>406</td>
<td>Not Acceptable – You requested a format that isn’t JSON</td>
</tr>
<tr class="row-even"><td>410</td>
<td>Gone – The object requested has been removed from our servers</td>
</tr>
<tr class="row-odd"><td>418</td>
<td>I’m a teapot</td>
</tr>
<tr class="row-even"><td>429</td>
<td>Too Many Requests – You’re requesting too much data! Slow down!</td>
</tr>
<tr class="row-odd"><td>500</td>
<td>Internal Server Error – We had a problem with our server. Try again later.</td>
</tr>
<tr class="row-even"><td>503</td>
<td>Service Unavailable – We’re temporarily offline for maintenance. Please try again later.</td>
</tr>
</tbody>
</table>
<div class="toctree-wrapper compound">
</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"><a class="reference internal" href="../receivingresponses/receivingresponses.html">Receiving Responses</a></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 current"><a class="current reference internal" href="#">Errors</a><ul class="simple">
</ul>
</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="../community_sdks/community_sdks.html" title="Previous document">Community SDKs</a>
</li>
<li>
<a href="../changelog/changelog.html" title="Next document">Changelog</a>
→
</li>
</ul>
</nav>
<nav id="breadcrumbs">
<ul>
<li><a href="../index.html">Battelrite 0.2 documentation</a></li>
</ul>
</nav>
</div>
</body>
</html>
|
