Bloqueio/Desbloqueio Veículo/Carga

bloqueio-veiculo-carga/audit/:bloqueio-veiculo-carga-id

Obter informações de interações no registro de Bloqueio/Desbloqueio Veículo/Carga

GET
http://cftv.barradorio.com.br:8080/api/bloqueio-veiculo-carga/audit/:bloqueio-veiculo-carga-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [bloqueioVeiculoCarga.bloqueioVeiculoCarga.read]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
URI Input
{ "description": "Registro do(a) Bloqueio\/Desbloqueio Veículo\/Carga", "type": "@OneOf", "schema": { "bloqueio-veiculo-carga-id": "Código" } }
Query Input
{ "description": "Registro do(a) Bloqueio\/Desbloqueio Veículo\/Carga", "type": "@OneOf", "schema": { "page": "Página", "pagination": "Paginação. Máximo 100." } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Bloqueio\/Desbloqueio Veículo\/Carga", "type": "@OneOf", "schema": { "bloqueioVeiculoCargaAudits": { "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

bloqueio-veiculo-carga/collection

Coleção de Bloqueio/Desbloqueio Veículo/Carga com informações resumidas e possibilidade de filtro

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

bloqueio-veiculo-carga/create

Criar um(a) Bloqueio/Desbloqueio Veículo/Carga. Um evento para cada bloqueio/desbloqueio de carga solicitado/efetuado diretamente no sistema do recinto. Não se trata do bloqueio no sistema Carga e/ou CCT. Transmitir imediatamente após o bloqueio

POST
http://cftv.barradorio.com.br:8080/api/bloqueio-veiculo-carga/create
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [bloqueioVeiculoCarga.bloqueioVeiculoCarga.create]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
Body Input
{ "description": "Registro do(a) Bloqueio\/Desbloqueio Veículo\/Carga", "type": "@OneOf", "schema": { "bloqueioVeiculoCarga": { "description": "Bloqueio\/Desbloqueio Veículo\/Carga", "type": "@OneOf", "schema": { "branch": { "description": "Bloqueio\/Desbloqueio Veículo\/Carga", "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", "blockStatus": { "description": "Bloqueio\/Desbloqueio Veículo\/Carga", "type": "@OneOf", "schema": { "id": "Identificação" } }, "numberManifest": "Número do Manifesto precisa ser um texto, Número do Manifesto precisa ter 100 caracteres", "typeManifest": { "description": "Bloqueio\/Desbloqueio Veículo\/Carga", "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": "Bloqueio\/Desbloqueio Veículo\/Carga", "type": "@OneOf", "schema": { "id": "Identificação" } }, "numberDeclaration": "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": "Bloqueio\/Desbloqueio Veículo\/Carga", "type": "@OneOf", "schema": { "id": "Identificação" } }, "plate": "Placa precisa ser um texto, Placa é obrigatório, Placa precisa ter 50 caracteres", "containerNumber": "Número do Container precisa ser um texto, Número do Container é obrigatório, Número do Container precisa ter 200 caracteres", "uld": "ULD precisa ser um texto, ULD é obrigatório, ULD precisa ter 10 caracteres", "requester": "Solicitante precisa ser um texto", "sector": "Setor precisa ser um texto, Setor precisa ter 100 caracteres", "reason": "Motivação precisa ser um texto, Motivação precisa ter 100 caracteres" } } } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Bloqueio\/Desbloqueio Veículo\/Carga", "type": "@OneOf", "schema": { "id": "Código", "message": "Mensagem" } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

bloqueio-veiculo-carga/delete/:bloqueio-veiculo-carga-id

Deletar Bloqueio/Desbloqueio Veículo/Carga

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

bloqueio-veiculo-carga/edit/:bloqueio-veiculo-carga-id

Editar um(a) Bloqueio/Desbloqueio Veículo/Carga. Um evento para cada bloqueio/desbloqueio de carga solicitado/efetuado diretamente no sistema do recinto. Não se trata do bloqueio no sistema Carga e/ou CCT. Transmitir imediatamente após o bloqueio

POST
http://cftv.barradorio.com.br:8080/api/bloqueio-veiculo-carga/edit/:bloqueio-veiculo-carga-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [bloqueioVeiculoCarga.bloqueioVeiculoCarga.edit]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
URI Input
{ "description": "Registro do(a) Bloqueio\/Desbloqueio Veículo\/Carga", "type": "@OneOf", "schema": { "bloqueio-veiculo-carga-id": "Código" } }
Body Input
{ "description": "Registro do(a) Bloqueio\/Desbloqueio Veículo\/Carga", "type": "@OneOf", "schema": { "bloqueioVeiculoCarga": { "description": "Bloqueio\/Desbloqueio Veículo\/Carga", "type": "@OneOf", "schema": { "branch": { "description": "Bloqueio\/Desbloqueio Veículo\/Carga", "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", "blockStatus": { "description": "Bloqueio\/Desbloqueio Veículo\/Carga", "type": "@OneOf", "schema": { "id": "Identificação" } }, "numberManifest": "Número do Manifesto precisa ser um texto, Número do Manifesto precisa ter 100 caracteres", "typeManifest": { "description": "Bloqueio\/Desbloqueio Veículo\/Carga", "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": "Bloqueio\/Desbloqueio Veículo\/Carga", "type": "@OneOf", "schema": { "id": "Identificação" } }, "numberDeclaration": "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": "Bloqueio\/Desbloqueio Veículo\/Carga", "type": "@OneOf", "schema": { "id": "Identificação" } }, "plate": "Placa precisa ser um texto, Placa é obrigatório, Placa precisa ter 50 caracteres", "containerNumber": "Número do Container precisa ser um texto, Número do Container é obrigatório, Número do Container precisa ter 200 caracteres", "uld": "ULD precisa ser um texto, ULD é obrigatório, ULD precisa ter 10 caracteres", "requester": "Solicitante precisa ser um texto", "sector": "Setor precisa ser um texto, Setor precisa ter 100 caracteres", "reason": "Motivação precisa ser um texto, Motivação precisa ter 100 caracteres" } } } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Bloqueio\/Desbloqueio Veículo\/Carga", "type": "@OneOf", "schema": { "id": "Código", "message": "Mensagem" } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

bloqueio-veiculo-carga/get/:bloqueio-veiculo-carga-id

Obter Bloqueio/Desbloqueio Veículo/Carga com todos os detalhes de suas informações

GET
http://cftv.barradorio.com.br:8080/api/bloqueio-veiculo-carga/get/:bloqueio-veiculo-carga-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [bloqueioVeiculoCarga.bloqueioVeiculoCarga.read]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
URI Input
{ "description": "Registro do(a) Bloqueio\/Desbloqueio Veículo\/Carga", "type": "@OneOf", "schema": { "bloqueio-veiculo-carga-id": "Código" } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Bloqueio\/Desbloqueio Veículo\/Carga", "type": "@OneOf", "schema": { "bloqueioVeiculoCarga": { "description": "Bloqueio\/Desbloqueio Veículo\/Carga", "type": "@OneOf", "schema": { "id": "Código", "created": "Data de Cadastro", "updated": "Data de Atualização", "integrationStatus": { "description": "Bloqueio\/Desbloqueio Veículo\/Carga", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "branch": { "description": "Bloqueio\/Desbloqueio Veículo\/Carga", "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", "blockStatus": { "description": "Bloqueio\/Desbloqueio Veículo\/Carga", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "numberManifest": "Número do Manifesto", "typeManifest": { "description": "Bloqueio\/Desbloqueio Veículo\/Carga", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "number": "Número do Conhecimento", "numberMawb": "Número do Conhecimento Master", "typeLading": { "description": "Bloqueio\/Desbloqueio Veículo\/Carga", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "numberDeclaration": "Número da Declaração", "typeCustomsDeclaration": { "description": "Bloqueio\/Desbloqueio Veículo\/Carga", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "plate": "Placa", "containerNumber": "Número do Container", "uld": "ULD", "requester": "Solicitante", "sector": "Setor", "reason": "Motivação", "bloqueioVeiculoCargaIntegration": { "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