Unidades

Esta é uma API para cadastro de unidades.

Esta API é autenticada usando OAuth2, ver documentação de autenticação

Listagem de unidades

GET /api/v1/cdm/sites

API para listagem de unidades

Exemplo requisição

GET /api/v1/cdm/sites HTTP/1.1
Host: cdm.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

Exemplo resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
  "cursor": {
    "previous": "",
    "current": "0",
    "next": "",
    "count": 2
  },
  "sites": [
    {
      "id": "AzBv2fGVFbrV1A3XSmyyg",
      "name": "Unidade01",
      "group_id": "Az2wVuhoLr4zuuS7DQfjf",
      "exten_prefix": "1"
    },
    {
      "id": "AxUBeHPXLcmPv4XZ58utA",
      "name": "Unidade03",
      "group_id": "AxUBdRob2tRLq9sPCfQFG",
      "exten_prefix": "139"
    }
  ]
}

Buscar uma unidade

GET /api/v1/cdm/sites/id

API para buscar uma unidade

Exemplo requisição

GET /api/v1/cdm/sites/Az2fDNvAta9pSrr5en8Su HTTP/1.1
Host: cdm.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

Exemplo resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "Az2fDNvAta9pSrr5en8Su",
  "name": "Unidade01",
  "group_id": "Az2wVuhoLr4zuuS7DQfjf",
  "exten_prefix": "1",
  "routers": [],
  "voips": []
}

Criar uma unidade

POST /api/v1/cdm/sites

API para criação de uma unidade

Exemplo requisição

POST /api/v1/cdm/sites HTTP/1.1
Host: cdm.exemplo.com
Content-Type: application/json
Accept: application/json
Authorization: Bearer <Access-Token>

{
  "name": "Unidade09",
  "group_id": "Az2wVuhoLr4zuuS7DQfjf", 
  "exten_prefix": "9"
}

Exemplo resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "Az2g33hnCce1mLEcPRhEF",
  "name": "Unidade09",
  "group_id": "Az2wVuhoLr4zuuS7DQfjf", 
  "exten_prefix": "9"
}

Atualizar uma unidade

PUT /api/v1/cdm/sites/id

API para atualização de uma unidade

Exemplo requisição

PUT /api/v1/cdm/sites/Az2fDNvAta9pSrr5en8Su HTTP/1.1
Host: cdm.exemplo.com
Content-Type: application/json
Accept: application/json
Authorization: Bearer <Access-Token>

{
  "name": "Unidade07"
}

Exemplo resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "Az2fDNvAta9pSrr5en8Su",
  "name": "Unidade07",
  "group_id": "Az2wVuhoLr4zuuS7DQfjf",
  "exten_prefix": "9"
}

Apagar uma unidade

DELETE /api/v1/cdm/sites/id

API para remoção de uma unidade

Exemplo requisição

DELETE /api/v1/cdm/sites/Az2fDNvAta9pSrr5en8Su HTTP/1.1
Host: cdm.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

Exemplo resposta

HTTP/1.1 200 OK
Content-Type: application/json

Formato dos dados

Parâmetros da url

idstring Identificador da unidade

Requisição

namestringrequerido único Nome da unidade Tamanho mínimo: 2
Tamanho máximo: 200
exten_prefixstringrequerido único Prefixo do ramal da unidade Tamanho mínimo: 1
Tamanho máximo: 4
group_idstringrequerido ID do grupo ao qual a unidade irá pertencer

Resposta

idstring Identificador da unidade
namestring Nome da unidade Tamanho mínimo: 2
Tamanho máximo: 200
exten_prefixstring Prefixo do ramal da unidade Tamanho mínimo: 1
Tamanho máximo: 4
group_idstring ID do grupo ao qual a unidade irá pertencer
routersarray<object> Lista de roteadores que pertencem à unidade. A documentação dos roteadores pode ser visualizada em [Roteadores](/cdm/routers)
voipsarray<object> Lista de dispositivos VoIP que pertencem à unidade. A documentação dos dispositivos VoIP pode ser visualizada em [Dispositivos VoIP](/cdm/voips)