Erros

Além dos erros específicos relativos ao contexto de negócio, os endpoints podem apresentar erros considerados comuns entre as requisições nas APIs.

Tratam-se de erros cujos status codes, códigos e descrições possuem uma forma fixa que sinalizam comportamentos irregulares já mapeados nos sistemas.

Erros comuns

🚧

Importante

Os códigos e mensagens dos erros 422 variam de acordo com a regra de negócio que ferem. Portanto, são detalhados nas páginas deste manual que documentam os endpoints.

Erro 400

Embora faça parte da lista de erros comuns, o erro 400 - INVALID_PARAMETER pode conter mensagens variáveis com o objetivo de auxiliar o usuário a identificar um campo faltante ou que apresente valor incorreto.

Na tabela a seguir, veja as possíveis mensagens que sua API poderá receber dentro de um erro 400:

Note que os termos entre chaves { } representam as palavras que poderão variar nas mensagens, correspondendo ao parâmetro ou valor informado de maneira equivocada.

Exemplo:

{
   "errors": [
      {
         "code": "INVALID_PARAMETER",
         "propertyName": "motherName",
         "message": [
            "motherName must not be empty."
         ]
      },
      {
         "code": "INVALID_PARAMETER",
         "propertyName": "documentNumber",
         "message": [
            "The documentNumber field is required."
         ]
      }
   ],
   "reference": "link"
}

📘

Nota

Para evitar a ocorrência de erros 400, siga as instruções de preenchimento dos campos disponíveis na documentação correspondente a cada endpoint.

Erros associados ao certificado TLS