Carregamento de Lote
carregamento-lote/audit/:carregamento-lote-id
Obter informações de interações no registro de Carregamento de Lote
GET
http://cftv.barradorio.com.br:8080/api/carregamento-lote/audit/:carregamento-lote-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [carregamentoLote.carregamentoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Carregamento de Lote",
"type": "@OneOf",
"schema": {
"carregamento-lote-id": "Código"
}
}
Query Input
{
"description": "Registro do(a) Carregamento de Lote",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Carregamento de Lote",
"type": "@OneOf",
"schema": {
"carregamentoLoteAudits": {
"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
carregamento-lote/collection
Coleção de Carregamento de Lote com informações resumidas e possibilidade de filtro
GET
http://cftv.barradorio.com.br:8080/api/carregamento-lote/collection
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [carregamentoLote.carregamentoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Registro do(a) Carregamento de Lote",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100.",
"order-by": "Atributo de Ordenação. carregamentoLote.id, carregamentoLote.created, carregamentoLote.updated, integrationStatus.name, branch.name, carregamentoLote.internalKey, carregamentoLote.occurrence, carregamentoLote.operatorCpf, carregamentoLote.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) Carregamento de Lote",
"type": "@OneOf",
"schema": {
"carregamentoLotes": {
"description": "Carregamento de Lote",
"type": "@ManyOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"integrationStatus": {
"description": "Carregamento de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"branch": {
"description": "Carregamento de Lote",
"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
carregamento-lote/create
Criar um(a) Carregamento de Lote. Um evento para cada carregamento de lotes em unidade de carga – contêiner, caminhão, etc. Não considerar os movimentos do tipo house keeping, a exemplo do carregamento em caminhão para utilizar o scanner, casos em que a carga retorna, em pouco tempo, para a mesma posição.
POST
http://cftv.barradorio.com.br:8080/api/carregamento-lote/create
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [carregamentoLote.carregamentoLote.create]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Body Input
{
"description": "Registro do(a) Carregamento de Lote",
"type": "@OneOf",
"schema": {
"carregamentoLote": {
"description": "Carregamento de Lote",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Carregamento de Lote",
"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",
"numberManifest": "Número do Manifesto precisa ser um texto, Número do Manifesto precisa ter 100 caracteres",
"typeManifest": {
"description": "Carregamento de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"numberMawb": "Número do Conhecimento Master precisa ser um texto, Número do Conhecimento Master precisa ter 100 caracteres",
"number": "Número do Conhecimento precisa ser um texto, Número do Conhecimento precisa ter 100 caracteres",
"typeLading": {
"description": "Carregamento de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"numberDeclaration": "Número da Declaração precisa ser um texto, Número da Declaração precisa ter 100 caracteres",
"typeCustomsDeclaration": {
"description": "Carregamento de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"lossIndicator": "Indicador de Perdimento precisa ser verdadeiro ou falso",
"lossDocument": "Documento de Perdimento precisa ser um texto, Documento de Perdimento precisa ter 100 caracteres",
"quantityLotItems": "Quantidade de Volumes do Lote precisa ser um número, Quantidade de Volumes do Lote é obrigatório",
"georreferenciamentoAreaArmazenagem": {
"description": "Carregamento de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"plateSemitrailer": "Placa do Semirreboque precisa ser um texto, Placa do Semirreboque precisa ter 50 caracteres",
"containerNumber": "Número do Container precisa ser um texto, Número do Container precisa ter 200 caracteres",
"uld": "ULD precisa ser um texto, ULD precisa ter 10 caracteres",
"deliverAirline": "Entrega Para Companhia Aerea precisa ser verdadeiro ou falso",
"cnpjAirline": "CNPJ Companhia Aerea precisa ser um texto, CNPJ Companhia Aerea precisa ter 14 caracteres",
"nameAirline": "Nome Companhia Aerea precisa ser um texto, Nome Companhia Aerea precisa ter 100 caracteres",
"iataAirplate": "IATA da Aeronave precisa ser um texto, IATA da Aeronave precisa ter 50 caracteres",
"prefixAirplate": "Prefixo da Aeronave precisa ser um texto, Prefixo da Aeronave precisa ter 20 caracteres",
"travel": "Viagem precisa ser um texto, Viagem precisa ter 20 caracteres",
"flight": "Voo precisa ser um texto, Voo precisa ter 20 caracteres",
"stopover": "Escala precisa ser um texto, Escala precisa ter 20 caracteres",
"deliverPerson": "Entrega Para Pessoa Fisica precisa ser verdadeiro ou falso",
"deliverPersonDocument": "CPF da Pessoa Fisica precisa ser um texto, CPF da Pessoa Fisica precisa ter 11 caracteres",
"deliverPersonForeignDocument": "Estrangeiro - Documento precisa ser um texto, Estrangeiro - Documento precisa ter 11 caracteres",
"deliverPersonForeignCountry": "Estrangeiro - País (SIGLA) precisa ser um texto, Estrangeiro - País (SIGLA) precisa ter 2 caracteres",
"deliverPersonForeignDocumentType": {
"description": "Carregamento de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"deliverPersonForeignDocumentExpire": "Estrangeiro - Validade precisa ser data e hora (Y-m-d H:i:s)",
"carregamentoLoteListaNfe": {
"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"
}
},
"carregamentoLoteListaLotes": {
"description": "Lotes",
"type": "@ManyOf",
"schema": {
"lotNumber": "Numero do Lote precisa ser um texto, Numero do Lote é obrigatório, Numero do Lote precisa ter 100 caracteres"
}
},
"carregamentoLoteCamera": {
"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) Carregamento de Lote",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
carregamento-lote/delete/:carregamento-lote-id
Deletar Carregamento de Lote
DELETE
http://cftv.barradorio.com.br:8080/api/carregamento-lote/delete/:carregamento-lote-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [carregamentoLote.carregamentoLote.delete]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Carregamento de Lote",
"type": "@OneOf",
"schema": {
"carregamento-lote-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Carregamento de Lote",
"type": "@OneOf",
"schema": {
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
carregamento-lote/edit/:carregamento-lote-id
Editar um(a) Carregamento de Lote. Um evento para cada carregamento de lotes em unidade de carga – contêiner, caminhão, etc. Não considerar os movimentos do tipo house keeping, a exemplo do carregamento em caminhão para utilizar o scanner, casos em que a carga retorna, em pouco tempo, para a mesma posição.
POST
http://cftv.barradorio.com.br:8080/api/carregamento-lote/edit/:carregamento-lote-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [carregamentoLote.carregamentoLote.edit]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Carregamento de Lote",
"type": "@OneOf",
"schema": {
"carregamento-lote-id": "Código"
}
}
Body Input
{
"description": "Registro do(a) Carregamento de Lote",
"type": "@OneOf",
"schema": {
"carregamentoLote": {
"description": "Carregamento de Lote",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Carregamento de Lote",
"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",
"numberManifest": "Número do Manifesto precisa ser um texto, Número do Manifesto precisa ter 100 caracteres",
"typeManifest": {
"description": "Carregamento de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"numberMawb": "Número do Conhecimento Master precisa ser um texto, Número do Conhecimento Master precisa ter 100 caracteres",
"number": "Número do Conhecimento precisa ser um texto, Número do Conhecimento precisa ter 100 caracteres",
"typeLading": {
"description": "Carregamento de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"numberDeclaration": "Número da Declaração precisa ser um texto, Número da Declaração precisa ter 100 caracteres",
"typeCustomsDeclaration": {
"description": "Carregamento de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"lossIndicator": "Indicador de Perdimento precisa ser verdadeiro ou falso",
"lossDocument": "Documento de Perdimento precisa ser um texto, Documento de Perdimento precisa ter 100 caracteres",
"quantityLotItems": "Quantidade de Volumes do Lote precisa ser um número, Quantidade de Volumes do Lote é obrigatório",
"georreferenciamentoAreaArmazenagem": {
"description": "Carregamento de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"plateSemitrailer": "Placa do Semirreboque precisa ser um texto, Placa do Semirreboque precisa ter 50 caracteres",
"containerNumber": "Número do Container precisa ser um texto, Número do Container precisa ter 200 caracteres",
"uld": "ULD precisa ser um texto, ULD precisa ter 10 caracteres",
"deliverAirline": "Entrega Para Companhia Aerea precisa ser verdadeiro ou falso",
"cnpjAirline": "CNPJ Companhia Aerea precisa ser um texto, CNPJ Companhia Aerea precisa ter 14 caracteres",
"nameAirline": "Nome Companhia Aerea precisa ser um texto, Nome Companhia Aerea precisa ter 100 caracteres",
"iataAirplate": "IATA da Aeronave precisa ser um texto, IATA da Aeronave precisa ter 50 caracteres",
"prefixAirplate": "Prefixo da Aeronave precisa ser um texto, Prefixo da Aeronave precisa ter 20 caracteres",
"travel": "Viagem precisa ser um texto, Viagem precisa ter 20 caracteres",
"flight": "Voo precisa ser um texto, Voo precisa ter 20 caracteres",
"stopover": "Escala precisa ser um texto, Escala precisa ter 20 caracteres",
"deliverPerson": "Entrega Para Pessoa Fisica precisa ser verdadeiro ou falso",
"deliverPersonDocument": "CPF da Pessoa Fisica precisa ser um texto, CPF da Pessoa Fisica precisa ter 11 caracteres",
"deliverPersonForeignDocument": "Estrangeiro - Documento precisa ser um texto, Estrangeiro - Documento precisa ter 11 caracteres",
"deliverPersonForeignCountry": "Estrangeiro - País (SIGLA) precisa ser um texto, Estrangeiro - País (SIGLA) precisa ter 2 caracteres",
"deliverPersonForeignDocumentType": {
"description": "Carregamento de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"deliverPersonForeignDocumentExpire": "Estrangeiro - Validade precisa ser data e hora (Y-m-d H:i:s)",
"carregamentoLoteListaNfe": {
"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"
}
},
"carregamentoLoteListaLotes": {
"description": "Lotes",
"type": "@ManyOf",
"schema": {
"id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente",
"lotNumber": "Numero do Lote precisa ser um texto, Numero do Lote é obrigatório, Numero do Lote precisa ter 100 caracteres"
}
},
"carregamentoLoteCamera": {
"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) Carregamento de Lote",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
carregamento-lote/get/:carregamento-lote-id
Obter Carregamento de Lote com todos os detalhes de suas informações
GET
http://cftv.barradorio.com.br:8080/api/carregamento-lote/get/:carregamento-lote-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [carregamentoLote.carregamentoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Carregamento de Lote",
"type": "@OneOf",
"schema": {
"carregamento-lote-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Carregamento de Lote",
"type": "@OneOf",
"schema": {
"carregamentoLote": {
"description": "Carregamento de Lote",
"type": "@OneOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"integrationStatus": {
"description": "Carregamento de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"branch": {
"description": "Carregamento de Lote",
"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",
"numberManifest": "Número do Manifesto",
"typeManifest": {
"description": "Carregamento de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"numberMawb": "Número do Conhecimento Master",
"number": "Número do Conhecimento",
"typeLading": {
"description": "Carregamento de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"numberDeclaration": "Número da Declaração",
"typeCustomsDeclaration": {
"description": "Carregamento de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"lossIndicator": "Indicador de Perdimento",
"lossDocument": "Documento de Perdimento",
"quantityLotItems": "Quantidade de Volumes do Lote",
"georreferenciamentoAreaArmazenagem": {
"description": "Carregamento de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"plateSemitrailer": "Placa do Semirreboque",
"containerNumber": "Número do Container",
"uld": "ULD",
"deliverAirline": "Entrega Para Companhia Aerea",
"cnpjAirline": "CNPJ Companhia Aerea",
"nameAirline": "Nome Companhia Aerea",
"iataAirplate": "IATA da Aeronave",
"prefixAirplate": "Prefixo da Aeronave",
"travel": "Viagem",
"flight": "Voo",
"stopover": "Escala",
"deliverPerson": "Entrega Para Pessoa Fisica",
"deliverPersonDocument": "CPF da Pessoa Fisica",
"deliverPersonForeignDocument": "Estrangeiro - Documento",
"deliverPersonForeignCountry": "Estrangeiro - País (SIGLA)",
"deliverPersonForeignDocumentType": {
"description": "Carregamento de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"deliverPersonForeignDocumentExpire": "Estrangeiro - Validade",
"carregamentoLoteListaNfe": {
"description": "NF-e",
"type": "@ManyOf",
"schema": {
"id": "Código",
"number": "Número da Chave NF-e"
}
},
"carregamentoLoteListaLotes": {
"description": "Lotes",
"type": "@ManyOf",
"schema": {
"id": "Código",
"lotNumber": "Numero do Lote"
}
},
"carregamentoLoteCamera": {
"description": "Cameras",
"type": "@ManyOf",
"schema": {
"id": "Código",
"georreferenciamentoCamera": {
"description": "Cameras",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
}
}
},
"carregamentoLoteIntegration": {
"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