Passar para o conteúdo principal

API - Devices

Lista os relógios do tipo coletor REP cadastrados para a empresa. Use este endpoint para descobrir o nome do relógio a partir do DeviceID.

Escrito por Gustavo Argoze Lopes da Costa

Este endpoint é uma consulta de apoio (DE-PARA), não faz parte da composição do apontamento em si. Ele serve para cruzar o DeviceID retornado em um apontamento (via API - Apontamentos | Central de Ajuda TWO com ShowMeta=true) com o nome/detalhes do relógio correspondente.

Endpoint

GET https://api1.tradingworks.net/v1/devices

Parâmetros

Este endpoint não recebe parâmetros. Retorna todos os relógios cadastrados para a empresa do token utilizado na requisição.

Headers

  • AUTH-TOKEN: Sua chave privada

Exemplo de Resposta

[   {     "DeviceID": 3083,     "DeviceGroupID": 4004,     "GroupTitle": "Grupo de Teste",     "CompanyID": 1,     "TWDeviceManufacturerID": 1,     "Manufacturer": "Intelbras",     "Code": "INTELBRAS",     "Title": "Dispositivo Intelbras",     "IP": "192.168.0.100",     "SSL": false,     "DeviceLimit": 20000,     "Details": "",     "Active": true,     "AllowAllCompany": true,     "HasAccessControl": false,     "EmployerCount": 0,     "EmployeeCount": 0,     "TeamCount": 0,     "DepartmentCount": 0   } ]

Campos retornados

Campo

Tipo

Observações

DeviceID

integer

Identificador único do relógio/coletor. É esse o valor que aparece como DeviceID nos apontamentos.

DeviceGroupID

integer

Identificador do grupo ao qual o relógio pertence.

GroupTitle

string

Nome do grupo ao qual o relógio pertence.

CompanyID

integer

Identificador da empresa proprietária do relógio.

TWDeviceManufacturerID

integer

Identificador do fabricante do relógio.

Manufacturer

string

Nome do fabricante do relógio (ex.: Intelbras).

Code

string

Código interno do fabricante/modelo do relógio.

Title

string

Nome/apelido cadastrado para o relógio.

IP

string

Endereço IP do relógio na rede.

SSL

boolean

Indica se a comunicação com o relógio utiliza SSL.

DeviceLimit

integer

Limite de registros/marcações suportado pelo relógio.

Details

string

Observações cadastradas sobre o relógio.

Active

boolean

Indica se o relógio está ativo.

LastSyncedNSR

integer

Último NSR (Número Sequencial de Registro) sincronizado pelo relógio. Campo aparece apenas para alguns fabricantes (não veio no exemplo da Intelbras, mas veio no da ControlID).

AllowAllCompany

boolean

Indica se todos os colaboradores da empresa podem marcar nesse relógio, sem nenhuma restrição de vínculo (grupo, departamento, etc.).

HasAccessControl

boolean

Indica se o relógio também é utilizado para controle de acesso.

EmployerCount

integer

Quantidade de empregadores vinculados ao relógio.

EmployeeCount

integer

Quantidade de colaboradores vinculados ao relógio.

TeamCount

integer

Quantidade de equipes vinculadas ao relógio.

DepartmentCount

integer

Quantidade de departamentos vinculados ao relógio.

Respondeu à sua pergunta?