Layout de resposta
A resposta das requisições do Webservice é em formato JSON. Todas as respostas do Webservice, trazem os seguintes parâmetros:
|
status |
Esse campo traz dois valores: danied - Caso ocorrer alguma falha com o processo de requisição accept - Caso a requisição for processada com sucesso |
|
info |
Esse campo traz um código que indica a causa da falha caso a resposta do status for danied |
|
message |
Esse campo traz a resposta da solicitação caso o status for accept. Por exemplo, em caso de inserção de dados, esse campo retorna o id do registro inserido. Já em caso de consulta de dados, retorna o resultado da consulta. Caso a resposta do status for danied, esse campo pode trazer detalhes da causa do erro. |
Exemplo de resposta:
{ "status": "danied",
"info": "xxxx",
"message": "xxx"
}
No layout de resposta para relatórios padrão, no campo message, traz uma estrutura de dados padronizada. A tabela a seguir especifica isso.
|
countrow |
Específica total de registro existentes na base de dados |
|
countcurrentrow |
Específica total de registro gerados na variável rows que foi consultado na base de dados |
|
pageindex |
Especifica a paginação atual. O offeset sobre a paginação |
|
pagemaxrow |
Especifica a quantidade máxima de registro a ser consultada na base de dados. O limite da paginação |
|
columns |
Especifica as colunas configuradas no sistema para montar tabelas com dados |
|
rows |
Lista de dados (array) consultados na base de dados. |
{ "status": "danied",
"info": "xxxx",
"Message": {"countrow":"xx","countcurrentrow":"xx","pageindex": "xx","pagemaxrow": "xx","columns":{"xx":"yy","ww":"qq"},"rows":[]}
}