Webservice (Comercial Contratos - Buscar contratos e faturas): 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:''' Obtém os contratos e faturas do cliente informado. | |||
'''URL:''' https://[URL]/ws/comercial/contratos/cliente/{idCliente} | |||
'''Método:''' POST | |||
'''Entrada:''' Pelo PathParam passar o código do cliente e JSON contendo usuário e senha. | |||
'''Saída:''' JSON contendo o status da edição (sucesso/erro). | |||
'''Campos JSON de entrada:''' | |||
{| class="wikitable" | |||
|'''Tag''' | |||
|'''Tipo Parâmetro''' | |||
|'''Tipo''' | |||
|'''Obrigatório''' | |||
|'''Observação''' | |||
|- | |||
|idCliente | |||
|Path Param | |||
|Integer | |||
|SIM | |||
| | |||
|- | |||
|usuario | |||
|body | |||
|String | |||
|SIM | |||
| | |||
|- | |||
|senha | |||
|body | |||
|String | |||
|SIM | |||
| | |||
|} | |||
'''Exemplo:''' | |||
* '''Envio:''' | |||
** https://[URL]/ws/comercial/contratos/cliente/{idCliente} | |||
*** '''Parâmetros adicionais:'''<syntaxhighlight lang="json" line="1"> | |||
{ | |||
"usuario":"68048424053", | |||
"senha":"senha_cliente" | |||
} | |||
</syntaxhighlight> | |||
* '''Retorno:''' | |||
** '''Sucesso:'''<syntaxhighlight lang="json" line="1"> | |||
{ | |||
"Celular":"31999994444", | |||
"NomeCompleto":"ADAPTER SOLUCOES", | |||
"DataNascimento":574398000000, | |||
"TelefoneFixo":"3130312596", | |||
"Email":"adapter@adaptersolucoes.com", | |||
"faturas":[ | |||
{ | |||
"IDFatura":25, | |||
"CodigoCliente":81593, | |||
"nroBoleto":35, | |||
"nroDocumento":"0008177049", | |||
"Vencimento":"2017-08-01", | |||
"Valor":90, | |||
"DebitoAutomaico":"FALSE" | |||
}, | |||
{ | |||
"IDFatura":26, | |||
"CodigoCliente":81593, | |||
"nroBoleto":27, | |||
"nroDocumento":"0008177048", | |||
"Vencimento":"2017-06-15", | |||
"Valor":150, | |||
"DebitoAutomaico":"FALSE" | |||
} | |||
], | |||
"CodigoCliente":81593, | |||
"NomeTratamento":"DANIELLE", | |||
"contratos":[ | |||
{ | |||
"Tecnologia":"FIBRA", | |||
"LoginRadius":null, | |||
"Franquia":240, | |||
"PlanoContrato":"INTERNET FIBRA 10 MB", | |||
"StatusContrato":"HABILITADO", | |||
"UnidadeMedida":"GB", | |||
"CodContrato":6976, | |||
"tipoEndereco":"PADRAO", | |||
"GrupoTecnologia":"INTERNET", | |||
"EnderecoInstalacao":"FRANCISCA MALVINA DE RESENDE, 444", | |||
"IDVencimento":"1" | |||
}, | |||
{ | |||
"Tecnologia":"RADIO", | |||
"LoginRadius":null, | |||
"Franquia":270, | |||
"PlanoContrato":"RADIO 10 MB", | |||
"StatusContrato":"HABILITADO", | |||
"UnidadeMedida":"GB", | |||
"CodContrato":7058, | |||
"tipoEndereco":"PADRAO", | |||
"GrupoTecnologia":"INTERNET", | |||
"EnderecoInstalacao":"ENIDIO JOSE, 966", | |||
"IDVencimento":"1" | |||
} | |||
], | |||
"atendimentosAbertos":1 | |||
} | |||
</syntaxhighlight> | |||
[[Webservice (Comercial Contratos)|Voltar ao menu Webservice Comercial Contratos]] | [[Webservice (Comercial Contratos)|Voltar ao menu Webservice Comercial Contratos]] |
Edição atual tal como às 15h57min de 17 de maio de 2023
Descrição: Obtém os contratos e faturas do cliente informado.
URL: https://[URL]/ws/comercial/contratos/cliente/{idCliente}
Método: POST
Entrada: Pelo PathParam passar o código do cliente e JSON contendo usuário e senha.
Saída: JSON contendo o status da edição (sucesso/erro).
Campos JSON de entrada:
Tag | Tipo Parâmetro | Tipo | Obrigatório | Observação |
idCliente | Path Param | Integer | SIM | |
usuario | body | String | SIM | |
senha | body | String | SIM |
Exemplo:
- Envio:
- https://[URL]/ws/comercial/contratos/cliente/{idCliente}
- Parâmetros adicionais:
{ "usuario":"68048424053", "senha":"senha_cliente" }
- Parâmetros adicionais:
- https://[URL]/ws/comercial/contratos/cliente/{idCliente}
- Retorno:
- Sucesso:
{ "Celular":"31999994444", "NomeCompleto":"ADAPTER SOLUCOES", "DataNascimento":574398000000, "TelefoneFixo":"3130312596", "Email":"adapter@adaptersolucoes.com", "faturas":[ { "IDFatura":25, "CodigoCliente":81593, "nroBoleto":35, "nroDocumento":"0008177049", "Vencimento":"2017-08-01", "Valor":90, "DebitoAutomaico":"FALSE" }, { "IDFatura":26, "CodigoCliente":81593, "nroBoleto":27, "nroDocumento":"0008177048", "Vencimento":"2017-06-15", "Valor":150, "DebitoAutomaico":"FALSE" } ], "CodigoCliente":81593, "NomeTratamento":"DANIELLE", "contratos":[ { "Tecnologia":"FIBRA", "LoginRadius":null, "Franquia":240, "PlanoContrato":"INTERNET FIBRA 10 MB", "StatusContrato":"HABILITADO", "UnidadeMedida":"GB", "CodContrato":6976, "tipoEndereco":"PADRAO", "GrupoTecnologia":"INTERNET", "EnderecoInstalacao":"FRANCISCA MALVINA DE RESENDE, 444", "IDVencimento":"1" }, { "Tecnologia":"RADIO", "LoginRadius":null, "Franquia":270, "PlanoContrato":"RADIO 10 MB", "StatusContrato":"HABILITADO", "UnidadeMedida":"GB", "CodContrato":7058, "tipoEndereco":"PADRAO", "GrupoTecnologia":"INTERNET", "EnderecoInstalacao":"ENIDIO JOSE, 966", "IDVencimento":"1" } ], "atendimentosAbertos":1 }
- Sucesso: