Códigos de erro podem ser retornados junto com um status de falha pela API. Eles podem auxiliar tratativas customizadas e explicar de forma mais granular o erro ocorrido.
Estes códigos são um trabalho em constante desenvolvimento e deverão crescer com o tempo.
| Código | Descrição |
|---|---|
| 0 | Não informado (Na maioria dos casos este código é omitido) |
| 1 | Erro desconhecido |
| 1001 | Mensagem já arquivada |
| 1002 | Mensagem já aprovada |
| 1003 | Mensagem já respondida |
Os códigos de erro são retornados em uma lista no campo "errorCodes" e também são concatenados no inicio das mensagens de erro conforme exemplo abaixo:
{
"title": "One or more validation errors occurred.",
"status": 400,
"instance": "/api/v1/Room/3eb32f0b-2456-4a5d-9b05-775fd6360bfe/QuestionAnswer/ff3ce3d2-7ac4-4046-b0ac-efad7671efba",
"traceId": "40000028-0006-fc00-b63f-84710c7967bb",
"errorCodes": [
1003
],
"errors": {
"RoomMessage": [
"1003 - A pergunta já possui uma resposta."
]
}
}
Algumas mensagens de erro podem não possuir um "errorCode" atrelado à ela, neste caso a mensagem não possuirá um código concatenado no inicio e não haverá um código correspondente na lista "errorCode" conforme exemplo abaixo:
{
"title": "One or more validation errors occurred.",
"status": 400,
"instance": "/api/v1/Room/3eb32f0b-2456-4a5d-9b05-775fd6360bfe/QuestionAnswer/ff3ce3d2-7ac4-4046-b0ac-efad7671efba",
"traceId": "40000028-0006-fc00-b63f-84710c7967bb",
"errorCodes": [
1003,
1001
],
"errors": {
"RoomMessage": [
"1003 - A pergunta já possui uma resposta.",
"1001 - A Mensagem que está tentando responder já está arquivada.",
"Mensagem do erro que não possui código."
]
}
}