Error Responses

Valid keys will become invalid if it's associated Project or Account is deleted, and error will be thrown when those keys are used again.

Get User API

Code: 400

Description: Occurs when an unknown error is caught. Given to ensure graceful fails.

JSON
{
"status": false,
"msg": "Unknown Error.",
"code": 400,
"error": {
"ErrorCode": "GS400",
"ErrorMessage": "An error occured"
}
}

Code: 401

Description: Occurs when an invalid API key of any form is passed. Note : API key of any inactive/deleted project or account is considered as Invalid.

JSON
{
"status": true,
"msg": "Invalid Api key.",
"code": 401,
"error": {
"ErrorCode": "GS401",
"ErrorMessage": "Invalid Api key",
"details": "Invalid Api key."
}
}

Code: 401

Description: Occurs when API key is not provided in the request.

JSON
{
"status": true,
"msg": "No Api key in Header provided",
"code": 401,
"error": {
"ErrorCode": "GS401",
"ErrorMessage": "Invalid Api key",
"details": "No Api key in Header provided"
}
}

Get Location API

Code: 400

Description: Occurs when an unknown error is caught. Given to ensure graceful fails.

JSON
{
"status": false,
"msg": "Unknown Error.",
"code": 400,
"error": {
"ErrorCode": "GS400",
"ErrorMessage": "An error occured"
}
}

Code: 400

Description: Occurs when the user_id provided is invalid.

JSON
{
"status": false,
"msg": "Error Occured.",
"code": 400,
"error": {
"ErrorCode": "GS402",
"ErrorMessage": "Invalid request",
"details": {
"user_id": {
"user_id": "This field is invalid"
}
}
}
}

Code: 400

Description: Occurs when user_id is not passed in the request header.

JSON
{
"status": false,
"msg": "Error Occured.",
"code": 400,
"error": {
"ErrorCode": "GS402",
"ErrorMessage": "Invalid request",
"details": {
"user_id": [
"This field is required."
]
}
}
}

Code: 401

Description: Occurs when API key is not provided in the request header.

JSON
{
"status": true,
"msg": "No Api key in Header provided",
"code": 401,
"error": {
"ErrorCode": "GS401",
"ErrorMessage": "Invalid Api key",
"details": "No Api key in Header provided"
}
}

Code: 401

Description: Occurs when an invalid API key of any form is passed.

JSON
{
"status": true,
"msg": "Invalid Api key.",
"code": 401,
"error": {
"ErrorCode": "GS401",
"ErrorMessage": "Invalid Api key",
"details": "Invalid Api key."
}
}

Create Geofence API

Code: 400

Description: Occurs when an unknown error is caught. Given to ensure graceful fails.

JSON
{
"status": false,
"msg": "Unknown Error.",
"code": 400,
"error": {
"ErrorCode": "GS400",
"ErrorMessage": "An error occured"
}
}

Code: 400

Description: Occurs when unsupported/invalid Geometry type is passed, or when given coordinates are invalid. NOTE: Invalid coordinates include wrong formatting and wrong data type. It is advised not to pass Latitude/Longitude data when they are out of their respective ranges. Unknown error occurs in that case.

JSON
// when there is required geometry type mismatch
{
"status": false,
"msg": "Error Occured.",
"code": 400,
"error": {
"ErrorCode": "GS402",
"ErrorMessage": "Invalid request",
"details": {
"geometry_type": [
"\"circles\" is not a valid choice."
]
}
}
}
// invalid coordiantes
{
"status": false,
"msg": "Error Occured.",
"code": 400,
"error": {
"ErrorCode": "GS402",
"ErrorMessage": "Invalid request",
"details": {
"coordinates": [
"Invalid coordinates for given geometry type"
]
}
}
}

Code: 400

Description: Occurs when mandatory fields, geometry_type and coordinate parameters are not passed.

JSON
{
"status": false,
"msg": "Error Occured.",
"code": 400,
"error": {
"ErrorCode": "GS402",
"ErrorMessage": "Invalid request",
"details": {
"geometry_type": [
"This field is required."
],
"coordinates": [
"This field is required."
]
}
}
}

Code: 401

Description: Occurs when API key is not provided in the request header.

