Base de Conhecimento de Gestão Comercial de Saneamento

Essa página está em modo somente de leitura. Você pode visualizar a fonte, mas não alterá-la. Informe-se com o administrador do Wiki, caso você ache que isso está incorreto.
{{ajuda:logo-gsan3.png?90|}}


====== WebService Atualizar Telefone do Cliente ======

<columns>
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:
  - key, //String// Contendo a chave de autenticação da empresa.
  - cpfCnpj, //String// Contendo o CPF/CNPJ do cliente que se pretende pesquisar.
  - foneAntigo, //String// Contendo o telefone a ser excluído, com no máximo 11 números, sendo os 2 primeiros reservados ao DDD.
  - foneNovo, //String// Contendo o telefone a ser inserido, com no máximo 11 números, sendo os 2 primeiros reservados ao DDD.
  - tipoFoneNovo //String// Contendo o tipo de fone, podendo ser as seguintes opcoes: 1 (Residencial), 2 (Comercial) ou 3 (Celular)
</columns>
\\


===== Exemplo de requisição para o sistema =====

Com as seguintes informações:
|IP|192.168.64.111|
|Chave de autenticação|aBC123DEF|
|CPF|123.123.123-87|
|Fone Antigo|(79)3333-4444|
|Fone Novo|(79)91111-2222|
|Tipo de Fone Novo|Celular|


\\

===== A Requisição Seria =====

http://192.168.64.111:8080/gsan/atualizarTelefoneCliente?key=aBC123DEF&cpfCnpj=12312312387&foneAntigo=7933334444&foneNovo=79911112222&tipoFoneNovo=3

\\

===== Retorno em Caso de Sucesso =====
<code javascript>
{
  "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.
      ]
}

</code>
\\

**Exemplo**:

<code javascript>
	
{
   "key": "aBC123DEF",
   "qtd": 1,
   "resultado": {
      "foneIncluidoComSucesso": true,
      "foneExcluidoComSucesso": false,
      "cpfCnpj": "12312312387"
   }
}
</code>

===== Retorno em Caso de erro =====
<code javascript>
{
  "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
}


</code>

**Exemplo**:
<code javascript>
{
  "error": 400,
  "msg": "parâmetros inválidos",
  "qtd": 0
}


</code>

===== Possíveis Códigos de Retorno =====
|Código|Mensagem|
|400|"parâmetros inválidos"|
|400|"CPF/CNPJ inválidos"|
|401|"chave inválida"|
|404|"A consulta não trouxe resultados"|
|500|“”|
\\

Clique **[[=treinamentos:integracoes|AQUI]]** para acessar outros serviços com os detalhes técnicos das integrações.