Dispositivos Acionadores

Os Dispositivos Acionadores são equipamentos responsáveis por iniciar ou liberar uma ação no sistema de controle de acesso, como abrir portas, liberar catracas ou acionar cancelas. Eles estão associados a grupos de dispositivos e rotas, definindo a lógica e os contextos em que a ação será permitida.

1. Obter dispositivos acionadores por filtro

Descrição:

Retorna uma lista de dispositivos acionadores com base nos filtros aplicados.

GET /api/v1/triggerDevices

Quando Usar:

Para listar os acionadores configurados no sistema.
Em interfaces de gerenciamento de dispositivos.

Obter dispositivos acionadores vinculados ao MG3000 por filtro

get

Obter dispositivos acionadores vinculados ao MG3000 por filtro

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 consulta

AccessControllerIdinteger · int64Obrigatório

SerialNumberstringOpcional

IdBiointeger · int32Opcional

PasswordstringOpcional

IdentificationCodestringOpcional

PageSizeinteger · int32ObrigatórioDefault: 10

PageNumberinteger · int32ObrigatórioDefault: 1

EnabledbooleanOpcionalDefault: true

SortOrderstringOpcionalDefault: asc

SortFieldstringObrigatórioDefault: id

ValuestringOpcional

cultureNamestringOpcional

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

Default: en-US

Respostas

200

application/json

get

/api/v1/triggerDevices

GET /api/v1/triggerDevices?AccessControllerId=1&PageSize=10&PageNumber=1&SortField=id HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

{
  "success": true,
  "failure": true,
  "data": {
    "data": [
      {
        "id": 1,
        "isEnabled": true,
        "typeTriggerDevice": "RF",
        "serialNumber": "text",
        "idBio": 1,
        "unit": 1,
        "block": "text",
        "label": "text",
        "carBrand": "Audi",
        "carColor": "Amarelo",
        "carPlate": "text",
        "personId": 1,
        "personUnit": 1,
        "personBlock": "text",
        "isVisitor": true,
        "hash": "text",
        "enabledReceivers": [
          {
            "id": 1,
            "receiverCode": 1,
            "status": true
          }
        ],
        "accessControllerId": 1,
        "identificationCode": "text"
      }
    ],
    "total": 1,
    "page": 1,
    "limit": 1,
    "pages": 1
  }
}

2. Cria novo dispositivo acionador

Descrição:

Esse endpoint permite criar um novo dispositivo acionador no sistema.

POST /api/v1/triggerDevices

Quando Usar:

Para cadastrar um novo equipamento responsável por liberar acessos.
Durante a implantação de novos pontos de controle.

Criar novo dispositivo acionador

post

Criar novo dispositivo acionador

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 consulta

accessControllerIdinteger · int64Obrigatório

Id do controlador de acesso na base de dados para vinculação do dispositivo

cultureNamestringOpcional

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

Default: en-US

Corpo

typeTriggerDevicestring · enumOpcionalValores possíveis:

serialnumberstring | nuloOpcional

carBrandinteger · int32Opcional

idBiointeger · int32 | nuloOpcional

carColorinteger · int32Opcional

carPlatestring | nuloOpcional

personIdinteger · int64 | nuloOpcional

personUnitinteger · int32Opcional

personBlockstring | nuloOpcional

equipmentPasswordstring | nuloOpcional

isVisitorbooleanOpcional

identificationCodestring | nuloOpcional

labelstring | nuloOpcional

Respostas

200

application/json

400

Bad Request

application/json

404

Not Found

application/json

post

/api/v1/triggerDevices

POST /api/v1/triggerDevices?accessControllerId=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 292

{
  "typeTriggerDevice": "RF",
  "serialnumber": "text",
  "carBrand": 1,
  "idBio": 1,
  "carColor": 1,
  "carPlate": "text",
  "personId": 1,
  "personUnit": 1,
  "personBlock": "text",
  "equipmentPassword": "text",
  "enabledReceivers": [
    {
      "receiverCode": 1,
      "status": true
    }
  ],
  "isVisitor": true,
  "identificationCode": "text",
  "label": "text"
}

