Error · AtendroZAP Docs

Error

Estrutura de dados do contrato OpenAPI.

Campos

Campo	Tipo	Presença	Descrição
`error`	`string`	obrigatório	—
`message`	`string`	opcional	—
`messageid`	`string`	opcional	ID para reconciliação quando o resultado é ambíguo.
`messageId`	`string`	opcional	—
`id`	`string`	opcional	—
`provider_code`	`integer`	opcional	—
`error_key`	`string`	opcional	—
`error_source`	`string`	opcional	—
`details`	`object`	opcional	—
`instance`	`object`	opcional	Modelo: Instance.

Definição OpenAPI

json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "messageid": {
      "type": "string",
      "description": "ID para reconciliação quando o resultado é ambíguo."
    },
    "messageId": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "provider_code": {
      "type": "integer"
    },
    "error_key": {
      "type": "string"
    },
    "error_source": {
      "type": "string"
    },
    "details": {
      "type": "object"
    },
    "instance": {
      "$ref": "#/components/schemas/Instance"
    }
  },
  "required": [
    "error"
  ]
}