Obter Entradas

Descrição

Permite obter uma lista das entradas registradas na unidade.

OBS. Quando a data de início e data de fim não são informadas, o sistema sempre irá considerar o dia atual da consulta. Além disso, é possível indicar apenas registerDateStart e o sistema considerará dessa data até o dia atual.

🔑 Parâmetros de Consulta (Query Parameters)

Este endpoint suporta filtros opcionais através de parâmetros de consulta (query parameters) para refinar os resultados.

Parâmetro	Tipo	Obrigatório	Descrição
`registerDateStart`	date-time	Não	Data inicial do registro no formato ISO 8601 (`YYYY-MM-DDTHH:mm:ssZ`). Quando informado sozinho, filtra da data informada até a data atual.
`registerDateEnd`	date-time	Não	Data final do registro no formato ISO 8601 (`YYYY-MM-DDTHH:mm:ssZ`).
`take`	int32	Não	Número total de registros a serem retornados. Valor padrão é `50`. Máximo permitido: `1000`.
`skip`	int32	Não	Número total de registros a serem ignorados. Valor padrão é `0`.
`idEntry`	int32	Não	ID único da entrada a ser retornada.
`idMember`	int32	Não	ID do membro a ser retornado
`idProspect`	int32	Não	ID do prospect a ser retornado
`idEmployee`	int32	Não	ID do funcionário a ser retornado

📤 Estrutura da Resposta

Campo	Tipo	Descrição
`date`	string	Data/hora do registro da entrada.
`dateTurn`	string	Data/hora correspondente ao turno da entrada.
`timeZone`	string	Fuso horário associado ao registro.
`idMember`	number	Identificador do membro (caso a entrada seja de um aluno).
`nameMember`	string	Nome do membro.
`idProspect`	number	Identificador do prospect (caso a entrada seja de um visitante/prospect).
`nameProspect`	string	Nome do prospect.
`idEmployee`	number	Identificador do colaborador (caso a entrada seja de um funcionário).
`nameEmployee`	string	Nome do colaborador.
`entryType`	string	Tipo da entrada (ex.: biometria, QR Code, manual, etc.).
`device`	string	Dispositivo utilizado para registrar a entrada.
`releasesByID`	number	Identificador da liberação associada (quando aplicável).
`idBranch`	number	Identificador da unidade onde a entrada ocorreu.
`blockReason`	string	Motivo do bloqueio, caso a entrada tenha sido bloqueada.
`entryAction`	string	Ação associada à entrada (ex.: liberado, bloqueado, tentativa).
`idMigration`	string	Identificador de migração, quando a entrada está relacionada a processos de migração.

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200OK

application/json

Success

Body

Exemplo

[
    {
        "date": "2019-08-24T14:15:22.123Z",
        "dateTurn": "2019-08-24T14:15:22.123Z",
        "timeZone": "string",
        "idMember": 0,
        "nameMember": "string",
        "idProspect": 0,
        "nameProspect": "string",
        "idEmployee": 0,
        "nameEmployee": "string",
        "entryType": "string",
        "device": "string",
        "releasesByID": 0,
        "idBranch": 0,
        "blockReason": "string",
        "entryAction": "string",
        "idMigration": "string"
    }
]

🟠400Bad Request

Get entries

Obter Entradas#

Descrição#

🔑 Parâmetros de Consulta (Query Parameters)#