Todas as respostas incluem um código de status HTTP e, a menos que o código de status seja 204 (Sem Conteúdo), um cabeçalho Accept. O conteúdo da resposta depende da solicitação. Algumas respostas incluem um corpo de documento, algumas incluem apenas uma URL e algumas estão vazias.

Códigos de resposta HTTP

Um cliente de API pode esperar um subconjunto de códigos de status HTTP em uma resposta.

Tabela 1. Códigos de status HTTP que a API retorna
Código de status Status Descrição
200 OK A solicitação é válida e foi concluída. A resposta inclui um corpo de documento.
201 criado A solicitação é válida. O objeto solicitado foi criado e pode ser encontrado na URL especificada no cabeçalho Location.
202 aceito A solicitação é válida e uma tarefa foi criada para tratá-la. Essa resposta geralmente é acompanhada por um elemento TaskStatus .
204 Nenhum conteúdo A solicitação é válida e foi concluída. A resposta não inclui um corpo.
400 Solicitação Inválida O corpo da solicitação está malformado, incompleto ou é inválido.
401 não autorizado Falha no logon ou o token de autenticação expirou.
403 Proibido O usuário não está autenticado ou não tem os privilégios adequados para acessar um ou mais objetos especificados na solicitação.
404 não encontrado Não foi possível encontrar o objeto especificado na solicitação.
Método 405 não permitido O método HTTP especificado na solicitação não é compatível com este objeto.
406 Inaceitável O recurso identificado pela solicitação não é capaz de gerar uma resposta do tipo especificado no cabeçalho Accept da solicitação.
415 Tipo de mídia não compatível O recurso identificado pela solicitação não é compatível com uma solicitação do Content-Type e do método HTTP especificados.
422 não encontrado Normalmente, indica uma URL de solicitação ou um corpo de solicitação malformados.
429 Demasiadas solicitações Um cliente enviou muitas solicitações ou vários clientes estão enviando muitas solicitações simultâneas e o servidor não pode processá-las devido aos limites de taxa.

Para solucionar o problema, tente enviar a solicitação novamente mais tarde.

500 Internal Server Error A solicitação foi recebida, mas não pôde ser concluída devido a um erro interno no servidor.
503 Serviço indisponível No momento, o servidor não pode lidar com a solicitação devido a uma condição temporária, como esgotamento de recursos ou manutenção do servidor.
Tempo limite do gateway 504 O servidor, enquanto atuava como gateway ou proxy, não recebeu uma resposta oportuna do servidor upstream especificado pela URL de solicitação.