Erros

Sempre que uma requisição retornar um HTTP Code diferente de "20*" indica que algum problema aconteceu, você pode consular a listagem dos HTTP Code possíveis em:

Retornos Possíveis

Junto ao HTTP Code, enviamos um elemento chamado de "Mensagem" que indica a causa do erro:

{
  "Mensagem": "Este Evento não esta Disponível para Venda"
}

💡 Sugestões

Em alguns casos, também é retornado o campo "Sugestao" indicando uma sugestão de como resolver o problema observado.

Exemplo:

{
  "Mensagem": "[Path: CodigoEvento] Não Localizamos um Evento com o Código '999'",
  "Sugestao": "Verifique se o Código está correto e se você tem permissão de acesso a este Evento"
}

❌ Problemas Relacionados a um Campo

No caso de um problema relacionado a um Campo, que é enviado via POST/PUT/DELETE, antes da mensagem, será indicado o Campo relacionado ao erro.

Exemplo:

{
  "Mensagem": "[Campo: CodigoEvento] Preencha o Código do Evento"
}

❌ Problemas Relacionados a um Path

No caso de um problema relacionado a um Path, antes da mensagem, será indicado o Path relacionado ao erro.

Exemplo:

Ao fazer um a Get para "/reservas/{CodigoReserva}/", caso a reserva não seja localizada, será retornado um erro relacionado a Path:

{
  "Mensagem": "[Path: CodigoReserva] Não Localizamos uma Reserva com o Código '99'",
  "Sugestao": "Verifique se o Código está correto"
}

❌ Problemas Relacionados a uma Query

No caso de um problema relacionado a um Query, antes da mensagem, será indicado o Query relacionado ao erro.

Exemplo:

Ao fazer um a Get para "/reservas/?QtdPorPagina=1000", caso a query "QtdPorPagina" não seja aceita, será retornado um erro relacionado a Query:

{
  "Mensagem": "[Query: QtdPorPagina] Máximo de 100 registros por página ao listar os Eventos",
  "Sugestao": "Altere a Variável 'QtdPorPagina' para uma quantidade inferior a '100'"
}