Webservice (Comercial Contratos - Buscar dados do contrato): 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:''' Busca dados gerais do contrato. | |||
'''URL:''' https://[URL]/ws/comercial/contrato/dados?somenteContrato=s | |||
'''Método:''' POST | |||
'''Entrada:''' JSON contendo o ID do contrato. | |||
'''Saída:''' JSON contendo os dados do contrato. | |||
'''Campos JSON de entrada:''' | |||
{| class="wikitable" | |||
|'''Tag''' | |||
|'''Tipo Parâmetro''' | |||
|'''Tipo''' | |||
|'''Obrigatório''' | |||
|'''Observação''' | |||
|- | |||
|idContrato | |||
|body | |||
|String | |||
|SIM | |||
| | |||
|} | |||
'''Exemplo:''' | |||
* '''Envio:''' | |||
** https://[URL]/ws/comercial/contrato/dados?somenteContrato=s | |||
*** '''Parâmetros adicionais:'''<syntaxhighlight lang="json"> | |||
{ | |||
"idContrato":1283321 | |||
} | |||
</syntaxhighlight> | |||
* '''Retorno:''' | |||
** '''Sucesso:'''<syntaxhighlight lang="json" line="1"> | |||
{ | |||
"ValorContrato":114.9, | |||
"Tecnologia":"FIBRA", | |||
"TipoContrato":"OUTROS", | |||
"StatusContrato":"HABILITADO", | |||
"IDContrato":61049, | |||
"DescricaoPlano":"FIBRA PROMO ION 10MBPS/30MBPS FRAN. 360GB", | |||
"Enderecos":[ | |||
{ | |||
"Logradouro":"RUA PEDRO RIBEIRO DE REZENDE", | |||
"UF":"MG", | |||
"Numero":102, | |||
"Tipo":"PADRAO", | |||
"Complemento":"CASA A", | |||
"Bairro":"NOVO HORIZONTE", | |||
"Cidade":"CONSELHEIRO LAFAIETE", | |||
"CEP":"36402157" | |||
} | |||
], | |||
"TipoTecnologia":"INTERNET", | |||
"IDVencimento":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 16h03min de 17 de maio de 2023
Descrição: Busca dados gerais do contrato.
URL: https://[URL]/ws/comercial/contrato/dados?somenteContrato=s
Método: POST
Entrada: JSON contendo o ID do contrato.
Saída: JSON contendo os dados do contrato.
Campos JSON de entrada:
Tag | Tipo Parâmetro | Tipo | Obrigatório | Observação |
idContrato | body | String | SIM |
Exemplo:
- Envio:
- https://[URL]/ws/comercial/contrato/dados?somenteContrato=s
- Parâmetros adicionais:
{ "idContrato":1283321 }
- Parâmetros adicionais:
- https://[URL]/ws/comercial/contrato/dados?somenteContrato=s
- Retorno:
- Sucesso:
{ "ValorContrato":114.9, "Tecnologia":"FIBRA", "TipoContrato":"OUTROS", "StatusContrato":"HABILITADO", "IDContrato":61049, "DescricaoPlano":"FIBRA PROMO ION 10MBPS/30MBPS FRAN. 360GB", "Enderecos":[ { "Logradouro":"RUA PEDRO RIBEIRO DE REZENDE", "UF":"MG", "Numero":102, "Tipo":"PADRAO", "Complemento":"CASA A", "Bairro":"NOVO HORIZONTE", "Cidade":"CONSELHEIRO LAFAIETE", "CEP":"36402157" } ], "TipoTecnologia":"INTERNET", "IDVencimento":1 }
- Sucesso: