Response Envelope

Standardized success and error response format for the Open VTS API.

All API responses are automatically wrapped by the server in a consistent envelope. This makes it straightforward to handle responses uniformly in your client code.

Success Response

Successful requests return a top-level status: "success" with the payload nested inside data.

200 OK

{
  "status": "success",
  "data": {
    "action": true,
    "message": "Vehicle created successfully",
    "data": {}
  },
  "timestamp": "2026-03-08T10:30:00.000Z"
}

statusstringAlways "success" for 2xx responses.

data.actionbooleanWhether the request performed its intended action.

data.messagestringHuman-readable summary of the result.

data.dataobject | arrayThe response payload (resource, list, etc.).

timestampstringISO 8601 server timestamp.

Error Response

Failed requests return a top-level status: "error" with structured error information.

400 Bad Request

{
  "status": "error",
  "data": {
    "statusCode": 400,
    "message": "Validation failed",
    "error": "Bad Request"
  },
  "timestamp": "2026-03-08T10:30:00.000Z"
}

statusstringAlways "error" for non-2xx responses.

data.statusCodenumberHTTP status code (mirrors the response status).

data.messagestringDescription of what went wrong.

data.errorstringHTTP status text (e.g. Bad Request, Unauthorized).

timestampstringISO 8601 server timestamp.

Client Handling

Always check response.status first, then read data.data for success or data.message for errors. The envelope shape is guaranteed on all endpoints.

Authentication

Error Handling