Webservice (Comercial Contratos - Buscar total de ligações agrupado por tipo de ligação): mudanças entre as edições

De Adapter
Ir para navegação Ir para pesquisar
 
Sem resumo de edição
 
Linha 1: Linha 1:


'''Descrição:''' Obtém o tempo total das ligações agrupado por tipo de ligação.


'''URL:''' https://[URL]/ws/comercial/ligacoes/contrato/{idContrato}


'''Método:''' POST


'''Entrada:''' Pelo PathParam passar o código do contrato 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
|
|}
'''Exemplo:'''


 
* '''Envio:'''
 
** https://[URL]/ws/comercial/total_navegacao/contrato/{idContrato}
 
*** '''Parâmetros adicionais:'''<syntaxhighlight lang="json" line="1">
 
{
 
  "usuario":"12312312312",
 
  "senha":"12312312312"
 
}
 
</syntaxhighlight>
 
* '''Retorno:'''
 
** '''Sucesso:'''<syntaxhighlight lang="json" line="1">
 
{
 
  "ligacoes":[
 
      {
        "descricao":"FIXO DDD",
        "duracao":5
      },
      {
        "descricao":"MOVEL DDD",
        "duracao":15
      }
  ]
}
</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 11h34min de 19 de maio de 2023

Descrição: Obtém o tempo total das ligações agrupado por tipo de ligação.

URL: https://[URL]/ws/comercial/ligacoes/contrato/{idContrato}

Método: POST

Entrada: Pelo PathParam passar o código do contrato 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

Exemplo:

  • Envio:
    • https://[URL]/ws/comercial/total_navegacao/contrato/{idContrato}
      • Parâmetros adicionais:
        {
           "usuario":"12312312312",
           "senha":"12312312312"
        }
        
  • Retorno:
    • Sucesso:
      {
         "ligacoes":[
            {
               "descricao":"FIXO DDD",
               "duracao":5
            },
            {
               "descricao":"MOVEL DDD",
               "duracao":15
            }
         ]
      }
      

Voltar ao menu Webservice Comercial Contratos