Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration ErrorCode

Error Codes

Index

Enumeration Members

Enumeration Members

BadRequest400

BadRequest400: 400

The payload has invalid data or is malformed.

From ./dist/samples/json/requests/errors/badRequest400.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.7",
    "method": "ERROR",
    "payload": {},
    "error": {
        "code": 400,
        "message": "Invalid data or payload is malformed."
    }
}

NotAccepted405

NotAccepted405: 405

The transfer method is not accepted.

readonly

Example Payload

From ./dist/samples/json/requests/errors/notAccepted405.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.7",
    "method": "ERROR",
    "payload": {},
    "error": {
        "code": 405,
        "message": "This payload cannot be sent for this request type"
    }
}

ServerError500

ServerError500: 500

Something went wrong on the operating device.

readonly

Example Payload

From ./dist/samples/json/requests/errors/serverError500.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.7",
    "method": "ERROR",
    "payload": {},
    "error": {
        "code": 500,
        "message": "Something went wrong on the other end..."
    }
}

ServiceUnavailable503

ServiceUnavailable503: 503

The client/server is temporarily not available in the hub or is disconnected.

readonly

Example Payload

From ./dist/samples/json/requests/errors/serviceUnavailable503.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.7",
    "method": "ERROR",
    "payload": {},
    "error": {
        "code": 503,
        "message": "Service is currently unavailable for communication."
    }
}

SystemUpdateError519

SystemUpdateError519: 519

The system updates encountered an error.

readonly

Example Payload

From ./dist/samples/json/requests/errors/systemUpdateError519.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.7",
    "method": "ERROR",
    "payload": {},
    "error": {
        "code": 519,
        "message": "Error with system updating."
    }
}

Unauthenticated401

Unauthenticated401: 401

The client has not logged in.

readonly

Example Payload

From ./dist/samples/json/requests/errors/unauthenticated401.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.7",
    "method": "ERROR",
    "payload": {},
    "error": {
        "code": 401,
        "message": "Missing authentication token."
    }
}

Unauthorized403

Unauthorized403: 403

The client has provided a token but is unauthorized to perform the request.

readonly

Example Payload

From ./dist/samples/json/requests/errors/unauthorized403.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.7",
    "method": "ERROR",
    "payload": {},
    "error": {
        "code": 403,
        "message": "Unauthorized to perform this action."
    }
}