{
  "success": true,
  "failure": true,
  "data": {
    "id": 1,
    "isEnabled": true,
    "typeTriggerDevice": "RF",
    "serialNumber": "text",
    "idBio": 1,
    "unit": 1,
    "block": "text",
    "label": "text",
    "carBrand": "Audi",
    "carColor": "Amarelo",
    "carPlate": "text",
    "personId": 1,
    "personUnit": 1,
    "personBlock": "text",
    "isVisitor": true,
    "hash": "text",
    "enabledReceivers": [
      {
        "id": 1,
        "receiverCode": 1,
        "status": true
      }
    ],
    "accessControllerId": 1,
    "identificationCode": "text"
  }
}

3. Desabilita todos os dispositivos acionadores

Descrição:

Desabilita logicamente todos os dispositivos acionadores vinculados a um controlador de acesso.

DELETE /api/v1/triggerDevices

Quando Usar:

Para remover todos os acionadores vinculados a um controlador de acesso sem removê-lo do histórico do sistema.
Em pausas operacionais ou desativações temporárias.

Remover todos os dispositivos acionadores vinculados a um controlador de acesso

delete

Remover todos os dispositivos acionadores vinculados a um controlador de acesso

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 consulta

accessControllerIdinteger · int64Obrigatório

Id do controlador de acesso na base de dados para vinculação do dispositivo

cultureNamestringOpcional

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

Default: en-US

Respostas

200

application/json

400

Bad Request

application/json

delete

/api/v1/triggerDevices

DELETE /api/v1/triggerDevices?accessControllerId=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": {
    "totalTriggerDevices": 1,
    "allRemoved": true
  }
}

4. Obter dispositivo acionador por id

Descrição:

Retorna os dados de um dispositivo acionador específico.

GET /api/v1/triggerDevices/{idTrigger}

Quando Usar:

Para visualizar detalhes de configuração de um dispositivo.
Em ações de edição, auditoria ou validação de associações.

Obter dispositivo acionador por id

get

Obter dispositivo acionador por id

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

idTriggerinteger · int64Obrigatório

Id do dispositivo acionador na base de dados

Parâmetros de consulta

accessControllerIdinteger · int64Obrigatório

Id do controlador de acesso na base de dados para vinculação do dispositivo

cultureNamestringOpcional

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

Default: en-US

Respostas

200

application/json

get

/api/v1/triggerDevices/{idTrigger}

GET /api/v1/triggerDevices/{idTrigger}?accessControllerId=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

{
  "success": true,
  "failure": true,
  "data": {
    "id": 1,
    "isEnabled": true,
    "typeTriggerDevice": "RF",
    "serialNumber": "text",
    "idBio": 1,
    "unit": 1,
    "block": "text",
    "label": "text",
    "carBrand": "Audi",
    "carColor": "Amarelo",
    "carPlate": "text",
    "personId": 1,
    "personUnit": 1,
    "personBlock": "text",
    "isVisitor": true,
    "hash": "text",
    "enabledReceivers": [
      {
        "id": 1,
        "receiverCode": 1,
        "status": true
      }
    ],
    "accessControllerId": 1,
    "identificationCode": "text"
  }
}

5. Atualiza dispositivo acionador por id

Descrição:

Atualiza os dados de um dispositivo acionador já existente, identificando-o pelo seu id

PUT /api/v1/triggerDevices/{idTrigger}

Quando Usar:

Para alterar nome, descrição ou reconfigurar lógica do acionador.
Durante manutenção ou ajustes operacionais.

Atualizar dispositivo acionador

put

Atualizar dispositivo acionador

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

idTriggerinteger · int64Obrigatório

Id do dispositivo acionador na base de dados

Parâmetros de consulta

accessControllerIdinteger · int64Obrigatório

Id do controlador de acesso na base de dados para vinculação do dispositivo

cultureNamestringOpcional

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

Default: en-US

Corpo

typeTriggerDevicestring · enumOpcionalValores possíveis:

serialnumberstring | nuloOpcional

idBiointeger · int32 | nuloOpcional

carBrandinteger · int32Opcional

carColorinteger · int32Opcional

carPlatestring | nuloOpcional

personIdinteger · int64 | nuloOpcional

personUnitinteger · int32 | nuloOpcional

personBlockstring | nuloOpcional

equipmentPasswordstring | nuloOpcional

isVisitorbooleanOpcional

identificationCodestring | nuloOpcional

labelstring | nuloOpcional

