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

De Adapter
Ir para navegação Ir para pesquisar
 
Sem resumo de edição
 
(Uma revisão intermediária pelo mesmo usuário não está sendo mostrada)
Linha 1: Linha 1:


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


'''URL:''' https://[URL]/ws/comercial/cliente/{idCliente}/alterar/vencimentos


'''Método:''' POST


'''Entrada:''' PathParam com o ID do cliente, JSON contendo o ID do vencimento atua e ID do novo vencimento.


'''Saída:''' String de FALHA OU SUCESSO.


'''Campos JSON de entrada:'''
{| class="wikitable"
|'''Tag'''
|'''Tipo Parâmetro'''
|'''Tipo'''
|'''Obrigatório'''
|'''Observação'''
|-
|idVencimentoAtual
|body
|String
|SIM
|
|-
|idNovoVencimento
|body
|String
|SIM
|
|}
'''Exemplo:'''


 
* '''Envio:'''
 
** https://[URL]/ws/comercial/cliente/{idCliente}/alterar/vencimentos
 
*** '''Parâmetros adicionais:''' <syntaxhighlight lang="json" line="1">
 
{
 
  "idVencimentoAtual":"2",
 
  "idNovoVencimento":"4"
 
}
 
</syntaxhighlight>
 
* '''Retorno:''' “SUCESSO” ou “FALHA”
 
 
 
 
 
 
 
 


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

Edição atual tal como às 18h11min de 19 de maio de 2023

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

URL: https://[URL]/ws/comercial/cliente/{idCliente}/alterar/vencimentos

Método: POST

Entrada: PathParam com o ID do cliente, JSON contendo o ID do vencimento atua e ID do novo vencimento.

Saída: String de FALHA OU SUCESSO.

Campos JSON de entrada:

Tag Tipo Parâmetro Tipo Obrigatório Observação
idVencimentoAtual body String SIM
idNovoVencimento body String SIM

Exemplo:

  • Envio:
    • https://[URL]/ws/comercial/cliente/{idCliente}/alterar/vencimentos
      • Parâmetros adicionais:
        {
           "idVencimentoAtual":"2",
           "idNovoVencimento":"4"
        }
        
  • Retorno: “SUCESSO” ou “FALHA”

Voltar ao menu Webservice Comercial Contratos