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-atualizar-telefone_cliente

WebService Atualizar Telefone do Cliente

O WebService recebe apenas requisições do tipo POST, 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. cpfCnpj, String Contendo o CPF/CNPJ do cliente que se pretende pesquisar.
  3. foneAntigo, String Contendo o telefone a ser excluído, com no máximo 11 números, sendo os 2 primeiros reservados ao DDD.
  4. foneNovo, String Contendo o telefone a ser inserido, com no máximo 11 números, sendo os 2 primeiros reservados ao DDD.
  5. tipoFoneNovo String Contendo o tipo de fone, podendo ser as seguintes opcoes: 1 (Residencial), 2 (Comercial) ou 3 (Celular)


Exemplo de requisição para o sistema

Com as seguintes informações:

IP192.168.64.111
Chave de autenticaçãoaBC123DEF
CPF123.123.123-87
Fone Antigo(79)3333-4444
Fone Novo(79)91111-2222
Tipo de Fone NovoCelular


A Requisição Seria

Retorno em Caso de Sucesso

{
  "key": (String) chave de autenticação recebida pelo Webservice,
  "qtd": (Integer) número de dados retornados pelo Webservice,
  "resultado":
      [
        "foneIncluidoComSucesso" : (Boolean) Indicador de que o Fone Novo foi incluído com sucesso.
        "foneExcluidoComSucesso" : (Boolean) Indicador de que o Fone Antigo foi excluído com sucesso.
        "cpfCnpj" : (String) CPF/CNPJ do cliente que foi pesquisado.
      ]
}


Exemplo:

{
   "key": "aBC123DEF",
   "qtd": 1,
   "resultado": {
      "foneIncluidoComSucesso": true,
      "foneExcluidoComSucesso": false,
      "cpfCnpj": "12312312387"
   }
}

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:

{
  "error": 400,
  "msg": "parâmetros inválidos",
  "qtd": 0
}

Possíveis Códigos de Retorno

CódigoMensagem
400“parâmetros inválidos”
400“CPF/CNPJ 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-atualizar-telefone_cliente.txt · Última modificação: 08/10/2020 19:46 por hiroshi.goncalves