Base de Conhecimento de Gestão Comercial de Saneamento

A maior base de documentação de GSAN do mercado mantida pela Consenso Tecnologia

Ferramentas do usuário

Ferramentas do site


integracoes:web-services-listar-dias-vencimento-alternativo

WebService Listar Dias de Vencimento Alternativo

O WebService recebe apenas requisições do tipo GET, e os parâmetros são passados via Query Parameter.

Ele espera os seguintes Parâmetros:

  1. key, String contendo a chave de autenticação da empresa.
  2. matrícula, String contendo a matrícula que será usada como filtro.
\\  ===== Exemplo de requisição para o sistema =====

Com as seguintes informações:

IP192.168.64.111
Chave de autenticaçãoaBC123DEF
Matrícula5101433

A Requisição Seria

Retorno em Caso de Sucesso

{
"key": (String) chave de autenticação recebida pelo WebService,
"qtd": (Integer) quantidade de dias que estão sendo retornados,
"resultado": [ List<Integer> contendo os dias específicos.]
}

Exemplo:

listar_dias_vencimento_json_1.jpg

\\  ===== Retorno em Caso de erro =====
{
    "error": (Integer) Código de erro da requisição,
    "msg": (String) Mensagem indicando o que houve, ou vazio em caso de erro 500,
    "qtd": (Integer) sempre valor 0
}

Exemplo:

\\  <WRAP center round box 100%>

acomp_ra_json_2.jpg</WRAP>

\\  ===== Possíveis Códigos de Retorno =====
CódigoMensagem
400“parâmetros inválidos”
401“chave inválida”
404“A consulta não trouxe resultados”
500“”

Clique AQUI para acessar outros serviços com os detalhes técnicos das integrações.

integracoes/web-services-listar-dias-vencimento-alternativo.txt · Última modificação: 22/08/2025 13:56 por jefferson.barbosa