Webservice (Comercial Contratos - Verificar se o cliente pode alterar o vencimento 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:''' Faz a verificação se o cliente pode alterar o vencimento do contrato | |||
'''URL:''' https://[URL]/ws/comercial/cliente/{idCliente}/verificar/vencimento_contrato?vencimentoAtual{idVencimentoContrato} | |||
'''Método:''' POST | |||
'''Entrada:''' Pelo Path Param passar o código do cliente, por Query Param id do vencimento atual do contrato. JSON contendo usuário e senha | |||
'''Saída:''' String informando se pode ou não alterar o vencimento. Caso a resposta seja "NOT_ACCEPTABLE", o vencimento já foi solicitado, porém será efetuado no próximo faturamento. Caso seja "ACCEPTED", está permitida a alteração. | |||
'''Campos JSON de entrada:''' | |||
{| class="wikitable" | |||
|'''Tag''' | |||
|'''Tipo Parâmetro''' | |||
|'''Tipo''' | |||
|'''Obrigatório''' | |||
|'''Observação''' | |||
|- | |||
|idCliente | |||
|Path Param | |||
|String | |||
|SIM | |||
| | |||
|- | |||
|idVencimentoContrato | |||
|Query Param | |||
|String | |||
|SIM | |||
| | |||
|- | |||
|usuario | |||
|body | |||
|String | |||
|SIM | |||
| | |||
|- | |||
|senha | |||
|body | |||
|String | |||
|SIM | |||
| | |||
|} | |||
'''Exemplo:''' | |||
* '''Envio:''' | |||
** https://[URL]/ws/comercial/cliente/{idCliente}/verificar/vencimento_contrato?vencimentoAtual{idVencimentoContrato} | |||
*** '''Parâmetros adicionais:'''<syntaxhighlight lang="json" line="1"> | |||
{ | |||
"usuario":"12312312312", | |||
"senha":"12312312312" | |||
} | |||
</syntaxhighlight> | |||
* '''Retorno:''' String informando se pode ou não alterar o vencimento. Caso a resposta seja "NOT_ACCEPTABLE", o vencimento já foi solicitado, porém será efetuado no próximo faturamento. Caso seja "ACCEPTED", está permitida a alteração. | |||
Edição das 15h10min de 19 de maio de 2023
Descrição: Faz a verificação se o cliente pode alterar o vencimento do contrato
URL: https://[URL]/ws/comercial/cliente/{idCliente}/verificar/vencimento_contrato?vencimentoAtual{idVencimentoContrato}
Método: POST
Entrada: Pelo Path Param passar o código do cliente, por Query Param id do vencimento atual do contrato. JSON contendo usuário e senha
Saída: String informando se pode ou não alterar o vencimento. Caso a resposta seja "NOT_ACCEPTABLE", o vencimento já foi solicitado, porém será efetuado no próximo faturamento. Caso seja "ACCEPTED", está permitida a alteração.
Campos JSON de entrada:
Tag | Tipo Parâmetro | Tipo | Obrigatório | Observação |
idCliente | Path Param | String | SIM | |
idVencimentoContrato | Query Param | String | SIM | |
usuario | body | String | SIM | |
senha | body | String | SIM |
Exemplo:
- Envio:
- https://[URL]/ws/comercial/cliente/{idCliente}/verificar/vencimento_contrato?vencimentoAtual{idVencimentoContrato}
- Parâmetros adicionais:
{ "usuario":"12312312312", "senha":"12312312312" }
- Parâmetros adicionais:
- https://[URL]/ws/comercial/cliente/{idCliente}/verificar/vencimento_contrato?vencimentoAtual{idVencimentoContrato}
- Retorno: String informando se pode ou não alterar o vencimento. Caso a resposta seja "NOT_ACCEPTABLE", o vencimento já foi solicitado, porém será efetuado no próximo faturamento. Caso seja "ACCEPTED", está permitida a alteração.