JSON
{
"status": true,
"msg": "No Api key in Header provided",
"code": 401,
"error": {
"ErrorCode": "GS401",
"ErrorMessage": "Invalid Api key",
"details": "No Api key in Header provided"
}
}

Code: 401

Description: Occurs when an invalid API key of any form is passed.

JSON
{
"status": true,
"msg": "Invalid Api key.",
"code": 401,
"error": {
"ErrorCode": "GS401",
"ErrorMessage": "Invalid Api key",
"details": "Invalid Api key."
}
}

Update Geofence API

Code: 400

Description: Occurs when an unknown error is caught. Given to ensure graceful fails.

JSON
{
"status": false,
"msg": "Unknown Error.",
"code": 400,
"error": {
"ErrorCode": "GS400",
"ErrorMessage": "An error occured"
}
}

Code: 400

Description: Occurs when geofence_id is not passed in the request header.

JSON
{
"status": false,
"msg": "Error Occured.",
"code": 400,
"error": {
"ErrorCode": "GS402",
"ErrorMessage": "Invalid request",
"details": {
"geofence_id": [
"This field is required."
]
}
}
}

Code: 401

Description: Occurs when API key is not provided in the request header.

JSON
{
"status": true,
"msg": "No Api key in Header provided",
"code": 401,
"error": {
"ErrorCode": "GS401",
"ErrorMessage": "Invalid Api key",
"details": "No Api key in Header provided"
}
}

Code: 401

Description: Occurs when an invalid API key of any form is passed.

JSON
{
"status": true,
"msg": "Invalid Api key.",
"code": 401,
"error": {
"ErrorCode": "GS401",
"ErrorMessage": "Invalid Api key",
"details": "Invalid Api key."
}
}

Get Geofence API

Code: 400

Description: Occurs when an unknown error is caught. Given to ensure graceful fails.Possibly bad formatting in the request.

JSON
{
"status": false,
"msg": "Unknown Error.",
"code": 400,
"error": {
"ErrorCode": "GS400",
"ErrorMessage": "An error occured"
}
}

Code: 401

Description: Occurs when API key is not provided in the request header.

JSON
{
"status": true,
"msg": "No Api key in Header provided",
"code": 401,
"error": {
"ErrorCode": "GS401",
"ErrorMessage": "Invalid Api key",
"details": "No Api key in Header provided"
}
}

Code: 401

Description: Occurs when an invalid API key of any form is passed.

JSON
{
"status": true,
"msg": "Invalid Api key.",
"code": 401,
"error": {
"ErrorCode": "GS401",
"ErrorMessage": "Invalid Api key",
"details": "Invalid Api key."
}
}

Delete Geofence API

Code: 400

Description: Occurs when an unknown error is caught. Given to ensure graceful fails.Possibly bad formatting in the request.

JSON
{
"status": false,
"msg": "Unknown Error.",
"code": 400,
"error": {
"ErrorCode": "GS400",
"ErrorMessage": "An error occured"
}
}

Code: 400

Description: Occurs when the given geofence doesn't exist.

JSON
{
"status": false,
"msg": "Error Occured.",
"code": 400,
"error": {
"ErrorCode": "GS400",
"ErrorMessage": "An error occured",
"details": "Geofence does not exist."
}
}

Code: 400

Description: Occurs when geofence_id is not provided.

JSON
{
"status": false,
"msg": "Error Occured.",
"code": 400,
"error": {
"ErrorCode": "GS402",
"ErrorMessage": "Invalid request",
"details": {
"geofence_id": [
"This field is required."
]
}
}
}

Code: 401

Description: Occurs when API key is not provided in the request header.

JSON
{
"status": true,
"msg": "No Api key in Header provided",
"code": 401,
"error": {
"ErrorCode": "GS401",
"ErrorMessage": "Invalid Api key",
"details": "No Api key in Header provided"
}
}

Code: 401

Description: Occurs when an invalid API key of any form is passed.

JSON
{
"status": true,
"msg": "Invalid Api key.",
"code": 401,
"error": {
"ErrorCode": "GS401",
"ErrorMessage": "Invalid Api key",
"details": "Invalid Api key."
}
}

Get Events API

Code: 400

Description: Occurs when either given geofence_id or location_id is invalid or doesn't exist or the given geofence_id is not event_enabled.

