Credenciamento de Veículos

credenciamento-veiculos/audit/:credenciamento-veiculos-id

Obter informações de interações no registro de Credenciamento de Veículos

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

Coleção de Credenciamento de Veículos com informações resumidas e possibilidade de filtro

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

Criar um(a) Credenciamento de Veículos. Enviar imediatamente após o cadastramento de um veículo autorizado a entrada/saída do recinto. Um envio por veículo (PLACA).

POST
http://cftv.barradorio.com.br:8080/api/credenciamento-veiculos/create
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [credenciamentoVeiculos.credenciamentoVeiculos.create]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
Body Input
{ "description": "Registro do(a) Credenciamento de Veículos", "type": "@OneOf", "schema": { "credenciamentoVeiculos": { "description": "Credenciamento de Veículos", "type": "@OneOf", "schema": { "branch": { "description": "Credenciamento de Veículos", "type": "@OneOf", "schema": { "id": "Identificação" } }, "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", "foreignOperatorRepresented": "Operador Estrangeiro Representado precisa ser um texto, Operador Estrangeiro Representado precisa ter 50 caracteres", "foreignDocumentRepresentedNumber": "Documento Estrangeiro Representado - Número precisa ser um texto, Documento Estrangeiro Representado - Número precisa ter 50 caracteres", "foreignDocumentRepresentedCountry": "Documento Estrangeiro Representado - País (SIGLA) precisa ser um texto, Documento Estrangeiro Representado - País (SIGLA) precisa ter 2 caracteres", "foreignDocumentRepresentedType": { "description": "Credenciamento de Veículos", "type": "@OneOf", "schema": { "id": "Identificação" } }, "foreignDocumentRepresentedValidity": "Documento Estrangeiro Representado - Validade precisa ser data e hora (Y-m-d H:i:s)", "plate": "Placa precisa ser um texto, Placa é obrigatório, Placa precisa ter 50 caracteres", "brand": "Marca precisa ser um texto, Marca precisa ter 20 caracteres", "model": "Modelo precisa ser um texto, Modelo precisa ter 20 caracteres", "year": "Ano precisa ter apenas dígitos, Ano precisa ter 4 caracteres", "fuelCapacityLt": "Capacidade Combustível em Litros precisa ser um número, Capacidade Combustível em Litros precisa ter 4 caracteres", "satelliteMonitor": "Monitoramento via Satelite precisa ser verdadeiro ou falso, Monitoramento via Satelite é obrigatório", "cnpjRepresented": "CNPJ Responsável precisa ter apenas dígitos, CNPJ Responsável precisa ter 20 caracteres", "cpfRepresented": "CPF Responsável precisa ter apenas dígitos, CPF Responsável precisa ter 11 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 Saída precisa ser data e hora (Y-m-d H:i:s)", "areas": "Areas de Acesso precisa ser um texto, Areas de Acesso 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 Veículos", "type": "@OneOf", "schema": { "id": "Código", "message": "Mensagem" } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

credenciamento-veiculos/delete/:credenciamento-veiculos-id

Deletar Credenciamento de Veículos

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

credenciamento-veiculos/edit/:credenciamento-veiculos-id

Editar um(a) Credenciamento de Veículos. Enviar imediatamente após o cadastramento de um veículo autorizado a entrada/saída do recinto. Um envio por veículo (PLACA).

POST
http://cftv.barradorio.com.br:8080/api/credenciamento-veiculos/edit/:credenciamento-veiculos-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [credenciamentoVeiculos.credenciamentoVeiculos.edit]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
URI Input
{ "description": "Registro do(a) Credenciamento de Veículos", "type": "@OneOf", "schema": { "credenciamento-veiculos-id": "Código" } }
Body Input
{ "description": "Registro do(a) Credenciamento de Veículos", "type": "@OneOf", "schema": { "credenciamentoVeiculos": { "description": "Credenciamento de Veículos", "type": "@OneOf", "schema": { "branch": { "description": "Credenciamento de Veículos", "type": "@OneOf", "schema": { "id": "Identificação" } }, "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", "foreignOperatorRepresented": "Operador Estrangeiro Representado precisa ser um texto, Operador Estrangeiro Representado precisa ter 50 caracteres", "foreignDocumentRepresentedNumber": "Documento Estrangeiro Representado - Número precisa ser um texto, Documento Estrangeiro Representado - Número precisa ter 50 caracteres", "foreignDocumentRepresentedCountry": "Documento Estrangeiro Representado - País (SIGLA) precisa ser um texto, Documento Estrangeiro Representado - País (SIGLA) precisa ter 2 caracteres", "foreignDocumentRepresentedType": { "description": "Credenciamento de Veículos", "type": "@OneOf", "schema": { "id": "Identificação" } }, "foreignDocumentRepresentedValidity": "Documento Estrangeiro Representado - Validade precisa ser data e hora (Y-m-d H:i:s)", "plate": "Placa precisa ser um texto, Placa é obrigatório, Placa precisa ter 50 caracteres", "brand": "Marca precisa ser um texto, Marca precisa ter 20 caracteres", "model": "Modelo precisa ser um texto, Modelo precisa ter 20 caracteres", "year": "Ano precisa ter apenas dígitos, Ano precisa ter 4 caracteres", "fuelCapacityLt": "Capacidade Combustível em Litros precisa ser um número, Capacidade Combustível em Litros precisa ter 4 caracteres", "satelliteMonitor": "Monitoramento via Satelite precisa ser verdadeiro ou falso, Monitoramento via Satelite é obrigatório", "cnpjRepresented": "CNPJ Responsável precisa ter apenas dígitos, CNPJ Responsável precisa ter 20 caracteres", "cpfRepresented": "CPF Responsável precisa ter apenas dígitos, CPF Responsável precisa ter 11 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 Saída precisa ser data e hora (Y-m-d H:i:s)", "areas": "Areas de Acesso precisa ser um texto, Areas de Acesso 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 Veículos", "type": "@OneOf", "schema": { "id": "Código", "message": "Mensagem" } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

credenciamento-veiculos/get/:credenciamento-veiculos-id

Obter Credenciamento de Veículos com todos os detalhes de suas informações

GET
http://cftv.barradorio.com.br:8080/api/credenciamento-veiculos/get/:credenciamento-veiculos-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [credenciamentoVeiculos.credenciamentoVeiculos.read]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
URI Input
{ "description": "Registro do(a) Credenciamento de Veículos", "type": "@OneOf", "schema": { "credenciamento-veiculos-id": "Código" } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Credenciamento de Veículos", "type": "@OneOf", "schema": { "credenciamentoVeiculos": { "description": "Credenciamento de Veículos", "type": "@OneOf", "schema": { "id": "Código", "created": "Data de Cadastro", "updated": "Data de Atualização", "integrationStatus": { "description": "Credenciamento de Veículos", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "branch": { "description": "Credenciamento de Veículos", "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", "foreignOperatorRepresented": "Operador Estrangeiro Representado", "foreignDocumentRepresentedNumber": "Documento Estrangeiro Representado - Número", "foreignDocumentRepresentedCountry": "Documento Estrangeiro Representado - País (SIGLA)", "foreignDocumentRepresentedType": { "description": "Credenciamento de Veículos", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "foreignDocumentRepresentedValidity": "Documento Estrangeiro Representado - Validade", "plate": "Placa", "brand": "Marca", "model": "Modelo", "year": "Ano", "fuelCapacityLt": "Capacidade Combustível em Litros", "satelliteMonitor": "Monitoramento via Satelite", "cnpjRepresented": "CNPJ Responsável", "cpfRepresented": "CPF Responsável", "validityStart": "Data de Inicio de Validade", "validityEnd": "Data Final de Validade", "timeInForecast": "Previsão de Hora de Entrada", "timeOutForecast": "Previsão de Hora de Saída", "areas": "Areas de Acesso", "enabled": "Credenciamento Ativo", "reason": "Motivação do Credenciamento", "credenciamentoVeiculosIntegration": { "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