Credenciamento de Pessoas

credenciamento-pessoas/audit/:credenciamento-pessoas-id

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

GET
http://cftv.barradorio.com.br:8080/api/credenciamento-pessoas/audit/:credenciamento-pessoas-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [credenciamentoPessoas.credenciamentoPessoas.read]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
URI Input
{ "description": "Registro do(a) Credenciamento de Pessoas", "type": "@OneOf", "schema": { "credenciamento-pessoas-id": "Código" } }
Query Input
{ "description": "Registro do(a) Credenciamento 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) Credenciamento de Pessoas", "type": "@OneOf", "schema": { "credenciamentoPessoasAudits": { "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

credenciamento-pessoas/collection

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

GET
http://cftv.barradorio.com.br:8080/api/credenciamento-pessoas/collection
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [credenciamentoPessoas.credenciamentoPessoas.read]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
Query Input
{ "description": "Registro do(a) Credenciamento de Pessoas", "type": "@OneOf", "schema": { "page": "Página", "pagination": "Paginação. Máximo 100.", "order-by": "Atributo de Ordenação. credenciamentoPessoas.id, credenciamentoPessoas.created, credenciamentoPessoas.updated, integrationStatus.name, branch.name, credenciamentoPessoas.internalKey, credenciamentoPessoas.occurrence, credenciamentoPessoas.operatorCpf, credenciamentoPessoas.responseProtocol, credenciamentoPessoas.cpf, credenciamentoPessoas.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) Credenciamento de Pessoas", "type": "@OneOf", "schema": { "credenciamentoPessoass": { "description": "Credenciamento de Pessoas", "type": "@ManyOf", "schema": { "id": "Código", "created": "Data de Cadastro", "updated": "Data de Atualização", "integrationStatus": { "description": "Credenciamento de Pessoas", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "branch": { "description": "Credenciamento 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

credenciamento-pessoas/create

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

POST
http://cftv.barradorio.com.br:8080/api/credenciamento-pessoas/create
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [credenciamentoPessoas.credenciamentoPessoas.create]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
Body Input
{ "description": "Registro do(a) Credenciamento de Pessoas", "type": "@OneOf", "schema": { "credenciamentoPessoas": { "description": "Credenciamento de Pessoas", "type": "@OneOf", "schema": { "branch": { "description": "Credenciamento 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", "foreignDocumentNumber": "Documento Estrangeiro - Número precisa ser um texto, Documento Estrangeiro - Número precisa ter 50 caracteres", "foreignDocumentCountry": "Documento Estrangeiro - País (SIGLA) precisa ser um texto, Documento Estrangeiro - País (SIGLA) precisa ter 2 caracteres", "foreignDocumentType": { "description": "Credenciamento de Pessoas", "type": "@OneOf", "schema": { "id": "Identificação" } }, "foreignDocumentValidity": "Documento Estrangeiro - Validade precisa ser data e hora (Y-m-d H:i:s)", "name": "Nome precisa ser um texto, Nome é obrigatório, Nome precisa ter 100 caracteres", "country": "País (SIGLA) precisa ser um texto, País (SIGLA) precisa ter 2 caracteres", "genre": { "description": "Credenciamento de Pessoas", "type": "@OneOf", "schema": { "id": "Identificação" } }, "cnh": "CNH precisa ser um texto, CNH precisa ter 50 caracteres", "birthday": "Data de Nascimento precisa ser data e hora (Y-m-d H:i:s)", "phone": "Telefone precisa ter apenas dígitos, Telefone precisa ter 20 caracteres", "cnpjRepresented": "CNPJ Representado precisa ter apenas dígitos, CNPJ Representado precisa ter 20 caracteres", "cpfRepresented": "CPF Representado precisa ter apenas dígitos, CPF Representado precisa ter 11 caracteres", "nameRepresented": "Nome Representado precisa ser um texto, Nome Representado precisa ter 100 caracteres", "qualification": "Qualificação precisa ser um texto, Qualificação precisa ter 50 caracteres", "role": "Função precisa ser um texto, Função precisa ter 50 caracteres", "validityStart": "Data de Inicio de Validade precisa ser data e hora (Y-m-d H:i:s)", "validityEnd": "Data Final de Validade precisa ser data e hora (Y-m-d H:i:s)", "timeInForecast": "Previsão de Hora de Entrada precisa ser data e hora (Y-m-d H:i:s)", "timeOutForecast": "Previsão de Hora de Saida precisa ser data e hora (Y-m-d H:i:s)", "areas": "Areas de Acesso precisa ser um texto, Areas de Acesso precisa ter 50 caracteres", "workingToolsDescription": "Materiais e Ferramentas de Trabalho precisa ser um texto, Materiais e Ferramentas de Trabalho precisa ter 100 caracteres", "enabled": "Credenciamento Ativo precisa ser verdadeiro ou falso, Credenciamento Ativo é obrigatório", "reason": "Motivação do Credenciamento precisa ser um texto, Motivação do Credenciamento precisa ter 100 caracteres" } } } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Credenciamento de Pessoas", "type": "@OneOf", "schema": { "id": "Código", "message": "Mensagem" } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

credenciamento-pessoas/delete/:credenciamento-pessoas-id

Deletar Credenciamento de Pessoas

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

credenciamento-pessoas/edit/:credenciamento-pessoas-id

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

POST
http://cftv.barradorio.com.br:8080/api/credenciamento-pessoas/edit/:credenciamento-pessoas-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [credenciamentoPessoas.credenciamentoPessoas.edit]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
URI Input
{ "description": "Registro do(a) Credenciamento de Pessoas", "type": "@OneOf", "schema": { "credenciamento-pessoas-id": "Código" } }
Body Input
{ "description": "Registro do(a) Credenciamento de Pessoas", "type": "@OneOf", "schema": { "credenciamentoPessoas": { "description": "Credenciamento de Pessoas", "type": "@OneOf", "schema": { "branch": { "description": "Credenciamento 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", "foreignDocumentNumber": "Documento Estrangeiro - Número precisa ser um texto, Documento Estrangeiro - Número precisa ter 50 caracteres", "foreignDocumentCountry": "Documento Estrangeiro - País (SIGLA) precisa ser um texto, Documento Estrangeiro - País (SIGLA) precisa ter 2 caracteres", "foreignDocumentType": { "description": "Credenciamento de Pessoas", "type": "@OneOf", "schema": { "id": "Identificação" } }, "foreignDocumentValidity": "Documento Estrangeiro - Validade precisa ser data e hora (Y-m-d H:i:s)", "name": "Nome precisa ser um texto, Nome é obrigatório, Nome precisa ter 100 caracteres", "country": "País (SIGLA) precisa ser um texto, País (SIGLA) precisa ter 2 caracteres", "genre": { "description": "Credenciamento de Pessoas", "type": "@OneOf", "schema": { "id": "Identificação" } }, "cnh": "CNH precisa ser um texto, CNH precisa ter 50 caracteres", "birthday": "Data de Nascimento precisa ser data e hora (Y-m-d H:i:s)", "phone": "Telefone precisa ter apenas dígitos, Telefone precisa ter 20 caracteres", "cnpjRepresented": "CNPJ Representado precisa ter apenas dígitos, CNPJ Representado precisa ter 20 caracteres", "cpfRepresented": "CPF Representado precisa ter apenas dígitos, CPF Representado precisa ter 11 caracteres", "nameRepresented": "Nome Representado precisa ser um texto, Nome Representado precisa ter 100 caracteres", "qualification": "Qualificação precisa ser um texto, Qualificação precisa ter 50 caracteres", "role": "Função precisa ser um texto, Função precisa ter 50 caracteres", "validityStart": "Data de Inicio de Validade precisa ser data e hora (Y-m-d H:i:s)", "validityEnd": "Data Final de Validade precisa ser data e hora (Y-m-d H:i:s)", "timeInForecast": "Previsão de Hora de Entrada precisa ser data e hora (Y-m-d H:i:s)", "timeOutForecast": "Previsão de Hora de Saida precisa ser data e hora (Y-m-d H:i:s)", "areas": "Areas de Acesso precisa ser um texto, Areas de Acesso precisa ter 50 caracteres", "workingToolsDescription": "Materiais e Ferramentas de Trabalho precisa ser um texto, Materiais e Ferramentas de Trabalho precisa ter 100 caracteres", "enabled": "Credenciamento Ativo precisa ser verdadeiro ou falso, Credenciamento Ativo é obrigatório", "reason": "Motivação do Credenciamento precisa ser um texto, Motivação do Credenciamento precisa ter 100 caracteres" } } } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Credenciamento de Pessoas", "type": "@OneOf", "schema": { "id": "Código", "message": "Mensagem" } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

credenciamento-pessoas/get/:credenciamento-pessoas-id

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

GET
http://cftv.barradorio.com.br:8080/api/credenciamento-pessoas/get/:credenciamento-pessoas-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [credenciamentoPessoas.credenciamentoPessoas.read]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
URI Input
{ "description": "Registro do(a) Credenciamento de Pessoas", "type": "@OneOf", "schema": { "credenciamento-pessoas-id": "Código" } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Credenciamento de Pessoas", "type": "@OneOf", "schema": { "credenciamentoPessoas": { "description": "Credenciamento de Pessoas", "type": "@OneOf", "schema": { "id": "Código", "created": "Data de Cadastro", "updated": "Data de Atualização", "integrationStatus": { "description": "Credenciamento de Pessoas", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "branch": { "description": "Credenciamento 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", "foreignDocumentNumber": "Documento Estrangeiro - Número", "foreignDocumentCountry": "Documento Estrangeiro - País (SIGLA)", "foreignDocumentType": { "description": "Credenciamento de Pessoas", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "foreignDocumentValidity": "Documento Estrangeiro - Validade", "name": "Nome", "country": "País (SIGLA)", "genre": { "description": "Credenciamento de Pessoas", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "cnh": "CNH", "birthday": "Data de Nascimento", "phone": "Telefone", "cnpjRepresented": "CNPJ Representado", "cpfRepresented": "CPF Representado", "nameRepresented": "Nome Representado", "qualification": "Qualificação", "role": "Função", "validityStart": "Data de Inicio de Validade", "validityEnd": "Data Final de Validade", "timeInForecast": "Previsão de Hora de Entrada", "timeOutForecast": "Previsão de Hora de Saida", "areas": "Areas de Acesso", "workingToolsDescription": "Materiais e Ferramentas de Trabalho", "enabled": "Credenciamento Ativo", "reason": "Motivação do Credenciamento", "credenciamentoPessoasIntegration": { "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