laptop-mobileDispositivos Acionadores

Esta seção documenta os comandos utilizados para consultar informações sobre os dispositivos acionadores cadastrados no controlador de acesso MG3000. Com esses endpoints, é possível obter a lista completa dos acionadores, bem como estatísticas sobre a quantidade total e a quantidade distinta cadastrada na memória do equipamento

1. Listar Dispositivos Acionadores (por Instância)

Descrição:

Retorna a lista completa dos dispositivos acionadores cadastrados na instância ativa do controlador MG3000.

  • GET /api/v1/accessControllers/instances/{id}/triggerDevices

Quando Usar:

  • Durante uma sessão de gerenciamento em tempo real via instância;

  • Para verificar os acionadores carregados na memória do equipamento conectado.

Listar os dispositivos acionadores cadastrados no MG3000 por Instância conectada

get

Listar os dispositivos acionadores cadastrados no MG3000 por Instância conectada

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int32Obrigatório

Id da instância da conexão

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Respostas
chevron-right
200

Quando a listagem ocorrer com sucesso

application/json
get
/api/v1/accessControllers/instances/{id}/triggerDevices

2. Obter Total de Dispositivos Acionadores (por Instância)

Descrição:

Informa o número total de dispositivos acionadores cadastrados na memória da instância do controlador, contando duplicações.

  • GET /api/v1/accessControllers/instances/{id}/triggerDevices/total

Quando Usar:

  • Para avaliar o uso de memória com acionadores em uma instância conectada;

  • Para identificar excesso ou ausência de dispositivos cadastrados.

Obter a quantidade total de dispositivos na memória do controlador de acesso MG3000 por Instância conectada

get

Obter a quantidade total de dispositivos na memória do controlador de acesso MG3000 por Instância conectada

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int32Obrigatório

Id da instância da conexão

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Respostas
chevron-right
200

Quando a obtenção da quantidade total ocorrer com sucesso

application/json
get
/api/v1/accessControllers/instances/{id}/triggerDevices/total

3. Obter Total Distinto de Dispositivos Acionadores (por Instância)

Descrição:

Retorna a quantidade de dispositivos únicos cadastrados (sem contar repetições) na instância do controlador MG3000.

  • GET /api/v1/accessControllers/instances/{id}/triggerDevices/totalDistinct

Quando Usar:

  • Para verificar a variedade de acionadores configurados;

  • Para diagnosticar problemas de duplicação no cadastro da instância conectada.

Obter a quantidade de cada dispositivo na memória do controlador de acesso MG3000 por Instância conectada

get

Obter a quantidade de cada dispositivo na memória do controlador de acesso MG3000 por Instância conectada

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int32Obrigatório

Id da instância da conexão

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Respostas
chevron-right
200

Quando a obtenção da quantidade ocorrer com sucesso

application/json
get
/api/v1/accessControllers/instances/{id}/triggerDevices/totalDistinct

4. Listar Dispositivos Acionadores (por ID)

Descrição:

Retorna a lista de todos os dispositivos acionadores registrados no controlador com base no ID.

  • GET /api/v1/accessControllers/{id}/triggerDevices

Quando Usar:

  • Para consultar acionadores sem necessidade de conexão ativa;

  • Em sistemas que armazenam os dados localmente no banco e acessam via ID.

Listar os dispositivos acionadores cadastrados no MG3000

get

Listar os dispositivos acionadores cadastrados no MG3000

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int64Obrigatório

Id do controlador de acesso

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Respostas
chevron-right
200

Quando a listagem ocorrer com sucesso

application/json
get
/api/v1/accessControllers/{id}/triggerDevices

5. Obter Total de Dispositivos Acionadores (por ID)

Descrição:

Informa a quantidade total de dispositivos acionadores (com repetições) cadastrados no MG3000 identificado pelo ID.

  • GET /api/v1/accessControllers/{id}/triggerDevices/total