Respostas

200

application/json

400

Bad Request

application/json

404

Not Found

application/json

put

/api/v1/triggerDevices/{idTrigger}

PUT /api/v1/triggerDevices/{idTrigger}?accessControllerId=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 299

{
  "typeTriggerDevice": "RF",
  "serialnumber": "text",
  "idBio": 1,
  "carBrand": 1,
  "carColor": 1,
  "carPlate": "text",
  "personId": 1,
  "personUnit": 1,
  "personBlock": "text",
  "equipmentPassword": "text",
  "enabledReceivers": [
    {
      "id": 1,
      "receiverCode": 1,
      "status": true
    }
  ],
  "isVisitor": true,
  "identificationCode": "text",
  "label": "text"
}

{
  "success": true,
  "failure": true,
  "data": {
    "id": 1,
    "isEnabled": true,
    "typeTriggerDevice": "RF",
    "serialNumber": "text",
    "idBio": 1,
    "unit": 1,
    "block": "text",
    "label": "text",
    "carBrand": "Audi",
    "carColor": "Amarelo",
    "carPlate": "text",
    "personId": 1,
    "personUnit": 1,
    "personBlock": "text",
    "isVisitor": true,
    "hash": "text",
    "enabledReceivers": [
      {
        "id": 1,
        "receiverCode": 1,
        "status": true
      }
    ],
    "accessControllerId": 1,
    "identificationCode": "text"
  }
}

6. Desabilita dispositivo acionador por ID

Descrição:

Desabilita logicamente um dispositivo acionador.

DELETE /api/v1/triggerDevices/{idTrigger}

Quando Usar:

Para desabilitar apenas um acionador sem impactar os demais vinculados ao mesmo controlador.
Útil em casos de manutenção individual, substituição ou desativação temporária de um único dispositivo.

Desabilitar dispositivo acionador

delete

Desabilitar dispositivo acionador

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

idTriggerinteger · int64Obrigatório

Id do dispositivo acionador na base de dados

Parâmetros de consulta

accessControllerIdinteger · int64Obrigatório

Id do controlador de acesso na base de dados para vinculação do dispositivo

cultureNamestringOpcional

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

Default: en-US

Respostas

200

application/json

400

Bad Request

application/json

delete

/api/v1/triggerDevices/{idTrigger}

DELETE /api/v1/triggerDevices/{idTrigger}?accessControllerId=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": true
}

AnteriorRotas PróximoAssociação com Grupos de Dispositivos

Atualizado há 4 meses

hashtag1. Obter dispositivos acionadores por filtro

hashtagDescrição:

hashtagQuando Usar:

hashtagObter dispositivos acionadores vinculados ao MG3000 por filtro

hashtag2. Cria novo dispositivo acionador

hashtagDescrição:

hashtagQuando Usar:

hashtagCriar novo dispositivo acionador

hashtag3. Desabilita todos os dispositivos acionadores

hashtagDescrição:

hashtagQuando Usar:

hashtagRemover todos os dispositivos acionadores vinculados a um controlador de acesso

hashtag4. Obter dispositivo acionador por id

hashtagDescrição:

hashtagQuando Usar:

hashtagObter dispositivo acionador por id

hashtag5. Atualiza dispositivo acionador por id

hashtagDescrição:

hashtagQuando Usar:

hashtagAtualizar dispositivo acionador

hashtag6. Desabilita dispositivo acionador por ID

hashtagDescrição:

hashtagQuando Usar:

hashtagDesabilitar dispositivo acionador

1. Obter dispositivos acionadores por filtro

Descrição:

Quando Usar:

Obter dispositivos acionadores vinculados ao MG3000 por filtro

2. Cria novo dispositivo acionador

Descrição:

Quando Usar:

Criar novo dispositivo acionador

3. Desabilita todos os dispositivos acionadores

Descrição:

Quando Usar:

Remover todos os dispositivos acionadores vinculados a um controlador de acesso

4. Obter dispositivo acionador por id

Descrição:

Quando Usar:

Obter dispositivo acionador por id

5. Atualiza dispositivo acionador por id

Descrição:

Quando Usar:

Atualizar dispositivo acionador

6. Desabilita dispositivo acionador por ID

Descrição:

Quando Usar:

Desabilitar dispositivo acionador