Listagem de ramal

Listagem de Ramais

Descrição: A API "Listagem de Ramais" tem o propósito de listar os ramais criados no sistema PABX e fornecer informações relevantes sobre o status de cada ramal. Ela oferece detalhes essenciais, como o ID do ramal, número externo, senha de registro, nome registrado, e-mail cadastrado, data de criação, última modificação e o status atual do ramal.

Propriedades da Resposta

A tabela abaixo apresenta as propriedades que são retornadas pela API:

Propriedade	Descrição	Tipo
id	ID do Ramal	String
exten	Número externo do Ramal	String
secret	Senha de registro do Ramal	String
name	Nome registrado do Ramal	String
email	E-mail cadastrado do Ramal	String
created	Data de criação do Ramal	String
modified	Última Alteração do Ramal	String
enabled	Status do Ramal	boolean

Essas informações permitem que os usuários obtenham uma visão geral dos ramais cadastrados no sistema e acompanhem seus respectivos status.

Exemplo de Corpo da Resposta

{
    "page": 0,
    "iTotalRecords": 19,
    "iTotalDisplayRecords": 19,
    "aaData": [
        {
            "id": 1,
            "exten": "2000",
            "secret": "2000@2000",
            "name": "Ramal 2000",
            "email": "2000@localhost",
            "created": "2022-10-28T15:05:40-03:00",
            "modified": "2022-10-28T15:05:40-03:00",
            "enabled": true
        },
        // Outras entradas de dados...
    ]
}

O exemplo acima mostra o formato da resposta da API com uma entrada de ramal fictício. As propriedades "page", "iTotalRecords" e "iTotalDisplayRecords" são utilizadas para controle de paginação e contagem total de registros.

Paginação

start (Inteiro): Este campo indica a posição de início da página de resultados. Ele define o índice inicial a partir do qual os resultados devem ser recuperados. No exemplo, start está definido como 0, o que significa que a página de resultados começa a partir do primeiro registro.

length (Inteiro): Este campo define o número máximo de registros que devem ser retornados em uma única página de resultados. No exemplo, length está definido como 10, o que significa que a página deve conter até 10 registros.

sEcho (Inteiro): O campo sEcho é frequentemente usado para rastrear solicitações de paginação. Cada vez que uma nova solicitação de página é feita, esse número de sequência é incrementado. Ele pode ser usado para garantir que as respostas correspondam às solicitações e evitar resultados desatualizados.

search (Objeto): Este campo é usado para configurar opções de pesquisa, mas no exemplo fornecido, parece estar configurado para desativar a pesquisa usando regex (expressões regulares). O campo regex está definido como false, o que significa que a pesquisa não deve usar expressões regulares.

Em resumo, esse JSON de paginação é usado para definir os parâmetros de uma solicitação de busca paginada, incluindo o início da página, o número máximo de registros por página, informações de rastreamento e configurações de pesquisa, como o uso de expressões regulares (neste caso, desativado). Isso é frequentemente utilizado em aplicações web para exibir grandes conjuntos de dados de forma paginada e controlada.

Requisição

Parâmetros Header

PreAuthorization

string

requerido

Exemplo:

Bearer {{access_token}}

Parâmetros Bodyapplication/json

start

integer

requerido

length

integer

requerido

sEcho

integer

requerido

object

requerido

regex

boolean

requerido

Exemplo

