Pessoas

Controlador responsável pela gestão das pessoas cadastradas no sistema, que podem estar associadas a dispositivos, rotas e permissões de acesso.

1. Obter pessoas por filtro

Descrição:

Obtém uma lista de pessoas cadastradas no sistema com base em filtros específicos.

GET/api/v1/persons

Quando Usar:

Listar todas as pessoas cadastradas.
Buscar pessoas específicas com base em atributos como nome, CPF, status, etc.
Aplicar filtros para paginação e gerenciamento em massa.

Obter pessoas por filtro

get

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

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/persons

GET /api/v1/persons?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,
        "namePerson": "text",
        "unit": 1,
        "block": "text",
        "identificationCode": "text"
      }
    ],
    "total": 1,
    "page": 1,
    "limit": 1,
    "pages": 1
  }
}

2. Cria nova pessoa

Descrição:

Cria um novo cadastro de pessoa no sistema.

POST /api/v1/persons

Quando Usar:

Adicionar novas pessoas que terão permissões de acesso.
Registrar visitantes, funcionários ou prestadores de serviço.

Cria nova pessoa

post

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

cultureNamestringOpcional

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

Default: en-US

Corpo

namePersonstring | nuloOpcional

unitinteger · int32Opcional

blockstring | nuloOpcional

identificationCodestring | nuloOpcional

Respostas

200

application/json

400

Bad Request

application/json

404

Not Found

application/json

post

/api/v1/persons

POST /api/v1/persons HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "namePerson": "text",
  "unit": 1,
  "block": "text",
  "identificationCode": "text"
}

{
  "success": true,
  "failure": true,
  "data": {
    "id": 1,
    "isEnabled": true,
    "namePerson": "text",
    "unit": 1,
    "block": "text",
    "identificationCode": "text"
  }
}

3. Obter pessoa por id

Descrição:

Recupera os dados de uma pessoa específica pelo seu identificador único.

GET /api/v1/persons/{id}

Quando Usar:

Consultar detalhes completos de uma pessoa já cadastrada.
Verificar status, dados de contato e documento.

Obter pessoa pelo id

get

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

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

200

application/json

get

/api/v1/persons/{id}

GET /api/v1/persons/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

{
  "success": true,
  "failure": true,
  "data": {
    "id": 1,
    "isEnabled": true,
    "namePerson": "text",
    "unit": 1,
    "block": "text",
    "identificationCode": "text"
  }
}

4. Atualiza pessoa por id

Descrição:

Atualiza os dados de uma pessoa previamente cadastrada.

PUT /api/v1/persons/{id}

Quando Usar:

Corrigir ou alterar informações de contato ou documento.
Atualizar dados pessoais como nome, e-mail ou telefone.

Atualiza pessoa

put

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

Parâmetros de consulta

cultureNamestringOpcional

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

Default: en-US

Corpo

namePersonstring | nuloOpcional

unitinteger · int32Opcional

blockstring | nuloOpcional

identificationCodestring | nuloOpcional

Respostas

200

application/json

400

Bad Request

application/json

404

Not Found

application/json

put

/api/v1/persons/{id}

PUT /api/v1/persons/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "namePerson": "text",
  "unit": 1,
  "block": "text",
  "identificationCode": "text"
}

{
  "success": true,
  "failure": true,
  "data": {
    "id": 1,
    "isEnabled": true,
    "namePerson": "text",
    "unit": 1,
    "block": "text",
    "identificationCode": "text"
  }
}

5. Desabilita pessoa por id

Descrição:

Desabilita logicamente o cadastro de uma pessoa.

DELETE /api/v1/persons/{id}

Quando Usar:

Revogar o acesso de uma pessoa sem excluir seu histórico no sistema.
Desativar perfis temporários (ex: visitante ou colaborador desligado).

Desabilita pessoa

delete

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

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

200

application/json

400

Bad Request

application/json

delete

/api/v1/persons/{id}

DELETE /api/v1/persons/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

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

6. Habilita pessoa

Descrição:

Reabilita o cadastro de uma pessoa anteriormente desabilitada.

PUT /api/v1/persons/{id}/enablements

Quando Usar:

Reativar o acesso de uma pessoa previamente desativada.
Restaurar o perfil de acesso sem necessidade de recadastramento.

Habilita pessoa

put

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

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

200

application/json

400

Bad Request

application/json

put

/api/v1/persons/{id}/enablements

PUT /api/v1/persons/{id}/enablements HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

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

AnteriorGrupo de Dispositivos PróximoReceptores

Atualizado há 7 meses

hashtag1. Obter pessoas por filtro

hashtagDescrição:

hashtagQuando Usar:

hashtagObter pessoas por filtro

hashtag2. Cria nova pessoa

hashtagDescrição:

hashtagQuando Usar:

hashtagCria nova pessoa

hashtag3. Obter pessoa por id

hashtagDescrição:

hashtagQuando Usar:

hashtagObter pessoa pelo id

hashtag4. Atualiza pessoa por id

hashtagDescrição:

hashtagQuando Usar:

hashtagAtualiza pessoa

hashtag5. Desabilita pessoa por id

hashtagDescrição:

hashtagQuando Usar:

hashtagDesabilita pessoa

hashtag6. Habilita pessoa

hashtagDescrição:

hashtagQuando Usar:

hashtagHabilita pessoa

1. Obter pessoas por filtro

Descrição:

Quando Usar:

Obter pessoas por filtro

2. Cria nova pessoa

Descrição:

Quando Usar:

Cria nova pessoa

3. Obter pessoa por id

Descrição:

Quando Usar:

Obter pessoa pelo id

4. Atualiza pessoa por id

Descrição:

Quando Usar:

Atualiza pessoa

5. Desabilita pessoa por id

Descrição:

Quando Usar:

Desabilita pessoa

6. Habilita pessoa

Descrição:

Quando Usar:

Habilita pessoa