Webservice (Comercial Contratos - Buscar extrato de ligação): mudanças entre as edições

De Adapter
Ir para navegação Ir para pesquisar
VisualWikitexto
(Criou página com ''''Descrição:''' Obtém o extrato de ligações de acordo com Contrato e período informado '''URL:''' https://[URL]/ws/comercial/ligacoes/contrato/{idContrato} '''Método...')
 
Sem resumo de edição
 
Linha 1: Linha 1:
'''Descrição:''' Obtém o extrato de ligações de acordo com Contrato e período informado
'''Descrição:''' Obtém o extrato de ligações de acordo com Contrato e período informado


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


'''Método:''' POST
'''Método:''' POST


'''Entrada:''' Pelo PathParam passar o código do contrato e JSON contendo usuário e senha
'''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.
'''Saída:''' JSON contendo o extrato de ligações filtradas de acordo com o ID do contrato e o período fornecido.


'''Campos JSON de entrada:'''
'''Campos JSON de entrada:'''
Linha 31: Linha 31:
|idContrato
|idContrato
|Path Param
|Path Param
|String
|SIM
|
|-
|dataInicio
|Query Param
|String
|SIM
|
|-
|dataInicio
|Query Param
|String
|String
|SIM
|SIM
Linha 38: Linha 50:


* '''Envio:'''
* '''Envio:'''
** https://[URL]/ws/comercial/total_navegacao/contrato/{idContrato}
** https://[URL]/ws/comercial/contrato/{idContrato}/extrato/ligacao?dataInicio={dataInicio}&dataFim={dataFim}
*** '''Parâmetros adicionais:'''
***'''Parâmetros adicionais:'''<syntaxhighlight lang="json" line="1">
 
{
 
  "usuario":"12312312312",
 
  "senha":"12312312312"
 
}
 
</syntaxhighlight>
 
* '''Retorno:'''
 
** '''Sucesso:'''<syntaxhighlight lang="json" line="1">
 
[
 
  {
 
      "id":1,
 
      "dataColeta":1499355958000,
 
      "isFaturado":false,
 
      "idServico":null,
 
      "origem":"553112341234",
 
      "valor":0,
 
      "batch":"0800 Camara Municipal Conselheiro Lafaiete",
 
      "dataLigacao":1390405381000,
 
      "descricao":"Brasil - MG",
      "idTipoLigacao":null,
      "descricaoTipoLigacao":null,
      "idChamada":1,
      "destino":"553135353535",
      "duracao":0,
      "controlNumber":2
  },
  {
      "id":2,
      "dataColeta":1499355958000,
      "isFaturado":false,
      "idServico":null,
      "origem":"553112341234",
      "valor":0,
      "batch":"0800 Camara Municipal Conselheiro Lafaiete",
      "dataLigacao":1390405454000,
      "descricao":"Brasil - MG",
      "idTipoLigacao":null,
      "descricaoTipoLigacao":null,
      "idChamada":2,
      "destino":"553135353535",
      "duracao":0,
      "controlNumber":2
  }
]
</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 11h50min de 19 de maio de 2023

Descrição: Obtém o extrato de ligações de acordo com Contrato e período informado

URL: https://[URL]/ws/comercial/contrato/{idContrato}/extrato/ligacao?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: JSON contendo o extrato de ligações filtradas de acordo com o ID do contrato e o período fornecido.

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
dataInicio Query Param String SIM

Exemplo:

  • Envio:
    • https://[URL]/ws/comercial/contrato/{idContrato}/extrato/ligacao?dataInicio={dataInicio}&dataFim={dataFim}
      • Parâmetros adicionais:
        {
   "usuario":"12312312312",
   "senha":"12312312312"
}
  • Retorno:
    • Sucesso:
      [
   {
      "id":1,
      "dataColeta":1499355958000,
      "isFaturado":false,
      "idServico":null,
      "origem":"553112341234",
      "valor":0,
      "batch":"0800 Camara Municipal Conselheiro Lafaiete",
      "dataLigacao":1390405381000,
      "descricao":"Brasil - MG",
      "idTipoLigacao":null,
      "descricaoTipoLigacao":null,
      "idChamada":1,
      "destino":"553135353535",
      "duracao":0,
      "controlNumber":2
   },
   {
      "id":2,
      "dataColeta":1499355958000,
      "isFaturado":false,
      "idServico":null,
      "origem":"553112341234",
      "valor":0,
      "batch":"0800 Camara Municipal Conselheiro Lafaiete",
      "dataLigacao":1390405454000,
      "descricao":"Brasil - MG",
      "idTipoLigacao":null,
      "descricaoTipoLigacao":null,
      "idChamada":2,
      "destino":"553135353535",
      "duracao":0,
      "controlNumber":2
   }
]

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_ligação)&oldid=1621”