{
  "start": 0,
  "length": 10,
  "sEcho": 1,
  "search": {
    "regex": false
  }
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200Listagem de ramal

application/json

Body

page

integer

requerido

iTotalRecords

integer

requerido

iTotalDisplayRecords

integer

requerido

aaData

array [object {8}]

requerido

integer

requerido

exten

string

requerido

secret

string

requerido

name

string

requerido

string

requerido

created

string

requerido

modified

string

requerido

enabled

boolean

requerido

Exemplo

{
  "page": 0,
  "iTotalRecords": 20,
  "iTotalDisplayRecords": 20,
  "aaData": [
    {
      "id": 1,
      "exten": "2000",
      "secret": "2000@2000",
      "name": "Ramal 2000",
      "email": "2000@localhost",
      "created": "2022-10-28T15:05:40-03:00",
      "modified": "2022-10-28T15:05:40-03:00",
      "enabled": true
    },
    {
      "id": 2,
      "exten": "2001",
      "secret": "2001@2001",
      "name": "Ramal 2001",
      "email": "2001@localhost",
      "created": "2022-10-28T15:05:40-03:00",
      "modified": "2022-10-28T15:05:40-03:00",
      "enabled": true
    },
    {
      "id": 3,
      "exten": "2002",
      "secret": "2002@2002",
      "name": "Ramal 2002",
      "email": "2002@localhost",
      "created": "2022-10-28T15:05:40-03:00",
      "modified": "2022-10-28T15:05:40-03:00",
      "enabled": true
    },
    {
      "id": 4,
      "exten": "2003",
      "secret": "2003@2003",
      "name": "Ramal 2003",
      "email": "2003@localhost",
      "created": "2022-10-28T15:05:40-03:00",
      "modified": "2022-10-28T15:05:40-03:00",
      "enabled": true
    },
    {
      "id": 5,
      "exten": "2004",
      "secret": "2004@2004",
      "name": "Tronco Merman",
      "email": "2004@localhost",
      "created": "2022-10-28T15:05:40-03:00",
      "modified": "2022-10-28T15:05:40-03:00",
      "enabled": true
    },
    {
      "id": 6,
      "exten": "2005",
      "secret": "2005",
      "name": "Ramal 2005",
      "email": "2005@localhost",
      "created": "2022-10-28T15:05:40-03:00",
      "modified": "2022-10-28T15:05:40-03:00",
      "enabled": true
    },
    {
      "id": 7,
      "exten": "2006",
      "secret": "2006",
      "name": "Ramal 2006",
      "email": "2006@localhost",
      "created": "2022-10-28T15:05:40-03:00",
      "modified": "2022-10-28T15:05:40-03:00",
      "enabled": true
    },
    {
      "id": 8,
      "exten": "2007",
      "secret": "2007@2007",
      "name": "Ramal 2007",
      "email": "2007@localhost",
      "created": "2022-10-28T15:05:40-03:00",
      "modified": "2022-10-28T15:05:40-03:00",
      "enabled": true
    },
    {
      "id": 9,
      "exten": "2008",
      "secret": "2008@2008",
      "name": "Ramal 2008",
      "email": "2008@localhost",
      "created": "2022-10-28T15:05:40-03:00",
      "modified": "2022-10-28T15:05:40-03:00",
      "enabled": true
    },
    {
      "id": 10,
      "exten": "2009",
      "secret": "2009@2009",
      "name": "Ramal 2009",
      "email": "2009@localhost",
      "created": "2022-10-28T15:05:40-03:00",
      "modified": "2022-10-28T15:05:40-03:00",
      "enabled": true
    },
    {
      "id": 11,
      "exten": "2010",
      "secret": "2010@2010",
      "name": "Ramal 2010",
      "email": "2010@localhost",
      "created": "2022-10-28T15:05:40-03:00",
      "modified": "2022-10-28T15:05:40-03:00",
      "enabled": true
    },
    {
      "id": 12,
      "exten": "3000",
      "secret": "3000@3000",
      "name": "Ramal 3000",
      "email": "3000@localhost",
      "created": "2022-10-28T15:05:40-03:00",
      "modified": "2022-10-28T15:05:40-03:00",
      "enabled": true
    },
    {
      "id": 13,
      "exten": "3001",
      "secret": "3001@3001",
      "name": "Ramal 3001",
      "email": "3001@localhost",
      "created": "2022-10-28T15:05:40-03:00",
      "modified": "2022-10-28T15:05:40-03:00",
      "enabled": true
    },
    {
      "id": 14,
      "exten": "3002",
      "secret": "3002@3002",
      "name": "Ramal 3002",
      "email": "3002@localhost",
      "created": "2022-10-28T15:05:40-03:00",
      "modified": "2022-10-28T15:05:40-03:00",
      "enabled": true
    },
    {
      "id": 15,
      "exten": "3003",
      "secret": "3003@3003",
      "name": "Ramal 3003",
      "email": "3003@localhost",
      "created": "2022-10-28T15:05:40-03:00",
      "modified": "2022-10-28T15:05:40-03:00",
      "enabled": true
    },
    {
      "id": 16,
      "exten": "3004",
      "secret": "3004@3004",
      "name": "Ramal 3004",
      "email": "3004@localhost",
      "created": "2022-10-28T15:05:40-03:00",
      "modified": "2022-10-28T15:05:40-03:00",
      "enabled": true
    },
    {
      "id": 17,
      "exten": "3005",
      "secret": "3005@3005",
      "name": "Ramal 3005",
      "email": "3005@localhost",
      "created": "2022-10-28T15:05:40-03:00",
      "modified": "2022-10-28T15:05:40-03:00",
      "enabled": true
    },
    {
      "id": 18,
      "exten": "9000",
      "secret": "9000@9000",
      "name": "Ramal de discagem",
      "email": "9000@localhost",
      "created": "2023-04-06T16:09:00-03:00",
      "modified": "2023-04-06T16:09:00-03:00",
      "enabled": true
    },
    {
      "id": 19,
      "exten": "5010",
      "secret": "5010*5010",
      "name": "porteiro",
      "email": "5010@localhost",
      "created": "2023-06-13T17:15:00-03:00",
      "modified": "2023-06-13T17:15:00-03:00",
      "enabled": true
    },
    {
      "id": 20,
      "exten": "201",
      "secret": "234587687",
      "name": "Test",
      "created": "2023-07-28T16:08:35-03:00",
      "modified": "2023-07-28T16:08:35-03:00",
      "enabled": true
    }
  ]
}

Listagem de ramal

Listagem de Ramais#

Propriedades da Resposta#

Exemplo de Corpo da Resposta#

Paginação#

Requisição

Exemplos de Requisição

Respostas

Listagem de Ramais

Propriedades da Resposta

Exemplo de Corpo da Resposta

Paginação