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

De Adapter
Ir para navegação Ir para pesquisar
VisualWikitexto
 
Sem resumo de edição
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'''
|-
|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/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 das 18h10min 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
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/vencimentos
      • Parâmetros adicionais: 
        {
   "idVencimentoAtual":"2",
   "idNovoVencimento":"4"
}
  • Retorno: “SUCESSO” ou “FALHA”

Voltar ao menu Webservice Comercial Contratos

Disponível em “http://192.168.0.28:80/wiki/index.php?title=Webservice_(Comercial_Contratos_-_Alterar_vencimento_de_contratos_por_cliente)&oldid=1647”