Quando Usar:

  • Para validar a quantidade de dispositivos cadastrados diretamente pelo banco;

  • Em relatórios que analisam ocupação de memória sem instância ativa.

Obter a quantidade total de dispositivos na memória do controlador de acesso MG3000

get

Obter a quantidade total de dispositivos na memória do controlador de acesso MG3000

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int64Obrigatório

Id do controlador de acesso

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Respostas
chevron-right
200

Quando a obtenção da quantidade total ocorrer com sucesso

application/json
get
/api/v1/accessControllers/{id}/triggerDevices/total

6. Obter Total Distinto de Dispositivos Acionadores (por ID)

Descrição:

Informa a quantidade de dispositivos únicos (sem duplicações) armazenados no controlador acessado por ID.

  • GET /api/v1/accessControllers/{id}/triggerDevices/totalDistinct

Quando Usar:

  • Para avaliar a diversidade dos acionadores cadastrados diretamente;

  • Em processos de auditoria e revisão de dados.

Obter a quantidade de cada dispositivo na memória do controlador de acesso MG3000

get

Obter a quantidade de cada dispositivo na memória do controlador de acesso MG3000

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int64Obrigatório

Id do controlador de acesso

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Respostas
chevron-right
200

Quando a obtenção da quantidade ocorrer com sucesso

application/json
get
/api/v1/accessControllers/{id}/triggerDevices/totalDistinct

7. Listar Dispositivos Acionadores por Tipo e serial (por Instância)

Descrição:

Consulta e retorna uma lista de dispositivos acionadores (como cartões, tags ou controles remotos) filtrando por um tipo específico e, por um número de serial. A operação utiliza o ID de uma instância de conexão ativa.

  • GET /api/v1/accessControllers/instances/{id}/triggerDevices/{typeTriggerDevice}

Quando usar:

  • Para verificar quais acionadores de um determinado tipo estão cadastrados em um controlador específico que está online.

  • Para popular uma interface de gerenciamento que exibe os dispositivos separados por categoria (cartões, controles, etc.).

Listar dispositivo acionador filtrado por tipo e número serial cadastrados no MG3000 por Instância conectada

get

Listar dispositivo acionador filtrado por tipo e número serial cadastrados no MG3000 por Instância conectada

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int32Obrigatório

Id da instância da conexão

typeTriggerDevicestring · enumObrigatórioValores possíveis:
Parâmetros de consulta
serialNumberstringObrigatório
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Respostas
chevron-right
200

Quando a listagem ocorrer com sucesso

application/json
get
/api/v1/accessControllers/instances/{id}/triggerDevices/{typeTriggerDevice}

8. Listar Dispositivos Acionadores por Tipo e serial (por ID)

Descrição:

Consulta e retorna uma lista de dispositivos acionadores de um tipo específico, utilizando o ID do controlador registrado no sistema.

  • GET /api/v1/accessControllers/{id}/triggerDevices/{typeTriggerDevice}

Quando Usar:

  • Para obter a lista de acionadores de um dispositivo (ex: tags de um morador) para um relatório, mesmo que o controlador esteja offline.

  • Para sistemas de backend que precisam verificar informações de cadastro de um dispositivo sem estabelecer uma conexão direta.

Listar dispositivo acionador filtrado por tipo e número serial cadastrados no MG3000

get

Listar dispositivo acionador filtrado por tipo e número serial cadastrados no MG3000

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int64Obrigatório

Id do controlador de acesso

typeTriggerDevicestring · enumObrigatórioValores possíveis:
Parâmetros de consulta
serialNumberstringObrigatório
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Respostas
chevron-right
200

Quando a listagem ocorrer com sucesso

application/json
get
/api/v1/accessControllers/{id}/triggerDevices/{typeTriggerDevice}

9. Listar Acionadores do Tipo Biometria (por Instância)

Descrição:

