Webservice (Comercial Contratos - Buscar extrato de navegação): 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:''' Obtém o extrato de navegação de acordo com Contrato e período informado.


'''URL:''' https://[URL]/ws/comercial/contrato/{idContrato}/extrato/navegacao?dataInicio={dataInicio}&dataFim={dataFim}


'''Método:''' POST


'''Entrada:''' Pelo Path Param passar o código do contrato, por Query Param passar a Data Inicial e a Data Final no formato (dd-MM-yyyy) e JSON contendo usuário e senha.


'''Saída:''' Retorna a mensagem informando.


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


 
* '''Envio:'''
 
** https://[URL]/ws/comercial/contrato/{idContrato}/extrato/navegacao?dataInicio={dataInicio}&dataFim={dataFim}
 
*** '''Parâmetros adicionais:'''<syntaxhighlight lang="json" line="1">
 
{
 
  "usuario":"12312312312",
 
  "senha":"12312312312"
 
}
 
</syntaxhighlight>
 
* '''Retorno:'''
 
** '''Sucesso:'''<syntaxhighlight lang="json" line="1">
 
[
 
  {
 
      "id":1,
 
      "dataColeta":1499264996000,
 
      "idRadacct":76984667,
 
      "loginRadius":"luziarsantos",
 
      "ipNas":"10.0.10.33",
 
      "inicioSessao":1492725782000,
 
      "fimSessao":1471958076000,
 
      "duracaoSessao":-20767706,
 
      "download":391787917,
      "upload":33658349,
      "macCliente":"00:0C:43:C2:8F:8F",
      "ipCliente":"187.73.84.95",
      "isFaturado":false,
      "circuitID":null,
      "motivoDesconexao":null,
      "duracaoFormatada":"0-5768:0-48:0-26",
      "downloadFormatado":0.3648809315636754
  },
  {
      "id":2,
      "dataColeta":1499265138000,
      "idRadacct":81463731,
      "loginRadius":"luziarsantos",
      "ipNas":"10.0.10.8",
      "inicioSessao":1492957543000,
      "fimSessao":1492974406000,
      "duracaoSessao":16863,
      "download":9342519,
      "upload":670931,
      "macCliente":"00:0C:43:D5:17:23",
      "ipCliente":"186.235.195.228",
      "isFaturado":false,
      "circuitID":null,
      "motivoDesconexao":null,
      "duracaoFormatada":"04:41:03",
      "downloadFormatado":0.008700898848474026
  }
]
</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 11h44min de 19 de maio de 2023

Descrição: Obtém o extrato de navegação de acordo com Contrato e período informado.

URL: https://[URL]/ws/comercial/contrato/{idContrato}/extrato/navegacao?dataInicio={dataInicio}&dataFim={dataFim}

Método: POST

Entrada: Pelo Path Param passar o código do contrato, por Query Param passar a Data Inicial e a Data Final no formato (dd-MM-yyyy) e JSON contendo usuário e senha.

Saída: Retorna a mensagem informando.

Campos JSON de entrada:

Tag Tipo Parâmetro Tipo Obrigatório Observação
usuario body String SIM
senha body String SIM
idContrato Path Param String SIM
dataInicio Query Param String SIM
dataFim Query Param String SIM

Exemplo:

  • Envio:
    • https://[URL]/ws/comercial/contrato/{idContrato}/extrato/navegacao?dataInicio={dataInicio}&dataFim={dataFim}
      • Parâmetros adicionais:
        {
   "usuario":"12312312312",
   "senha":"12312312312"
}
  • Retorno:
    • Sucesso:
      [
   {
      "id":1,
      "dataColeta":1499264996000,
      "idRadacct":76984667,
      "loginRadius":"luziarsantos",
      "ipNas":"10.0.10.33",
      "inicioSessao":1492725782000,
      "fimSessao":1471958076000,
      "duracaoSessao":-20767706,
      "download":391787917,
      "upload":33658349,
      "macCliente":"00:0C:43:C2:8F:8F",
      "ipCliente":"187.73.84.95",
      "isFaturado":false,
      "circuitID":null,
      "motivoDesconexao":null,
      "duracaoFormatada":"0-5768:0-48:0-26",
      "downloadFormatado":0.3648809315636754
   },
   {
      "id":2,
      "dataColeta":1499265138000,
      "idRadacct":81463731,
      "loginRadius":"luziarsantos",
      "ipNas":"10.0.10.8",
      "inicioSessao":1492957543000,
      "fimSessao":1492974406000,
      "duracaoSessao":16863,
      "download":9342519,
      "upload":670931,
      "macCliente":"00:0C:43:D5:17:23",
      "ipCliente":"186.235.195.228",
      "isFaturado":false,
      "circuitID":null,
      "motivoDesconexao":null,
      "duracaoFormatada":"04:41:03",
      "downloadFormatado":0.008700898848474026
   }
]

Voltar ao menu Webservice Comercial Contratos

Disponível em “http://192.168.0.28:80/wiki/index.php?title=Webservice_(Comercial_Contratos_-_Buscar_extrato_de_navegação)&oldid=1618”