Agendamento de Acesso de Veículos

agenda-acesso-veiculos/audit/:agenda-acesso-veiculos-id

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

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

agenda-acesso-veiculos/collection

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

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

agenda-acesso-veiculos/create

Criar um(a) Agendamento de Acesso de Veículos. Enviar imediatamente após o agendamento de previsão de acesso 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/agenda-acesso-veiculos/create
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [agendaAcessoVeiculos.agendaAcessoVeiculos.create]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
Body Input
{ "description": "Registro do(a) Agendamento de Acesso de Veículos", "type": "@OneOf", "schema": { "agendaAcessoVeiculos": { "description": "Agendamento de Acesso de Veículos", "type": "@OneOf", "schema": { "branch": { "description": "Agendamento de Acesso de Veículos", "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", "accessDirection": { "description": "Agendamento de Acesso de Veículos", "type": "@OneOf", "schema": { "id": "Identificação" } }, "datatimeSchedule": "Data\/Hora de Agendamento precisa ser data e hora (Y-m-d H:i:s), Data\/Hora de Agendamento é obrigatório", "bulkType": { "description": "Agendamento de Acesso de Veículos", "type": "@OneOf", "schema": { "id": "Identificação" } }, "plate": "Placa precisa ser um texto, Placa é obrigatório, Placa precisa ter 50 caracteres", "plateByOcr": "Captura da Placa via OCR precisa ser verdadeiro ou falso", "districtPlate": "UF Emplacamento precisa ser um texto, UF Emplacamento precisa ter 2 caracteres", "cnpjTransportador": "CNPJ da Transportador precisa ter apenas dígitos, CNPJ da Transportador precisa ter 14 caracteres", "nomeTransportador": "Nome do Transportador precisa ser um texto, Nome do Transportador precisa ter 100 caracteres", "cpfMotorista": "CPF do Motorista precisa ter apenas dígitos, CPF do Motorista precisa ter 11 caracteres", "nomeMotorista": "Nome do Motorista precisa ser um texto, Nome do Motorista precisa ter 100 caracteres", "puIdentityRelatedRecinto": "Código do Recinto para Destino na Saída e Origem na Entrada precisa ser um texto, Código do Recinto para Destino na Saída e Origem na Entrada é obrigatório, Código do Recinto para Destino na Saída e Origem na Entrada precisa ter 15 caracteres", "datetimeDeparture": "Data de Partida da Origem precisa ser data e hora (Y-m-d H:i:s)", "modalTransport": { "description": "Agendamento de Acesso de Veículos", "type": "@OneOf", "schema": { "id": "Identificação" } }, "georreferenciamentoGate": { "description": "Agendamento de Acesso de Veículos", "type": "@OneOf", "schema": { "id": "Identificação" } }, "agendaAcessoVeiculosListaConhecimento": { "description": "Conhecimentos", "type": "@ManyOf", "schema": { "numberManifest": "Número do Manifesto precisa ser um texto, Número do Manifesto precisa ter 100 caracteres", "typeManifest": { "description": "Conhecimentos", "type": "@OneOf", "schema": { "id": "Identificação" } }, "number": "Número do Conhecimento precisa ser um texto, Número do Conhecimento é obrigatório, Número do Conhecimento precisa ter 100 caracteres", "numberMawb": "Número do Conhecimento Master precisa ser um texto, Número do Conhecimento Master precisa ter 100 caracteres", "typeLading": { "description": "Conhecimentos", "type": "@OneOf", "schema": { "id": "Identificação" } } } }, "agendaAcessoVeiculosListaDeclaracaoAduaneira": { "description": "Declarações Aduaneiras", "type": "@ManyOf", "schema": { "number": "Número da Declaração precisa ser um texto, Número da Declaração é obrigatório, Número da Declaração precisa ter 100 caracteres", "typeCustomsDeclaration": { "description": "Declarações Aduaneiras", "type": "@OneOf", "schema": { "id": "Identificação" } } } }, "agendaAcessoVeiculosListaNfe": { "description": "NF-e", "type": "@ManyOf", "schema": { "number": "Número da Chave NF-e precisa ser um texto, Número da Chave NF-e é obrigatório, Número da Chave NF-e precisa ter 100 caracteres" } }, "agendaAcessoVeiculosListaMalas": { "description": "Malas", "type": "@ManyOf", "schema": { "number": "Número da Mala precisa ser um texto, Número da Mala é obrigatório, Número da Mala precisa ter 100 caracteres" } }, "agendaAcessoVeiculosListaChassi": { "description": "Chassi", "type": "@ManyOf", "schema": { "number": "Número do Chassi precisa ser um texto, Número do Chassi é obrigatório, Número do Chassi precisa ter 50 caracteres" } }, "agendaAcessoVeiculosCamera": { "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) Agendamento de Acesso de Veículos", "type": "@OneOf", "schema": { "id": "Código", "message": "Mensagem" } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

agenda-acesso-veiculos/delete/:agenda-acesso-veiculos-id

Deletar Agendamento de Acesso de Veículos

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

agenda-acesso-veiculos/edit/:agenda-acesso-veiculos-id

Editar um(a) Agendamento de Acesso de Veículos. Enviar imediatamente após o agendamento de previsão de acesso 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/agenda-acesso-veiculos/edit/:agenda-acesso-veiculos-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [agendaAcessoVeiculos.agendaAcessoVeiculos.edit]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
URI Input
{ "description": "Registro do(a) Agendamento de Acesso de Veículos", "type": "@OneOf", "schema": { "agenda-acesso-veiculos-id": "Código" } }
Body Input
{ "description": "Registro do(a) Agendamento de Acesso de Veículos", "type": "@OneOf", "schema": { "agendaAcessoVeiculos": { "description": "Agendamento de Acesso de Veículos", "type": "@OneOf", "schema": { "branch": { "description": "Agendamento de Acesso de Veículos", "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", "accessDirection": { "description": "Agendamento de Acesso de Veículos", "type": "@OneOf", "schema": { "id": "Identificação" } }, "datatimeSchedule": "Data\/Hora de Agendamento precisa ser data e hora (Y-m-d H:i:s), Data\/Hora de Agendamento é obrigatório", "bulkType": { "description": "Agendamento de Acesso de Veículos", "type": "@OneOf", "schema": { "id": "Identificação" } }, "plate": "Placa precisa ser um texto, Placa é obrigatório, Placa precisa ter 50 caracteres", "plateByOcr": "Captura da Placa via OCR precisa ser verdadeiro ou falso", "districtPlate": "UF Emplacamento precisa ser um texto, UF Emplacamento precisa ter 2 caracteres", "cnpjTransportador": "CNPJ da Transportador precisa ter apenas dígitos, CNPJ da Transportador precisa ter 14 caracteres", "nomeTransportador": "Nome do Transportador precisa ser um texto, Nome do Transportador precisa ter 100 caracteres", "cpfMotorista": "CPF do Motorista precisa ter apenas dígitos, CPF do Motorista precisa ter 11 caracteres", "nomeMotorista": "Nome do Motorista precisa ser um texto, Nome do Motorista precisa ter 100 caracteres", "puIdentityRelatedRecinto": "Código do Recinto para Destino na Saída e Origem na Entrada precisa ser um texto, Código do Recinto para Destino na Saída e Origem na Entrada é obrigatório, Código do Recinto para Destino na Saída e Origem na Entrada precisa ter 15 caracteres", "datetimeDeparture": "Data de Partida da Origem precisa ser data e hora (Y-m-d H:i:s)", "modalTransport": { "description": "Agendamento de Acesso de Veículos", "type": "@OneOf", "schema": { "id": "Identificação" } }, "georreferenciamentoGate": { "description": "Agendamento de Acesso de Veículos", "type": "@OneOf", "schema": { "id": "Identificação" } }, "agendaAcessoVeiculosListaConhecimento": { "description": "Conhecimentos", "type": "@ManyOf", "schema": { "id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente", "numberManifest": "Número do Manifesto precisa ser um texto, Número do Manifesto precisa ter 100 caracteres", "typeManifest": { "description": "Conhecimentos", "type": "@OneOf", "schema": { "id": "Identificação" } }, "number": "Número do Conhecimento precisa ser um texto, Número do Conhecimento é obrigatório, Número do Conhecimento precisa ter 100 caracteres", "numberMawb": "Número do Conhecimento Master precisa ser um texto, Número do Conhecimento Master precisa ter 100 caracteres", "typeLading": { "description": "Conhecimentos", "type": "@OneOf", "schema": { "id": "Identificação" } } } }, "agendaAcessoVeiculosListaDeclaracaoAduaneira": { "description": "Declarações Aduaneiras", "type": "@ManyOf", "schema": { "id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente", "number": "Número da Declaração precisa ser um texto, Número da Declaração é obrigatório, Número da Declaração precisa ter 100 caracteres", "typeCustomsDeclaration": { "description": "Declarações Aduaneiras", "type": "@OneOf", "schema": { "id": "Identificação" } } } }, "agendaAcessoVeiculosListaNfe": { "description": "NF-e", "type": "@ManyOf", "schema": { "id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente", "number": "Número da Chave NF-e precisa ser um texto, Número da Chave NF-e é obrigatório, Número da Chave NF-e precisa ter 100 caracteres" } }, "agendaAcessoVeiculosListaMalas": { "description": "Malas", "type": "@ManyOf", "schema": { "id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente", "number": "Número da Mala precisa ser um texto, Número da Mala é obrigatório, Número da Mala precisa ter 100 caracteres" } }, "agendaAcessoVeiculosListaChassi": { "description": "Chassi", "type": "@ManyOf", "schema": { "id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente", "number": "Número do Chassi precisa ser um texto, Número do Chassi é obrigatório, Número do Chassi precisa ter 50 caracteres" } }, "agendaAcessoVeiculosCamera": { "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) Agendamento de Acesso de Veículos", "type": "@OneOf", "schema": { "id": "Código", "message": "Mensagem" } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

agenda-acesso-veiculos/get/:agenda-acesso-veiculos-id

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

GET
http://cftv.barradorio.com.br:8080/api/agenda-acesso-veiculos/get/:agenda-acesso-veiculos-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [agendaAcessoVeiculos.agendaAcessoVeiculos.read]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
URI Input
{ "description": "Registro do(a) Agendamento de Acesso de Veículos", "type": "@OneOf", "schema": { "agenda-acesso-veiculos-id": "Código" } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Agendamento de Acesso de Veículos", "type": "@OneOf", "schema": { "agendaAcessoVeiculos": { "description": "Agendamento de Acesso de Veículos", "type": "@OneOf", "schema": { "id": "Código", "created": "Data de Cadastro", "updated": "Data de Atualização", "integrationStatus": { "description": "Agendamento de Acesso de Veículos", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "branch": { "description": "Agendamento de Acesso 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", "accessDirection": { "description": "Agendamento de Acesso de Veículos", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "datatimeSchedule": "Data\/Hora de Agendamento", "bulkType": { "description": "Agendamento de Acesso de Veículos", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "plate": "Placa", "plateByOcr": "Captura da Placa via OCR", "districtPlate": "UF Emplacamento", "cnpjTransportador": "CNPJ da Transportador", "nomeTransportador": "Nome do Transportador", "cpfMotorista": "CPF do Motorista", "nomeMotorista": "Nome do Motorista", "puIdentityRelatedRecinto": "Código do Recinto para Destino na Saída e Origem na Entrada", "datetimeDeparture": "Data de Partida da Origem", "modalTransport": { "description": "Agendamento de Acesso de Veículos", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "georreferenciamentoGate": { "description": "Agendamento de Acesso de Veículos", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "agendaAcessoVeiculosListaConhecimento": { "description": "Conhecimentos", "type": "@ManyOf", "schema": { "id": "Código", "numberManifest": "Número do Manifesto", "typeManifest": { "description": "Conhecimentos", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "number": "Número do Conhecimento", "numberMawb": "Número do Conhecimento Master", "typeLading": { "description": "Conhecimentos", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } } } }, "agendaAcessoVeiculosListaDeclaracaoAduaneira": { "description": "Declarações Aduaneiras", "type": "@ManyOf", "schema": { "id": "Código", "number": "Número da Declaração", "typeCustomsDeclaration": { "description": "Declarações Aduaneiras", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } } } }, "agendaAcessoVeiculosListaNfe": { "description": "NF-e", "type": "@ManyOf", "schema": { "id": "Código", "number": "Número da Chave NF-e" } }, "agendaAcessoVeiculosListaMalas": { "description": "Malas", "type": "@ManyOf", "schema": { "id": "Código", "number": "Número da Mala" } }, "agendaAcessoVeiculosListaChassi": { "description": "Chassi", "type": "@ManyOf", "schema": { "id": "Código", "number": "Número do Chassi" } }, "agendaAcessoVeiculosCamera": { "description": "Cameras", "type": "@ManyOf", "schema": { "id": "Código", "georreferenciamentoCamera": { "description": "Cameras", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } } } }, "agendaAcessoVeiculosIntegration": { "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