Pesagem de Veículo/Carga
pesagem-veiculo-carga/audit/:pesagem-veiculo-carga-id
Obter informações de interações no registro de Pesagem de Veículo/Carga
GET
http://cftv.barradorio.com.br:8080/api/pesagem-veiculo-carga/audit/:pesagem-veiculo-carga-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [pesagemVeiculoCarga.pesagemVeiculoCarga.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Pesagem de Veículo\/Carga",
"type": "@OneOf",
"schema": {
"pesagem-veiculo-carga-id": "Código"
}
}
Query Input
{
"description": "Registro do(a) Pesagem de 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) Pesagem de Veículo\/Carga",
"type": "@OneOf",
"schema": {
"pesagemVeiculoCargaAudits": {
"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
pesagem-veiculo-carga/collection
Coleção de Pesagem de Veículo/Carga com informações resumidas e possibilidade de filtro
GET
http://cftv.barradorio.com.br:8080/api/pesagem-veiculo-carga/collection
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [pesagemVeiculoCarga.pesagemVeiculoCarga.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Registro do(a) Pesagem de Veículo\/Carga",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100.",
"order-by": "Atributo de Ordenação. pesagemVeiculoCarga.id, pesagemVeiculoCarga.created, pesagemVeiculoCarga.updated, integrationStatus.name, branch.name, pesagemVeiculoCarga.internalKey, pesagemVeiculoCarga.occurrence, pesagemVeiculoCarga.operatorCpf, pesagemVeiculoCarga.responseProtocol, ductsType.name, accessDirection.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-ductsType-id": "Duto",
"filter-conveyorBelts-id": "Correias Transportadoras"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Pesagem de Veículo\/Carga",
"type": "@OneOf",
"schema": {
"pesagemVeiculoCargas": {
"description": "Pesagem de Veículo\/Carga",
"type": "@ManyOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"deleted": "Data de Deleçao",
"integrationStatus": {
"description": "Pesagem de Veículo\/Carga",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"branch": {
"description": "Pesagem de 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",
"ductsType": {
"description": "Pesagem de Veículo\/Carga",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"conveyorBelts": {
"description": "Pesagem de Veículo\/Carga",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
}
}
},
"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
pesagem-veiculo-carga/create
Criar um(a) Pesagem de Veículo/Carga. Enviar imediatamente após a pesagem. Um envio por unidade de carga pesada. Usar este evento também nos casos em que a pesagem for efetuada em equipamentos de movimentação de Contêineres (RTG, etc) e, neste caso, não informar placas (veículos e semirreboques) e nem taras do conjunto transportador. Caso a pesagem aconteça via Portainer ou balança de fluxo na operação de embarque/desembarque navio, informar o peso aferido no evento Embarque/Desembarque Navio. No caso de granel que ingressar ou sair do recinto via dutos, transmitir o presente evento com a soma das bateladas da balança de fluxo ao final da operação.
POST
http://cftv.barradorio.com.br:8080/api/pesagem-veiculo-carga/create
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [pesagemVeiculoCarga.pesagemVeiculoCarga.create]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Body Input
{
"description": "Registro do(a) Pesagem de Veículo\/Carga",
"type": "@OneOf",
"schema": {
"pesagemVeiculoCarga": {
"description": "Pesagem de Veículo\/Carga",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Pesagem de Veículo\/Carga",
"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",
"grossWeightManifest": "Peso Bruto do Manifesto precisa ser um número decimal",
"plate": "Placa do Veículo precisa ser um texto, Placa do Veículo é obrigatório, Placa do Veículo precisa ter 50 caracteres",
"plateByOcr": "Captura da Placa via OCR precisa ser verdadeiro ou falso, Captura da Placa via OCR é obrigatório",
"tara": "Tara do Veículo precisa ser um número decimal",
"taraSet": "Tara do Conjunto (Quando a Tara NÃO é Aferida Separadamente ) precisa ser um número decimal",
"grossWeightScale": "Peso Bruto na Balança precisa ser um número decimal",
"empty": "Vazio precisa ser verdadeiro ou falso",
"autoWeightCapture": "Captura Automática de Peso precisa ser verdadeiro ou falso",
"ductsType": {
"description": "Pesagem de Veículo\/Carga",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"conveyorBelts": {
"description": "Pesagem de Veículo\/Carga",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"ncm": "NCM da Mercadoria precisa ser um texto, NCM da Mercadoria precisa ter 8 caracteres",
"volume": "Volume precisa ser um número decimal",
"georreferenciamentoBalanca": {
"description": "Pesagem de Veículo\/Carga",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"pesagemVeiculoCargaConhecimento": {
"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"
}
}
}
},
"pesagemVeiculoCargaListaNfe": {
"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"
}
},
"pesagemVeiculoCargaSemitrailer": {
"description": "Semirreboque",
"type": "@ManyOf",
"schema": {
"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, Captura da Placa via OCR é obrigatório",
"tara": "Tara do Veículo precisa ser um número decimal"
}
},
"pesagemVeiculoCargaContainersUld": {
"description": "Containers ULD",
"type": "@ManyOf",
"schema": {
"containerNumber": "Número do Container precisa ser um texto, Número do Container é obrigatório, Número do Container precisa ter 200 caracteres",
"containerNumberByOcr": "Captura da Container via OCR precisa ser verdadeiro ou falso, Captura da Container via OCR é obrigatório",
"containerType": {
"description": "Containers ULD",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"uld": "ULD precisa ser um texto, ULD é obrigatório, ULD precisa ter 10 caracteres",
"tara": "Tara do Veículo precisa ser um número decimal"
}
},
"pesagemVeiculoCargaCamera": {
"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) Pesagem de Veículo\/Carga",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pesagem-veiculo-carga/delete/:pesagem-veiculo-carga-id
Deletar Pesagem de Veículo/Carga
DELETE
http://cftv.barradorio.com.br:8080/api/pesagem-veiculo-carga/delete/:pesagem-veiculo-carga-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [pesagemVeiculoCarga.pesagemVeiculoCarga.delete]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Pesagem de Veículo\/Carga",
"type": "@OneOf",
"schema": {
"pesagem-veiculo-carga-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Pesagem de Veículo\/Carga",
"type": "@OneOf",
"schema": {
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pesagem-veiculo-carga/edit/:pesagem-veiculo-carga-id
Editar um(a) Pesagem de Veículo/Carga. Enviar imediatamente após a pesagem. Um envio por unidade de carga pesada. Usar este evento também nos casos em que a pesagem for efetuada em equipamentos de movimentação de Contêineres (RTG, etc) e, neste caso, não informar placas (veículos e semirreboques) e nem taras do conjunto transportador. Caso a pesagem aconteça via Portainer ou balança de fluxo na operação de embarque/desembarque navio, informar o peso aferido no evento Embarque/Desembarque Navio. No caso de granel que ingressar ou sair do recinto via dutos, transmitir o presente evento com a soma das bateladas da balança de fluxo ao final da operação.
POST
http://cftv.barradorio.com.br:8080/api/pesagem-veiculo-carga/edit/:pesagem-veiculo-carga-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [pesagemVeiculoCarga.pesagemVeiculoCarga.edit]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Pesagem de Veículo\/Carga",
"type": "@OneOf",
"schema": {
"pesagem-veiculo-carga-id": "Código"
}
}
Body Input
{
"description": "Registro do(a) Pesagem de Veículo\/Carga",
"type": "@OneOf",
"schema": {
"pesagemVeiculoCarga": {
"description": "Pesagem de Veículo\/Carga",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Pesagem de Veículo\/Carga",
"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",
"grossWeightManifest": "Peso Bruto do Manifesto precisa ser um número decimal",
"plate": "Placa do Veículo precisa ser um texto, Placa do Veículo é obrigatório, Placa do Veículo precisa ter 50 caracteres",
"plateByOcr": "Captura da Placa via OCR precisa ser verdadeiro ou falso, Captura da Placa via OCR é obrigatório",
"tara": "Tara do Veículo precisa ser um número decimal",
"taraSet": "Tara do Conjunto (Quando a Tara NÃO é Aferida Separadamente ) precisa ser um número decimal",
"grossWeightScale": "Peso Bruto na Balança precisa ser um número decimal",
"empty": "Vazio precisa ser verdadeiro ou falso",
"autoWeightCapture": "Captura Automática de Peso precisa ser verdadeiro ou falso",
"ductsType": {
"description": "Pesagem de Veículo\/Carga",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"conveyorBelts": {
"description": "Pesagem de Veículo\/Carga",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"ncm": "NCM da Mercadoria precisa ser um texto, NCM da Mercadoria precisa ter 8 caracteres",
"volume": "Volume precisa ser um número decimal",
"georreferenciamentoBalanca": {
"description": "Pesagem de Veículo\/Carga",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"pesagemVeiculoCargaConhecimento": {
"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"
}
}
}
},
"pesagemVeiculoCargaListaNfe": {
"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"
}
},
"pesagemVeiculoCargaSemitrailer": {
"description": "Semirreboque",
"type": "@ManyOf",
"schema": {
"id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente",
"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, Captura da Placa via OCR é obrigatório",
"tara": "Tara do Veículo precisa ser um número decimal"
}
},
"pesagemVeiculoCargaContainersUld": {
"description": "Containers ULD",
"type": "@ManyOf",
"schema": {
"id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente",
"containerNumber": "Número do Container precisa ser um texto, Número do Container é obrigatório, Número do Container precisa ter 200 caracteres",
"containerNumberByOcr": "Captura da Container via OCR precisa ser verdadeiro ou falso, Captura da Container via OCR é obrigatório",
"containerType": {
"description": "Containers ULD",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"uld": "ULD precisa ser um texto, ULD é obrigatório, ULD precisa ter 10 caracteres",
"tara": "Tara do Veículo precisa ser um número decimal"
}
},
"pesagemVeiculoCargaCamera": {
"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) Pesagem de Veículo\/Carga",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pesagem-veiculo-carga/get/:pesagem-veiculo-carga-id
Obter Pesagem de Veículo/Carga com todos os detalhes de suas informações
GET
http://cftv.barradorio.com.br:8080/api/pesagem-veiculo-carga/get/:pesagem-veiculo-carga-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [pesagemVeiculoCarga.pesagemVeiculoCarga.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Pesagem de Veículo\/Carga",
"type": "@OneOf",
"schema": {
"pesagem-veiculo-carga-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Pesagem de Veículo\/Carga",
"type": "@OneOf",
"schema": {
"pesagemVeiculoCarga": {
"description": "Pesagem de Veículo\/Carga",
"type": "@OneOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"deleted": "Data de Deleçao",
"integrationStatus": {
"description": "Pesagem de Veículo\/Carga",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"branch": {
"description": "Pesagem de 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",
"grossWeightManifest": "Peso Bruto do Manifesto",
"plate": "Placa do Veículo",
"plateByOcr": "Captura da Placa via OCR",
"tara": "Tara do Veículo",
"taraSet": "Tara do Conjunto (Quando a Tara NÃO é Aferida Separadamente )",
"grossWeightScale": "Peso Bruto na Balança",
"empty": "Vazio",
"autoWeightCapture": "Captura Automática de Peso",
"ductsType": {
"description": "Pesagem de Veículo\/Carga",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"conveyorBelts": {
"description": "Pesagem de Veículo\/Carga",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"ncm": "NCM da Mercadoria",
"volume": "Volume",
"georreferenciamentoBalanca": {
"description": "Pesagem de Veículo\/Carga",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"pesagemVeiculoCargaConhecimento": {
"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"
}
}
}
},
"pesagemVeiculoCargaListaNfe": {
"description": "NF-e",
"type": "@ManyOf",
"schema": {
"id": "Código",
"number": "Número da Chave NF-e"
}
},
"pesagemVeiculoCargaSemitrailer": {
"description": "Semirreboque",
"type": "@ManyOf",
"schema": {
"id": "Código",
"plate": "Placa",
"plateByOcr": "Captura da Placa via OCR",
"tara": "Tara do Veículo"
}
},
"pesagemVeiculoCargaContainersUld": {
"description": "Containers ULD",
"type": "@ManyOf",
"schema": {
"id": "Código",
"containerNumber": "Número do Container",
"containerNumberByOcr": "Captura da Container via OCR",
"containerType": {
"description": "Containers ULD",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"uld": "ULD",
"tara": "Tara do Veículo"
}
},
"pesagemVeiculoCargaCamera": {
"description": "Cameras",
"type": "@ManyOf",
"schema": {
"id": "Código",
"georreferenciamentoCamera": {
"description": "Cameras",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
}
}
},
"pesagemVeiculoCargaIntegration": {
"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