Error Returns
The following are all error responses that can be returned via the API.
400: Bad Request

No Query

No payload provided in the body of the request.
1
{
2
"meta": {
3
"timestamp": "2019-10-21T13:02:48"
4
},
5
"error": {
6
"message": "No Query",
7
"code": "IN0"
8
}
9
}
Copied!

Query Not Parsable

Input JSON not valid.
1
{
2
"meta": {
3
"timestamp": "2019-10-21T13:04:26"
4
},
5
"error": {
6
"message": "Query Not Parsable",
7
"code": "IN1",
8
"detail": "{the payload body}"
9
}
10
}
Copied!

Bad Login

Invalid username or password.
1
{
2
"meta": {
3
"timestamp": "2019-10-21T13:06:12"
4
},
5
"error": {
6
"message": "Bad Login",
7
"code": "AUTH0"
8
}
9
}
Copied!

No Target

No target object provided in the body of the request.
1
{
2
"meta": {
3
"timestamp": "2019-10-21T13:17:30"
4
},
5
"error": {
6
"message": "No Target",
7
"code": "QRY0",
8
"detail": "This service requires a target to be specified."
9
}
10
}
Copied!

Missing Required Input

One or more of the required input attributes are missing or empty.
1
{
2
"meta": {
3
"timestamp": "2019-10-21T13:19:46"
4
},
5
"error": {
6
"message": "Missing Required Input",
7
"code": "QRY1",
8
"detail": "Service requires Address to be specified."
9
}
10
}
Copied!

Input Failed Validation

One or more of the input fields are not being sent as described.
1
{
2
"meta": {
3
"timestamp": "2019-10-21T13:21:08"
4
},
5
"error": {
6
"message": "Input Failed Validation",
7
"code": "QRY2",
8
"detail": "Age input must conform to (^[<>]=?[0-9]{1,3}$|^[0-9]{1,3}[+-]$|^[0-9]{1,3}-[0-9]{1,3}$)."
9
}
10
}
Copied!

Token Bad or Expired

The token you are sending for quiz scoring is either invalid or has expired.
1
{
2
"meta": {
3
"timestamp": "2019-10-23T11:36:49"
4
},
5
"error": {
6
"message": "Token Bad or Expired",
7
"code": "QRY6",
8
"detail": "1bauxkpczhdiyy3vqm15ais8ue12u7zw"
9
}
10
}
Copied!
403: Forbidden

User Not Active

The API user is not an active account.
1
{
2
"meta": {
3
"timestamp": "2019-10-21T13:15:24"
4
},
5
"error": {
6
"message": "User Not Active",
7
"code": "AUTH3",
8
"detail": "This user account (username) is not currently active."
9
}
10
}
Copied!
404: Not Found

No Such Service

Invalid or empty service name provided.
1
{
2
"meta": {
3
"timestamp": "2019-10-21T13:07:17"
4
},
5
"error": {
6
"message": "No Such Service",
7
"code": "AUTH1",
8
"detail": "Request service not found."
9
}
10
}
Copied!
Last modified 1yr ago
Copy link