Errors & responses - Delogue Nexos API

The response envelope

Every response, success or error, uses the same envelope:

{
  "status": "success",
  "code": "ok",
  "data": { },
  "error": null,
  "pagination": { }
}

Field	Description
`status`	`"success"` or `"error"`.
`code`	A short, machine-readable result code.
`data`	The payload (object or array). `null` on error.
`error`	Error details. `null` on success.
`pagination`	Present on list responses. See Pagination.

Error format

On failure, error.details[] carries one row per problem:

{
  "status": "error",
  "code": "validation_error.required_field",
  "error": {
    "details": [
      { "type": "validation_error.required_field", "field": "name", "value": "Name is required." }
    ]
  }
}

type: a hierarchical error code (validation_error.too_long, resource_error.brand_not_found, …).
field: the offending input field, or omitted when no single field is at fault.
value: a human-readable message.

Status codes

Status	Meaning
200	Success.
201	Resource created.
400	Validation error (malformed or invalid input).
401	Unauthenticated: missing or invalid API key.
403	Authenticated but not authorised for the resource.
404	Resource not found.
409	Conflict: e.g. a duplicate resource.
422	Business rule violation.
500	Unexpected server error.