Webservice (Comercial Contratos - Solicitar atualização de dados do cliente): mudanças entre as edições
Ir para navegação
Ir para pesquisar
(Criou página com ' Voltar ao menu Webservice Comercial Contratos') |
Sem resumo de edição |
||
Linha 1: | Linha 1: | ||
'''Descrição:''' Envia uma solicitação para realizar a atualização dos Dados do cliente. | |||
'''URL:''' https://[URL]/ws/comercial/alteraPerfil | |||
'''Método:''' POST | |||
'''Entrada:''' JSON no corpo da requisição | |||
'''Saída:''' JSON contendo um Map com o retorno do resultado de execução do método. | |||
'''Campos JSON de entrada:''' | |||
{| class="wikitable" | |||
|'''Tag''' | |||
|'''Tipo Parâmetro''' | |||
|'''Tipo''' | |||
|'''Obrigatório''' | |||
|'''Observação''' | |||
|- | |||
|idContrato | |||
|body | |||
|String | |||
|SIM | |||
| | |||
|- | |||
|IDCliente | |||
|body | |||
|String | |||
|SIM | |||
| | |||
|- | |||
|NomeCompleto | |||
|body | |||
|String | |||
|NÃO | |||
| | |||
|- | |||
|RG | |||
|body | |||
|String | |||
|NÃO | |||
| | |||
|- | |||
|DataNascimento | |||
|body | |||
|String | |||
|NÃO | |||
| | |||
|- | |||
|Email | |||
|body | |||
|String | |||
|NÃO | |||
| | |||
|- | |||
|TelefoneFixo | |||
|body | |||
|String | |||
|NÃO | |||
| | |||
|- | |||
|Celular | |||
|body | |||
|String | |||
|NÃO | |||
| | |||
|- | |||
|Telefone1 | |||
|body | |||
|String | |||
|NÃO | |||
| | |||
|- | |||
|Telefone2 | |||
|body | |||
|String | |||
|NÃO | |||
| | |||
|- | |||
|Contratos | |||
|body | |||
|List<> | |||
|NÃO | |||
| | |||
|- | |||
|Plano | |||
|body | |||
|String | |||
|SIM | |||
| | |||
|- | |||
|CodContrato | |||
|body | |||
|String | |||
|SIM | |||
| | |||
|- | |||
|TipoEndereco | |||
|body | |||
|String | |||
|NÃO | |||
| | |||
|- | |||
|TipoLogradouro | |||
|body | |||
|String | |||
|NÃO | |||
| | |||
|- | |||
|Logradouro | |||
|body | |||
|String | |||
|NÃO | |||
| | |||
|- | |||
|Numero | |||
|body | |||
|String | |||
|NÃO | |||
| | |||
|- | |||
|Complemento | |||
|body | |||
|String | |||
|NÃO | |||
| | |||
|- | |||
|Bairro | |||
|body | |||
|String | |||
|NÃO | |||
| | |||
|- | |||
|Cidade | |||
|body | |||
|String | |||
|NÃO | |||
| | |||
|} | |||
'''Exemplo:''' | |||
* '''Envio:''' | |||
** https://[URL]/ws/comercial/alteraPerfil | |||
*** '''Parâmetros adicionais:'''<syntaxhighlight lang="json" line="1"> | |||
{ | |||
"IDCliente":"66499", | |||
"NomeCompleto":"ADAPTER SOLUÇÕES", | |||
"RG":"MG-11.111.1", | |||
"DataNascimento":"05-02-1983", | |||
"Email":"adapter@adaptersolucoes.com", | |||
"TelefoneFixo":"(99) 9999-9999", | |||
"Celular":"(99) 99999-9999", | |||
"Telefone1":"", | |||
"Telefone2":"", | |||
"Contratos":[ | |||
{ | |||
"Plano":"FIBRA ÓPTICA 5MB", | |||
"CodContrato":"10568", | |||
"TipoEndereco":"INSTALACAO", | |||
"TipoLogradouro":"RUA", | |||
"Logradouro":"DONA MARIANA GUIMARAES", | |||
"Numero":"513", | |||
"Complemento":"", | |||
"Bairro":"QUELUZ", | |||
"Cidade":"CONSELHEIRO LAFAIETE" | |||
}, | |||
{ | |||
"Plano":"FONE ILIMITADO", | |||
"CodContrato":"83102", | |||
"TipoEndereco":"PADRAO", | |||
"TipoLogradouro":"AVENIDA", | |||
"Logradouro":"MARIANA GUIMARAES", | |||
"Numero":"513", | |||
"Complemento":"", | |||
"Bairro":"QUELUZ", | |||
"Cidade":"CONSELHEIRO LAFAIETE" | |||
} | |||
] | |||
} | |||
</syntaxhighlight> | |||
* '''Retorno:''' | |||
** '''Sucesso:''' A solicitação foi enviada ao setor responsável, que realizara as atualizações dos dados! | |||
** '''Erro:''' Exceção na execução do método | |||
[[Webservice (Comercial Contratos)|Voltar ao menu Webservice Comercial Contratos]] | [[Webservice (Comercial Contratos)|Voltar ao menu Webservice Comercial Contratos]] |
Edição atual tal como às 14h29min de 19 de maio de 2023
Descrição: Envia uma solicitação para realizar a atualização dos Dados do cliente.
URL: https://[URL]/ws/comercial/alteraPerfil
Método: POST
Entrada: JSON no corpo da requisição
Saída: JSON contendo um Map com o retorno do resultado de execução do método.
Campos JSON de entrada:
Tag | Tipo Parâmetro | Tipo | Obrigatório | Observação |
idContrato | body | String | SIM | |
IDCliente | body | String | SIM | |
NomeCompleto | body | String | NÃO | |
RG | body | String | NÃO | |
DataNascimento | body | String | NÃO | |
body | String | NÃO | ||
TelefoneFixo | body | String | NÃO | |
Celular | body | String | NÃO | |
Telefone1 | body | String | NÃO | |
Telefone2 | body | String | NÃO | |
Contratos | body | List<> | NÃO | |
Plano | body | String | SIM | |
CodContrato | body | String | SIM | |
TipoEndereco | body | String | NÃO | |
TipoLogradouro | body | String | NÃO | |
Logradouro | body | String | NÃO | |
Numero | body | String | NÃO | |
Complemento | body | String | NÃO | |
Bairro | body | String | NÃO | |
Cidade | body | String | NÃO |
Exemplo:
- Envio:
- https://[URL]/ws/comercial/alteraPerfil
- Parâmetros adicionais:
{ "IDCliente":"66499", "NomeCompleto":"ADAPTER SOLUÇÕES", "RG":"MG-11.111.1", "DataNascimento":"05-02-1983", "Email":"adapter@adaptersolucoes.com", "TelefoneFixo":"(99) 9999-9999", "Celular":"(99) 99999-9999", "Telefone1":"", "Telefone2":"", "Contratos":[ { "Plano":"FIBRA ÓPTICA 5MB", "CodContrato":"10568", "TipoEndereco":"INSTALACAO", "TipoLogradouro":"RUA", "Logradouro":"DONA MARIANA GUIMARAES", "Numero":"513", "Complemento":"", "Bairro":"QUELUZ", "Cidade":"CONSELHEIRO LAFAIETE" }, { "Plano":"FONE ILIMITADO", "CodContrato":"83102", "TipoEndereco":"PADRAO", "TipoLogradouro":"AVENIDA", "Logradouro":"MARIANA GUIMARAES", "Numero":"513", "Complemento":"", "Bairro":"QUELUZ", "Cidade":"CONSELHEIRO LAFAIETE" } ] }
- Parâmetros adicionais:
- https://[URL]/ws/comercial/alteraPerfil
- Retorno:
- Sucesso: A solicitação foi enviada ao setor responsável, que realizara as atualizações dos dados!
- Erro: Exceção na execução do método