Códigos de Retorno

A API retornará os códigos HTTP Status para cada request.

Status Code Success 2xx

Descrição: Requisição bem sucedida.

Método HTTP: GET.

Response Body: de acordo com a necessidade.

Descrição: Requisição concluída e resultou em um novo recurso.

Método HTTP: POST.

Response Body: de acordo com a necessidade.

Descrição: Requisição aceita para processamento, mas o processamento ainda não foi concluído (utilizado em requisições assíncronas).

Métodos HTTP: GET, POST, PUT, DELETE e PATCH.

Response Body: de acordo com a necessidade.

Descrição: Requisição concluída, mas não é necessário retornar informações adicionais.

Métodos HTTP: PUT, DELETE e PATCH.

Status Code Client Error 4xx

Descrição: A solicitação não pôde ser entendida pelo servidor devido à sintaxe malformada (utilizado quando o consumidor da API fez uma requisição passando uma mensagem com formato diferente do especificado pela documentação da API).

Métodos HTTP: GET, POST, PUT, DELETE e PATCH.

Response Body: string.

Descrição: Requisição requer autenticação do usuário (utilizado quando o consumidor da API não passou uma credencial de acesso válida).

Métodos HTTP: GET, POST, PUT, DELETE e PATCH.

Response Body: string.

Descrição: Servidor entendeu o pedido, mas se recusa a aceitá-la (utilizado quando o consumidor da API passou sua credencial de acesso válida mas não tem permissão para acessar um recurso em específico).

Métodos HTTP: GET, POST, PUT, DELETE e PATCH.

Response Body: string.

Descrição: Servidor não encontrou nada na URI (utilizado quando o consumidor da API tentou acessar uma API, recurso ou elemento que não existe).

Métodos HTTP: GET, POST, PUT, DELETE e PATCH.

Response Body: string.

Descrição: Método especificado não é permitido para o recurso (utilizado quando o método HTTP não é compatível com o recurso/elemento. Por exemplo: POST: /fornecedores/123, nesse caso, não é possível criar um fornecedor em um elemento).

Métodos HTTP: GET, POST, PUT, DELETE e PATCH.

Response Body: string.

Descrição: A solicitação é maior do que o servidor está disposto ou capaz de processar (utilizado quando a mensagem passada pelo consumidor da API é maior do que a API está configurada para aceitar).

Métodos HTTP: GET, POST, PUT, DELETE e PATCH.

Descrição: O pedido foi bem formado, mas não pôde ser seguido devido a erros semânticos (utilizado para o caso de algum erro de negócio, por exemplo, tentativa de excluir um recurso de campo que está atendendo um chamado).

Métodos HTTP: GET, POST, PUT, DELETE e PATCH.

Descrição: Usuário enviou muitas solicitações em um determinado período de tempo (utilizado quando o consumidor da API fez mais requisições do que é permitido para ele ou para a API).

Métodos HTTP: GET, POST, PUT, DELETE e PATCH.

Status Code Server Error 5xx

Descrição: Servidor encontrou uma condição inesperada que impediu de cumprir o pedido (utilizado em caso de erros inesperados na implementação da API).

Métodos HTTP: GET, POST, PUT, DELETE e PATCH.

Response Body: string.

Descrição: Servidor, enquanto age como um gateway ou proxy, recebeu uma resposta inválida (utilizado em casos de erros inesperados no Gateway de APIs).

Métodos HTTP: GET, POST, PUT, DELETE e PATCH.

Response Body: string.

Descrição: O servidor, enquanto age como um gateway ou proxy, não recebeu uma resposta do servidor no tempo especificado (utilizado quando a implementação da API demorou mais tempo do que era esperado para responder).

Métodos HTTP: GET, POST, PUT, DELETE e PATCH.

Response Body: string.

Português, Brasil