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

Visitou: • web-services-consultar-doacao

Barra lateral

integracoes:web-services-consultar-doacao

Tabela de conteúdos

WebService Consultar Doação

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. key (Obrigatório), String contendo a chave de autenticação da empresa.
  2. cnpj (Obrigatório), String contendo o CNPJ (apenas números) da entidade beneficente que receberá a doação.
  3. dtInicial (Obrigatório), String contendo uma data no formato “dd/mm/aaaa” com a data inicial da adesão ao cadastro de doações
  4. matricula (Opcional), String contendo o identificador do imóvel.


Exemplo de requisição para o sistema

Com as seguintes informações:

URLhttp://evolutiva.consensotec.com.br:8106
keyj4iugjg94l-jg1ekgK9-Z9epV_SZSiL_CB_REQ1yFUi-0KSDcbeYlhj6xev5aBAC
cnpj05726909000145
dtInicial01/01/2023


A Requisição Seria

http://evolutiva.consensotec.com.br:8106/gsan/consultarDoacao

Envio - JSON

{
    "key": "fqzc36y8cv-jg1ekgK9-Z9epV_SZSiL_CB_REQ1yFUi-0KSDcbeYlhj6xev5aATX",
    "cnpj": "40970592000190",
    "dtInicial": "01/05/2023"
}


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-consultar-doacao.txt · Última modificação: 28/08/2023 11:38 por hiroshi.goncalves

Ferramentas da página

Exceto onde for informado ao contrário, o conteúdo neste wiki está sob a seguinte licença: CC Attribution-Noncommercial 4.0 International
CC Attribution-Noncommercial 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki