-
Notifications
You must be signed in to change notification settings - Fork 0
/
error_responses.html
42 lines (33 loc) · 3.24 KB
/
error_responses.html
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
<!DOCTYPE html><html><head><meta charset="utf-8"><title>Loopline Systems API</title><link rel="stylesheet" href="css/bootstrap-3.1.1.min.css"><link rel="stylesheet" href="css/font-awesome-4.0.3.min.css"><link rel="stylesheet" href="css/styles.css"><link rel="shortcut icon" href="http://cdn.loopline-systems.com/favicon.ico"><link rel="apple-touch-icon-precomposed" sizes="144x144" href="http://cdn.loopline-systems.com/lls-logo-144.png"></head><body><a href="#top" class="text-muted back-to-top"><i class="fa fa-toggle-up"></i> Back to top</a><div class="container"><div class="row"><div class="col-md-3"><nav class="static"><a href="index.html"><img src="img/lls-logo.png" class="logo"></a><div id="static-pages" class="list-group"><a href="index.html" class="list-group-item heading">Loopline Systems API</a><a href="chrome_postman.html" class="list-group-item">Sandboxing with Postman</a><a href="error_responses.html" class="list-group-item">Error Responses</a><a href="integrations.html" class="list-group-item">Integrations</a><a href="index.html" class="list-group-item">REST API</a></div></nav><nav id="nav" class="hidden-sm hidden-xs affix nav dynamic"></nav></div><div id="content" class="col-md-8"><div><header><div class="page-header"><h1 id="top">Loopline Systems API Documentation</h1></div></header></div><h3>Format</h3>
<p>All error responses will have this format: </p>
<pre><code>### Example (External Library Error)
{
"error": {
"code": 500
"identifier": "ERR_GLOBAL_EXTERNAL_EXCEPTION",
"message": "Something went wrong"
}
}
### Example (Bad Request)
{
"error": {
"code": 400
"identifier": "ERR_USER_IS_DEACTIVATED",
"message": "Error: User is deactivated"
}
}
### Example (Conflict)
{
"error": {
"code" 409
"identifier": "ERR_USER_EMAIL_DUPLICATE",
"message": "This email address is already in use"
}
}</code></pre>
<h3>Explanation</h3>
<p>The <code>code</code> is simply the HTTP status code returned. It is duplicated in the header, but was included here for easy access.</p>
<p>The <code>identifier</code> is a unique value for our custom exceptions. In case an exception is thrown from an external library the identifier will be 'ERR_GLOBAL_EXTERNAL_EXCEPTION'.</p>
<p>The <code>message</code> should give a more detail description of what went wrong.</p><hr /></div></div></div><p id="footer" style="text-align: center;" class="text-muted">Generated with <a href="https://apiblueprint.org/" target="_blank" class="aglio">API Blueprint</a> and <a href="https://github.com/danielgtaylor/aglio" target="_blank" class="aglio">Aglio</a> and <a href="http://www.loopline-systems.com" target="_blank" class="aglio">© 2020 made with <span no-class="❤" class="heart">❤︎</span> in berlin</a></p></body><script src="js/jquery-1.11.0.min.js"></script><script src="js/bootstrap-3.1.1.min.js"></script><script src="js/api-doc.js"></script><script>(function() {
$('table').addClass('table');
}).call(this);
</script></html>