Skip to main content

Payloads

Estrutura de requisição​

Cada requisição deve ser um objeto JSON contendo os dados primários da entidade.

{
  "key": "value"
}

Estrutura de resposta​

Cada endpoint retornará um objeto JSON contendo os atributos abaixo.

Resposta bem-sucedida​

Se a resposta for bem-sucedida, o objeto JSON irá conter obrigatoriamente um objeto com os dados da entidade;

Se a resposta for bem-sucedida, o objeto JSON deverá conter:

  • Obrigatoriamente um objeto com os dados da entidade.
  • Obrigatoriamente um item code com o código da ação executada.
  • Obrigatoriamente um item message com o descritivo da ação executada.
{
  "...",
  "code": "...",
  "message": "..."
}

Resposta malsucedida​

Se a resposta for malsucedida, o objeto JSON deverá conter:

  • Obrigatoriamente um item statusCode com o status HTTP da requisição.
  • Obrigatoriamente um item message com o descritivo do erro.
  • Obrigatoriamente um item error com o tipo do erro.
{
  "statusCode": "...",
  "message": "...",
  "error": "..."
}