Webservice (Comercial Contratos - Alterar vencimento dos contratos de um cliente): mudanças entre as edições

De Adapter
Ir para navegação Ir para pesquisar
 
Sem resumo de edição
 
Linha 1: Linha 1:


'''Descrição:''' Altera para o novo vencimento todos os contratos de um determinado cliente que possuírem o vencimento atual selecionado.


'''URL:''' https://[URL]/ws/comercial/cliente/{idCliente}/alterar/vencimento_contrato?vencimentoAtual{idVencimentoContrato}&novoVencimento={idVencimento}


'''Método:''' POST


'''Entrada:''' Pelo Path Param passar o código do cliente, por Query Param id do vencimento atual do contrato e id do novo vencimento. JSON contendo usuário e senha.


'''Saída:''' "OK" se for alterado algum contrato do cliente para o novo vencimento, nesse caso o cliente receberá um e-mail informando que a alteração do vencimento foi feita com sucesso. Caso a alteração de vencimento venha a acontecer depois do próximo faturamento, o cliente também é informado no e-mail. Caso não aconteça alteração em nenhum contrato a resposta será "NOT_MODIFIED".


'''Campos JSON de entrada:'''
{| class="wikitable"
|'''Tag'''
|'''Tipo Parâmetro'''
|'''Tipo'''
|'''Obrigatório'''
|'''Observação'''
|-
|idCliente
|Path Param
|String
|SIM
|
|-
|idVencimentoContra  to
|Query Param
|String
|SIM
|
|-
|idVencimento
|Query Param
|String
|SIM
|
|-
|usuario
|body
|String
|SIM
|
|-
|senha
|body
|String
|SIM
|
|}
'''Exemplo:'''


 
* '''Envio:'''
 
** https://[URL]/ws/comercial/cliente/{idCliente}/alterar/vencimento_contrato?vencimentoAtual{idVencimentoContrato}&novoVencimento={idVencimento}
 
*** '''Parâmetros adicionais:'''<syntaxhighlight lang="json" line="1">
 
{
 
  "usuario":"12312312312",
 
  "senha":"12312312312"
 
}
 
</syntaxhighlight>
 
* '''Retorno:'''
 
** '''Sucesso:''' "OK" se for alterado algum contrato do cliente para o novo vencimento, nesse caso o cliente receberá um e-mail informando que a alteração do vencimento foi feita com sucesso. Caso a alteração de vencimento venha a acontecer depois do próximo faturamento, o cliente também é informado no e-mail. Caso não aconteça alteração em nenhum contrato a resposta será "NOT_MODIFIED".
 
 
 
 


[[Webservice (Comercial Contratos)|Voltar ao menu Webservice Comercial Contratos]]
[[Webservice (Comercial Contratos)|Voltar ao menu Webservice Comercial Contratos]]

Edição atual tal como às 17h56min de 19 de maio de 2023

Descrição: Altera para o novo vencimento todos os contratos de um determinado cliente que possuírem o vencimento atual selecionado.

URL: https://[URL]/ws/comercial/cliente/{idCliente}/alterar/vencimento_contrato?vencimentoAtual{idVencimentoContrato}&novoVencimento={idVencimento}

Método: POST

Entrada: Pelo Path Param passar o código do cliente, por Query Param id do vencimento atual do contrato e id do novo vencimento. JSON contendo usuário e senha.

Saída: "OK" se for alterado algum contrato do cliente para o novo vencimento, nesse caso o cliente receberá um e-mail informando que a alteração do vencimento foi feita com sucesso. Caso a alteração de vencimento venha a acontecer depois do próximo faturamento, o cliente também é informado no e-mail. Caso não aconteça alteração em nenhum contrato a resposta será "NOT_MODIFIED".

Campos JSON de entrada:

Tag Tipo Parâmetro Tipo Obrigatório Observação
idCliente Path Param String SIM
idVencimentoContra to Query Param String SIM
idVencimento Query Param String SIM
usuario body String SIM
senha body String SIM

Exemplo:

  • Envio:
    • https://[URL]/ws/comercial/cliente/{idCliente}/alterar/vencimento_contrato?vencimentoAtual{idVencimentoContrato}&novoVencimento={idVencimento}
      • Parâmetros adicionais:
        {
           "usuario":"12312312312",
           "senha":"12312312312"
        }
        
  • Retorno:
    • Sucesso: "OK" se for alterado algum contrato do cliente para o novo vencimento, nesse caso o cliente receberá um e-mail informando que a alteração do vencimento foi feita com sucesso. Caso a alteração de vencimento venha a acontecer depois do próximo faturamento, o cliente também é informado no e-mail. Caso não aconteça alteração em nenhum contrato a resposta será "NOT_MODIFIED".

Voltar ao menu Webservice Comercial Contratos