Mensagens de erro

Quando a execução de um pedido à Web API resulta num erro, a resposta inclui um status code que indica a condição do erro.

No entanto, esse código pode nem sempre ser suficiente para determinar a origem do erro, por isso, nestes casos o corpo da resposta inclui informação adicional.

Exemplos

Se ocorrer um erro ao executar o endpoint para criar uma entidade porque já existe uma entidade com a mesma chave, a resposta obtida terá o status code 400 e o corpo da mensagem inclui uma mensagem de validação semelhante à seguinte:

{
    "message": "This record already exists in the data repository of the Payment Term entity.",
    "%ERRORCODE%": "DataExceptionErrorCode.EntityAlreadyExists"
}

Se tentar eliminar um registo que não existe, o sistema retorna o status code 404 e uma mensagem semelhante à seguinte:

{
    "message": "The 'Payment Term' was not found."
}

%ERRORCODE%

Note-se que, no primeiro exemplo, a resposta inclui um atributo com o nome %ERRORCODE%. Este atributo é devolvido no resultado sempre que o mesmo status code possa ser devolvido para erros distintos, permitindo assim que a aplicação que processa a resposta trate esses casos diferentes de forma distinta.