JSON
{
"status": false,
"msg": "Error Occured.",
"code": 400,
"error": {
"ErrorCode": "GS402",
"ErrorMessage": "Invalid request",
"details": {
"geofence_id": {
"geofence_id": "This field is invalid"
},
"location_id": {
"location_id": "This field is invalid"
}
}
}
}

Code: 400

Description: Occurs when an unknown error is caught. Given to ensure graceful fails.Possibly bad formatting in the header.

JSON
{
"status": false,
"msg": "Unknown Error.",
"code": 400,
"error": {
"ErrorCode": "GS400",
"ErrorMessage": "An error occured"
}
}

Code: 401

Description: Occurs when API key is not provided in the request header.

JSON
{
"status": true,
"msg": "No Api key in Header provided",
"code": 401,
"error": {
"ErrorCode": "GS401",
"ErrorMessage": "Invalid Api key",
"details": "No Api key in Header provided"
}
}

Code: 401

Description: Occurs when an invalid API key of any form is passed.

JSON
{
"status": true,
"msg": "Invalid Api key.",
"code": 401,
"error": {
"ErrorCode": "GS401",
"ErrorMessage": "Invalid Api key",
"details": "Invalid Api key."
}
}

Get Trips List API

Code: 400

Description: Occurs when mandatory field app_id is not provided.

JSON
{
"status": false,
"msg": "Error Occured.",
"code": 400,
"error": {
"ErrorCode": "GS402",
"ErrorMessage": "Invalid request",
"details": {
"app_id": [
"This field is required."
]
}
}
}

Code: 400

Description: Occurs when mandatory field user_id is not provided.

JSON
{
"status": false,
"msg": "Error Occured.",
"code": 400,
"error": {
"ErrorCode": "GS402",
"ErrorMessage": "Invalid request",
"details": {
"user_id": [
"This field is required."
]
}
}
}

Code: 400

Description: Occurs when an unknown error is caught. Given to ensure graceful fails. Possibly bad formatting in the request.

JSON
{
"status": false,
"msg": "Unknown Error.",
"code": 400,
"error": {
"ErrorCode": "GS400",
"ErrorMessage": "An error occured"
}
}

Code: 401

Description: Occurs when API key is not provided in the request header.

JSON
{
"status": true,
"msg": "No Api key in Header provided",
"code": 401,
"error": {
"ErrorCode": "GS401",
"ErrorMessage": "Invalid Api key",
"details": "No Api key in Header provided"
}
}

Code: 401

Description: Occurs when an invalid API key of any form is passed.

JSON
{
"status": true,
"msg": "Invalid Api key.",
"code": 401,
"error": {
"ErrorCode": "GS401",
"ErrorMessage": "Invalid Api key",
"details": "Invalid Api key."
}
}

Get Trips Route API

Code: 400

Description: Occurs when mandatory field app_id is not provided.

JSON
{
"status": false,
"msg": "Error Occured.",
"code": 400,
"error": {
"ErrorCode": "GS402",
"ErrorMessage": "Invalid request",
"details": {
"app_id": [
"This field is required."
]
}
}
}

Code: 400

Description: Occurs when mandatory field trip_id is not provided.

JSON
{
"status": false,
"msg": "Error Occured.",
"code": 400,
"error": {
"ErrorCode": "GS402",
"ErrorMessage": "Invalid request",
"details": {
"trip_id": [
"This field is required."
]
}
}
}

Code: 400

Description: Occurs when an unknown error is caught. Given to ensure graceful fails. Possibly bad formatting in the request.

JSON
{
"status": false,
"msg": "Unknown Error.",
"code": 400,
"error": {
"ErrorCode": "GS400",
"ErrorMessage": "An error occured"
}
}

Code: 401

Description: Occurs when API key is not provided in the request header.

JSON
{
"status": true,
"msg": "No Api key in Header provided",
"code": 401,
"error": {
"ErrorCode": "GS401",
"ErrorMessage": "Invalid Api key",
"details": "No Api key in Header provided"
}
}

Code: 401

Description: Occurs when an invalid API key of any form is passed.

JSON
{
"status": true,
"msg": "Invalid Api key.",
"code": 401,
"error": {
"ErrorCode": "GS401",
"ErrorMessage": "Invalid Api key",
"details": "Invalid Api key."
}
}