Passar para o conteúdo principal

API - Equipamentos

Lista os relógios do tipo aplicativo/portal (mobile/web) cadastrados para a empresa. Use este endpoint para descobrir o nome do relógio a partir do EquipmentID.

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 EquipmentID retornado em um apontamento (via API - Apontamentos | Central de Ajuda TWO com ShowMeta=true) com o nome/detalhes do equipamento correspondente.

Endpoint

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

Parâmetros

Este endpoint não recebe parâmetros. Retorna somente os equipamentos ativos cadastrados para a empresa do token utilizado na requisição, e não existe filtro (nem por grupo, nem por status).

Headers

  • AUTH-TOKEN: Sua chave privada

Exemplo de Resposta

[
{
"EquipmentID": 1,
"EquipmentName": "teste1",
"EquipmentDetails": "",
"SerialNumber": "1234567 teste",
"ActivationDate": "2022-08-17T19:42:00.813",
"AllowFacial": false,
"AllowPIN": true,
"AllowNoGPS": false,
"AllowNoAutomaticTime": false,
"Active": true,
"EmployerCount": 0,
"EmployeeCount": 0
}
]

Campos retornados

Campo

Tipo

Observações

EquipmentID

integer

Identificador único do equipamento. É esse o valor que aparece como EquipmentID nos apontamentos.

EquipmentName

string

Nome cadastrado para o equipamento.

EquipmentDetails

string

Observações cadastradas sobre o equipamento.

SerialNumber

string

Número de série do equipamento.

ActivationDate

datetime

Data e hora em que o equipamento foi ativado.

AllowFacial

boolean

Indica se o equipamento permite marcação por reconhecimento facial.

AllowPIN

boolean

Indica se o equipamento permite marcação por PIN.

AllowNoGPS

boolean

Indica se o equipamento permite marcação sem captura de GPS.

AllowNoAutomaticTime

boolean

Indica se o equipamento permite marcação sem ajuste automático de horário.

Active

boolean

Indica se o equipamento está ativo.

EmployerCount

integer

Quantidade de empregadores vinculados ao equipamento.

EmployeeCount

integer

Quantidade de colaboradores vinculados ao equipamento.

Respondeu à sua pergunta?