Códigos de estado das respostas

As respostas aos pedidos à Web API produzem códigos de estados (status code) HTTP diferentes consoante o resultado da operação.

Se a operação for executada com sucesso, será retornado um status code esperado para o tipo de operação.

Em caso de erro, por exemplo, na validação dos parâmetros do pedido, ou no caso de ocorrer outra exceção inesperada, será devolvido um status code de erro.

Status codes

De seguida é apresentada a lista de status codes que podem ser retornados para cada um dos endpoints.

Criação de um registo (POST)

Status codes esperados:

• 201 (Created) – o registo foi criado com sucesso.

Status codes de erro:

• 400 (BadRequest) – os parâmetros do pedido são inválidos.
• 401 (Unauthorized) – os headers de autenticação não são válidos.
• 403 (Forbidden) - a app não está autorizada a aceder à subscrição.
• 500 (InternalServerError) – ocorreu um erro interno no processamento do pedido.

Atualização de um atributo de um registo (PUT)

Status codes esperados:

• 200 (OK) – o registo foi atualizado com sucesso.

Status codes de erro:

• 401 (Unauthorized) – os headers de autenticação não são válidos.
• 404 (NotFound) – o registo não existe.
• 403 (Forbidden) - a app não está autorizada a aceder à subscrição.
• 500 (InternalServerError) – ocorreu um erro interno no processamento do pedido.

Anulação de um registo (DELETE)

Status codes esperados:

• 204 (NoContent) – o registo foi eliminado com sucesso.

Status codes de erro:

• 401 (Unauthorized) – os headers de autenticação não são válidos.
• 403 (Forbidden) - a app não está autorizada a aceder à subscrição.
• 500 (InternalServerError) – ocorreu um erro interno no processamento do pedido.

Consulta de um registo (GET)

Status codes esperados:

• 200 (OK) – o corpo da mensagem contém o registo.

Status codes de erro:

• 401 (Unauthorized) – os headers de autenticação não são válidos.
• 403 (Forbidden) - a app não está autorizada a aceder à subscrição.
• 404 (NotFound) – o registo não existe.
• 500 (InternalServerError) – ocorreu um erro interno no processamento do pedido.

Listagem de todos os registos (GET)

Status codes esperados:

• 200 (OK) – o corpo da mensagem contém a lista dos registos.

Status codes de erro:

• 401 (Unauthorized) – os headers de autenticação não são válidos.
• 403 (Forbidden) - a app não está autorizada a aceder à subscrição.
• 500 (InternalServerError) – ocorreu um erro interno no processamento do pedido.

Listagem de uma página de registos (GET)

Status codes esperados:

• 200 (OK) – o corpo da mensagem contém a lista dos registos.

Status codes de erro:

• 401 (Unauthorized) – os headers de autenticação não são válidos.
• 403 (Forbidden) - a app não está autorizada a aceder à subscrição.
• 500 (InternalServerError) – ocorreu um erro interno no processamento do pedido.

Mensagens de erro

Nos casos em que ocorre um erro no pedido, o corpo da mensagem da resposta inclui dados adicionais sobre o erro.

Mais informação: Mensagens de erro