Consulta e retorna a lista de todos os dispositivos acionadores do tipo "Biometria" cadastrados no controlador, utilizando o ID da instância de conexão ativa.

  • GET /api/v1/accessControllers/instances/{id}/triggerDevices/biometrics

Quando Usar:

  • Para verificar quais usuários têm biometria cadastrada em um equipamento específico durante uma sessão de manutenção.

  • Para sincronizar a lista de biometrias de um controlador conectado com um banco de dados central.

Exibir dispositivo acionador tipo Biometria cadastrado no MG3000 por Instância conectada

get

Exibir dispositivo acionador tipo Biometria cadastrado no MG3000 por Instância conectada

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int32Obrigatório

Id da instância da conexão

Parâmetros de consulta
idBiointeger · int32Obrigatório
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Respostas
chevron-right
200

OK

application/json
get
/api/v1/accessControllers/instances/{id}/triggerDevices/biometrics

10. Listar Acionadores do Tipo Biometria (por ID)

Descrição:

Consulta e retorna a lista de todos os dispositivos acionadores do tipo "Biometria" cadastrados, utilizando o ID do controlador registrado no sistema.

  • GET /api/v1/accessControllers/{id}/triggerDevices/biometrics

Quando Usar:

  • Para sistemas de gerenciamento central que precisam consolidar informações de biometria de múltiplos locais ou dispositivos.

  • Para verificar o cadastro biométrico de um usuário em um controlador específico sem depender de uma conexão em tempo real.

Exibir dispositivo acionador tipo Biometria cadastrado no MG3000

get

Exibir dispositivo acionador tipo Biometria cadastrado no MG3000

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int64Obrigatório

Id do controlador de acesso

Parâmetros de consulta
idBiointeger · int32Obrigatório
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Respostas
chevron-right
200

OK

application/json
get
/api/v1/accessControllers/{id}/triggerDevices/biometrics

11. Listar Acionadores do Tipo Senha (por Instância)

Descrição:

Consulta e retorna a lista de todos os dispositivos acionadores do tipo "Senha" cadastrados no controlador, utilizando o ID da instância de conexão ativa.

  • GET /api/v1/accessControllers/instances/{id}/triggerDevices/passwords

Quando Usar:

  • Para auditar ou exibir todas as senhas de acesso configuradas em um dispositivo que está atualmente conectado.

  • Para permitir que um operador visualize as senhas cadastradas antes de adicionar ou remover uma nova.

Exibir dispositivo acionador tipo Senha cadastrado no MG3000 por Instância conectada

get

Exibir dispositivo acionador tipo Senha cadastrado no MG3000 por Instância conectada

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int32Obrigatório

Id da instância da conexão

Parâmetros de consulta
passwordstringObrigatório
unitinteger · int32Obrigatório
blockstringObrigatório
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Respostas
chevron-right
200

OK

application/json
get
/api/v1/accessControllers/instances/{id}/triggerDevices/passwords

12. Listar Acionadores do Tipo Senha (por ID)

Descrição:

Consulta e retorna a lista de todos os dispositivos acionadores do tipo "Senha" cadastrados, utilizando o ID do controlador registrado no sistema.

  • GET /api/v1/accessControllers/{id}/triggerDevices/passwords

Quando Usar:

  • Para gerar relatórios de segurança ou auditoria sobre as senhas cadastradas em toda a base de controladores.

  • Para permitir que um administrador central visualize as senhas de um equipamento específico, independentemente de seu status de conexão.

Exibir dispositivo acionador tipo Senha cadastrado no MG3000

get

Exibir dispositivo acionador tipo Senha cadastrado no MG3000

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int64Obrigatório

Id do controlador de acesso

Parâmetros de consulta
passwordstringObrigatório
unitinteger · int32Obrigatório
blockstringObrigatório
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Respostas
chevron-right
200

OK

application/json
get
/api/v1/accessControllers/{id}/triggerDevices/passwords

Atualizado