Alterar registros

PUT 
/evento

Atualiza registros existentes por data[].id, no body application/json. Campos omitidos mantêm os valores atuais. O servidor define dataAtualizacao. IDs inexistentes são ignorados; se nenhum registro for atualizado, retorna 400 com success false e total 0. Filtros na URL não são lidos pelo PUT. O contrato expõe os campos usuais de retorno da integração; o binding legado também admite propriedades da entidade.

Request

application/json

Body

Body

required

Corpo JSON; os campos não são parâmetros de URL.

data

object[]

required

Lista de registros. Envie ao menos um registro para executar a operação.

Array [

]

minimo

Payload mínimo ilustrativo

{
  "data": [
    {
      "id": 1001
    }
  ]
}

completo

Payload completo ilustrativo

{
  "data": [
    {
      "id": 1001,
      "situacao": "2",
      "observacao": "OK"
    }
  ]
}

Responses

200

Sucesso

application/json

Schema

Schema

success booleanrequired
message stringnullable
data object[]nullable

Example (from schema)

{
  "success": true,
  "message": "string",
  "total": 0,
  "data": [
    {}
  ]
}

sucesso

Sucesso ilustrativo

{
  "success": true,
  "message": null,
  "total": 1,
  "data": null
}

400

O serviço retornou success false. PUT sem IDs existentes, dependentes sem sucesso, ou falha tratada na consulta de ocorrências. Não representa todas as falhas de validação.

application/json

Schema

Schema

success booleanrequired
message stringnullable
data object[]nullable

Example (from schema)

{
  "success": true,
  "message": "string",
  "total": 0,
  "data": [
    {}
  ]
}

semProcessamento

Resultado negativo do serviço, ilustrativo

{
  "success": false,
  "message": null,
  "total": 0,
  "data": null
}

401

Nao autorizado

application/json

Schema

Schema

property name* any

Example (from schema)

{}

ilustrativo

Exemplo legado, dependente do serviço de autenticação

{
  "success": false,
  "message": "Authorization expirado ou inexistente."
}

500

Exceção no binding, validação ou processamento. Pode ocorrer ao faltar campo obrigatório. Mensagem/cause dependem da exceção.

application/json

Schema

Schema

message stringnullablerequired

Example (from schema)

{
  "success": false,
  "message": "string"
}

excecao

Exceção ilustrativa; mensagem depende do erro

{
  "success": false,
  "message": "Falha ao processar a requisição."
}

Loading...