Webservice (Comercial Contratos - Informações de Contrato): 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:''' Busca informações de contratos de acordo com os filtros passados por parâmetro.


'''URL:''' https://[URL]/ws/area/cliente/contrato/{idContrato: [0-9]+}


'''Método:''' GET


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


'''Saída:''' JSON contendo os dados solicitados.


'''Campos JSON de entrada:'''
{| class="wikitable"
|'''Tag'''
|'''Tipo Parâmetro'''
|'''Tipo'''
|'''Obrigatório'''
|'''Observação'''
|-
|Authorization
|header
|String
|SIM
|
|-
|Token
|header
|String
|SIM
|
|-
|idContrato
|Path Param
|Integer
|SIM
|
|}
'''Exemplo:'''


 
* '''Envio:'''
 
** https://[URL]/ws/area/cliente/contrato/{idContrato: [0-9]+}
 
*** '''Parâmetros adicionais:''' Não possui.
 
* '''Retorno:'''
 
** '''Sucesso:'''<syntaxhighlight lang="json" line="1">
 
{
 
  "data":{
 
      "descricaoStatus":"HABILITADO",
 
      "vencimentoFidelidade":1639061038000,
 
      "enderecos":[
 
        "PADRAO - RUA TESTE, 669 - TESTE -TESTE -56000000"
 
      ],
      "descricaoVelocidade":"BLS 1MB",
      "descricaoFormaCobranca":"BOLETO SANTANDER CR - 5724031",
      "valor":9.99,
      "nomePlano":"SUPER LIGEIRO EMPRESARIAL - PRE",
      "id":311974,
      "diaVencimento":"5"
  },
  "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 15h20min de 17 de maio de 2023

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

URL: https://[URL]/ws/area/cliente/contrato/{idContrato: [0-9]+}

Método: GET

Entrada: Header: Token {{token}}, Authorization Basic {{authorization}}, PathParam: idContrato

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 Path Param Integer SIM

Exemplo:

  • Envio:
    • https://[URL]/ws/area/cliente/contrato/{idContrato: [0-9]+}
      • Parâmetros adicionais: Não possui.
  • Retorno:
    • Sucesso:
      {
   "data":{
      "descricaoStatus":"HABILITADO",
      "vencimentoFidelidade":1639061038000,
      "enderecos":[
         "PADRAO - RUA TESTE, 669 - TESTE -TESTE -56000000"
      ],
      "descricaoVelocidade":"BLS 1MB",
      "descricaoFormaCobranca":"BOLETO SANTANDER CR - 5724031",
      "valor":9.99,
      "nomePlano":"SUPER LIGEIRO EMPRESARIAL - PRE",
      "id":311974,
      "diaVencimento":"5"
   },
   "status":"OK"
}

Voltar ao menu Webservice Comercial Contratos

Disponível em “http://192.168.0.28:80/wiki/index.php?title=Webservice_(Comercial_Contratos_-_Informações_de_Contrato)&oldid=1596”