Webservice (Comercial Contratos - Alteração de Dados Rede De Contrato): mudanças entre as edições

De Adapter
Ir para navegação Ir para pesquisar
(Criou página com ''''Descrição:''' Busca informações de dados rede de contratos de acordo com os filtros passados por parâmetro. '''URL:''' <nowiki>https://{{url}/ws/area/cliente/contrato...')
 
Sem resumo de edição
 
Linha 1: Linha 1:
'''Descrição:''' Busca informações de dados rede de contratos de acordo com os filtros passados por parâmetro.
'''Descrição:''' Busca informações de dados rede de contratos de acordo com os filtros passados por parâmetro.


'''URL:''' <nowiki>https://{{url}/ws/area/cliente/contrato/rede/{idContrato</nowiki> [0-9]+}
'''URL:''' <nowiki>https://{{url}/ws/area/cliente/alterar/dados/rede</nowiki>


'''Método:''' GET
'''Método:''' PUT


'''Entrada:''' Header: ''Token <nowiki>{{token}}</nowiki>, Authorization Basic <nowiki>{{authorization}}</nowiki>,'' PathParam: ''idContrato''
'''Entrada:''' Header: ''Token <nowiki>{{token}}</nowiki>, Authorization Basic {{authorization},'' Body: ''idContrato, loginWiFi, senhaWiFi''


'''Saída:''' JSON contendo os dados solicitados.
'''Saída:''' JSON contendo os dados solicitados.
Linha 30: Linha 30:
|-
|-
|idContrato
|idContrato
|Path Param
|body
|Integer
|Integer
|SIM
|
|-
|loginWiFi
|body
|String
|SIM
|
|-
|senhaWifi
|body
|String
|SIM
|SIM
|
|
Linha 38: Linha 50:


* '''Envio:'''
* '''Envio:'''
** <nowiki>https://{{url}/ws/area/cliente/contrato/rede/{idContrato</nowiki> [0-9]+}
** <nowiki>https://{{url}/ws/area/cliente/alterar/dados/rede</nowiki>
*** '''Parâmetros adicionais:''' Não possui.
***'''Parâmetros adicionais:''' <syntaxhighlight lang="json" line="1">
{
    "idContrato":1,
    "loginWiFi":"adapter.solucoes",
    "senhaWifi":"senha_wifi_equipamento"
}
</syntaxhighlight>
* '''Retorno:'''
* '''Retorno:'''
** '''Sucesso:'''
**'''Sucesso:'''<syntaxhighlight lang="json" line="1">
 
{
 
  "data":"O login e a senha do Wi-Fi do contrato de ID 'X' foram atualizadas com sucesso.",
 
  "status":"OK"
 
}
 
</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 15h35min de 17 de maio de 2023

Descrição: Busca informações de dados rede de contratos de acordo com os filtros passados por parâmetro.

URL: https://{{url}/ws/area/cliente/alterar/dados/rede

Método: PUT

Entrada: Header: Token {{token}}, Authorization Basic {{authorization}, Body: idContrato, loginWiFi, senhaWiFi

Saída: JSON contendo os dados solicitados.

Campos JSON de entrada:

Tag Tipo Parâmetro Tipo Obrigatório Observação
Authorization header String SIM
Token header String SIM
idContrato body Integer SIM
loginWiFi body String SIM
senhaWifi body String SIM

Exemplo:

  • Envio:
    • https://{{url}/ws/area/cliente/alterar/dados/rede
      • Parâmetros adicionais:
        {
            "idContrato":1,
            "loginWiFi":"adapter.solucoes",
            "senhaWifi":"senha_wifi_equipamento"
        }
        
  • Retorno:
    • Sucesso:
      {
         "data":"O login e a senha do Wi-Fi do contrato de ID 'X' foram atualizadas com sucesso.",
         "status":"OK"
      }
      

Voltar ao menu Webservice Comercial Contratos