Acesso de Pessoas

acesso-pessoas/audit/:acesso-pessoas-id

Obter informações de interações no registro de Acesso de Pessoas

GET
http://cftv.barradorio.com.br:8080/api/acesso-pessoas/audit/:acesso-pessoas-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoPessoas.acessoPessoas.read]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
URI Input
{ "description": "Registro do(a) Acesso de Pessoas", "type": "@OneOf", "schema": { "acesso-pessoas-id": "Código" } }
Query Input
{ "description": "Registro do(a) Acesso de Pessoas", "type": "@OneOf", "schema": { "page": "Página", "pagination": "Paginação. Máximo 100." } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Acesso de Pessoas", "type": "@OneOf", "schema": { "acessoPessoasAudits": { "description": "Auditoria", "type": "@ManyOf", "schema": { "created": "Data\/Hora", "description": "Alterações", "authorUser": { "description": "Auditoria", "type": "@OneOf", "schema": { "id": "Código", "name": "Nome" } } } }, "total": "Total de Registros", "page": "Página Carregada", "pages": "Total de Páginas", "pagination": "Páginação" } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

acesso-pessoas/collection

Coleção de Acesso de Pessoas com informações resumidas e possibilidade de filtro

GET
http://cftv.barradorio.com.br:8080/api/acesso-pessoas/collection
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoPessoas.acessoPessoas.read]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
Query Input
{ "description": "Registro do(a) Acesso de Pessoas", "type": "@OneOf", "schema": { "page": "Página", "pagination": "Paginação. Máximo 100.", "order-by": "Atributo de Ordenação. acessoPessoas.id, acessoPessoas.created, acessoPessoas.updated, integrationStatus.name, branch.name, acessoPessoas.internalKey, acessoPessoas.occurrence, acessoPessoas.operatorCpf, acessoPessoas.responseProtocol, acessoPessoas.cpf, acessoPessoas.name", "order-type": "Tipo de Ordenação no Atributo. ASC ou DESC. Padrão DESC", "filter-id": "Código", "filter-created-start": "Data de Cadastro", "filter-created-end": "Data de Cadastro", "filter-updated-start": "Data de Atualização", "filter-updated-end": "Data de Atualização", "filter-integrationStatus-id": "Situação", "filter-branch-id": "Filial", "filter-internalKey-contains": "Identificador do Registro", "filter-occurrence-start": "Data\/Hora de Ocorrência", "filter-occurrence-end": "Data\/Hora de Ocorrência", "filter-operatorCpf-contains": "CPF do Operador", "filter-responseProtocol-contains": "Protocolo de Resposta", "filter-cpf-contains": "CPF", "filter-name-contains": "Nome" } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Acesso de Pessoas", "type": "@OneOf", "schema": { "acessoPessoass": { "description": "Acesso de Pessoas", "type": "@ManyOf", "schema": { "id": "Código", "created": "Data de Cadastro", "updated": "Data de Atualização", "integrationStatus": { "description": "Acesso de Pessoas", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "branch": { "description": "Acesso de Pessoas", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "internalKey": "Identificador do Registro", "occurrence": "Data\/Hora de Ocorrência", "operatorCpf": "CPF do Operador", "responseProtocol": "Protocolo de Resposta", "cpf": "CPF", "name": "Nome" } }, "total": "Total de Registros", "page": "Página Carregada", "pages": "Total de Páginas", "pagination": "Páginação", "order-by": "Atributo de Ordenação", "order-type": "Tipo de Ordenação" } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

acesso-pessoas/create

Criar um(a) Acesso de Pessoas. Enviar imediatamente após o acesso de uma pessoa autorizado a entrada/saída do recinto. Um envio por pessoa (CPF).

POST
http://cftv.barradorio.com.br:8080/api/acesso-pessoas/create
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoPessoas.acessoPessoas.create]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
Body Input
{ "description": "Registro do(a) Acesso de Pessoas", "type": "@OneOf", "schema": { "acessoPessoas": { "description": "Acesso de Pessoas", "type": "@OneOf", "schema": { "branch": { "description": "Acesso de Pessoas", "type": "@OneOf", "schema": { "id": "Identificação" } }, "internalKey": "Identificador do Registro precisa ser um texto, Identificador do Registro é obrigatório, Identificador do Registro precisa ter 80 caracteres", "occurrence": "Data\/Hora de Ocorrência precisa ser data e hora (Y-m-d H:i:s), Data\/Hora de Ocorrência é obrigatório", "operatorCpf": "CPF do Operador precisa ter apenas dígitos, CPF do Operador é obrigatório, CPF do Operador precisa ter 11 caracteres", "cpf": "CPF precisa ter apenas dígitos, CPF é obrigatório, CPF precisa ter 11 caracteres", "name": "Nome precisa ser um texto, Nome é obrigatório, Nome precisa ter 100 caracteres", "accessDirection": { "description": "Acesso de Pessoas", "type": "@OneOf", "schema": { "id": "Identificação" } }, "accessIdentitication": { "description": "Acesso de Pessoas", "type": "@OneOf", "schema": { "id": "Identificação" } }, "foreignDocument": "Identidade Estrangeiro precisa ser um texto, Identidade Estrangeiro precisa ter 50 caracteres", "reservation": "Reserva de Passageiro precisa ser um texto, Reserva de Passageiro precisa ter 50 caracteres", "flight": "Voo de Passageiro precisa ser um texto, Voo de Passageiro precisa ter 20 caracteres", "georreferenciamentoCatraca": { "description": "Acesso de Pessoas", "type": "@OneOf", "schema": { "id": "Identificação" } }, "acessoPessoasCamera": { "description": "Cameras", "type": "@ManyOf", "schema": { "georreferenciamentoCamera": { "description": "Cameras", "type": "@OneOf", "schema": { "id": "Identificação" } } } } } } } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Acesso de Pessoas", "type": "@OneOf", "schema": { "id": "Código", "message": "Mensagem" } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

acesso-pessoas/delete/:acesso-pessoas-id

Deletar Acesso de Pessoas

DELETE
http://cftv.barradorio.com.br:8080/api/acesso-pessoas/delete/:acesso-pessoas-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoPessoas.acessoPessoas.delete]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
URI Input
{ "description": "Registro do(a) Acesso de Pessoas", "type": "@OneOf", "schema": { "acesso-pessoas-id": "Código" } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Acesso de Pessoas", "type": "@OneOf", "schema": { "message": "Mensagem" } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

acesso-pessoas/edit/:acesso-pessoas-id

Editar um(a) Acesso de Pessoas. Enviar imediatamente após o acesso de uma pessoa autorizado a entrada/saída do recinto. Um envio por pessoa (CPF).

POST
http://cftv.barradorio.com.br:8080/api/acesso-pessoas/edit/:acesso-pessoas-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoPessoas.acessoPessoas.edit]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
URI Input
{ "description": "Registro do(a) Acesso de Pessoas", "type": "@OneOf", "schema": { "acesso-pessoas-id": "Código" } }
Body Input
{ "description": "Registro do(a) Acesso de Pessoas", "type": "@OneOf", "schema": { "acessoPessoas": { "description": "Acesso de Pessoas", "type": "@OneOf", "schema": { "branch": { "description": "Acesso de Pessoas", "type": "@OneOf", "schema": { "id": "Identificação" } }, "internalKey": "Identificador do Registro precisa ser um texto, Identificador do Registro é obrigatório, Identificador do Registro precisa ter 80 caracteres", "occurrence": "Data\/Hora de Ocorrência precisa ser data e hora (Y-m-d H:i:s), Data\/Hora de Ocorrência é obrigatório", "operatorCpf": "CPF do Operador precisa ter apenas dígitos, CPF do Operador é obrigatório, CPF do Operador precisa ter 11 caracteres", "cpf": "CPF precisa ter apenas dígitos, CPF é obrigatório, CPF precisa ter 11 caracteres", "name": "Nome precisa ser um texto, Nome é obrigatório, Nome precisa ter 100 caracteres", "accessDirection": { "description": "Acesso de Pessoas", "type": "@OneOf", "schema": { "id": "Identificação" } }, "accessIdentitication": { "description": "Acesso de Pessoas", "type": "@OneOf", "schema": { "id": "Identificação" } }, "foreignDocument": "Identidade Estrangeiro precisa ser um texto, Identidade Estrangeiro precisa ter 50 caracteres", "reservation": "Reserva de Passageiro precisa ser um texto, Reserva de Passageiro precisa ter 50 caracteres", "flight": "Voo de Passageiro precisa ser um texto, Voo de Passageiro precisa ter 20 caracteres", "georreferenciamentoCatraca": { "description": "Acesso de Pessoas", "type": "@OneOf", "schema": { "id": "Identificação" } }, "acessoPessoasCamera": { "description": "Cameras", "type": "@ManyOf", "schema": { "id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente", "georreferenciamentoCamera": { "description": "Cameras", "type": "@OneOf", "schema": { "id": "Identificação" } } } } } } } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Acesso de Pessoas", "type": "@OneOf", "schema": { "id": "Código", "message": "Mensagem" } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

acesso-pessoas/get/:acesso-pessoas-id

Obter Acesso de Pessoas com todos os detalhes de suas informações

GET
http://cftv.barradorio.com.br:8080/api/acesso-pessoas/get/:acesso-pessoas-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoPessoas.acessoPessoas.read]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
URI Input
{ "description": "Registro do(a) Acesso de Pessoas", "type": "@OneOf", "schema": { "acesso-pessoas-id": "Código" } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Acesso de Pessoas", "type": "@OneOf", "schema": { "acessoPessoas": { "description": "Acesso de Pessoas", "type": "@OneOf", "schema": { "id": "Código", "created": "Data de Cadastro", "updated": "Data de Atualização", "integrationStatus": { "description": "Acesso de Pessoas", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "branch": { "description": "Acesso de Pessoas", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "internalKey": "Identificador do Registro", "occurrence": "Data\/Hora de Ocorrência", "operatorCpf": "CPF do Operador", "responseProtocol": "Protocolo de Resposta", "cpf": "CPF", "name": "Nome", "accessDirection": { "description": "Acesso de Pessoas", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "accessIdentitication": { "description": "Acesso de Pessoas", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "foreignDocument": "Identidade Estrangeiro", "reservation": "Reserva de Passageiro", "flight": "Voo de Passageiro", "georreferenciamentoCatraca": { "description": "Acesso de Pessoas", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "acessoPessoasCamera": { "description": "Cameras", "type": "@ManyOf", "schema": { "id": "Código", "georreferenciamentoCamera": { "description": "Cameras", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } } } }, "acessoPessoasIntegration": { "description": "Integração", "type": "@ManyOf", "schema": { "id": "Código", "sentDatetime": "Data\/Hora", "sentUrl": "URL", "sentMethod": "Método", "sentAuthToken": "Autenticação", "sentBody": "Mensagem de Envio", "responseStatus": "Status de Resposta", "responseBody": "Mensagem de Resposta", "responseProtocol": "Protocolo de Resposta", "retry": "Nova Tentativa" } } } } } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message