Cada chamada de API retorna um Objeto JSON com informações solicitadas ou um objeto com um par de Nome/Valor refletindo um estado da operação solicitada, que também pode conter uma mensagem de erro com descrição.

O primeiro nome/valor reflete se a chamada foi executada corretamente:

  • “Sucesso”: verdadeiro – Caso o pedido fosse correto (aceito) e executado corretamente.
  • “Sucesso”: falso – Ocorreu um erro.

O segundo nome/valor traz texto descritivo curto em qualquer resultado:

  • “Resultado”: “OK” – Caso a solicitação tenha sido correta (aceita) e executada corretamente.
  • “ErroDescrição”: “descrição do erro de texto” – Se ocorreu um erro.
Exemplo de resposta ao sucesso:

{
“Sucesso”: verdade,
“Resultado”: “Filtro 1110 foi atualizado”
}

Exemplos de resposta a erros:

{
“Sucesso”: falso,
“ErroDescrição”: [
“Login falhou! Verifique seu nome de usuário ou senha”
] }

{ “Sucesso”: falso, “Erro Descritor”: “ID de história inválido” }

O Dotcom-Monitor fornece recursos para códigos de erro adicionais explicados. Leia mais sobre descrições específicas de código de erro aqui em nossa Wiki.