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-retornar-conta-json

Essa é uma revisão anterior do documento!


WebService Retornar Conta Json

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

Os seguinte parâmetros são esperados:

  1. matricula (Obrigatório), String contendo o identificador do imóvel.


Exemplo de requisição para o sistema

Com as seguintes informações:


A Requisição Seria

Envio - JSON

{
    "key": "fqzc36y8cv-jg1ekgK9-Z9epV_SZSiL_CB_REQ1yFUi-0KSDcbeYlhj6xev5aATX",
    "matricula": "999999999"
}


Retorno com Sucesso - JSON

{
    "key": "fqzc36y8cv-jg1ekgK9-Z9epV_SZSiL_CB_REQ1yFUi-0KSDcbeYlhj6xev5aATX",
    "qtd": 3,
    "resultado": {
        "motivo": "OK",
        "doacoes": [
            {
                "matricula": "11885343",
                "entidade": "AMECC - ASSOCIACAO MENORES COM CRISTO",
                "valor": "40,00",
                "dtAdesao": "23/08/2023",
                "usuarioAdesao": "INTERNET",
                "dtCancelamento": "23/08/2023",
                "usuarioCancelamento": "INTERNET"
            },
            {
                "matricula": "11885343",
                "entidade": "AMECC - ASSOCIACAO MENORES COM CRISTO",
                "valor": "500,00",
                "dtAdesao": "22/08/2023",
                "usuarioAdesao": "INTERNET",
                "dtCancelamento": "22/08/2023",
                "usuarioCancelamento": "INTERNET"
            },
            {
                "matricula": "60",
                "entidade": "AMECC - ASSOCIACAO MENORES COM CRISTO",
                "valor": "150,00",
                "dtAdesao": "19/08/2023",
                "usuarioAdesao": "GSAN ADMIN"
            }
        ]
    }
}


Retorno com Insucesso - JSON

{
    "key": "fqzc36y8cv-jg1ekgK9-Z9epV_SZSiL_CB_REQ1yFUi-0KSDcbeYlhj6xev5aATX",
    "error": 422,
    "qtd": 0,
    "resultado": {
        "motivo": "A pesquisa não retornou resultados."
    }
}


Possíveis Códigos de Retorno

CódigoMensagem
200“OK”
500“Internal Server Error”
404“Page not found”
422“Unprocessable Entity”


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

integracoes/web-services-retornar-conta-json.1709142372.txt.gz · Última modificação: 28/02/2024 17:46 por denys.tavares