Search ""
access-profile/audit/:access-profile-id
Obter informações de interações no registro de Perfil de Acesso
GET
http://cftv.barradorio.com.br:8080/api/access-profile/audit/:access-profile-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [accessProfile.accessProfile.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Perfil de Acesso",
"type": "@OneOf",
"schema": {
"access-profile-id": "Código"
}
}
Query Input
{
"description": "Registro do(a) Perfil de Acesso",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Perfil de Acesso",
"type": "@OneOf",
"schema": {
"accessProfileAudits": {
"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
access-profile/collection
Coleção de Perfil de Acesso com informações resumidas e possibilidade de filtro
GET
http://cftv.barradorio.com.br:8080/api/access-profile/collection
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [accessProfile.accessProfile.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Registro do(a) Perfil de Acesso",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100.",
"order-by": "Atributo de Ordenação. accessProfile.id, accessProfile.name",
"order-type": "Tipo de Ordenação no Atributo. ASC ou DESC. Padrão DESC",
"filter-id": "Código",
"filter-name-contains": "Nome"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Perfil de Acesso",
"type": "@OneOf",
"schema": {
"accessProfiles": {
"description": "Perfil de Acesso",
"type": "@ManyOf",
"schema": {
"id": "Código",
"name": "Nome"
}
},
"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
access-profile/create/options/access-profile-resource/resource
Opções de Recurso
GET
http://cftv.barradorio.com.br:8080/api/access-profile/create/options/access-profile-resource/resource
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [accessProfile.accessProfile.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Recurso",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
access-profile/create
Criar um(a) Perfil de Acesso
POST
http://cftv.barradorio.com.br:8080/api/access-profile/create
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [accessProfile.accessProfile.create]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Body Input
{
"description": "Registro do(a) Perfil de Acesso",
"type": "@OneOf",
"schema": {
"accessProfile": {
"description": "Perfil de Acesso",
"type": "@OneOf",
"schema": {
"name": "Nome precisa ser um texto, Nome é obrigatório, Nome precisa ter 120 caracteres",
"accessProfileResource": {
"description": "Recursos",
"type": "@ManyOf",
"schema": {
"resource": {
"description": "Recursos",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
}
}
}
}
}
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Perfil de Acesso",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
access-profile/delete/:access-profile-id
Deletar Perfil de Acesso
DELETE
http://cftv.barradorio.com.br:8080/api/access-profile/delete/:access-profile-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [accessProfile.accessProfile.delete]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Perfil de Acesso",
"type": "@OneOf",
"schema": {
"access-profile-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Perfil de Acesso",
"type": "@OneOf",
"schema": {
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
access-profile/edit/options/access-profile-resource/resource
Opções de Recurso
GET
http://cftv.barradorio.com.br:8080/api/access-profile/edit/options/access-profile-resource/resource
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [accessProfile.accessProfile.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Recurso",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
access-profile/edit/:access-profile-id
Editar um(a) Perfil de Acesso
POST
http://cftv.barradorio.com.br:8080/api/access-profile/edit/:access-profile-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [accessProfile.accessProfile.edit]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Perfil de Acesso",
"type": "@OneOf",
"schema": {
"access-profile-id": "Código"
}
}
Body Input
{
"description": "Registro do(a) Perfil de Acesso",
"type": "@OneOf",
"schema": {
"accessProfile": {
"description": "Perfil de Acesso",
"type": "@OneOf",
"schema": {
"name": "Nome precisa ser um texto, Nome é obrigatório, Nome precisa ter 120 caracteres",
"accessProfileResource": {
"description": "Recursos",
"type": "@ManyOf",
"schema": {
"id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente",
"resource": {
"description": "Recursos",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
}
}
}
}
}
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Perfil de Acesso",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
access-profile/get/:access-profile-id
Obter Perfil de Acesso com todos os detalhes de suas informações
GET
http://cftv.barradorio.com.br:8080/api/access-profile/get/:access-profile-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [accessProfile.accessProfile.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Perfil de Acesso",
"type": "@OneOf",
"schema": {
"access-profile-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Perfil de Acesso",
"type": "@OneOf",
"schema": {
"accessProfile": {
"description": "Perfil de Acesso",
"type": "@OneOf",
"schema": {
"id": "Código",
"name": "Nome",
"accessProfileResource": {
"description": "Recursos",
"type": "@ManyOf",
"schema": {
"id": "Código",
"resource": {
"description": "Recursos",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
}
}
}
}
}
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-pessoas/audit/:acesso-pessoas-id
Obter informações de interações no registro de Acesso de Pessoas
GET
http://cftv.barradorio.com.br:8080/api/acesso-pessoas/audit/:acesso-pessoas-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoPessoas.acessoPessoas.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Acesso de Pessoas",
"type": "@OneOf",
"schema": {
"acesso-pessoas-id": "Código"
}
}
Query Input
{
"description": "Registro do(a) Acesso de Pessoas",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Acesso de Pessoas",
"type": "@OneOf",
"schema": {
"acessoPessoasAudits": {
"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
acesso-pessoas/collection/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/acesso-pessoas/collection/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoPessoas.acessoPessoas.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-pessoas/collection/options/integration-status
Opções de Situação
GET
http://cftv.barradorio.com.br:8080/api/acesso-pessoas/collection/options/integration-status
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoPessoas.acessoPessoas.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Situação",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-pessoas/collection
Coleção de Acesso de Pessoas com informações resumidas e possibilidade de filtro
GET
http://cftv.barradorio.com.br:8080/api/acesso-pessoas/collection
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoPessoas.acessoPessoas.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Registro do(a) Acesso de Pessoas",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100.",
"order-by": "Atributo de Ordenação. acessoPessoas.id, acessoPessoas.created, acessoPessoas.updated, integrationStatus.name, branch.name, acessoPessoas.internalKey, acessoPessoas.occurrence, acessoPessoas.operatorCpf, acessoPessoas.responseProtocol, acessoPessoas.cpf, acessoPessoas.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-cpf-contains": "CPF",
"filter-name-contains": "Nome"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Acesso de Pessoas",
"type": "@OneOf",
"schema": {
"acessoPessoass": {
"description": "Acesso de Pessoas",
"type": "@ManyOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"integrationStatus": {
"description": "Acesso de Pessoas",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"branch": {
"description": "Acesso de Pessoas",
"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",
"cpf": "CPF",
"name": "Nome"
}
},
"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
acesso-pessoas/create/options/access-direction
Opções de Direção de Acesso
GET
http://cftv.barradorio.com.br:8080/api/acesso-pessoas/create/options/access-direction
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoPessoas.acessoPessoas.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Direção de Acesso",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-pessoas/create/options/access-identitication
Opções de Identificação de Acesso
GET
http://cftv.barradorio.com.br:8080/api/acesso-pessoas/create/options/access-identitication
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoPessoas.acessoPessoas.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Identificação de Acesso",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-pessoas/create/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/acesso-pessoas/create/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoPessoas.acessoPessoas.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-pessoas/create/options/acesso-pessoas-camera/georreferenciamento-camera
Opções de Camera em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/acesso-pessoas/create/options/acesso-pessoas-camera/georreferenciamento-camera
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoPessoas.acessoPessoas.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Camera em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-pessoas/create/options/georreferenciamento-catraca
Opções de Catraca em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/acesso-pessoas/create/options/georreferenciamento-catraca
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoPessoas.acessoPessoas.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Catraca em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-pessoas/create
Criar um(a) Acesso de Pessoas. Enviar imediatamente após o acesso de uma pessoa autorizado a entrada/saída do recinto. Um envio por pessoa (CPF).
POST
http://cftv.barradorio.com.br:8080/api/acesso-pessoas/create
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoPessoas.acessoPessoas.create]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Body Input
{
"description": "Registro do(a) Acesso de Pessoas",
"type": "@OneOf",
"schema": {
"acessoPessoas": {
"description": "Acesso de Pessoas",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Acesso de Pessoas",
"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",
"cpf": "CPF precisa ter apenas dígitos, CPF é obrigatório, CPF precisa ter 11 caracteres",
"name": "Nome precisa ser um texto, Nome é obrigatório, Nome precisa ter 100 caracteres",
"accessDirection": {
"description": "Acesso de Pessoas",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"accessIdentitication": {
"description": "Acesso de Pessoas",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"foreignDocument": "Identidade Estrangeiro precisa ser um texto, Identidade Estrangeiro precisa ter 50 caracteres",
"reservation": "Reserva de Passageiro precisa ser um texto, Reserva de Passageiro precisa ter 50 caracteres",
"flight": "Voo de Passageiro precisa ser um texto, Voo de Passageiro precisa ter 20 caracteres",
"georreferenciamentoCatraca": {
"description": "Acesso de Pessoas",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"acessoPessoasCamera": {
"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) Acesso de Pessoas",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-pessoas/delete/:acesso-pessoas-id
Deletar Acesso de Pessoas
DELETE
http://cftv.barradorio.com.br:8080/api/acesso-pessoas/delete/:acesso-pessoas-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoPessoas.acessoPessoas.delete]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Acesso de Pessoas",
"type": "@OneOf",
"schema": {
"acesso-pessoas-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Acesso de Pessoas",
"type": "@OneOf",
"schema": {
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-pessoas/edit/options/access-direction
Opções de Direção de Acesso
GET
http://cftv.barradorio.com.br:8080/api/acesso-pessoas/edit/options/access-direction
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoPessoas.acessoPessoas.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Direção de Acesso",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-pessoas/edit/options/access-identitication
Opções de Identificação de Acesso
GET
http://cftv.barradorio.com.br:8080/api/acesso-pessoas/edit/options/access-identitication
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoPessoas.acessoPessoas.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Identificação de Acesso",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-pessoas/edit/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/acesso-pessoas/edit/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoPessoas.acessoPessoas.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-pessoas/edit/options/acesso-pessoas-camera/georreferenciamento-camera
Opções de Camera em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/acesso-pessoas/edit/options/acesso-pessoas-camera/georreferenciamento-camera
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoPessoas.acessoPessoas.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Camera em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-pessoas/edit/options/georreferenciamento-catraca
Opções de Catraca em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/acesso-pessoas/edit/options/georreferenciamento-catraca
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoPessoas.acessoPessoas.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Catraca em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-pessoas/edit/:acesso-pessoas-id
Editar um(a) Acesso de Pessoas. Enviar imediatamente após o acesso de uma pessoa autorizado a entrada/saída do recinto. Um envio por pessoa (CPF).
POST
http://cftv.barradorio.com.br:8080/api/acesso-pessoas/edit/:acesso-pessoas-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoPessoas.acessoPessoas.edit]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Acesso de Pessoas",
"type": "@OneOf",
"schema": {
"acesso-pessoas-id": "Código"
}
}
Body Input
{
"description": "Registro do(a) Acesso de Pessoas",
"type": "@OneOf",
"schema": {
"acessoPessoas": {
"description": "Acesso de Pessoas",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Acesso de Pessoas",
"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",
"cpf": "CPF precisa ter apenas dígitos, CPF é obrigatório, CPF precisa ter 11 caracteres",
"name": "Nome precisa ser um texto, Nome é obrigatório, Nome precisa ter 100 caracteres",
"accessDirection": {
"description": "Acesso de Pessoas",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"accessIdentitication": {
"description": "Acesso de Pessoas",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"foreignDocument": "Identidade Estrangeiro precisa ser um texto, Identidade Estrangeiro precisa ter 50 caracteres",
"reservation": "Reserva de Passageiro precisa ser um texto, Reserva de Passageiro precisa ter 50 caracteres",
"flight": "Voo de Passageiro precisa ser um texto, Voo de Passageiro precisa ter 20 caracteres",
"georreferenciamentoCatraca": {
"description": "Acesso de Pessoas",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"acessoPessoasCamera": {
"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) Acesso de Pessoas",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-pessoas/get/:acesso-pessoas-id
Obter Acesso de Pessoas com todos os detalhes de suas informações
GET
http://cftv.barradorio.com.br:8080/api/acesso-pessoas/get/:acesso-pessoas-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoPessoas.acessoPessoas.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Acesso de Pessoas",
"type": "@OneOf",
"schema": {
"acesso-pessoas-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Acesso de Pessoas",
"type": "@OneOf",
"schema": {
"acessoPessoas": {
"description": "Acesso de Pessoas",
"type": "@OneOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"integrationStatus": {
"description": "Acesso de Pessoas",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"branch": {
"description": "Acesso de Pessoas",
"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",
"cpf": "CPF",
"name": "Nome",
"accessDirection": {
"description": "Acesso de Pessoas",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"accessIdentitication": {
"description": "Acesso de Pessoas",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"foreignDocument": "Identidade Estrangeiro",
"reservation": "Reserva de Passageiro",
"flight": "Voo de Passageiro",
"georreferenciamentoCatraca": {
"description": "Acesso de Pessoas",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"acessoPessoasCamera": {
"description": "Cameras",
"type": "@ManyOf",
"schema": {
"id": "Código",
"georreferenciamentoCamera": {
"description": "Cameras",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
}
}
},
"acessoPessoasIntegration": {
"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
acesso-veiculos/audit/:acesso-veiculos-id
Obter informações de interações no registro de Acesso de Veículos
GET
http://cftv.barradorio.com.br:8080/api/acesso-veiculos/audit/:acesso-veiculos-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Acesso de Veículos",
"type": "@OneOf",
"schema": {
"acesso-veiculos-id": "Código"
}
}
Query Input
{
"description": "Registro do(a) 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) Acesso de Veículos",
"type": "@OneOf",
"schema": {
"acessoVeiculosAudits": {
"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
acesso-veiculos/collection/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/acesso-veiculos/collection/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-veiculos/collection/options/integration-status
Opções de Situação
GET
http://cftv.barradorio.com.br:8080/api/acesso-veiculos/collection/options/integration-status
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Situação",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-veiculos/collection
Coleção de Acesso de Veículos com informações resumidas e possibilidade de filtro
GET
http://cftv.barradorio.com.br:8080/api/acesso-veiculos/collection
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Registro do(a) Acesso de Veículos",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100.",
"order-by": "Atributo de Ordenação. acessoVeiculos.id, acessoVeiculos.created, acessoVeiculos.updated, integrationStatus.name, branch.name, acessoVeiculos.internalKey, acessoVeiculos.occurrence, acessoVeiculos.operatorCpf, acessoVeiculos.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) Acesso de Veículos",
"type": "@OneOf",
"schema": {
"acessoVeiculoss": {
"description": "Acesso de Veículos",
"type": "@ManyOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"deleted": "Data de Deleçao",
"integrationStatus": {
"description": "Acesso de Veículos",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"branch": {
"description": "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
acesso-veiculos/create/options/access-direction
Opções de Direção de Acesso
GET
http://cftv.barradorio.com.br:8080/api/acesso-veiculos/create/options/access-direction
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Direção de Acesso",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-veiculos/create/options/agendamento-acesso-veiculo
Opções de Agendamento de Acesso de Veículo
GET
http://cftv.barradorio.com.br:8080/api/acesso-veiculos/create/options/agendamento-acesso-veiculo
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Agendamento de Acesso de Veículo",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"internalKey": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-veiculos/create/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/acesso-veiculos/create/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-veiculos/create/options/bulk-type
Opções de Tipo Granel
GET
http://cftv.barradorio.com.br:8080/api/acesso-veiculos/create/options/bulk-type
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo Granel",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-veiculos/create/options/acesso-veiculos-camera/georreferenciamento-camera
Opções de Camera em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/acesso-veiculos/create/options/acesso-veiculos-camera/georreferenciamento-camera
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Camera em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-veiculos/create/options/georreferenciamento-gate
Opções de Gate em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/acesso-veiculos/create/options/georreferenciamento-gate
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Gate em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-veiculos/create/options/acesso-veiculos-lista-conhecimento/type-lading
Opções de Tipo de Conhecimento
GET
http://cftv.barradorio.com.br:8080/api/acesso-veiculos/create/options/acesso-veiculos-lista-conhecimento/type-lading
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Conhecimento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-veiculos/create/options/acesso-veiculos-lista-conhecimento/type-manifest
Opções de Tipo do Manifesto
GET
http://cftv.barradorio.com.br:8080/api/acesso-veiculos/create/options/acesso-veiculos-lista-conhecimento/type-manifest
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo do Manifesto",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-veiculos/create/options/acesso-veiculos-lista-declaracao-aduaneira/type-customs-declaration
Opções de Tipo de Declaração
GET
http://cftv.barradorio.com.br:8080/api/acesso-veiculos/create/options/acesso-veiculos-lista-declaracao-aduaneira/type-customs-declaration
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Declaração",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-veiculos/create/options/acesso-veiculos-lista-semitrailer/tipo-lacre
Opções de Tipo do Lacre
GET
http://cftv.barradorio.com.br:8080/api/acesso-veiculos/create/options/acesso-veiculos-lista-semitrailer/tipo-lacre
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo do Lacre",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-veiculos/create/options/modal-transport
Opções de Modal de Transporte
GET
http://cftv.barradorio.com.br:8080/api/acesso-veiculos/create/options/modal-transport
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Modal de Transporte",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-veiculos/create
Criar um(a) Acesso de Veículos. Enviar imediatamente após o 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/acesso-veiculos/create
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.create]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Body Input
{
"description": "Registro do(a) Acesso de Veículos",
"type": "@OneOf",
"schema": {
"acessoVeiculos": {
"description": "Acesso de Veículos",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Acesso 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",
"accessDirection": {
"description": "Acesso de Veículos",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"agendamentoAcessoVeiculo": {
"description": "Acesso de Veículos",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"bulkType": {
"description": "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, Captura da Placa via OCR é obrigatório",
"districtPlate": "UF Emplacamento precisa ser um texto, UF Emplacamento é obrigatório, UF Emplacamento precisa ter 2 caracteres",
"cnpjTransportador": "CNPJ da Transportador precisa ter apenas dígitos, CNPJ da Transportador é obrigatório, CNPJ da Transportador precisa ter 14 caracteres",
"cpfTransportador": "CPF do Transportador (Autônomo) precisa ter apenas dígitos, CPF do Transportador (Autônomo) precisa ter 11 caracteres",
"transportadorEstrangeiro": "Identificação de Transportador Estrangeiro precisa ser um texto, Identificação de Transportador Estrangeiro precisa ter 50 caracteres",
"nomeTransportador": "Nome do Transportador precisa ser um texto, Nome do Transportador é obrigatório, Nome do Transportador precisa ter 100 caracteres",
"cpfMotorista": "CPF do Motorista precisa ter apenas dígitos, CPF do Motorista é obrigatório, CPF do Motorista precisa ter 11 caracteres",
"identidadeEstrangeiroMotorista": "Identidade Estrangeira do Motorista precisa ser um texto, Identidade Estrangeira do Motorista precisa ter 50 caracteres",
"nomeMotorista": "Nome do Motorista precisa ser um texto, Nome do Motorista é obrigatório, 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 precisa ter 15 caracteres",
"trafficRegime": "Regime de Trânsito precisa ser verdadeiro ou falso",
"datetimeDeparture": "Data de Partida da Origem precisa ser data e hora (Y-m-d H:i:s)",
"modalTransport": {
"description": "Acesso de Veículos",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"georreferenciamentoGate": {
"description": "Acesso de Veículos",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"acessoVeiculosListaConhecimento": {
"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"
}
}
}
},
"acessoVeiculosListaSemitrailer": {
"description": "Semirreboque",
"type": "@ManyOf",
"schema": {
"numeroLacre": "Numero do Lacre precisa ser um texto, Numero do Lacre precisa ter 50 caracteres",
"tipoLacre": {
"description": "Semirreboque",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"orcPlate": "Captura por OCR precisa ser verdadeiro ou falso",
"plate": "Placa precisa ser um texto, Placa precisa ter 50 caracteres",
"empty": "Vazio precisa ser verdadeiro ou falso",
"damage": "Avaria precisa ser verdadeiro ou falso",
"portoDescarregamento": "Porto de Descarregamento precisa ser um texto, Porto de Descarregamento precisa ter 30 caracteres",
"paisDestinoFinalCarga": "País de Destino Final da Carga precisa ser um texto, País de Destino Final da Carga precisa ter 2 caracteres",
"navioImo": "Navio - IMO precisa ser um texto, Navio - IMO precisa ter 10 caracteres",
"navioNome": "Navio - nome precisa ser um texto, Navio - nome precisa ter 100 caracteres",
"clienteNome": "Cliente - Nome precisa ser um texto, Cliente - Nome precisa ter 100 caracteres",
"clienteCnpj": "Cliente - CNPJ precisa ser um texto, Cliente - CNPJ precisa ter 14 caracteres",
"clienteCpf": "Cliente - CPF precisa ser um texto, Cliente - CPF precisa ter 11 caracteres",
"cnpjEstabelecimentoEstufagem": "CNPJ Estabelecimento Estufagem precisa ser um texto, CNPJ Estabelecimento Estufagem precisa ter 14 caracteres",
"nomeEstabelecimentoEstufagem": "Nome Estabelecimento Estufagem precisa ser um texto, Nome Estabelecimento Estufagem precisa ter 200 caracteres"
}
},
"acessoVeiculosListaDeclaracaoAduaneira": {
"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"
}
}
}
},
"acessoVeiculosListaNfe": {
"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"
}
},
"acessoVeiculosListaMalas": {
"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"
}
},
"acessoVeiculosListaChassi": {
"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"
}
},
"acessoVeiculosCamera": {
"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) 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
acesso-veiculos/delete/:acesso-veiculos-id
Deletar Acesso de Veículos
DELETE
http://cftv.barradorio.com.br:8080/api/acesso-veiculos/delete/:acesso-veiculos-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.delete]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Acesso de Veículos",
"type": "@OneOf",
"schema": {
"acesso-veiculos-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Acesso de Veículos",
"type": "@OneOf",
"schema": {
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-veiculos/edit/options/access-direction
Opções de Direção de Acesso
GET
http://cftv.barradorio.com.br:8080/api/acesso-veiculos/edit/options/access-direction
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Direção de Acesso",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-veiculos/edit/options/agendamento-acesso-veiculo
Opções de Agendamento de Acesso de Veículo
GET
http://cftv.barradorio.com.br:8080/api/acesso-veiculos/edit/options/agendamento-acesso-veiculo
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Agendamento de Acesso de Veículo",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"internalKey": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-veiculos/edit/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/acesso-veiculos/edit/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-veiculos/edit/options/bulk-type
Opções de Tipo Granel
GET
http://cftv.barradorio.com.br:8080/api/acesso-veiculos/edit/options/bulk-type
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo Granel",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-veiculos/edit/options/acesso-veiculos-camera/georreferenciamento-camera
Opções de Camera em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/acesso-veiculos/edit/options/acesso-veiculos-camera/georreferenciamento-camera
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Camera em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-veiculos/edit/options/georreferenciamento-gate
Opções de Gate em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/acesso-veiculos/edit/options/georreferenciamento-gate
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Gate em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-veiculos/edit/options/acesso-veiculos-lista-conhecimento/type-lading
Opções de Tipo de Conhecimento
GET
http://cftv.barradorio.com.br:8080/api/acesso-veiculos/edit/options/acesso-veiculos-lista-conhecimento/type-lading
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Conhecimento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-veiculos/edit/options/acesso-veiculos-lista-conhecimento/type-manifest
Opções de Tipo do Manifesto
GET
http://cftv.barradorio.com.br:8080/api/acesso-veiculos/edit/options/acesso-veiculos-lista-conhecimento/type-manifest
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo do Manifesto",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-veiculos/edit/options/acesso-veiculos-lista-declaracao-aduaneira/type-customs-declaration
Opções de Tipo de Declaração
GET
http://cftv.barradorio.com.br:8080/api/acesso-veiculos/edit/options/acesso-veiculos-lista-declaracao-aduaneira/type-customs-declaration
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Declaração",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-veiculos/edit/options/acesso-veiculos-lista-semitrailer/tipo-lacre
Opções de Tipo do Lacre
GET
http://cftv.barradorio.com.br:8080/api/acesso-veiculos/edit/options/acesso-veiculos-lista-semitrailer/tipo-lacre
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo do Lacre",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-veiculos/edit/options/modal-transport
Opções de Modal de Transporte
GET
http://cftv.barradorio.com.br:8080/api/acesso-veiculos/edit/options/modal-transport
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Modal de Transporte",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
acesso-veiculos/edit/:acesso-veiculos-id
Editar um(a) Acesso de Veículos. Enviar imediatamente após o 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/acesso-veiculos/edit/:acesso-veiculos-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.edit]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Acesso de Veículos",
"type": "@OneOf",
"schema": {
"acesso-veiculos-id": "Código"
}
}
Body Input
{
"description": "Registro do(a) Acesso de Veículos",
"type": "@OneOf",
"schema": {
"acessoVeiculos": {
"description": "Acesso de Veículos",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Acesso 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",
"accessDirection": {
"description": "Acesso de Veículos",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"agendamentoAcessoVeiculo": {
"description": "Acesso de Veículos",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"bulkType": {
"description": "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, Captura da Placa via OCR é obrigatório",
"districtPlate": "UF Emplacamento precisa ser um texto, UF Emplacamento é obrigatório, UF Emplacamento precisa ter 2 caracteres",
"cnpjTransportador": "CNPJ da Transportador precisa ter apenas dígitos, CNPJ da Transportador é obrigatório, CNPJ da Transportador precisa ter 14 caracteres",
"cpfTransportador": "CPF do Transportador (Autônomo) precisa ter apenas dígitos, CPF do Transportador (Autônomo) precisa ter 11 caracteres",
"transportadorEstrangeiro": "Identificação de Transportador Estrangeiro precisa ser um texto, Identificação de Transportador Estrangeiro precisa ter 50 caracteres",
"nomeTransportador": "Nome do Transportador precisa ser um texto, Nome do Transportador é obrigatório, Nome do Transportador precisa ter 100 caracteres",
"cpfMotorista": "CPF do Motorista precisa ter apenas dígitos, CPF do Motorista é obrigatório, CPF do Motorista precisa ter 11 caracteres",
"identidadeEstrangeiroMotorista": "Identidade Estrangeira do Motorista precisa ser um texto, Identidade Estrangeira do Motorista precisa ter 50 caracteres",
"nomeMotorista": "Nome do Motorista precisa ser um texto, Nome do Motorista é obrigatório, 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 precisa ter 15 caracteres",
"trafficRegime": "Regime de Trânsito precisa ser verdadeiro ou falso",
"datetimeDeparture": "Data de Partida da Origem precisa ser data e hora (Y-m-d H:i:s)",
"modalTransport": {
"description": "Acesso de Veículos",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"georreferenciamentoGate": {
"description": "Acesso de Veículos",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"acessoVeiculosListaConhecimento": {
"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"
}
}
}
},
"acessoVeiculosListaSemitrailer": {
"description": "Semirreboque",
"type": "@ManyOf",
"schema": {
"id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente",
"numeroLacre": "Numero do Lacre precisa ser um texto, Numero do Lacre precisa ter 50 caracteres",
"tipoLacre": {
"description": "Semirreboque",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"orcPlate": "Captura por OCR precisa ser verdadeiro ou falso",
"plate": "Placa precisa ser um texto, Placa precisa ter 50 caracteres",
"empty": "Vazio precisa ser verdadeiro ou falso",
"damage": "Avaria precisa ser verdadeiro ou falso",
"portoDescarregamento": "Porto de Descarregamento precisa ser um texto, Porto de Descarregamento precisa ter 30 caracteres",
"paisDestinoFinalCarga": "País de Destino Final da Carga precisa ser um texto, País de Destino Final da Carga precisa ter 2 caracteres",
"navioImo": "Navio - IMO precisa ser um texto, Navio - IMO precisa ter 10 caracteres",
"navioNome": "Navio - nome precisa ser um texto, Navio - nome precisa ter 100 caracteres",
"clienteNome": "Cliente - Nome precisa ser um texto, Cliente - Nome precisa ter 100 caracteres",
"clienteCnpj": "Cliente - CNPJ precisa ser um texto, Cliente - CNPJ precisa ter 14 caracteres",
"clienteCpf": "Cliente - CPF precisa ser um texto, Cliente - CPF precisa ter 11 caracteres",
"cnpjEstabelecimentoEstufagem": "CNPJ Estabelecimento Estufagem precisa ser um texto, CNPJ Estabelecimento Estufagem precisa ter 14 caracteres",
"nomeEstabelecimentoEstufagem": "Nome Estabelecimento Estufagem precisa ser um texto, Nome Estabelecimento Estufagem precisa ter 200 caracteres"
}
},
"acessoVeiculosListaDeclaracaoAduaneira": {
"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"
}
}
}
},
"acessoVeiculosListaNfe": {
"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"
}
},
"acessoVeiculosListaMalas": {
"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"
}
},
"acessoVeiculosListaChassi": {
"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"
}
},
"acessoVeiculosCamera": {
"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) 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
acesso-veiculos/get/:acesso-veiculos-id
Obter Acesso de Veículos com todos os detalhes de suas informações
GET
http://cftv.barradorio.com.br:8080/api/acesso-veiculos/get/:acesso-veiculos-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [acessoVeiculos.acessoVeiculos.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Acesso de Veículos",
"type": "@OneOf",
"schema": {
"acesso-veiculos-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Acesso de Veículos",
"type": "@OneOf",
"schema": {
"acessoVeiculos": {
"description": "Acesso de Veículos",
"type": "@OneOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"deleted": "Data de Deleçao",
"integrationStatus": {
"description": "Acesso de Veículos",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"branch": {
"description": "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": "Acesso de Veículos",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"agendamentoAcessoVeiculo": {
"description": "Acesso de Veículos",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"internalKey": "Descrição"
}
},
"bulkType": {
"description": "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",
"cpfTransportador": "CPF do Transportador (Autônomo)",
"transportadorEstrangeiro": "Identificação de Transportador Estrangeiro",
"nomeTransportador": "Nome do Transportador",
"cpfMotorista": "CPF do Motorista",
"identidadeEstrangeiroMotorista": "Identidade Estrangeira do Motorista",
"nomeMotorista": "Nome do Motorista",
"puIdentityRelatedRecinto": "Código do Recinto para Destino na Saída e Origem na Entrada",
"trafficRegime": "Regime de Trânsito",
"datetimeDeparture": "Data de Partida da Origem",
"modalTransport": {
"description": "Acesso de Veículos",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"georreferenciamentoGate": {
"description": "Acesso de Veículos",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"acessoVeiculosListaConhecimento": {
"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"
}
}
}
},
"acessoVeiculosListaSemitrailer": {
"description": "Semirreboque",
"type": "@ManyOf",
"schema": {
"id": "Código",
"numeroLacre": "Numero do Lacre",
"tipoLacre": {
"description": "Semirreboque",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"orcPlate": "Captura por OCR",
"plate": "Placa",
"empty": "Vazio",
"damage": "Avaria",
"portoDescarregamento": "Porto de Descarregamento",
"paisDestinoFinalCarga": "País de Destino Final da Carga",
"navioImo": "Navio - IMO",
"navioNome": "Navio - nome",
"clienteNome": "Cliente - Nome",
"clienteCnpj": "Cliente - CNPJ",
"clienteCpf": "Cliente - CPF",
"cnpjEstabelecimentoEstufagem": "CNPJ Estabelecimento Estufagem",
"nomeEstabelecimentoEstufagem": "Nome Estabelecimento Estufagem"
}
},
"acessoVeiculosListaDeclaracaoAduaneira": {
"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"
}
}
}
},
"acessoVeiculosListaNfe": {
"description": "NF-e",
"type": "@ManyOf",
"schema": {
"id": "Código",
"number": "Número da Chave NF-e"
}
},
"acessoVeiculosListaMalas": {
"description": "Malas",
"type": "@ManyOf",
"schema": {
"id": "Código",
"number": "Número da Mala"
}
},
"acessoVeiculosListaChassi": {
"description": "Chassi",
"type": "@ManyOf",
"schema": {
"id": "Código",
"number": "Número do Chassi"
}
},
"acessoVeiculosCamera": {
"description": "Cameras",
"type": "@ManyOf",
"schema": {
"id": "Código",
"georreferenciamentoCamera": {
"description": "Cameras",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
}
}
},
"acessoVeiculosIntegration": {
"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
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/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/agenda-acesso-veiculos/collection/options/branch
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
agenda-acesso-veiculos/collection/options/integration-status
Opções de Situação
GET
http://cftv.barradorio.com.br:8080/api/agenda-acesso-veiculos/collection/options/integration-status
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Situação",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
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",
"deleted": "Data de Deleçao",
"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/options/access-direction
Opções de Direção de Acesso
GET
http://cftv.barradorio.com.br:8080/api/agenda-acesso-veiculos/create/options/access-direction
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Direção de Acesso",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
agenda-acesso-veiculos/create/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/agenda-acesso-veiculos/create/options/branch
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
agenda-acesso-veiculos/create/options/bulk-type
Opções de Tipo Granel
GET
http://cftv.barradorio.com.br:8080/api/agenda-acesso-veiculos/create/options/bulk-type
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo Granel",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
agenda-acesso-veiculos/create/options/agenda-acesso-veiculos-camera/georreferenciamento-camera
Opções de Camera em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/agenda-acesso-veiculos/create/options/agenda-acesso-veiculos-camera/georreferenciamento-camera
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Camera em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
agenda-acesso-veiculos/create/options/georreferenciamento-gate
Opções de Gate em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/agenda-acesso-veiculos/create/options/georreferenciamento-gate
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Gate em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
agenda-acesso-veiculos/create/options/agenda-acesso-veiculos-lista-conhecimento/type-lading
Opções de Tipo de Conhecimento
GET
http://cftv.barradorio.com.br:8080/api/agenda-acesso-veiculos/create/options/agenda-acesso-veiculos-lista-conhecimento/type-lading
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Conhecimento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
agenda-acesso-veiculos/create/options/agenda-acesso-veiculos-lista-conhecimento/type-manifest
Opções de Tipo do Manifesto
GET
http://cftv.barradorio.com.br:8080/api/agenda-acesso-veiculos/create/options/agenda-acesso-veiculos-lista-conhecimento/type-manifest
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo do Manifesto",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
agenda-acesso-veiculos/create/options/agenda-acesso-veiculos-lista-declaracao-aduaneira/type-customs-declaration
Opções de Tipo de Declaração
GET
http://cftv.barradorio.com.br:8080/api/agenda-acesso-veiculos/create/options/agenda-acesso-veiculos-lista-declaracao-aduaneira/type-customs-declaration
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Declaração",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
agenda-acesso-veiculos/create/options/agenda-acesso-veiculos-lista-semitrailer/tipo-lacre
Opções de Tipo do Lacre
GET
http://cftv.barradorio.com.br:8080/api/agenda-acesso-veiculos/create/options/agenda-acesso-veiculos-lista-semitrailer/tipo-lacre
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo do Lacre",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
agenda-acesso-veiculos/create/options/modal-transport
Opções de Modal de Transporte
GET
http://cftv.barradorio.com.br:8080/api/agenda-acesso-veiculos/create/options/modal-transport
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Modal de Transporte",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
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 precisa ter 15 caracteres",
"trafficRegime": "Regime de Trânsito precisa ser verdadeiro ou falso",
"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"
}
}
}
},
"agendaAcessoVeiculosListaSemitrailer": {
"description": "Semirreboque",
"type": "@ManyOf",
"schema": {
"numeroLacre": "Numero do Lacre precisa ser um texto, Numero do Lacre precisa ter 50 caracteres",
"tipoLacre": {
"description": "Semirreboque",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"orcPlate": "Captura por OCR precisa ser verdadeiro ou falso",
"plate": "Placa precisa ser um texto, Placa precisa ter 50 caracteres",
"empty": "Vazio precisa ser verdadeiro ou falso",
"damage": "Avaria precisa ser verdadeiro ou falso",
"portoDescarregamento": "Porto de Descarregamento precisa ser um texto, Porto de Descarregamento precisa ter 30 caracteres",
"paisDestinoFinalCarga": "País de Destino Final da Carga precisa ser um texto, País de Destino Final da Carga precisa ter 2 caracteres",
"navioImo": "Navio - IMO precisa ser um texto, Navio - IMO precisa ter 10 caracteres",
"navioNome": "Navio - nome precisa ser um texto, Navio - nome precisa ter 100 caracteres",
"clienteNome": "Cliente - Nome precisa ser um texto, Cliente - Nome precisa ter 100 caracteres",
"clienteCnpj": "Cliente - CNPJ precisa ser um texto, Cliente - CNPJ precisa ter 14 caracteres",
"cnpjEstabelecimentoEstufagem": "CNPJ Estabelecimento Estufagem precisa ser um texto, CNPJ Estabelecimento Estufagem precisa ter 14 caracteres",
"nomeEstabelecimentoEstufagem": "Nome Estabelecimento Estufagem precisa ser um texto, Nome Estabelecimento Estufagem precisa ter 200 caracteres"
}
},
"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/options/access-direction
Opções de Direção de Acesso
GET
http://cftv.barradorio.com.br:8080/api/agenda-acesso-veiculos/edit/options/access-direction
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Direção de Acesso",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
agenda-acesso-veiculos/edit/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/agenda-acesso-veiculos/edit/options/branch
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
agenda-acesso-veiculos/edit/options/bulk-type
Opções de Tipo Granel
GET
http://cftv.barradorio.com.br:8080/api/agenda-acesso-veiculos/edit/options/bulk-type
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo Granel",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
agenda-acesso-veiculos/edit/options/agenda-acesso-veiculos-camera/georreferenciamento-camera
Opções de Camera em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/agenda-acesso-veiculos/edit/options/agenda-acesso-veiculos-camera/georreferenciamento-camera
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Camera em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
agenda-acesso-veiculos/edit/options/georreferenciamento-gate
Opções de Gate em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/agenda-acesso-veiculos/edit/options/georreferenciamento-gate
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Gate em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
agenda-acesso-veiculos/edit/options/agenda-acesso-veiculos-lista-conhecimento/type-lading
Opções de Tipo de Conhecimento
GET
http://cftv.barradorio.com.br:8080/api/agenda-acesso-veiculos/edit/options/agenda-acesso-veiculos-lista-conhecimento/type-lading
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Conhecimento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
agenda-acesso-veiculos/edit/options/agenda-acesso-veiculos-lista-conhecimento/type-manifest
Opções de Tipo do Manifesto
GET
http://cftv.barradorio.com.br:8080/api/agenda-acesso-veiculos/edit/options/agenda-acesso-veiculos-lista-conhecimento/type-manifest
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo do Manifesto",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
agenda-acesso-veiculos/edit/options/agenda-acesso-veiculos-lista-declaracao-aduaneira/type-customs-declaration
Opções de Tipo de Declaração
GET
http://cftv.barradorio.com.br:8080/api/agenda-acesso-veiculos/edit/options/agenda-acesso-veiculos-lista-declaracao-aduaneira/type-customs-declaration
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Declaração",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
agenda-acesso-veiculos/edit/options/agenda-acesso-veiculos-lista-semitrailer/tipo-lacre
Opções de Tipo do Lacre
GET
http://cftv.barradorio.com.br:8080/api/agenda-acesso-veiculos/edit/options/agenda-acesso-veiculos-lista-semitrailer/tipo-lacre
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo do Lacre",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
agenda-acesso-veiculos/edit/options/modal-transport
Opções de Modal de Transporte
GET
http://cftv.barradorio.com.br:8080/api/agenda-acesso-veiculos/edit/options/modal-transport
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Modal de Transporte",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
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 precisa ter 15 caracteres",
"trafficRegime": "Regime de Trânsito precisa ser verdadeiro ou falso",
"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"
}
}
}
},
"agendaAcessoVeiculosListaSemitrailer": {
"description": "Semirreboque",
"type": "@ManyOf",
"schema": {
"id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente",
"numeroLacre": "Numero do Lacre precisa ser um texto, Numero do Lacre precisa ter 50 caracteres",
"tipoLacre": {
"description": "Semirreboque",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"orcPlate": "Captura por OCR precisa ser verdadeiro ou falso",
"plate": "Placa precisa ser um texto, Placa precisa ter 50 caracteres",
"empty": "Vazio precisa ser verdadeiro ou falso",
"damage": "Avaria precisa ser verdadeiro ou falso",
"portoDescarregamento": "Porto de Descarregamento precisa ser um texto, Porto de Descarregamento precisa ter 30 caracteres",
"paisDestinoFinalCarga": "País de Destino Final da Carga precisa ser um texto, País de Destino Final da Carga precisa ter 2 caracteres",
"navioImo": "Navio - IMO precisa ser um texto, Navio - IMO precisa ter 10 caracteres",
"navioNome": "Navio - nome precisa ser um texto, Navio - nome precisa ter 100 caracteres",
"clienteNome": "Cliente - Nome precisa ser um texto, Cliente - Nome precisa ter 100 caracteres",
"clienteCnpj": "Cliente - CNPJ precisa ser um texto, Cliente - CNPJ precisa ter 14 caracteres",
"cnpjEstabelecimentoEstufagem": "CNPJ Estabelecimento Estufagem precisa ser um texto, CNPJ Estabelecimento Estufagem precisa ter 14 caracteres",
"nomeEstabelecimentoEstufagem": "Nome Estabelecimento Estufagem precisa ser um texto, Nome Estabelecimento Estufagem precisa ter 200 caracteres"
}
},
"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",
"deleted": "Data de Deleçao",
"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",
"trafficRegime": "Regime de Trânsito",
"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"
}
}
}
},
"agendaAcessoVeiculosListaSemitrailer": {
"description": "Semirreboque",
"type": "@ManyOf",
"schema": {
"id": "Código",
"numeroLacre": "Numero do Lacre",
"tipoLacre": {
"description": "Semirreboque",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"orcPlate": "Captura por OCR",
"plate": "Placa",
"empty": "Vazio",
"damage": "Avaria",
"portoDescarregamento": "Porto de Descarregamento",
"paisDestinoFinalCarga": "País de Destino Final da Carga",
"navioImo": "Navio - IMO",
"navioNome": "Navio - nome",
"clienteNome": "Cliente - Nome",
"clienteCnpj": "Cliente - CNPJ",
"cnpjEstabelecimentoEstufagem": "CNPJ Estabelecimento Estufagem",
"nomeEstabelecimentoEstufagem": "Nome Estabelecimento Estufagem"
}
},
"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
agenda-operacao-navio-aero/audit/:agenda-operacao-navio-aero-id
Obter informações de interações no registro de Agenda/Operação de Navios/Aeronaves
GET
http://cftv.barradorio.com.br:8080/api/agenda-operacao-navio-aero/audit/:agenda-operacao-navio-aero-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [agendaOperacaoNavioAero.agendaOperacaoNavioAero.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Agenda\/Operação de Navios\/Aeronaves",
"type": "@OneOf",
"schema": {
"agenda-operacao-navio-aero-id": "Código"
}
}
Query Input
{
"description": "Registro do(a) Agenda\/Operação de Navios\/Aeronaves",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Agenda\/Operação de Navios\/Aeronaves",
"type": "@OneOf",
"schema": {
"agendaOperacaoNavioAeroAudits": {
"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-operacao-navio-aero/collection/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/agenda-operacao-navio-aero/collection/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [agendaOperacaoNavioAero.agendaOperacaoNavioAero.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
agenda-operacao-navio-aero/collection/options/integration-status
Opções de Situação
GET
http://cftv.barradorio.com.br:8080/api/agenda-operacao-navio-aero/collection/options/integration-status
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [agendaOperacaoNavioAero.agendaOperacaoNavioAero.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Situação",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
agenda-operacao-navio-aero/collection
Coleção de Agenda/Operação de Navios/Aeronaves com informações resumidas e possibilidade de filtro
GET
http://cftv.barradorio.com.br:8080/api/agenda-operacao-navio-aero/collection
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [agendaOperacaoNavioAero.agendaOperacaoNavioAero.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Registro do(a) Agenda\/Operação de Navios\/Aeronaves",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100.",
"order-by": "Atributo de Ordenação. agendaOperacaoNavioAero.id, agendaOperacaoNavioAero.created, agendaOperacaoNavioAero.updated, integrationStatus.name, branch.name, agendaOperacaoNavioAero.internalKey, agendaOperacaoNavioAero.occurrence, agendaOperacaoNavioAero.operatorCpf, agendaOperacaoNavioAero.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) Agenda\/Operação de Navios\/Aeronaves",
"type": "@OneOf",
"schema": {
"agendaOperacaoNavioAeros": {
"description": "Agenda\/Operação de Navios\/Aeronaves",
"type": "@ManyOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"integrationStatus": {
"description": "Agenda\/Operação de Navios\/Aeronaves",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"branch": {
"description": "Agenda\/Operação de Navios\/Aeronaves",
"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-operacao-navio-aero/create/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/agenda-operacao-navio-aero/create/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [agendaOperacaoNavioAero.agendaOperacaoNavioAero.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
agenda-operacao-navio-aero/create
POST
http://cftv.barradorio.com.br:8080/api/agenda-operacao-navio-aero/create
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [agendaOperacaoNavioAero.agendaOperacaoNavioAero.create]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Body Input
{
"description": "Registro do(a) Agenda\/Operação de Navios\/Aeronaves",
"type": "@OneOf",
"schema": {
"agendaOperacaoNavioAero": {
"description": "Agenda\/Operação de Navios\/Aeronaves",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Agenda\/Operação de Navios\/Aeronaves",
"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",
"shipImo": "IMO do Navio precisa ser um texto, IMO do Navio precisa ter 10 caracteres",
"shipName": "Nome do Navio precisa ser um texto, Nome do Navio precisa ter 100 caracteres",
"aitaPlane": "IATA Aeronave precisa ser um texto, IATA Aeronave precisa ter 50 caracteres",
"prefixPlane": "Prefixo Aeronave precisa ser um texto, Prefixo 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",
"scheduleForecastIn": "Data Prevista de Chegada precisa ser data e hora (Y-m-d H:i:s)",
"scheduleForecastOut": "Data Prevista de Saída precisa ser data e hora (Y-m-d H:i:s)",
"arrivalIn": "Data de Chegada precisa ser data e hora (Y-m-d H:i:s)",
"arrivalOut": "Data de Saída precisa ser data e hora (Y-m-d H:i:s)",
"operationStarted": "Data Inicial de Operação precisa ser data e hora (Y-m-d H:i:s)",
"operationEnd": "Data Final de Operação precisa ser data e hora (Y-m-d H:i:s)"
}
}
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Agenda\/Operação de Navios\/Aeronaves",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
agenda-operacao-navio-aero/delete/:agenda-operacao-navio-aero-id
Deletar Agenda/Operação de Navios/Aeronaves
DELETE
http://cftv.barradorio.com.br:8080/api/agenda-operacao-navio-aero/delete/:agenda-operacao-navio-aero-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [agendaOperacaoNavioAero.agendaOperacaoNavioAero.delete]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Agenda\/Operação de Navios\/Aeronaves",
"type": "@OneOf",
"schema": {
"agenda-operacao-navio-aero-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Agenda\/Operação de Navios\/Aeronaves",
"type": "@OneOf",
"schema": {
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
agenda-operacao-navio-aero/edit/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/agenda-operacao-navio-aero/edit/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [agendaOperacaoNavioAero.agendaOperacaoNavioAero.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
agenda-operacao-navio-aero/edit/:agenda-operacao-navio-aero-id
POST
http://cftv.barradorio.com.br:8080/api/agenda-operacao-navio-aero/edit/:agenda-operacao-navio-aero-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [agendaOperacaoNavioAero.agendaOperacaoNavioAero.edit]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Agenda\/Operação de Navios\/Aeronaves",
"type": "@OneOf",
"schema": {
"agenda-operacao-navio-aero-id": "Código"
}
}
Body Input
{
"description": "Registro do(a) Agenda\/Operação de Navios\/Aeronaves",
"type": "@OneOf",
"schema": {
"agendaOperacaoNavioAero": {
"description": "Agenda\/Operação de Navios\/Aeronaves",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Agenda\/Operação de Navios\/Aeronaves",
"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",
"shipImo": "IMO do Navio precisa ser um texto, IMO do Navio precisa ter 10 caracteres",
"shipName": "Nome do Navio precisa ser um texto, Nome do Navio precisa ter 100 caracteres",
"aitaPlane": "IATA Aeronave precisa ser um texto, IATA Aeronave precisa ter 50 caracteres",
"prefixPlane": "Prefixo Aeronave precisa ser um texto, Prefixo 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",
"scheduleForecastIn": "Data Prevista de Chegada precisa ser data e hora (Y-m-d H:i:s)",
"scheduleForecastOut": "Data Prevista de Saída precisa ser data e hora (Y-m-d H:i:s)",
"arrivalIn": "Data de Chegada precisa ser data e hora (Y-m-d H:i:s)",
"arrivalOut": "Data de Saída precisa ser data e hora (Y-m-d H:i:s)",
"operationStarted": "Data Inicial de Operação precisa ser data e hora (Y-m-d H:i:s)",
"operationEnd": "Data Final de Operação precisa ser data e hora (Y-m-d H:i:s)"
}
}
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Agenda\/Operação de Navios\/Aeronaves",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
agenda-operacao-navio-aero/get/:agenda-operacao-navio-aero-id
Obter Agenda/Operação de Navios/Aeronaves com todos os detalhes de suas informações
GET
http://cftv.barradorio.com.br:8080/api/agenda-operacao-navio-aero/get/:agenda-operacao-navio-aero-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [agendaOperacaoNavioAero.agendaOperacaoNavioAero.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Agenda\/Operação de Navios\/Aeronaves",
"type": "@OneOf",
"schema": {
"agenda-operacao-navio-aero-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Agenda\/Operação de Navios\/Aeronaves",
"type": "@OneOf",
"schema": {
"agendaOperacaoNavioAero": {
"description": "Agenda\/Operação de Navios\/Aeronaves",
"type": "@OneOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"integrationStatus": {
"description": "Agenda\/Operação de Navios\/Aeronaves",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"branch": {
"description": "Agenda\/Operação de Navios\/Aeronaves",
"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",
"shipImo": "IMO do Navio",
"shipName": "Nome do Navio",
"aitaPlane": "IATA Aeronave",
"prefixPlane": "Prefixo Aeronave",
"travel": "Viagem",
"flight": "Voo",
"stopover": "Escala",
"scheduleForecastIn": "Data Prevista de Chegada",
"scheduleForecastOut": "Data Prevista de Saída",
"arrivalIn": "Data de Chegada",
"arrivalOut": "Data de Saída",
"operationStarted": "Data Inicial de Operação",
"operationEnd": "Data Final de Operação",
"agendaOperacaoNavioAeroIntegration": {
"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
atribuicao-troca-navio/audit/:atribuicao-troca-navio-id
Obter informações de interações no registro de Atribuição/Troca de Navio
GET
http://cftv.barradorio.com.br:8080/api/atribuicao-troca-navio/audit/:atribuicao-troca-navio-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [atribuicaoTrocaNavio.atribuicaoTrocaNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Atribuição\/Troca de Navio",
"type": "@OneOf",
"schema": {
"atribuicao-troca-navio-id": "Código"
}
}
Query Input
{
"description": "Registro do(a) Atribuição\/Troca de Navio",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Atribuição\/Troca de Navio",
"type": "@OneOf",
"schema": {
"atribuicaoTrocaNavioAudits": {
"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
atribuicao-troca-navio/collection/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/atribuicao-troca-navio/collection/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [atribuicaoTrocaNavio.atribuicaoTrocaNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
atribuicao-troca-navio/collection/options/integration-status
Opções de Situação
GET
http://cftv.barradorio.com.br:8080/api/atribuicao-troca-navio/collection/options/integration-status
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [atribuicaoTrocaNavio.atribuicaoTrocaNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Situação",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
atribuicao-troca-navio/collection
Coleção de Atribuição/Troca de Navio com informações resumidas e possibilidade de filtro
GET
http://cftv.barradorio.com.br:8080/api/atribuicao-troca-navio/collection
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [atribuicaoTrocaNavio.atribuicaoTrocaNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Registro do(a) Atribuição\/Troca de Navio",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100.",
"order-by": "Atributo de Ordenação. atribuicaoTrocaNavio.id, atribuicaoTrocaNavio.created, atribuicaoTrocaNavio.updated, integrationStatus.name, branch.name, atribuicaoTrocaNavio.internalKey, atribuicaoTrocaNavio.occurrence, atribuicaoTrocaNavio.operatorCpf, atribuicaoTrocaNavio.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) Atribuição\/Troca de Navio",
"type": "@OneOf",
"schema": {
"atribuicaoTrocaNavios": {
"description": "Atribuição\/Troca de Navio",
"type": "@ManyOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"integrationStatus": {
"description": "Atribuição\/Troca de Navio",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"branch": {
"description": "Atribuição\/Troca de Navio",
"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
atribuicao-troca-navio/create/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/atribuicao-troca-navio/create/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [atribuicaoTrocaNavio.atribuicaoTrocaNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
atribuicao-troca-navio/create
Criar um(a) Atribuição/Troca de Navio. Enviar em imediato um evento para cada alteração de navio em que a unidade de carga ou carga solta irá embarcar.
POST
http://cftv.barradorio.com.br:8080/api/atribuicao-troca-navio/create
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [atribuicaoTrocaNavio.atribuicaoTrocaNavio.create]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Body Input
{
"description": "Registro do(a) Atribuição\/Troca de Navio",
"type": "@OneOf",
"schema": {
"atribuicaoTrocaNavio": {
"description": "Atribuição\/Troca de Navio",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Atribuição\/Troca de Navio",
"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",
"containerNumber": "Número do Container precisa ser um texto, Número do Container é obrigatório, Número do Container precisa ter 200 caracteres",
"shipImo": "IMO do Navio precisa ser um texto, IMO do Navio precisa ter 10 caracteres",
"shipName": "Nome do Navio precisa ser um texto, Nome do Navio precisa ter 100 caracteres",
"travel": "Viagem precisa ser um texto, Viagem precisa ter 20 caracteres",
"stopover": "Escala precisa ser um texto, Escala precisa ter 20 caracteres",
"portUnloading": "Porto de Descarregamento precisa ser um texto, Porto de Descarregamento precisa ter 2 caracteres",
"portArrival": "Porto de Destino Final precisa ser um texto, Porto de Destino Final precisa ter 2 caracteres"
}
}
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Atribuição\/Troca de Navio",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
atribuicao-troca-navio/delete/:atribuicao-troca-navio-id
Deletar Atribuição/Troca de Navio
DELETE
http://cftv.barradorio.com.br:8080/api/atribuicao-troca-navio/delete/:atribuicao-troca-navio-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [atribuicaoTrocaNavio.atribuicaoTrocaNavio.delete]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Atribuição\/Troca de Navio",
"type": "@OneOf",
"schema": {
"atribuicao-troca-navio-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Atribuição\/Troca de Navio",
"type": "@OneOf",
"schema": {
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
atribuicao-troca-navio/edit/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/atribuicao-troca-navio/edit/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [atribuicaoTrocaNavio.atribuicaoTrocaNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
atribuicao-troca-navio/edit/:atribuicao-troca-navio-id
Editar um(a) Atribuição/Troca de Navio. Enviar em imediato um evento para cada alteração de navio em que a unidade de carga ou carga solta irá embarcar.
POST
http://cftv.barradorio.com.br:8080/api/atribuicao-troca-navio/edit/:atribuicao-troca-navio-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [atribuicaoTrocaNavio.atribuicaoTrocaNavio.edit]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Atribuição\/Troca de Navio",
"type": "@OneOf",
"schema": {
"atribuicao-troca-navio-id": "Código"
}
}
Body Input
{
"description": "Registro do(a) Atribuição\/Troca de Navio",
"type": "@OneOf",
"schema": {
"atribuicaoTrocaNavio": {
"description": "Atribuição\/Troca de Navio",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Atribuição\/Troca de Navio",
"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",
"containerNumber": "Número do Container precisa ser um texto, Número do Container é obrigatório, Número do Container precisa ter 200 caracteres",
"shipImo": "IMO do Navio precisa ser um texto, IMO do Navio precisa ter 10 caracteres",
"shipName": "Nome do Navio precisa ser um texto, Nome do Navio precisa ter 100 caracteres",
"travel": "Viagem precisa ser um texto, Viagem precisa ter 20 caracteres",
"stopover": "Escala precisa ser um texto, Escala precisa ter 20 caracteres",
"portUnloading": "Porto de Descarregamento precisa ser um texto, Porto de Descarregamento precisa ter 2 caracteres",
"portArrival": "Porto de Destino Final precisa ser um texto, Porto de Destino Final precisa ter 2 caracteres"
}
}
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Atribuição\/Troca de Navio",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
atribuicao-troca-navio/get/:atribuicao-troca-navio-id
Obter Atribuição/Troca de Navio com todos os detalhes de suas informações
GET
http://cftv.barradorio.com.br:8080/api/atribuicao-troca-navio/get/:atribuicao-troca-navio-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [atribuicaoTrocaNavio.atribuicaoTrocaNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Atribuição\/Troca de Navio",
"type": "@OneOf",
"schema": {
"atribuicao-troca-navio-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Atribuição\/Troca de Navio",
"type": "@OneOf",
"schema": {
"atribuicaoTrocaNavio": {
"description": "Atribuição\/Troca de Navio",
"type": "@OneOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"integrationStatus": {
"description": "Atribuição\/Troca de Navio",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"branch": {
"description": "Atribuição\/Troca de Navio",
"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",
"containerNumber": "Número do Container",
"shipImo": "IMO do Navio",
"shipName": "Nome do Navio",
"travel": "Viagem",
"stopover": "Escala",
"portUnloading": "Porto de Descarregamento",
"portArrival": "Porto de Destino Final",
"atribuicaoTrocaNavioIntegration": {
"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
authentication/user/info
Informações de usuário autenticado
POST
http://cftv.barradorio.com.br:8080/api/authentication/user/info
Header Input
Requer autenticação de usuário
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Informações de autenticação de usuário",
"type": "@OneOf",
"schema": {
"user": {
"description": "Informações de autenticação de usuário",
"type": "@OneOf",
"schema": {
"name": "Nome",
"email": "E-mail",
"userAccessProfile": {
"description": "Perfil de acesso",
"type": "@ManyOf",
"schema": {
"accessProfile": {
"description": "Perfil de acesso",
"type": "@OneOf",
"schema": {
"name": "Nome",
"accessProfileResource": {
"description": "Recursos de perfil de acesso",
"type": "@ManyOf",
"schema": {
"resource": {
"description": "Recurso de perfil de acesso",
"type": "@OneOf",
"schema": {
"name": "Nome",
"alias": "Pseudônimo"
}
}
}
}
}
}
}
},
"userResource": {
"description": "Recursos",
"type": "@ManyOf",
"schema": {
"resource": {
"description": "Recurso",
"type": "@OneOf",
"schema": {
"name": "Nome",
"alias": "Pseudônimo"
}
}
}
}
}
}
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
authentication/user/login
Autenticação de usuário
POST
http://cftv.barradorio.com.br:8080/api/authentication/user/login
Body Input
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"email": "E-mail",
"password": "Senha em MD5",
"device": "Descrição do Dispositivo",
"fcmToken": "Token do Dispositivo no Firebase Cloud Messaging. Opcional"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
authentication/user/logout
Logout de usuário autenticado
POST
http://cftv.barradorio.com.br:8080/api/authentication/user/logout
Header Input
Requer autenticação de usuário
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Fechar autenticação",
"type": "@OneOf",
"schema": {}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
authentication/user/password
Trocar senha de usuário autenticado
POST
http://cftv.barradorio.com.br:8080/api/authentication/user/password
Header Input
Requer autenticação de usuário
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Body Input
{
"description": "Trocar senha",
"type": "@OneOf",
"schema": {
"nowPassword": "Senha Atual em MD5",
"newPassword": "Nova Senha em MD5"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Trocar senha",
"type": "@OneOf",
"schema": {}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
authentication/user/recovery-complete
Confirmação de nova senha de usuário
POST
http://cftv.barradorio.com.br:8080/api/authentication/user/recovery-complete
Body Input
{
"description": "Trocar senha",
"type": "@OneOf",
"schema": {
"email": "E-mail de Confirmação",
"token": "Token de Autenticação"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Trocar senha",
"type": "@OneOf",
"schema": {
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
authentication/user/recovery-request
Solicitar nova senha de usuário
POST
http://cftv.barradorio.com.br:8080/api/authentication/user/recovery-request
Body Input
{
"description": "Trocar senha",
"type": "@OneOf",
"schema": {
"email": "E-mail para Recuperação de Acesso",
"url": "Endereço URL para Receber Token Confirmação. Será Enviado Parâmetros GET com os Campos de token e email",
"device": "Descrição do Dispositivo"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Trocar senha",
"type": "@OneOf",
"schema": {
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
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/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/bloqueio-veiculo-carga/collection/options/branch
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
bloqueio-veiculo-carga/collection/options/integration-status
Opções de Situação
GET
http://cftv.barradorio.com.br:8080/api/bloqueio-veiculo-carga/collection/options/integration-status
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Situação",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
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/options/block-status
Opções de Situação do Bloqueio
GET
http://cftv.barradorio.com.br:8080/api/bloqueio-veiculo-carga/create/options/block-status
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Situação do Bloqueio",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
bloqueio-veiculo-carga/create/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/bloqueio-veiculo-carga/create/options/branch
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
bloqueio-veiculo-carga/create/options/type-customs-declaration
Opções de Tipo de Declaração
GET
http://cftv.barradorio.com.br:8080/api/bloqueio-veiculo-carga/create/options/type-customs-declaration
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Declaração",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
bloqueio-veiculo-carga/create/options/type-lading
Opções de Tipo de Conhecimento
GET
http://cftv.barradorio.com.br:8080/api/bloqueio-veiculo-carga/create/options/type-lading
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Conhecimento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
bloqueio-veiculo-carga/create/options/type-manifest
Opções de Tipo do Manifesto
GET
http://cftv.barradorio.com.br:8080/api/bloqueio-veiculo-carga/create/options/type-manifest
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo do Manifesto",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
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/options/block-status
Opções de Situação do Bloqueio
GET
http://cftv.barradorio.com.br:8080/api/bloqueio-veiculo-carga/edit/options/block-status
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Situação do Bloqueio",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
bloqueio-veiculo-carga/edit/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/bloqueio-veiculo-carga/edit/options/branch
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
bloqueio-veiculo-carga/edit/options/type-customs-declaration
Opções de Tipo de Declaração
GET
http://cftv.barradorio.com.br:8080/api/bloqueio-veiculo-carga/edit/options/type-customs-declaration
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Declaração",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
bloqueio-veiculo-carga/edit/options/type-lading
Opções de Tipo de Conhecimento
GET
http://cftv.barradorio.com.br:8080/api/bloqueio-veiculo-carga/edit/options/type-lading
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Conhecimento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
bloqueio-veiculo-carga/edit/options/type-manifest
Opções de Tipo do Manifesto
GET
http://cftv.barradorio.com.br:8080/api/bloqueio-veiculo-carga/edit/options/type-manifest
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo do Manifesto",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
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
branch/audit/:branch-id
Obter informações de interações no registro de Filial
GET
http://cftv.barradorio.com.br:8080/api/branch/audit/:branch-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [branch.branch.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Filial",
"type": "@OneOf",
"schema": {
"branch-id": "Código"
}
}
Query Input
{
"description": "Registro do(a) Filial",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Filial",
"type": "@OneOf",
"schema": {
"branchAudits": {
"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
branch/collection/options/pu-crt-type
Opções de Tipo de Certificado
GET
http://cftv.barradorio.com.br:8080/api/branch/collection/options/pu-crt-type
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [branch.branch.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Certificado",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
branch/collection/options/pu-role
Opções de Perfil
GET
http://cftv.barradorio.com.br:8080/api/branch/collection/options/pu-role
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [branch.branch.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Perfil",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
branch/collection
Coleção de Filial com informações resumidas e possibilidade de filtro
GET
http://cftv.barradorio.com.br:8080/api/branch/collection
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [branch.branch.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Registro do(a) Filial",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100.",
"order-by": "Atributo de Ordenação. branch.id, branch.name, branch.cnpj, portalUnicoRole.name, branch.puIdentityRecinto, branch.puIdentityRfb, crtType.name, branch.puProduction",
"order-type": "Tipo de Ordenação no Atributo. ASC ou DESC. Padrão DESC",
"filter-id": "Código",
"filter-name-contains": "Nome",
"filter-cnpj-contains": "CNPJ",
"filter-puRole-id": "Perfil",
"filter-puIdentityRecinto-contains": "Código do Recinto",
"filter-puIdentityRfb-contains": "Código da RFB",
"filter-puCrtType-id": "Tipo de Certificado",
"filter-puProduction": "Produção"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Filial",
"type": "@OneOf",
"schema": {
"branchs": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Código",
"name": "Nome",
"cnpj": "CNPJ",
"puRole": {
"description": "Filial",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"puIdentityRecinto": "Código do Recinto",
"puIdentityRfb": "Código da RFB",
"puCrtType": {
"description": "Filial",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"puProduction": "Produçã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
branch/create/options/pu-crt-type
Opções de Tipo de Certificado
GET
http://cftv.barradorio.com.br:8080/api/branch/create/options/pu-crt-type
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [branch.branch.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Certificado",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
branch/create/options/pu-role
Opções de Perfil
GET
http://cftv.barradorio.com.br:8080/api/branch/create/options/pu-role
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [branch.branch.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Perfil",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
branch/create
Criar um(a) Filial
POST
http://cftv.barradorio.com.br:8080/api/branch/create
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [branch.branch.create]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Body Input
{
"description": "Registro do(a) Filial",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Filial",
"type": "@OneOf",
"schema": {
"name": "Nome precisa ser um texto, Nome é obrigatório, Nome precisa ter 80 caracteres",
"cnpj": "CNPJ precisa ter apenas dígitos, CNPJ é obrigatório, CNPJ precisa ter 14 caracteres",
"puRole": {
"description": "Filial",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"puIdentityRecinto": "Código do Recinto precisa ser um texto, Código do Recinto é obrigatório, Código do Recinto precisa ter 15 caracteres",
"puIdentityRfb": "Código da RFB precisa ser um texto, Código da RFB é obrigatório, Código da RFB precisa ter 15 caracteres",
"puCrt": "Certificado precisa ser um texto, Certificado precisa ter 180 caracteres, Certificado é obrigatório, Trata-se do nome do arquivo que está salvo no sistema de arquivos da aplicação",
"puCrtType": {
"description": "Filial",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"puCrtPassword": "Senha do Certificado precisa ser um texto, Senha do Certificado é obrigatório, Senha do Certificado precisa ter 25 caracteres",
"puCrtValidity": "Validade do Certificado precisa ser data e hora (Y-m-d H:i:s), Validade do Certificado é obrigatório",
"puEmailNotify": "E-mail de Notificação precisa ser um texto, E-mail de Notificação é obrigatório, E-mail de Notificação precisa ter 180 caracteres",
"puProduction": "Produção precisa ser verdadeiro ou falso, Produção é obrigatório",
"addressZipcode": "CEP precisa ser um texto, CEP precisa ter 8 caracteres",
"addressUf": "UF precisa ser um texto, UF precisa ter 120 caracteres",
"addressCity": "Cidade precisa ser um texto, Cidade precisa ter 80 caracteres",
"addressDistrict": "Bairro precisa ser um texto, Bairro precisa ter 80 caracteres",
"addressStreet": "Rua precisa ser um texto, Rua precisa ter 120 caracteres",
"addressNumber": "Número precisa ser um texto, Número precisa ter 12 caracteres",
"addressComplements": "Complemento precisa ser um texto, Complemento precisa ter 40 caracteres"
}
}
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Filial",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
branch/delete/:branch-id
Deletar Filial
DELETE
http://cftv.barradorio.com.br:8080/api/branch/delete/:branch-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [branch.branch.delete]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Filial",
"type": "@OneOf",
"schema": {
"branch-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Filial",
"type": "@OneOf",
"schema": {
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
branch/edit/options/pu-crt-type
Opções de Tipo de Certificado
GET
http://cftv.barradorio.com.br:8080/api/branch/edit/options/pu-crt-type
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [branch.branch.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Certificado",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
branch/edit/options/pu-role
Opções de Perfil
GET
http://cftv.barradorio.com.br:8080/api/branch/edit/options/pu-role
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [branch.branch.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Perfil",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
branch/edit/:branch-id
Editar um(a) Filial
POST
http://cftv.barradorio.com.br:8080/api/branch/edit/:branch-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [branch.branch.edit]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Filial",
"type": "@OneOf",
"schema": {
"branch-id": "Código"
}
}
Body Input
{
"description": "Registro do(a) Filial",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Filial",
"type": "@OneOf",
"schema": {
"name": "Nome precisa ser um texto, Nome é obrigatório, Nome precisa ter 80 caracteres",
"cnpj": "CNPJ precisa ter apenas dígitos, CNPJ é obrigatório, CNPJ precisa ter 14 caracteres",
"puRole": {
"description": "Filial",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"puIdentityRecinto": "Código do Recinto precisa ser um texto, Código do Recinto é obrigatório, Código do Recinto precisa ter 15 caracteres",
"puIdentityRfb": "Código da RFB precisa ser um texto, Código da RFB é obrigatório, Código da RFB precisa ter 15 caracteres",
"puCrt": "Certificado precisa ser um texto, Certificado precisa ter 180 caracteres, Certificado é obrigatório, Trata-se do nome do arquivo que está salvo no sistema de arquivos da aplicação",
"puCrtType": {
"description": "Filial",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"puCrtPassword": "Senha do Certificado precisa ser um texto, Senha do Certificado é obrigatório, Senha do Certificado precisa ter 25 caracteres",
"puCrtValidity": "Validade do Certificado precisa ser data e hora (Y-m-d H:i:s), Validade do Certificado é obrigatório",
"puEmailNotify": "E-mail de Notificação precisa ser um texto, E-mail de Notificação é obrigatório, E-mail de Notificação precisa ter 180 caracteres",
"puProduction": "Produção precisa ser verdadeiro ou falso, Produção é obrigatório",
"addressZipcode": "CEP precisa ser um texto, CEP precisa ter 8 caracteres",
"addressUf": "UF precisa ser um texto, UF precisa ter 120 caracteres",
"addressCity": "Cidade precisa ser um texto, Cidade precisa ter 80 caracteres",
"addressDistrict": "Bairro precisa ser um texto, Bairro precisa ter 80 caracteres",
"addressStreet": "Rua precisa ser um texto, Rua precisa ter 120 caracteres",
"addressNumber": "Número precisa ser um texto, Número precisa ter 12 caracteres",
"addressComplements": "Complemento precisa ser um texto, Complemento precisa ter 40 caracteres"
}
}
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Filial",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
branch/get/:branch-id
Obter Filial com todos os detalhes de suas informações
GET
http://cftv.barradorio.com.br:8080/api/branch/get/:branch-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [branch.branch.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Filial",
"type": "@OneOf",
"schema": {
"branch-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Filial",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Filial",
"type": "@OneOf",
"schema": {
"id": "Código",
"name": "Nome",
"cnpj": "CNPJ",
"puRole": {
"description": "Filial",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"puIdentityRecinto": "Código do Recinto",
"puIdentityRfb": "Código da RFB",
"puCrt": "Certificado",
"puCrtType": {
"description": "Filial",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"puCrtPassword": "Senha do Certificado",
"puCrtValidity": "Validade do Certificado",
"puEmailNotify": "E-mail de Notificação",
"puProduction": "Produção",
"addressZipcode": "CEP",
"addressUf": "UF",
"addressCity": "Cidade",
"addressDistrict": "Bairro",
"addressStreet": "Rua",
"addressNumber": "Número",
"addressComplements": "Complemento"
}
}
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
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/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/carregamento-lote/collection/options/branch
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
carregamento-lote/collection/options/integration-status
Opções de Situação
GET
http://cftv.barradorio.com.br:8080/api/carregamento-lote/collection/options/integration-status
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Situação",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
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/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/carregamento-lote/create/options/branch
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
carregamento-lote/create/options/carregamento-lote-camera/georreferenciamento-camera
Opções de Camera em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/carregamento-lote/create/options/carregamento-lote-camera/georreferenciamento-camera
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Camera em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
carregamento-lote/create/options/deliver-person-foreign-document-type
Opções de Estrangeiro - Tipo de Documento
GET
http://cftv.barradorio.com.br:8080/api/carregamento-lote/create/options/deliver-person-foreign-document-type
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Estrangeiro - Tipo de Documento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
carregamento-lote/create/options/georreferenciamento-area-armazenagem
Opções de Area de Armazenagem em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/carregamento-lote/create/options/georreferenciamento-area-armazenagem
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Area de Armazenagem em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
carregamento-lote/create/options/type-customs-declaration
Opções de Tipo de Declaração
GET
http://cftv.barradorio.com.br:8080/api/carregamento-lote/create/options/type-customs-declaration
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Declaração",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
carregamento-lote/create/options/type-lading
Opções de Tipo de Conhecimento
GET
http://cftv.barradorio.com.br:8080/api/carregamento-lote/create/options/type-lading
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Conhecimento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
carregamento-lote/create/options/type-manifest
Opções de Tipo do Manifesto
GET
http://cftv.barradorio.com.br:8080/api/carregamento-lote/create/options/type-manifest
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo do Manifesto",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
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/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/carregamento-lote/edit/options/branch
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
carregamento-lote/edit/options/carregamento-lote-camera/georreferenciamento-camera
Opções de Camera em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/carregamento-lote/edit/options/carregamento-lote-camera/georreferenciamento-camera
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Camera em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
carregamento-lote/edit/options/deliver-person-foreign-document-type
Opções de Estrangeiro - Tipo de Documento
GET
http://cftv.barradorio.com.br:8080/api/carregamento-lote/edit/options/deliver-person-foreign-document-type
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Estrangeiro - Tipo de Documento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
carregamento-lote/edit/options/georreferenciamento-area-armazenagem
Opções de Area de Armazenagem em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/carregamento-lote/edit/options/georreferenciamento-area-armazenagem
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Area de Armazenagem em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
carregamento-lote/edit/options/type-customs-declaration
Opções de Tipo de Declaração
GET
http://cftv.barradorio.com.br:8080/api/carregamento-lote/edit/options/type-customs-declaration
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Declaração",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
carregamento-lote/edit/options/type-lading
Opções de Tipo de Conhecimento
GET
http://cftv.barradorio.com.br:8080/api/carregamento-lote/edit/options/type-lading
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Conhecimento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
carregamento-lote/edit/options/type-manifest
Opções de Tipo do Manifesto
GET
http://cftv.barradorio.com.br:8080/api/carregamento-lote/edit/options/type-manifest
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo do Manifesto",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
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
conferencia-fisica/audit/:conferencia-fisica-id
Obter informações de interações no registro de Conferência Física
GET
http://cftv.barradorio.com.br:8080/api/conferencia-fisica/audit/:conferencia-fisica-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [conferenciaFisica.conferenciaFisica.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Conferência Física",
"type": "@OneOf",
"schema": {
"conferencia-fisica-id": "Código"
}
}
Query Input
{
"description": "Registro do(a) Conferência Física",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Conferência Física",
"type": "@OneOf",
"schema": {
"conferenciaFisicaAudits": {
"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
conferencia-fisica/collection/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/conferencia-fisica/collection/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [conferenciaFisica.conferenciaFisica.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
conferencia-fisica/collection/options/integration-status
Opções de Situação
GET
http://cftv.barradorio.com.br:8080/api/conferencia-fisica/collection/options/integration-status
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [conferenciaFisica.conferenciaFisica.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Situação",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
conferencia-fisica/collection/options/physical-conference-type
Opções de Tipo de Conferência Física
GET
http://cftv.barradorio.com.br:8080/api/conferencia-fisica/collection/options/physical-conference-type
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [conferenciaFisica.conferenciaFisica.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Conferência Física",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
conferencia-fisica/collection
Coleção de Conferência Física com informações resumidas e possibilidade de filtro
GET
http://cftv.barradorio.com.br:8080/api/conferencia-fisica/collection
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [conferenciaFisica.conferenciaFisica.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Registro do(a) Conferência Física",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100.",
"order-by": "Atributo de Ordenação. conferenciaFisica.id, conferenciaFisica.created, conferenciaFisica.updated, integrationStatus.name, branch.name, conferenciaFisica.internalKey, conferenciaFisica.occurrence, conferenciaFisica.operatorCpf, conferenciaFisica.responseProtocol, physicalConferenceType.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-physicalConferenceType-id": "Tipo de Conferência Física"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Conferência Física",
"type": "@OneOf",
"schema": {
"conferenciaFisicas": {
"description": "Conferência Física",
"type": "@ManyOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"integrationStatus": {
"description": "Conferência Física",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"branch": {
"description": "Conferência Física",
"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",
"physicalConferenceType": {
"description": "Conferência Física",
"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
conferencia-fisica/create/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/conferencia-fisica/create/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [conferenciaFisica.conferenciaFisica.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
conferencia-fisica/create/options/conferencia-fisica-camera/georreferenciamento-camera
Opções de Camera em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/conferencia-fisica/create/options/conferencia-fisica-camera/georreferenciamento-camera
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [conferenciaFisica.conferenciaFisica.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Camera em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
conferencia-fisica/create/options/conferencia-fisica-damage/damage-type
Opções de Tipo de Avaria
GET
http://cftv.barradorio.com.br:8080/api/conferencia-fisica/create/options/conferencia-fisica-damage/damage-type
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [conferenciaFisica.conferenciaFisica.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Avaria",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
conferencia-fisica/create/options/type-customs-declaration
Opções de Tipo de Declaração
GET
http://cftv.barradorio.com.br:8080/api/conferencia-fisica/create/options/type-customs-declaration
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [conferenciaFisica.conferenciaFisica.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Declaração",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
conferencia-fisica/create/options/type-lading
Opções de Tipo de Conhecimento
GET
http://cftv.barradorio.com.br:8080/api/conferencia-fisica/create/options/type-lading
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [conferenciaFisica.conferenciaFisica.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Conhecimento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
conferencia-fisica/create/options/type-manifest
Opções de Tipo do Manifesto
GET
http://cftv.barradorio.com.br:8080/api/conferencia-fisica/create/options/type-manifest
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [conferenciaFisica.conferenciaFisica.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo do Manifesto",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
conferencia-fisica/create
Criar um(a) Conferência Física. Enviar imediatamente após a conferencia física da carga. Não enviar para conferência de embalagem de madeira. Um envio por conhecimento.
POST
http://cftv.barradorio.com.br:8080/api/conferencia-fisica/create
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [conferenciaFisica.conferenciaFisica.create]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Body Input
{
"description": "Registro do(a) Conferência Física",
"type": "@OneOf",
"schema": {
"conferenciaFisica": {
"description": "Conferência Física",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Conferência Física",
"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",
"datatimeSchedule": "Data\/Hora de Agendamento precisa ser data e hora (Y-m-d H:i:s), Data\/Hora de Agendamento é obrigatório",
"remote": "Conferencia Remota precisa ser verdadeiro ou falso, Conferencia Remota é obrigatório",
"requester": "Solicitante precisa ser um texto",
"sector": "Setor precisa ser um texto, Setor precisa ter 100 caracteres",
"numberManifest": "Número do Manifesto precisa ser um texto, Número do Manifesto precisa ter 100 caracteres",
"typeManifest": {
"description": "Conferência Física",
"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": "Conferência Física",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"numberCustomsDeclaration": "Número da Declaração precisa ser um texto, Número da Declaração precisa ter 100 caracteres",
"typeCustomsDeclaration": {
"description": "Conferência Física",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"datetimePositioningStart": "Data Inicial de Posicionamento da Carga precisa ser data e hora (Y-m-d H:i:s)",
"datetimePositioningEnd": "Data Final de Posicionamento da Carga precisa ser data e hora (Y-m-d H:i:s)",
"datetimeConferenceStart": "Data Inicial de Conferência da Carga precisa ser data e hora (Y-m-d H:i:s)",
"datetimeConferenceEnd": "Data Final de Conferência da Carga precisa ser data e hora (Y-m-d H:i:s)",
"takeSample": "Retirar Amostra precisa ser verdadeiro ou falso, Retirar Amostra é obrigatório",
"quantityDamageVolumes": "Quantidade de Volumes Avariados precisa ser um número",
"damageNotes": "Observações de Avarias precisa ser um texto, Observações de Avarias precisa ter 200 caracteres",
"quantityDivergence": "Divergência de Quantidade precisa ser verdadeiro ou falso",
"qualificationDivergence": "Divergência de Qualificação precisa ser verdadeiro ou falso",
"quantityVolumesDivergence": "Quantidade de Volumes Divergentes precisa ser um número",
"divergenceNotes": "Observações de Divergências precisa ser um texto, Observações de Divergências precisa ter 200 caracteres",
"conferenciaFisicaPhone": {
"description": "Telefones",
"type": "@ManyOf",
"schema": {
"phone": "Telefone precisa ter apenas dígitos, Telefone é obrigatório, Telefone precisa ter 100 caracteres"
}
},
"conferenciaFisicaPlateSemitrailer": {
"description": "Semirreboque",
"type": "@ManyOf",
"schema": {
"plate": "Placa precisa ser um texto, Placa é obrigatório, Placa precisa ter 50 caracteres"
}
},
"conferenciaFisicaPlateContainer": {
"description": "Container",
"type": "@ManyOf",
"schema": {
"number": "Número precisa ser um texto, Número é obrigatório, Número precisa ter 200 caracteres"
}
},
"conferenciaFisicaPlateUld": {
"description": "Identificação ULD",
"type": "@ManyOf",
"schema": {
"uld": "ULD precisa ser um texto, ULD é obrigatório, ULD precisa ter 10 caracteres"
}
},
"conferenciaFisicaOperator": {
"description": "Operadores do Manuseio de Carga",
"type": "@ManyOf",
"schema": {
"cpf": "CPF precisa ter apenas dígitos, CPF é obrigatório, CPF precisa ter 11 caracteres",
"name": "Nome precisa ser um texto, Nome é obrigatório, Nome precisa ter 100 caracteres"
}
},
"conferenciaFisicaPeople": {
"description": "Pessoas que Acompanharam a Conferência",
"type": "@ManyOf",
"schema": {
"cpf": "CPF precisa ter apenas dígitos, CPF é obrigatório, CPF precisa ter 11 caracteres",
"name": "Nome precisa ser um texto, Nome é obrigatório, Nome precisa ter 100 caracteres",
"role": "Função precisa ser um texto, Função precisa ter 100 caracteres"
}
},
"conferenciaFisicaSeal": {
"description": "Lacres",
"type": "@ManyOf",
"schema": {
"sif": "Local SIF precisa ser um texto, Local SIF precisa ter 100 caracteres",
"number": "Número precisa ser um texto, Número é obrigatório"
}
},
"conferenciaFisicaDamage": {
"description": "Avarias",
"type": "@ManyOf",
"schema": {
"damageType": {
"description": "Avarias",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
}
}
},
"conferenciaFisicaCamera": {
"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) Conferência Física",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
conferencia-fisica/delete/:conferencia-fisica-id
Deletar Conferência Física
DELETE
http://cftv.barradorio.com.br:8080/api/conferencia-fisica/delete/:conferencia-fisica-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [conferenciaFisica.conferenciaFisica.delete]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Conferência Física",
"type": "@OneOf",
"schema": {
"conferencia-fisica-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Conferência Física",
"type": "@OneOf",
"schema": {
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
conferencia-fisica/edit/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/conferencia-fisica/edit/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [conferenciaFisica.conferenciaFisica.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
conferencia-fisica/edit/options/conferencia-fisica-camera/georreferenciamento-camera
Opções de Camera em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/conferencia-fisica/edit/options/conferencia-fisica-camera/georreferenciamento-camera
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [conferenciaFisica.conferenciaFisica.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Camera em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
conferencia-fisica/edit/options/conferencia-fisica-damage/damage-type
Opções de Tipo de Avaria
GET
http://cftv.barradorio.com.br:8080/api/conferencia-fisica/edit/options/conferencia-fisica-damage/damage-type
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [conferenciaFisica.conferenciaFisica.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Avaria",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
conferencia-fisica/edit/options/type-customs-declaration
Opções de Tipo de Declaração
GET
http://cftv.barradorio.com.br:8080/api/conferencia-fisica/edit/options/type-customs-declaration
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [conferenciaFisica.conferenciaFisica.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Declaração",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
conferencia-fisica/edit/options/type-lading
Opções de Tipo de Conhecimento
GET
http://cftv.barradorio.com.br:8080/api/conferencia-fisica/edit/options/type-lading
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [conferenciaFisica.conferenciaFisica.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Conhecimento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
conferencia-fisica/edit/options/type-manifest
Opções de Tipo do Manifesto
GET
http://cftv.barradorio.com.br:8080/api/conferencia-fisica/edit/options/type-manifest
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [conferenciaFisica.conferenciaFisica.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo do Manifesto",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
conferencia-fisica/edit/:conferencia-fisica-id
Editar um(a) Conferência Física. Enviar imediatamente após a conferencia física da carga. Não enviar para conferência de embalagem de madeira. Um envio por conhecimento.
POST
http://cftv.barradorio.com.br:8080/api/conferencia-fisica/edit/:conferencia-fisica-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [conferenciaFisica.conferenciaFisica.edit]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Conferência Física",
"type": "@OneOf",
"schema": {
"conferencia-fisica-id": "Código"
}
}
Body Input
{
"description": "Registro do(a) Conferência Física",
"type": "@OneOf",
"schema": {
"conferenciaFisica": {
"description": "Conferência Física",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Conferência Física",
"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",
"datatimeSchedule": "Data\/Hora de Agendamento precisa ser data e hora (Y-m-d H:i:s), Data\/Hora de Agendamento é obrigatório",
"remote": "Conferencia Remota precisa ser verdadeiro ou falso, Conferencia Remota é obrigatório",
"requester": "Solicitante precisa ser um texto",
"sector": "Setor precisa ser um texto, Setor precisa ter 100 caracteres",
"numberManifest": "Número do Manifesto precisa ser um texto, Número do Manifesto precisa ter 100 caracteres",
"typeManifest": {
"description": "Conferência Física",
"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": "Conferência Física",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"numberCustomsDeclaration": "Número da Declaração precisa ser um texto, Número da Declaração precisa ter 100 caracteres",
"typeCustomsDeclaration": {
"description": "Conferência Física",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"datetimePositioningStart": "Data Inicial de Posicionamento da Carga precisa ser data e hora (Y-m-d H:i:s)",
"datetimePositioningEnd": "Data Final de Posicionamento da Carga precisa ser data e hora (Y-m-d H:i:s)",
"datetimeConferenceStart": "Data Inicial de Conferência da Carga precisa ser data e hora (Y-m-d H:i:s)",
"datetimeConferenceEnd": "Data Final de Conferência da Carga precisa ser data e hora (Y-m-d H:i:s)",
"takeSample": "Retirar Amostra precisa ser verdadeiro ou falso, Retirar Amostra é obrigatório",
"quantityDamageVolumes": "Quantidade de Volumes Avariados precisa ser um número",
"damageNotes": "Observações de Avarias precisa ser um texto, Observações de Avarias precisa ter 200 caracteres",
"quantityDivergence": "Divergência de Quantidade precisa ser verdadeiro ou falso",
"qualificationDivergence": "Divergência de Qualificação precisa ser verdadeiro ou falso",
"quantityVolumesDivergence": "Quantidade de Volumes Divergentes precisa ser um número",
"divergenceNotes": "Observações de Divergências precisa ser um texto, Observações de Divergências precisa ter 200 caracteres",
"conferenciaFisicaPhone": {
"description": "Telefones",
"type": "@ManyOf",
"schema": {
"id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente",
"phone": "Telefone precisa ter apenas dígitos, Telefone é obrigatório, Telefone precisa ter 100 caracteres"
}
},
"conferenciaFisicaPlateSemitrailer": {
"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"
}
},
"conferenciaFisicaPlateContainer": {
"description": "Container",
"type": "@ManyOf",
"schema": {
"id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente",
"number": "Número precisa ser um texto, Número é obrigatório, Número precisa ter 200 caracteres"
}
},
"conferenciaFisicaPlateUld": {
"description": "Identificação ULD",
"type": "@ManyOf",
"schema": {
"id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente",
"uld": "ULD precisa ser um texto, ULD é obrigatório, ULD precisa ter 10 caracteres"
}
},
"conferenciaFisicaOperator": {
"description": "Operadores do Manuseio de Carga",
"type": "@ManyOf",
"schema": {
"id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente",
"cpf": "CPF precisa ter apenas dígitos, CPF é obrigatório, CPF precisa ter 11 caracteres",
"name": "Nome precisa ser um texto, Nome é obrigatório, Nome precisa ter 100 caracteres"
}
},
"conferenciaFisicaPeople": {
"description": "Pessoas que Acompanharam a Conferência",
"type": "@ManyOf",
"schema": {
"id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente",
"cpf": "CPF precisa ter apenas dígitos, CPF é obrigatório, CPF precisa ter 11 caracteres",
"name": "Nome precisa ser um texto, Nome é obrigatório, Nome precisa ter 100 caracteres",
"role": "Função precisa ser um texto, Função precisa ter 100 caracteres"
}
},
"conferenciaFisicaSeal": {
"description": "Lacres",
"type": "@ManyOf",
"schema": {
"id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente",
"sif": "Local SIF precisa ser um texto, Local SIF precisa ter 100 caracteres",
"number": "Número precisa ser um texto, Número é obrigatório"
}
},
"conferenciaFisicaDamage": {
"description": "Avarias",
"type": "@ManyOf",
"schema": {
"id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente",
"damageType": {
"description": "Avarias",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
}
}
},
"conferenciaFisicaCamera": {
"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) Conferência Física",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
conferencia-fisica/get/:conferencia-fisica-id
Obter Conferência Física com todos os detalhes de suas informações
GET
http://cftv.barradorio.com.br:8080/api/conferencia-fisica/get/:conferencia-fisica-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [conferenciaFisica.conferenciaFisica.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Conferência Física",
"type": "@OneOf",
"schema": {
"conferencia-fisica-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Conferência Física",
"type": "@OneOf",
"schema": {
"conferenciaFisica": {
"description": "Conferência Física",
"type": "@OneOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"integrationStatus": {
"description": "Conferência Física",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"branch": {
"description": "Conferência Física",
"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",
"physicalConferenceType": {
"description": "Conferência Física",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"datatimeSchedule": "Data\/Hora de Agendamento",
"remote": "Conferencia Remota",
"requester": "Solicitante",
"sector": "Setor",
"numberManifest": "Número do Manifesto",
"typeManifest": {
"description": "Conferência Física",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"number": "Número do Conhecimento",
"numberMawb": "Número do Conhecimento Master",
"typeLading": {
"description": "Conferência Física",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"numberCustomsDeclaration": "Número da Declaração",
"typeCustomsDeclaration": {
"description": "Conferência Física",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"datetimePositioningStart": "Data Inicial de Posicionamento da Carga",
"datetimePositioningEnd": "Data Final de Posicionamento da Carga",
"datetimeConferenceStart": "Data Inicial de Conferência da Carga",
"datetimeConferenceEnd": "Data Final de Conferência da Carga",
"takeSample": "Retirar Amostra",
"quantityDamageVolumes": "Quantidade de Volumes Avariados",
"damageNotes": "Observações de Avarias",
"quantityDivergence": "Divergência de Quantidade",
"qualificationDivergence": "Divergência de Qualificação",
"quantityVolumesDivergence": "Quantidade de Volumes Divergentes",
"divergenceNotes": "Observações de Divergências",
"conferenciaFisicaPhone": {
"description": "Telefones",
"type": "@ManyOf",
"schema": {
"id": "Código",
"phone": "Telefone"
}
},
"conferenciaFisicaPlateSemitrailer": {
"description": "Semirreboque",
"type": "@ManyOf",
"schema": {
"id": "Código",
"plate": "Placa"
}
},
"conferenciaFisicaPlateContainer": {
"description": "Container",
"type": "@ManyOf",
"schema": {
"id": "Código",
"number": "Número"
}
},
"conferenciaFisicaPlateUld": {
"description": "Identificação ULD",
"type": "@ManyOf",
"schema": {
"id": "Código",
"uld": "ULD"
}
},
"conferenciaFisicaOperator": {
"description": "Operadores do Manuseio de Carga",
"type": "@ManyOf",
"schema": {
"id": "Código",
"cpf": "CPF",
"name": "Nome"
}
},
"conferenciaFisicaPeople": {
"description": "Pessoas que Acompanharam a Conferência",
"type": "@ManyOf",
"schema": {
"id": "Código",
"cpf": "CPF",
"name": "Nome",
"role": "Função"
}
},
"conferenciaFisicaSeal": {
"description": "Lacres",
"type": "@ManyOf",
"schema": {
"id": "Código",
"sif": "Local SIF",
"number": "Número",
"sealType": {
"description": "Lacres",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
}
}
},
"conferenciaFisicaDamage": {
"description": "Avarias",
"type": "@ManyOf",
"schema": {
"id": "Código",
"damageType": {
"description": "Avarias",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
}
}
},
"conferenciaFisicaCamera": {
"description": "Cameras",
"type": "@ManyOf",
"schema": {
"id": "Código",
"georreferenciamentoCamera": {
"description": "Cameras",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
}
}
},
"conferenciaFisicaIntegration": {
"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
credenciamento-pessoas/audit/:credenciamento-pessoas-id
Obter informações de interações no registro de Credenciamento de Pessoas
GET
http://cftv.barradorio.com.br:8080/api/credenciamento-pessoas/audit/:credenciamento-pessoas-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [credenciamentoPessoas.credenciamentoPessoas.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Credenciamento de Pessoas",
"type": "@OneOf",
"schema": {
"credenciamento-pessoas-id": "Código"
}
}
Query Input
{
"description": "Registro do(a) Credenciamento de Pessoas",
"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 Pessoas",
"type": "@OneOf",
"schema": {
"credenciamentoPessoasAudits": {
"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-pessoas/collection/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/credenciamento-pessoas/collection/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [credenciamentoPessoas.credenciamentoPessoas.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
credenciamento-pessoas/collection/options/integration-status
Opções de Situação
GET
http://cftv.barradorio.com.br:8080/api/credenciamento-pessoas/collection/options/integration-status
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [credenciamentoPessoas.credenciamentoPessoas.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Situação",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
credenciamento-pessoas/collection
Coleção de Credenciamento de Pessoas com informações resumidas e possibilidade de filtro
GET
http://cftv.barradorio.com.br:8080/api/credenciamento-pessoas/collection
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [credenciamentoPessoas.credenciamentoPessoas.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Registro do(a) Credenciamento de Pessoas",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100.",
"order-by": "Atributo de Ordenação. credenciamentoPessoas.id, credenciamentoPessoas.created, credenciamentoPessoas.updated, integrationStatus.name, branch.name, credenciamentoPessoas.internalKey, credenciamentoPessoas.occurrence, credenciamentoPessoas.operatorCpf, credenciamentoPessoas.responseProtocol, credenciamentoPessoas.cpf, credenciamentoPessoas.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-cpf-contains": "CPF",
"filter-name-contains": "Nome"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Credenciamento de Pessoas",
"type": "@OneOf",
"schema": {
"credenciamentoPessoass": {
"description": "Credenciamento de Pessoas",
"type": "@ManyOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"integrationStatus": {
"description": "Credenciamento de Pessoas",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"branch": {
"description": "Credenciamento de Pessoas",
"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",
"cpf": "CPF",
"name": "Nome"
}
},
"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-pessoas/create/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/credenciamento-pessoas/create/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [credenciamentoPessoas.credenciamentoPessoas.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
credenciamento-pessoas/create/options/foreign-document-represented-type
Opções de Documento Estrangeiro Representado - Tipo de Documento
GET
http://cftv.barradorio.com.br:8080/api/credenciamento-pessoas/create/options/foreign-document-represented-type
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [credenciamentoPessoas.credenciamentoPessoas.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Documento Estrangeiro Representado - Tipo de Documento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
credenciamento-pessoas/create/options/foreign-document-type
Opções de Documento Estrangeiro - Tipo de Documento
GET
http://cftv.barradorio.com.br:8080/api/credenciamento-pessoas/create/options/foreign-document-type
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [credenciamentoPessoas.credenciamentoPessoas.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Documento Estrangeiro - Tipo de Documento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
credenciamento-pessoas/create/options/genre
Opções de Gênero
GET
http://cftv.barradorio.com.br:8080/api/credenciamento-pessoas/create/options/genre
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [credenciamentoPessoas.credenciamentoPessoas.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Gênero",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
credenciamento-pessoas/create
Criar um(a) Credenciamento de Pessoas. Enviar imediatamente após o cadastramento de uma pessoa autorizado a entrada/saída do recinto. Um envio por pessoa (CPF).
POST
http://cftv.barradorio.com.br:8080/api/credenciamento-pessoas/create
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [credenciamentoPessoas.credenciamentoPessoas.create]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Body Input
{
"description": "Registro do(a) Credenciamento de Pessoas",
"type": "@OneOf",
"schema": {
"credenciamentoPessoas": {
"description": "Credenciamento de Pessoas",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Credenciamento de Pessoas",
"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",
"cpf": "CPF precisa ter apenas dígitos, CPF é obrigatório, CPF precisa ter 11 caracteres",
"foreignOperatorRepresented": "Operador Estrangeiro Representado precisa ser um texto, Operador Estrangeiro Representado precisa ter 50 caracteres",
"foreignDocumentNumber": "Documento Estrangeiro - Número precisa ser um texto, Documento Estrangeiro - Número precisa ter 50 caracteres",
"foreignDocumentCountry": "Documento Estrangeiro - País (SIGLA) precisa ser um texto, Documento Estrangeiro - País (SIGLA) precisa ter 2 caracteres",
"foreignDocumentType": {
"description": "Credenciamento de Pessoas",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"foreignDocumentValidity": "Documento Estrangeiro - Validade precisa ser data e hora (Y-m-d H:i:s)",
"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 Pessoas",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"foreignDocumentRepresentedValidity": "Documento Estrangeiro Representado - Validade precisa ser data e hora (Y-m-d H:i:s)",
"name": "Nome precisa ser um texto, Nome é obrigatório, Nome precisa ter 100 caracteres",
"country": "País (SIGLA) precisa ser um texto, País (SIGLA) precisa ter 2 caracteres",
"genre": {
"description": "Credenciamento de Pessoas",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"cnh": "CNH precisa ser um texto, CNH precisa ter 50 caracteres",
"birthday": "Data de Nascimento precisa ser data e hora (Y-m-d H:i:s)",
"phone": "Telefone precisa ter apenas dígitos, Telefone precisa ter 20 caracteres",
"cnpjRepresented": "CNPJ Representado precisa ter apenas dígitos, CNPJ Representado precisa ter 20 caracteres",
"cpfRepresented": "CPF Representado precisa ter apenas dígitos, CPF Representado precisa ter 11 caracteres",
"nameRepresented": "Nome Representado precisa ser um texto, Nome Representado precisa ter 100 caracteres",
"qualification": "Qualificação precisa ser um texto, Qualificação precisa ter 50 caracteres",
"role": "Função precisa ser um texto, Função precisa ter 50 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 Saida precisa ser data e hora (Y-m-d H:i:s)",
"areas": "Areas de Acesso precisa ser um texto, Areas de Acesso precisa ter 50 caracteres",
"workingToolsDescription": "Materiais e Ferramentas de Trabalho precisa ser um texto, Materiais e Ferramentas de Trabalho 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 Pessoas",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
credenciamento-pessoas/delete/:credenciamento-pessoas-id
Deletar Credenciamento de Pessoas
DELETE
http://cftv.barradorio.com.br:8080/api/credenciamento-pessoas/delete/:credenciamento-pessoas-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [credenciamentoPessoas.credenciamentoPessoas.delete]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Credenciamento de Pessoas",
"type": "@OneOf",
"schema": {
"credenciamento-pessoas-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Credenciamento de Pessoas",
"type": "@OneOf",
"schema": {
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
credenciamento-pessoas/edit/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/credenciamento-pessoas/edit/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [credenciamentoPessoas.credenciamentoPessoas.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
credenciamento-pessoas/edit/options/foreign-document-represented-type
Opções de Documento Estrangeiro Representado - Tipo de Documento
GET
http://cftv.barradorio.com.br:8080/api/credenciamento-pessoas/edit/options/foreign-document-represented-type
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [credenciamentoPessoas.credenciamentoPessoas.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Documento Estrangeiro Representado - Tipo de Documento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
credenciamento-pessoas/edit/options/foreign-document-type
Opções de Documento Estrangeiro - Tipo de Documento
GET
http://cftv.barradorio.com.br:8080/api/credenciamento-pessoas/edit/options/foreign-document-type
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [credenciamentoPessoas.credenciamentoPessoas.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Documento Estrangeiro - Tipo de Documento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
credenciamento-pessoas/edit/options/genre
Opções de Gênero
GET
http://cftv.barradorio.com.br:8080/api/credenciamento-pessoas/edit/options/genre
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [credenciamentoPessoas.credenciamentoPessoas.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Gênero",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
credenciamento-pessoas/edit/:credenciamento-pessoas-id
Editar um(a) Credenciamento de Pessoas. Enviar imediatamente após o cadastramento de uma pessoa autorizado a entrada/saída do recinto. Um envio por pessoa (CPF).
POST
http://cftv.barradorio.com.br:8080/api/credenciamento-pessoas/edit/:credenciamento-pessoas-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [credenciamentoPessoas.credenciamentoPessoas.edit]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Credenciamento de Pessoas",
"type": "@OneOf",
"schema": {
"credenciamento-pessoas-id": "Código"
}
}
Body Input
{
"description": "Registro do(a) Credenciamento de Pessoas",
"type": "@OneOf",
"schema": {
"credenciamentoPessoas": {
"description": "Credenciamento de Pessoas",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Credenciamento de Pessoas",
"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",
"cpf": "CPF precisa ter apenas dígitos, CPF é obrigatório, CPF precisa ter 11 caracteres",
"foreignOperatorRepresented": "Operador Estrangeiro Representado precisa ser um texto, Operador Estrangeiro Representado precisa ter 50 caracteres",
"foreignDocumentNumber": "Documento Estrangeiro - Número precisa ser um texto, Documento Estrangeiro - Número precisa ter 50 caracteres",
"foreignDocumentCountry": "Documento Estrangeiro - País (SIGLA) precisa ser um texto, Documento Estrangeiro - País (SIGLA) precisa ter 2 caracteres",
"foreignDocumentType": {
"description": "Credenciamento de Pessoas",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"foreignDocumentValidity": "Documento Estrangeiro - Validade precisa ser data e hora (Y-m-d H:i:s)",
"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 Pessoas",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"foreignDocumentRepresentedValidity": "Documento Estrangeiro Representado - Validade precisa ser data e hora (Y-m-d H:i:s)",
"name": "Nome precisa ser um texto, Nome é obrigatório, Nome precisa ter 100 caracteres",
"country": "País (SIGLA) precisa ser um texto, País (SIGLA) precisa ter 2 caracteres",
"genre": {
"description": "Credenciamento de Pessoas",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"cnh": "CNH precisa ser um texto, CNH precisa ter 50 caracteres",
"birthday": "Data de Nascimento precisa ser data e hora (Y-m-d H:i:s)",
"phone": "Telefone precisa ter apenas dígitos, Telefone precisa ter 20 caracteres",
"cnpjRepresented": "CNPJ Representado precisa ter apenas dígitos, CNPJ Representado precisa ter 20 caracteres",
"cpfRepresented": "CPF Representado precisa ter apenas dígitos, CPF Representado precisa ter 11 caracteres",
"nameRepresented": "Nome Representado precisa ser um texto, Nome Representado precisa ter 100 caracteres",
"qualification": "Qualificação precisa ser um texto, Qualificação precisa ter 50 caracteres",
"role": "Função precisa ser um texto, Função precisa ter 50 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 Saida precisa ser data e hora (Y-m-d H:i:s)",
"areas": "Areas de Acesso precisa ser um texto, Areas de Acesso precisa ter 50 caracteres",
"workingToolsDescription": "Materiais e Ferramentas de Trabalho precisa ser um texto, Materiais e Ferramentas de Trabalho 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 Pessoas",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
credenciamento-pessoas/get/:credenciamento-pessoas-id
Obter Credenciamento de Pessoas com todos os detalhes de suas informações
GET
http://cftv.barradorio.com.br:8080/api/credenciamento-pessoas/get/:credenciamento-pessoas-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [credenciamentoPessoas.credenciamentoPessoas.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Credenciamento de Pessoas",
"type": "@OneOf",
"schema": {
"credenciamento-pessoas-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Credenciamento de Pessoas",
"type": "@OneOf",
"schema": {
"credenciamentoPessoas": {
"description": "Credenciamento de Pessoas",
"type": "@OneOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"integrationStatus": {
"description": "Credenciamento de Pessoas",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"branch": {
"description": "Credenciamento de Pessoas",
"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",
"cpf": "CPF",
"foreignOperatorRepresented": "Operador Estrangeiro Representado",
"foreignDocumentNumber": "Documento Estrangeiro - Número",
"foreignDocumentCountry": "Documento Estrangeiro - País (SIGLA)",
"foreignDocumentType": {
"description": "Credenciamento de Pessoas",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"foreignDocumentValidity": "Documento Estrangeiro - Validade",
"foreignDocumentRepresentedNumber": "Documento Estrangeiro Representado - Número",
"foreignDocumentRepresentedCountry": "Documento Estrangeiro Representado - País (SIGLA)",
"foreignDocumentRepresentedType": {
"description": "Credenciamento de Pessoas",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"foreignDocumentRepresentedValidity": "Documento Estrangeiro Representado - Validade",
"name": "Nome",
"country": "País (SIGLA)",
"genre": {
"description": "Credenciamento de Pessoas",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"cnh": "CNH",
"birthday": "Data de Nascimento",
"phone": "Telefone",
"cnpjRepresented": "CNPJ Representado",
"cpfRepresented": "CPF Representado",
"nameRepresented": "Nome Representado",
"qualification": "Qualificação",
"role": "Função",
"validityStart": "Data de Inicio de Validade",
"validityEnd": "Data Final de Validade",
"timeInForecast": "Previsão de Hora de Entrada",
"timeOutForecast": "Previsão de Hora de Saida",
"areas": "Areas de Acesso",
"workingToolsDescription": "Materiais e Ferramentas de Trabalho",
"enabled": "Credenciamento Ativo",
"reason": "Motivação do Credenciamento",
"credenciamentoPessoasIntegration": {
"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
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/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/credenciamento-veiculos/collection/options/branch
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
credenciamento-veiculos/collection/options/integration-status
Opções de Situação
GET
http://cftv.barradorio.com.br:8080/api/credenciamento-veiculos/collection/options/integration-status
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Situação",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
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/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/credenciamento-veiculos/create/options/branch
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
credenciamento-veiculos/create/options/foreign-document-represented-type
Opções de Documento Estrangeiro Representado - Tipo de Documento
GET
http://cftv.barradorio.com.br:8080/api/credenciamento-veiculos/create/options/foreign-document-represented-type
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Documento Estrangeiro Representado - Tipo de Documento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
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/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/credenciamento-veiculos/edit/options/branch
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
credenciamento-veiculos/edit/options/foreign-document-represented-type
Opções de Documento Estrangeiro Representado - Tipo de Documento
GET
http://cftv.barradorio.com.br:8080/api/credenciamento-veiculos/edit/options/foreign-document-represented-type
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Documento Estrangeiro Representado - Tipo de Documento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
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
embarque-desembarque-navio/audit/:embarque-desembarque-navio-id
Obter informações de interações no registro de Embarque/Desembarque no Navio
GET
http://cftv.barradorio.com.br:8080/api/embarque-desembarque-navio/audit/:embarque-desembarque-navio-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [embarqueDesembarqueNavio.embarqueDesembarqueNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"embarque-desembarque-navio-id": "Código"
}
}
Query Input
{
"description": "Registro do(a) Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"embarqueDesembarqueNavioAudits": {
"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
embarque-desembarque-navio/collection/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/embarque-desembarque-navio/collection/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [embarqueDesembarqueNavio.embarqueDesembarqueNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
embarque-desembarque-navio/collection/options/integration-status
Opções de Situação
GET
http://cftv.barradorio.com.br:8080/api/embarque-desembarque-navio/collection/options/integration-status
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [embarqueDesembarqueNavio.embarqueDesembarqueNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Situação",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
embarque-desembarque-navio/collection
Coleção de Embarque/Desembarque no Navio com informações resumidas e possibilidade de filtro
GET
http://cftv.barradorio.com.br:8080/api/embarque-desembarque-navio/collection
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [embarqueDesembarqueNavio.embarqueDesembarqueNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Registro do(a) Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100.",
"order-by": "Atributo de Ordenação. embarqueDesembarqueNavio.id, embarqueDesembarqueNavio.created, embarqueDesembarqueNavio.updated, integrationStatus.name, branch.name, embarqueDesembarqueNavio.internalKey, embarqueDesembarqueNavio.occurrence, embarqueDesembarqueNavio.operatorCpf, embarqueDesembarqueNavio.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) Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"embarqueDesembarqueNavios": {
"description": "Embarque\/Desembarque no Navio",
"type": "@ManyOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"deleted": "Data de Deleçao",
"integrationStatus": {
"description": "Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"branch": {
"description": "Embarque\/Desembarque no Navio",
"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
embarque-desembarque-navio/create/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/embarque-desembarque-navio/create/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [embarqueDesembarqueNavio.embarqueDesembarqueNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
embarque-desembarque-navio/create/options/bulk-type
Opções de Tipo Granel
GET
http://cftv.barradorio.com.br:8080/api/embarque-desembarque-navio/create/options/bulk-type
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [embarqueDesembarqueNavio.embarqueDesembarqueNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo Granel",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
embarque-desembarque-navio/create/options/embarque-desembarque-navio-camera/georreferenciamento-camera
Opções de Camera em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/embarque-desembarque-navio/create/options/embarque-desembarque-navio-camera/georreferenciamento-camera
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [embarqueDesembarqueNavio.embarqueDesembarqueNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Camera em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
embarque-desembarque-navio/create/options/embarque-desembarque-navio-conhecimento/type-lading
Opções de Tipo de Conhecimento
GET
http://cftv.barradorio.com.br:8080/api/embarque-desembarque-navio/create/options/embarque-desembarque-navio-conhecimento/type-lading
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [embarqueDesembarqueNavio.embarqueDesembarqueNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Conhecimento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
embarque-desembarque-navio/create/options/embarque-desembarque-navio-conhecimento/type-manifest
Opções de Tipo do Manifesto
GET
http://cftv.barradorio.com.br:8080/api/embarque-desembarque-navio/create/options/embarque-desembarque-navio-conhecimento/type-manifest
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [embarqueDesembarqueNavio.embarqueDesembarqueNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo do Manifesto",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
embarque-desembarque-navio/create/options/container-type
Opções de Tipo de Container
GET
http://cftv.barradorio.com.br:8080/api/embarque-desembarque-navio/create/options/container-type
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [embarqueDesembarqueNavio.embarqueDesembarqueNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Container",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
embarque-desembarque-navio/create/options/embarque-desembarque-navio-declaracao-aduaneira/type-customs-declaration
Opções de Tipo de Declaração
GET
http://cftv.barradorio.com.br:8080/api/embarque-desembarque-navio/create/options/embarque-desembarque-navio-declaracao-aduaneira/type-customs-declaration
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [embarqueDesembarqueNavio.embarqueDesembarqueNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Declaração",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
embarque-desembarque-navio/create/options/georreferenciamento-portainer
Opções de Portainer em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/embarque-desembarque-navio/create/options/georreferenciamento-portainer
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [embarqueDesembarqueNavio.embarqueDesembarqueNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Portainer em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
embarque-desembarque-navio/create/options/ship-operation
Opções de Embarque/Desembarque
GET
http://cftv.barradorio.com.br:8080/api/embarque-desembarque-navio/create/options/ship-operation
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [embarqueDesembarqueNavio.embarqueDesembarqueNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Embarque\/Desembarque",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
embarque-desembarque-navio/create/options/embarque-desembarque-navio-volume/type-packing
Opções de Tipo do Embalagem
GET
http://cftv.barradorio.com.br:8080/api/embarque-desembarque-navio/create/options/embarque-desembarque-navio-volume/type-packing
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [embarqueDesembarqueNavio.embarqueDesembarqueNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo do Embalagem",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
embarque-desembarque-navio/create
Criar um(a) Embarque/Desembarque no Navio. Enviar em imediato após o encerramento de embarque ou desembarque de navios no recinto. Enviar também após transbordo e baldeação entre navios. Deverá ser feito um envio por container/granel/carga solta embarcado ou desembarcado.
POST
http://cftv.barradorio.com.br:8080/api/embarque-desembarque-navio/create
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [embarqueDesembarqueNavio.embarqueDesembarqueNavio.create]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Body Input
{
"description": "Registro do(a) Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"embarqueDesembarqueNavio": {
"description": "Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Embarque\/Desembarque no Navio",
"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",
"shipOperation": {
"description": "Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"containerNumber": "Número do Container precisa ser um texto, Número do Container precisa ter 200 caracteres",
"containerType": {
"description": "Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"containerTara": "Tara do Container precisa ser um número decimal",
"grossWeightManifest": "Peso Bruto do Manifesto precisa ser um número decimal",
"grossWeightScale": "Peso Bruto da Balança precisa ser um número decimal",
"grossWeightTonnage": "Peso Arqueação precisa ser um número decimal",
"ncm": "NCM da Mercadoria precisa ser um texto, NCM da Mercadoria precisa ter 8 caracteres",
"bulkType": {
"description": "Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"volume": "Volume (Metros Cubicos) precisa ser um número decimal",
"looseCargo": "Carga Solta precisa ser verdadeiro ou falso",
"lotNumber": "Numero do Lote precisa ser um texto, Numero do Lote é obrigatório, Numero do Lote precisa ter 100 caracteres",
"shipImo": "IMO do Navio precisa ser um texto, IMO do Navio é obrigatório, IMO do Navio precisa ter 10 caracteres",
"shipName": "Nome do Navio precisa ser um texto, Nome do Navio é obrigatório, Nome do Navio precisa ter 100 caracteres",
"travel": "Viagem precisa ser um texto, Viagem é obrigatório, Viagem precisa ter 20 caracteres",
"stopover": "Escala precisa ser um texto, Escala é obrigatório, Escala precisa ter 20 caracteres",
"shipContainerPosition": "Posição do Container no Navio precisa ser um texto, Posição do Container no Navio precisa ter 20 caracteres",
"nextShipImo": "IMO do Próximo Navio (Transbordo ou Baldeação de Carga) precisa ser um texto, IMO do Próximo Navio (Transbordo ou Baldeação de Carga) precisa ter 10 caracteres",
"nextShipName": "Nome do Próximo Navio (Transbordo ou Baldeação de Carga) precisa ser um texto, Nome do Próximo Navio (Transbordo ou Baldeação de Carga) precisa ter 100 caracteres",
"georreferenciamentoPortainer": {
"description": "Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"embarqueDesembarqueNavioChassi": {
"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"
}
},
"embarqueDesembarqueNavioVolume": {
"description": "Volumes",
"type": "@ManyOf",
"schema": {
"containWood": "Contém Madeira precisa ser verdadeiro ou falso, Contém Madeira é obrigatório",
"quantity": "Quantidade precisa ser um número, Quantidade é obrigatório",
"typePacking": {
"description": "Volumes",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
}
}
},
"embarqueDesembarqueNavioCarregamento": {
"description": "Porto de Carregamento",
"type": "@ManyOf",
"schema": {
"port": "Porto precisa ser um texto, Porto é obrigatório"
}
},
"embarqueDesembarqueNavioDescarregamento": {
"description": "Porto de Descarregamento",
"type": "@ManyOf",
"schema": {
"port": "Porto precisa ser um texto, Porto é obrigatório"
}
},
"embarqueDesembarqueNavioPais": {
"description": "País Destino Final",
"type": "@ManyOf",
"schema": {
"country": "País (SIGLA) precisa ser um texto, País (SIGLA) é obrigatório, País (SIGLA) precisa ter 2 caracteres"
}
},
"embarqueDesembarqueNavioConhecimento": {
"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"
}
}
}
},
"embarqueDesembarqueNavioDeclaracaoAduaneira": {
"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"
}
}
}
},
"embarqueDesembarqueNavioNfe": {
"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"
}
},
"embarqueDesembarqueNavioCamera": {
"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) Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
embarque-desembarque-navio/delete/:embarque-desembarque-navio-id
Deletar Embarque/Desembarque no Navio
DELETE
http://cftv.barradorio.com.br:8080/api/embarque-desembarque-navio/delete/:embarque-desembarque-navio-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [embarqueDesembarqueNavio.embarqueDesembarqueNavio.delete]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"embarque-desembarque-navio-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
embarque-desembarque-navio/edit/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/embarque-desembarque-navio/edit/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [embarqueDesembarqueNavio.embarqueDesembarqueNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
embarque-desembarque-navio/edit/options/bulk-type
Opções de Tipo Granel
GET
http://cftv.barradorio.com.br:8080/api/embarque-desembarque-navio/edit/options/bulk-type
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [embarqueDesembarqueNavio.embarqueDesembarqueNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo Granel",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
embarque-desembarque-navio/edit/options/embarque-desembarque-navio-camera/georreferenciamento-camera
Opções de Camera em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/embarque-desembarque-navio/edit/options/embarque-desembarque-navio-camera/georreferenciamento-camera
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [embarqueDesembarqueNavio.embarqueDesembarqueNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Camera em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
embarque-desembarque-navio/edit/options/embarque-desembarque-navio-conhecimento/type-lading
Opções de Tipo de Conhecimento
GET
http://cftv.barradorio.com.br:8080/api/embarque-desembarque-navio/edit/options/embarque-desembarque-navio-conhecimento/type-lading
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [embarqueDesembarqueNavio.embarqueDesembarqueNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Conhecimento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
embarque-desembarque-navio/edit/options/embarque-desembarque-navio-conhecimento/type-manifest
Opções de Tipo do Manifesto
GET
http://cftv.barradorio.com.br:8080/api/embarque-desembarque-navio/edit/options/embarque-desembarque-navio-conhecimento/type-manifest
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [embarqueDesembarqueNavio.embarqueDesembarqueNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo do Manifesto",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
embarque-desembarque-navio/edit/options/container-type
Opções de Tipo de Container
GET
http://cftv.barradorio.com.br:8080/api/embarque-desembarque-navio/edit/options/container-type
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [embarqueDesembarqueNavio.embarqueDesembarqueNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Container",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
embarque-desembarque-navio/edit/options/embarque-desembarque-navio-declaracao-aduaneira/type-customs-declaration
Opções de Tipo de Declaração
GET
http://cftv.barradorio.com.br:8080/api/embarque-desembarque-navio/edit/options/embarque-desembarque-navio-declaracao-aduaneira/type-customs-declaration
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [embarqueDesembarqueNavio.embarqueDesembarqueNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Declaração",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
embarque-desembarque-navio/edit/options/georreferenciamento-portainer
Opções de Portainer em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/embarque-desembarque-navio/edit/options/georreferenciamento-portainer
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [embarqueDesembarqueNavio.embarqueDesembarqueNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Portainer em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
embarque-desembarque-navio/edit/options/ship-operation
Opções de Embarque/Desembarque
GET
http://cftv.barradorio.com.br:8080/api/embarque-desembarque-navio/edit/options/ship-operation
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [embarqueDesembarqueNavio.embarqueDesembarqueNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Embarque\/Desembarque",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
embarque-desembarque-navio/edit/options/embarque-desembarque-navio-volume/type-packing
Opções de Tipo do Embalagem
GET
http://cftv.barradorio.com.br:8080/api/embarque-desembarque-navio/edit/options/embarque-desembarque-navio-volume/type-packing
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [embarqueDesembarqueNavio.embarqueDesembarqueNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo do Embalagem",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
embarque-desembarque-navio/edit/:embarque-desembarque-navio-id
Editar um(a) Embarque/Desembarque no Navio. Enviar em imediato após o encerramento de embarque ou desembarque de navios no recinto. Enviar também após transbordo e baldeação entre navios. Deverá ser feito um envio por container/granel/carga solta embarcado ou desembarcado.
POST
http://cftv.barradorio.com.br:8080/api/embarque-desembarque-navio/edit/:embarque-desembarque-navio-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [embarqueDesembarqueNavio.embarqueDesembarqueNavio.edit]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"embarque-desembarque-navio-id": "Código"
}
}
Body Input
{
"description": "Registro do(a) Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"embarqueDesembarqueNavio": {
"description": "Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Embarque\/Desembarque no Navio",
"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",
"shipOperation": {
"description": "Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"containerNumber": "Número do Container precisa ser um texto, Número do Container precisa ter 200 caracteres",
"containerType": {
"description": "Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"containerTara": "Tara do Container precisa ser um número decimal",
"grossWeightManifest": "Peso Bruto do Manifesto precisa ser um número decimal",
"grossWeightScale": "Peso Bruto da Balança precisa ser um número decimal",
"grossWeightTonnage": "Peso Arqueação precisa ser um número decimal",
"ncm": "NCM da Mercadoria precisa ser um texto, NCM da Mercadoria precisa ter 8 caracteres",
"bulkType": {
"description": "Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"volume": "Volume (Metros Cubicos) precisa ser um número decimal",
"looseCargo": "Carga Solta precisa ser verdadeiro ou falso",
"lotNumber": "Numero do Lote precisa ser um texto, Numero do Lote é obrigatório, Numero do Lote precisa ter 100 caracteres",
"shipImo": "IMO do Navio precisa ser um texto, IMO do Navio é obrigatório, IMO do Navio precisa ter 10 caracteres",
"shipName": "Nome do Navio precisa ser um texto, Nome do Navio é obrigatório, Nome do Navio precisa ter 100 caracteres",
"travel": "Viagem precisa ser um texto, Viagem é obrigatório, Viagem precisa ter 20 caracteres",
"stopover": "Escala precisa ser um texto, Escala é obrigatório, Escala precisa ter 20 caracteres",
"shipContainerPosition": "Posição do Container no Navio precisa ser um texto, Posição do Container no Navio precisa ter 20 caracteres",
"nextShipImo": "IMO do Próximo Navio (Transbordo ou Baldeação de Carga) precisa ser um texto, IMO do Próximo Navio (Transbordo ou Baldeação de Carga) precisa ter 10 caracteres",
"nextShipName": "Nome do Próximo Navio (Transbordo ou Baldeação de Carga) precisa ser um texto, Nome do Próximo Navio (Transbordo ou Baldeação de Carga) precisa ter 100 caracteres",
"georreferenciamentoPortainer": {
"description": "Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"embarqueDesembarqueNavioChassi": {
"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"
}
},
"embarqueDesembarqueNavioVolume": {
"description": "Volumes",
"type": "@ManyOf",
"schema": {
"id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente",
"containWood": "Contém Madeira precisa ser verdadeiro ou falso, Contém Madeira é obrigatório",
"quantity": "Quantidade precisa ser um número, Quantidade é obrigatório",
"typePacking": {
"description": "Volumes",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
}
}
},
"embarqueDesembarqueNavioCarregamento": {
"description": "Porto de Carregamento",
"type": "@ManyOf",
"schema": {
"id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente",
"port": "Porto precisa ser um texto, Porto é obrigatório"
}
},
"embarqueDesembarqueNavioDescarregamento": {
"description": "Porto de Descarregamento",
"type": "@ManyOf",
"schema": {
"id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente",
"port": "Porto precisa ser um texto, Porto é obrigatório"
}
},
"embarqueDesembarqueNavioPais": {
"description": "País Destino Final",
"type": "@ManyOf",
"schema": {
"id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente",
"country": "País (SIGLA) precisa ser um texto, País (SIGLA) é obrigatório, País (SIGLA) precisa ter 2 caracteres"
}
},
"embarqueDesembarqueNavioConhecimento": {
"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"
}
}
}
},
"embarqueDesembarqueNavioDeclaracaoAduaneira": {
"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"
}
}
}
},
"embarqueDesembarqueNavioNfe": {
"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"
}
},
"embarqueDesembarqueNavioCamera": {
"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) Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
embarque-desembarque-navio/get/:embarque-desembarque-navio-id
Obter Embarque/Desembarque no Navio com todos os detalhes de suas informações
GET
http://cftv.barradorio.com.br:8080/api/embarque-desembarque-navio/get/:embarque-desembarque-navio-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [embarqueDesembarqueNavio.embarqueDesembarqueNavio.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"embarque-desembarque-navio-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"embarqueDesembarqueNavio": {
"description": "Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"deleted": "Data de Deleçao",
"integrationStatus": {
"description": "Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"branch": {
"description": "Embarque\/Desembarque no Navio",
"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",
"shipOperation": {
"description": "Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"containerNumber": "Número do Container",
"containerType": {
"description": "Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"containerTara": "Tara do Container",
"grossWeightManifest": "Peso Bruto do Manifesto",
"grossWeightScale": "Peso Bruto da Balança",
"grossWeightTonnage": "Peso Arqueação",
"ncm": "NCM da Mercadoria",
"bulkType": {
"description": "Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"volume": "Volume (Metros Cubicos)",
"looseCargo": "Carga Solta",
"lotNumber": "Numero do Lote",
"shipImo": "IMO do Navio",
"shipName": "Nome do Navio",
"travel": "Viagem",
"stopover": "Escala",
"shipContainerPosition": "Posição do Container no Navio",
"nextShipImo": "IMO do Próximo Navio (Transbordo ou Baldeação de Carga)",
"nextShipName": "Nome do Próximo Navio (Transbordo ou Baldeação de Carga)",
"georreferenciamentoPortainer": {
"description": "Embarque\/Desembarque no Navio",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"embarqueDesembarqueNavioChassi": {
"description": "Chassi",
"type": "@ManyOf",
"schema": {
"id": "Código",
"number": "Número do Chassi"
}
},
"embarqueDesembarqueNavioVolume": {
"description": "Volumes",
"type": "@ManyOf",
"schema": {
"id": "Código",
"containWood": "Contém Madeira",
"quantity": "Quantidade",
"typePacking": {
"description": "Volumes",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
}
}
},
"embarqueDesembarqueNavioCarregamento": {
"description": "Porto de Carregamento",
"type": "@ManyOf",
"schema": {
"id": "Código",
"port": "Porto"
}
},
"embarqueDesembarqueNavioDescarregamento": {
"description": "Porto de Descarregamento",
"type": "@ManyOf",
"schema": {
"id": "Código",
"port": "Porto"
}
},
"embarqueDesembarqueNavioPais": {
"description": "País Destino Final",
"type": "@ManyOf",
"schema": {
"id": "Código",
"country": "País (SIGLA)"
}
},
"embarqueDesembarqueNavioConhecimento": {
"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"
}
}
}
},
"embarqueDesembarqueNavioDeclaracaoAduaneira": {
"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"
}
}
}
},
"embarqueDesembarqueNavioNfe": {
"description": "NF-e",
"type": "@ManyOf",
"schema": {
"id": "Código",
"number": "Número da Chave NF-e"
}
},
"embarqueDesembarqueNavioCamera": {
"description": "Cameras",
"type": "@ManyOf",
"schema": {
"id": "Código",
"georreferenciamentoCamera": {
"description": "Cameras",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
}
}
},
"embarqueDesembarqueNavioIntegration": {
"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
filesystem/read/:filename
Leitura de um arquivo no sistema de arquivos da aplicação. A leitura de arquivos é sempre pública, sem necessário autenticação.
GET
http://cftv.barradorio.com.br:8080/api/filesystem/read/:filename
URI Input
{
"description": "Leitura de arquivo",
"type": "@OneOf",
"schema": {
"filename": "Nome do Arquivo"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
filesystem/write
Escrever um arquivo no sistema de arquivos da aplicação.
POST
http://cftv.barradorio.com.br:8080/api/filesystem/write
Header Input
Requer autenticação de usuário
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Body Input
{
"description": "Escrita de arquivo",
"type": "@OneOf",
"schema": {
"contents": "Conteúdo do Arquivo em BASE64",
"maxsize": "Tamanho Maximo em KB"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Escrita de arquivo",
"type": "@OneOf",
"schema": {
"filename": "Nome do Arquivo"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
georreferenciamento/audit/:georreferenciamento-id
Obter informações de interações no registro de Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/georreferenciamento/audit/:georreferenciamento-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [georreferenciamento.georreferenciamento.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Georreferenciamento",
"type": "@OneOf",
"schema": {
"georreferenciamento-id": "Código"
}
}
Query Input
{
"description": "Registro do(a) Georreferenciamento",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Georreferenciamento",
"type": "@OneOf",
"schema": {
"georreferenciamentoAudits": {
"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
georreferenciamento/collection/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/georreferenciamento/collection/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [georreferenciamento.georreferenciamento.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
georreferenciamento/collection/options/integration-status
Opções de Situação
GET
http://cftv.barradorio.com.br:8080/api/georreferenciamento/collection/options/integration-status
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [georreferenciamento.georreferenciamento.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Situação",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
georreferenciamento/collection
Coleção de Georreferenciamento com informações resumidas e possibilidade de filtro
GET
http://cftv.barradorio.com.br:8080/api/georreferenciamento/collection
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [georreferenciamento.georreferenciamento.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Registro do(a) Georreferenciamento",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100.",
"order-by": "Atributo de Ordenação. georreferenciamento.id, georreferenciamento.created, georreferenciamento.updated, integrationStatus.name, branch.name, georreferenciamento.internalKey, georreferenciamento.occurrence, georreferenciamento.operatorCpf, georreferenciamento.responseProtocol, georreferenciamento.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-name-contains": "Nome do Equipamento"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Georreferenciamento",
"type": "@OneOf",
"schema": {
"georreferenciamentos": {
"description": "Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"integrationStatus": {
"description": "Georreferenciamento",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"branch": {
"description": "Georreferenciamento",
"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",
"name": "Nome do Equipamento"
}
},
"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
georreferenciamento/create/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/georreferenciamento/create/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [georreferenciamento.georreferenciamento.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
georreferenciamento/create/options/equipment-type
Opções de Tipo de Equipamento
GET
http://cftv.barradorio.com.br:8080/api/georreferenciamento/create/options/equipment-type
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [georreferenciamento.georreferenciamento.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Equipamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
georreferenciamento/create/options/integration-status
Opções de Situação
GET
http://cftv.barradorio.com.br:8080/api/georreferenciamento/create/options/integration-status
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [georreferenciamento.georreferenciamento.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Situação",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
georreferenciamento/create
Criar um(a) Georreferenciamento. Um envio em imediato por Balanças/Catracas/Gates/Cameras do recinto e a posição Geográfica onde estão armazenados respectivamente. Estas informações podem ser utilizadas por outros eventos da API.
POST
http://cftv.barradorio.com.br:8080/api/georreferenciamento/create
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [georreferenciamento.georreferenciamento.create]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Body Input
{
"description": "Registro do(a) Georreferenciamento",
"type": "@OneOf",
"schema": {
"georreferenciamento": {
"description": "Georreferenciamento",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Georreferenciamento",
"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",
"name": "Nome do Equipamento precisa ser um texto, Nome do Equipamento é obrigatório, Nome do Equipamento precisa ter 100 caracteres",
"area": "Area do Equipamento precisa ser um texto, Area do Equipamento precisa ter 50 caracteres",
"active": "Ativo precisa ser verdadeiro ou falso, Ativo é obrigatório",
"azimuteCamera": "Azimute (P\/ Cameras) precisa ser um número",
"equipmentType": {
"description": "Georreferenciamento",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"latitude": "Latitude (Ponto 1) precisa ser um texto, Latitude (Ponto 1) precisa ter 10 caracteres",
"longitude": "Longitude (Ponto 1) precisa ser um texto, Longitude (Ponto 1) precisa ter 10 caracteres",
"latitude2": "Latitude (Ponto 2) precisa ser um texto, Latitude (Ponto 2) precisa ter 10 caracteres",
"longitude2": "Longitude (Ponto 2) precisa ser um texto, Longitude (Ponto 2) precisa ter 10 caracteres",
"latitude3": "Latitude (Ponto 3) precisa ser um texto, Latitude (Ponto 3) precisa ter 10 caracteres",
"longitude3": "Longitude (Ponto 3) precisa ser um texto, Longitude (Ponto 3) precisa ter 10 caracteres",
"latitude4": "Latitude (Ponto 4) precisa ser um texto, Latitude (Ponto 4) precisa ter 10 caracteres",
"longitude4": "Longitude (Ponto 4) precisa ser um texto, Longitude (Ponto 4) precisa ter 10 caracteres"
}
}
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Georreferenciamento",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
georreferenciamento/delete/:georreferenciamento-id
Deletar Georreferenciamento
DELETE
http://cftv.barradorio.com.br:8080/api/georreferenciamento/delete/:georreferenciamento-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [georreferenciamento.georreferenciamento.delete]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Georreferenciamento",
"type": "@OneOf",
"schema": {
"georreferenciamento-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Georreferenciamento",
"type": "@OneOf",
"schema": {
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
georreferenciamento/edit/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/georreferenciamento/edit/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [georreferenciamento.georreferenciamento.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
georreferenciamento/edit/options/equipment-type
Opções de Tipo de Equipamento
GET
http://cftv.barradorio.com.br:8080/api/georreferenciamento/edit/options/equipment-type
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [georreferenciamento.georreferenciamento.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Equipamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
georreferenciamento/edit/options/integration-status
Opções de Situação
GET
http://cftv.barradorio.com.br:8080/api/georreferenciamento/edit/options/integration-status
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [georreferenciamento.georreferenciamento.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Situação",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
georreferenciamento/edit/:georreferenciamento-id
Editar um(a) Georreferenciamento. Um envio em imediato por Balanças/Catracas/Gates/Cameras do recinto e a posição Geográfica onde estão armazenados respectivamente. Estas informações podem ser utilizadas por outros eventos da API.
POST
http://cftv.barradorio.com.br:8080/api/georreferenciamento/edit/:georreferenciamento-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [georreferenciamento.georreferenciamento.edit]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Georreferenciamento",
"type": "@OneOf",
"schema": {
"georreferenciamento-id": "Código"
}
}
Body Input
{
"description": "Registro do(a) Georreferenciamento",
"type": "@OneOf",
"schema": {
"georreferenciamento": {
"description": "Georreferenciamento",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Georreferenciamento",
"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",
"name": "Nome do Equipamento precisa ser um texto, Nome do Equipamento é obrigatório, Nome do Equipamento precisa ter 100 caracteres",
"area": "Area do Equipamento precisa ser um texto, Area do Equipamento precisa ter 50 caracteres",
"active": "Ativo precisa ser verdadeiro ou falso, Ativo é obrigatório",
"azimuteCamera": "Azimute (P\/ Cameras) precisa ser um número",
"equipmentType": {
"description": "Georreferenciamento",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"latitude": "Latitude (Ponto 1) precisa ser um texto, Latitude (Ponto 1) precisa ter 10 caracteres",
"longitude": "Longitude (Ponto 1) precisa ser um texto, Longitude (Ponto 1) precisa ter 10 caracteres",
"latitude2": "Latitude (Ponto 2) precisa ser um texto, Latitude (Ponto 2) precisa ter 10 caracteres",
"longitude2": "Longitude (Ponto 2) precisa ser um texto, Longitude (Ponto 2) precisa ter 10 caracteres",
"latitude3": "Latitude (Ponto 3) precisa ser um texto, Latitude (Ponto 3) precisa ter 10 caracteres",
"longitude3": "Longitude (Ponto 3) precisa ser um texto, Longitude (Ponto 3) precisa ter 10 caracteres",
"latitude4": "Latitude (Ponto 4) precisa ser um texto, Latitude (Ponto 4) precisa ter 10 caracteres",
"longitude4": "Longitude (Ponto 4) precisa ser um texto, Longitude (Ponto 4) precisa ter 10 caracteres"
}
}
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Georreferenciamento",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
georreferenciamento/get/:georreferenciamento-id
Obter Georreferenciamento com todos os detalhes de suas informações
GET
http://cftv.barradorio.com.br:8080/api/georreferenciamento/get/:georreferenciamento-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [georreferenciamento.georreferenciamento.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Georreferenciamento",
"type": "@OneOf",
"schema": {
"georreferenciamento-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Georreferenciamento",
"type": "@OneOf",
"schema": {
"georreferenciamento": {
"description": "Georreferenciamento",
"type": "@OneOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"integrationStatus": {
"description": "Georreferenciamento",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"branch": {
"description": "Georreferenciamento",
"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",
"name": "Nome do Equipamento",
"area": "Area do Equipamento",
"active": "Ativo",
"azimuteCamera": "Azimute (P\/ Cameras)",
"equipmentType": {
"description": "Georreferenciamento",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"latitude": "Latitude (Ponto 1)",
"longitude": "Longitude (Ponto 1)",
"latitude2": "Latitude (Ponto 2)",
"longitude2": "Longitude (Ponto 2)",
"latitude3": "Latitude (Ponto 3)",
"longitude3": "Longitude (Ponto 3)",
"latitude4": "Latitude (Ponto 4)",
"longitude4": "Longitude (Ponto 4)",
"georreferenciamentoIntegration": {
"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
geracao-lote/audit/:geracao-lote-id
Obter informações de interações no registro de Geração de Lote
GET
http://cftv.barradorio.com.br:8080/api/geracao-lote/audit/:geracao-lote-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Geração de Lote",
"type": "@OneOf",
"schema": {
"geracao-lote-id": "Código"
}
}
Query Input
{
"description": "Registro do(a) Geração 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) Geração de Lote",
"type": "@OneOf",
"schema": {
"geracaoLoteAudits": {
"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
geracao-lote/collection/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/geracao-lote/collection/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
geracao-lote/collection/options/integration-status
Opções de Situação
GET
http://cftv.barradorio.com.br:8080/api/geracao-lote/collection/options/integration-status
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Situação",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
geracao-lote/collection
Coleção de Geração de Lote com informações resumidas e possibilidade de filtro
GET
http://cftv.barradorio.com.br:8080/api/geracao-lote/collection
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Registro do(a) Geração de Lote",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100.",
"order-by": "Atributo de Ordenação. geracaoLote.id, geracaoLote.created, geracaoLote.updated, integrationStatus.name, branch.name, geracaoLote.internalKey, geracaoLote.occurrence, geracaoLote.operatorCpf, geracaoLote.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) Geração de Lote",
"type": "@OneOf",
"schema": {
"geracaoLotes": {
"description": "Geração de Lote",
"type": "@ManyOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"deleted": "Data de Deleçao",
"integrationStatus": {
"description": "Geração de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"branch": {
"description": "Geração 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
geracao-lote/create/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/geracao-lote/create/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
geracao-lote/create/options/geracao-lote-camera/georreferenciamento-camera
Opções de Camera em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/geracao-lote/create/options/geracao-lote-camera/georreferenciamento-camera
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Camera em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
geracao-lote/create/options/georreferenciamento-area-armazenagem
Opções de Area de Armazenagem em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/geracao-lote/create/options/georreferenciamento-area-armazenagem
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Area de Armazenagem em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
geracao-lote/create/options/international-shipping
Opções de Indicador de Remessa Internacional
GET
http://cftv.barradorio.com.br:8080/api/geracao-lote/create/options/international-shipping
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Indicador de Remessa Internacional",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
geracao-lote/create/options/geracao-lote-lista-avarias/damage-type
Opções de Tipo de Avaria
GET
http://cftv.barradorio.com.br:8080/api/geracao-lote/create/options/geracao-lote-lista-avarias/damage-type
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Avaria",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
geracao-lote/create/options/geracao-lote-lista-lotes/type-packing
Opções de Tipo do Embalagem
GET
http://cftv.barradorio.com.br:8080/api/geracao-lote/create/options/geracao-lote-lista-lotes/type-packing
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo do Embalagem",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
geracao-lote/create/options/geracao-lote-lista-mercadoria-perigosa/type-dangerous-goods
Opções de Tipo de Mercadoria Perigosa
GET
http://cftv.barradorio.com.br:8080/api/geracao-lote/create/options/geracao-lote-lista-mercadoria-perigosa/type-dangerous-goods
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Mercadoria Perigosa",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
geracao-lote/create/options/geracao-lote-lista-volume-manifesto/type-packing
Opções de Tipo do Embalagem
GET
http://cftv.barradorio.com.br:8080/api/geracao-lote/create/options/geracao-lote-lista-volume-manifesto/type-packing
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo do Embalagem",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
geracao-lote/create/options/type-customs-declaration
Opções de Tipo de Declaração
GET
http://cftv.barradorio.com.br:8080/api/geracao-lote/create/options/type-customs-declaration
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Declaração",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
geracao-lote/create/options/type-lading
Opções de Tipo de Conhecimento
GET
http://cftv.barradorio.com.br:8080/api/geracao-lote/create/options/type-lading
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Conhecimento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
geracao-lote/create/options/type-manifest
Opções de Tipo do Manifesto
GET
http://cftv.barradorio.com.br:8080/api/geracao-lote/create/options/type-manifest
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo do Manifesto",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
geracao-lote/create
Criar um(a) Geração de Lote. Um evento para cada conjunto de LOTES gerados por conhecimento. Não considerar os movimentos do tipo “house keeping”, a exemplo de desunitização para verificação ou inspeção física, casos em que a carga deve ser reunitizada após o processo.
POST
http://cftv.barradorio.com.br:8080/api/geracao-lote/create
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.create]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Body Input
{
"description": "Registro do(a) Geração de Lote",
"type": "@OneOf",
"schema": {
"geracaoLote": {
"description": "Geração de Lote",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Geração 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",
"plate": "Placa precisa ser um texto, Placa precisa ter 50 caracteres",
"georreferenciamentoAreaArmazenagem": {
"description": "Geração de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"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": "Geração 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": "Geração de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"numberRuc": "Número da RUC precisa ser um texto, Número da RUC precisa ter 35 caracteres",
"numberDeclaration": "Número da Declaração precisa ser um texto, Número da Declaração precisa ter 100 caracteres",
"typeCustomsDeclaration": {
"description": "Geração de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"cnpjPreviousResponsible": "CNPJ do Responsável Anterior precisa ser um texto, CNPJ do Responsável Anterior precisa ter 14 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 precisa ter 15 caracteres",
"weightManifest": "Peso do Manifesto precisa ser um número decimal",
"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",
"shipImo": "IMO do Navio precisa ser um texto, IMO do Navio precisa ter 10 caracteres",
"shipName": "Nome do Navio precisa ser um texto, Nome do Navio precisa ter 100 caracteres",
"aitaPlane": "IATA Aeronave precisa ser um texto, IATA Aeronave precisa ter 50 caracteres",
"prefixPlane": "Prefixo Aeronave precisa ser um texto, Prefixo Aeronave precisa ter 20 caracteres",
"travel": "Viagem precisa ser um texto, Viagem precisa ter 20 caracteres",
"stopover": "Escala precisa ser um texto, Escala precisa ter 20 caracteres",
"iataAirport": "Aeroporto de Origem precisa ser um texto, Aeroporto de Origem precisa ter 3 caracteres",
"plateSemitrailer": "Placa do Semirreboque precisa ser um texto, Placa do Semirreboque precisa ter 50 caracteres",
"perishable": "Perecível precisa ser verdadeiro ou falso",
"looseCargo": "Carga Solta precisa ser verdadeiro ou falso",
"internationalShipping": {
"description": "Geração de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"receptionNotes": "Observações de Recepção precisa ser um texto, Observações de Recepção precisa ter 200 caracteres",
"geracaoLoteListaLotes": {
"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",
"containWood": "Contém Madeira precisa ser verdadeiro ou falso, Contém Madeira é obrigatório",
"quantity": "Quantidade precisa ser um número, Quantidade é obrigatório",
"typePacking": {
"description": "Lotes",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"brand": "Marca precisa ser um texto, Marca precisa ter 100 caracteres",
"subBrand": "Contramarca precisa ser um texto, Contramarca precisa ter 100 caracteres",
"qualificationDivergence": "Divergência de Qualificação precisa ser verdadeiro ou falso, Divergência de Qualificação é obrigatório",
"quantityDivergence": "Divergência de Quantidade precisa ser verdadeiro ou falso, Divergência de Quantidade é obrigatório",
"commercialPackaging": "Embalagem Comercial precisa ser um texto, Embalagem Comercial precisa ter 100 caracteres",
"weight": "Peso do Lote na Balança precisa ser um número decimal",
"quantityDamagedItems": "Quantidade de Volumes Avariados precisa ser um número",
"quantityDivergenceItems": "Quantidade de Volumes Divergentes precisa ser um número",
"damageNotes": "Observações de Avarias precisa ser um texto, Observações de Avarias precisa ter 200 caracteres",
"divergenceNotes": "Observações de Divergência precisa ser um texto, Observações de Divergência precisa ter 200 caracteres"
}
},
"geracaoLoteListaAvarias": {
"description": "Avarias",
"type": "@ManyOf",
"schema": {
"damageType": {
"description": "Avarias",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
}
}
},
"geracaoLoteListaNfe": {
"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"
}
},
"geracaoLoteListaMalas": {
"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"
}
},
"geracaoLoteListaVolumeManifesto": {
"description": "Volumes Manifestados",
"type": "@ManyOf",
"schema": {
"quanty": "Quantidade precisa ser um número, Quantidade é obrigatório",
"typePacking": {
"description": "Volumes Manifestados",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
}
}
},
"geracaoLoteListaChassi": {
"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"
}
},
"geracaoLoteListaMercadoriaPerigosa": {
"description": "Mercadorias Perigosas",
"type": "@ManyOf",
"schema": {
"typeDangerousGoods": {
"description": "Mercadorias Perigosas",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
}
}
},
"geracaoLoteCamera": {
"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) Geração de Lote",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
geracao-lote/delete/:geracao-lote-id
Deletar Geração de Lote
DELETE
http://cftv.barradorio.com.br:8080/api/geracao-lote/delete/:geracao-lote-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.delete]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Geração de Lote",
"type": "@OneOf",
"schema": {
"geracao-lote-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Geração de Lote",
"type": "@OneOf",
"schema": {
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
geracao-lote/edit/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/geracao-lote/edit/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
geracao-lote/edit/options/geracao-lote-camera/georreferenciamento-camera
Opções de Camera em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/geracao-lote/edit/options/geracao-lote-camera/georreferenciamento-camera
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Camera em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
geracao-lote/edit/options/georreferenciamento-area-armazenagem
Opções de Area de Armazenagem em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/geracao-lote/edit/options/georreferenciamento-area-armazenagem
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Area de Armazenagem em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
geracao-lote/edit/options/international-shipping
Opções de Indicador de Remessa Internacional
GET
http://cftv.barradorio.com.br:8080/api/geracao-lote/edit/options/international-shipping
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Indicador de Remessa Internacional",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
geracao-lote/edit/options/geracao-lote-lista-avarias/damage-type
Opções de Tipo de Avaria
GET
http://cftv.barradorio.com.br:8080/api/geracao-lote/edit/options/geracao-lote-lista-avarias/damage-type
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Avaria",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
geracao-lote/edit/options/geracao-lote-lista-lotes/type-packing
Opções de Tipo do Embalagem
GET
http://cftv.barradorio.com.br:8080/api/geracao-lote/edit/options/geracao-lote-lista-lotes/type-packing
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo do Embalagem",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
geracao-lote/edit/options/geracao-lote-lista-mercadoria-perigosa/type-dangerous-goods
Opções de Tipo de Mercadoria Perigosa
GET
http://cftv.barradorio.com.br:8080/api/geracao-lote/edit/options/geracao-lote-lista-mercadoria-perigosa/type-dangerous-goods
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Mercadoria Perigosa",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
geracao-lote/edit/options/geracao-lote-lista-volume-manifesto/type-packing
Opções de Tipo do Embalagem
GET
http://cftv.barradorio.com.br:8080/api/geracao-lote/edit/options/geracao-lote-lista-volume-manifesto/type-packing
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo do Embalagem",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
geracao-lote/edit/options/type-customs-declaration
Opções de Tipo de Declaração
GET
http://cftv.barradorio.com.br:8080/api/geracao-lote/edit/options/type-customs-declaration
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Declaração",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
geracao-lote/edit/options/type-lading
Opções de Tipo de Conhecimento
GET
http://cftv.barradorio.com.br:8080/api/geracao-lote/edit/options/type-lading
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Conhecimento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
geracao-lote/edit/options/type-manifest
Opções de Tipo do Manifesto
GET
http://cftv.barradorio.com.br:8080/api/geracao-lote/edit/options/type-manifest
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo do Manifesto",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
geracao-lote/edit/:geracao-lote-id
Editar um(a) Geração de Lote. Um evento para cada conjunto de LOTES gerados por conhecimento. Não considerar os movimentos do tipo “house keeping”, a exemplo de desunitização para verificação ou inspeção física, casos em que a carga deve ser reunitizada após o processo.
POST
http://cftv.barradorio.com.br:8080/api/geracao-lote/edit/:geracao-lote-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.edit]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Geração de Lote",
"type": "@OneOf",
"schema": {
"geracao-lote-id": "Código"
}
}
Body Input
{
"description": "Registro do(a) Geração de Lote",
"type": "@OneOf",
"schema": {
"geracaoLote": {
"description": "Geração de Lote",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Geração 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",
"plate": "Placa precisa ser um texto, Placa precisa ter 50 caracteres",
"georreferenciamentoAreaArmazenagem": {
"description": "Geração de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"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": "Geração 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": "Geração de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"numberRuc": "Número da RUC precisa ser um texto, Número da RUC precisa ter 35 caracteres",
"numberDeclaration": "Número da Declaração precisa ser um texto, Número da Declaração precisa ter 100 caracteres",
"typeCustomsDeclaration": {
"description": "Geração de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"cnpjPreviousResponsible": "CNPJ do Responsável Anterior precisa ser um texto, CNPJ do Responsável Anterior precisa ter 14 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 precisa ter 15 caracteres",
"weightManifest": "Peso do Manifesto precisa ser um número decimal",
"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",
"shipImo": "IMO do Navio precisa ser um texto, IMO do Navio precisa ter 10 caracteres",
"shipName": "Nome do Navio precisa ser um texto, Nome do Navio precisa ter 100 caracteres",
"aitaPlane": "IATA Aeronave precisa ser um texto, IATA Aeronave precisa ter 50 caracteres",
"prefixPlane": "Prefixo Aeronave precisa ser um texto, Prefixo Aeronave precisa ter 20 caracteres",
"travel": "Viagem precisa ser um texto, Viagem precisa ter 20 caracteres",
"stopover": "Escala precisa ser um texto, Escala precisa ter 20 caracteres",
"iataAirport": "Aeroporto de Origem precisa ser um texto, Aeroporto de Origem precisa ter 3 caracteres",
"plateSemitrailer": "Placa do Semirreboque precisa ser um texto, Placa do Semirreboque precisa ter 50 caracteres",
"perishable": "Perecível precisa ser verdadeiro ou falso",
"looseCargo": "Carga Solta precisa ser verdadeiro ou falso",
"internationalShipping": {
"description": "Geração de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"receptionNotes": "Observações de Recepção precisa ser um texto, Observações de Recepção precisa ter 200 caracteres",
"geracaoLoteListaLotes": {
"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",
"containWood": "Contém Madeira precisa ser verdadeiro ou falso, Contém Madeira é obrigatório",
"quantity": "Quantidade precisa ser um número, Quantidade é obrigatório",
"typePacking": {
"description": "Lotes",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"brand": "Marca precisa ser um texto, Marca precisa ter 100 caracteres",
"subBrand": "Contramarca precisa ser um texto, Contramarca precisa ter 100 caracteres",
"qualificationDivergence": "Divergência de Qualificação precisa ser verdadeiro ou falso, Divergência de Qualificação é obrigatório",
"quantityDivergence": "Divergência de Quantidade precisa ser verdadeiro ou falso, Divergência de Quantidade é obrigatório",
"commercialPackaging": "Embalagem Comercial precisa ser um texto, Embalagem Comercial precisa ter 100 caracteres",
"weight": "Peso do Lote na Balança precisa ser um número decimal",
"quantityDamagedItems": "Quantidade de Volumes Avariados precisa ser um número",
"quantityDivergenceItems": "Quantidade de Volumes Divergentes precisa ser um número",
"damageNotes": "Observações de Avarias precisa ser um texto, Observações de Avarias precisa ter 200 caracteres",
"divergenceNotes": "Observações de Divergência precisa ser um texto, Observações de Divergência precisa ter 200 caracteres"
}
},
"geracaoLoteListaAvarias": {
"description": "Avarias",
"type": "@ManyOf",
"schema": {
"id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente",
"damageType": {
"description": "Avarias",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
}
}
},
"geracaoLoteListaNfe": {
"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"
}
},
"geracaoLoteListaMalas": {
"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"
}
},
"geracaoLoteListaVolumeManifesto": {
"description": "Volumes Manifestados",
"type": "@ManyOf",
"schema": {
"id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente",
"quanty": "Quantidade precisa ser um número, Quantidade é obrigatório",
"typePacking": {
"description": "Volumes Manifestados",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
}
}
},
"geracaoLoteListaChassi": {
"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"
}
},
"geracaoLoteListaMercadoriaPerigosa": {
"description": "Mercadorias Perigosas",
"type": "@ManyOf",
"schema": {
"id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente",
"typeDangerousGoods": {
"description": "Mercadorias Perigosas",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
}
}
},
"geracaoLoteCamera": {
"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) Geração de Lote",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
geracao-lote/get/:geracao-lote-id
Obter Geração de Lote com todos os detalhes de suas informações
GET
http://cftv.barradorio.com.br:8080/api/geracao-lote/get/:geracao-lote-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [geracaoLote.geracaoLote.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Geração de Lote",
"type": "@OneOf",
"schema": {
"geracao-lote-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Geração de Lote",
"type": "@OneOf",
"schema": {
"geracaoLote": {
"description": "Geração de Lote",
"type": "@OneOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"deleted": "Data de Deleçao",
"integrationStatus": {
"description": "Geração de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"branch": {
"description": "Geração de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"internalKey": "Identificador do Registro",
"occurrence": "Data\/Hora de Ocorrência",
"plate": "Placa",
"georreferenciamentoAreaArmazenagem": {
"description": "Geração de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"operatorCpf": "CPF do Operador",
"responseProtocol": "Protocolo de Resposta",
"numberManifest": "Número do Manifesto",
"typeManifest": {
"description": "Geração de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"numberMawb": "Número do Conhecimento Master",
"number": "Número do Conhecimento",
"typeLading": {
"description": "Geração de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"numberRuc": "Número da RUC",
"numberDeclaration": "Número da Declaração",
"typeCustomsDeclaration": {
"description": "Geração de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"cnpjPreviousResponsible": "CNPJ do Responsável Anterior",
"puIdentityRelatedRecinto": "Código do Recinto para Destino na Saída e Origem na Entrada",
"weightManifest": "Peso do Manifesto",
"containerNumber": "Número do Container",
"uld": "ULD",
"shipImo": "IMO do Navio",
"shipName": "Nome do Navio",
"aitaPlane": "IATA Aeronave",
"prefixPlane": "Prefixo Aeronave",
"travel": "Viagem",
"stopover": "Escala",
"iataAirport": "Aeroporto de Origem",
"plateSemitrailer": "Placa do Semirreboque",
"perishable": "Perecível",
"looseCargo": "Carga Solta",
"internationalShipping": {
"description": "Geração de Lote",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"receptionNotes": "Observações de Recepção",
"geracaoLoteListaLotes": {
"description": "Lotes",
"type": "@ManyOf",
"schema": {
"id": "Código",
"lotNumber": "Numero do Lote",
"containWood": "Contém Madeira",
"quantity": "Quantidade",
"typePacking": {
"description": "Lotes",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"brand": "Marca",
"subBrand": "Contramarca",
"qualificationDivergence": "Divergência de Qualificação",
"quantityDivergence": "Divergência de Quantidade",
"commercialPackaging": "Embalagem Comercial",
"weight": "Peso do Lote na Balança",
"quantityDamagedItems": "Quantidade de Volumes Avariados",
"quantityDivergenceItems": "Quantidade de Volumes Divergentes",
"damageNotes": "Observações de Avarias",
"divergenceNotes": "Observações de Divergência"
}
},
"geracaoLoteListaAvarias": {
"description": "Avarias",
"type": "@ManyOf",
"schema": {
"id": "Código",
"damageType": {
"description": "Avarias",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
}
}
},
"geracaoLoteListaNfe": {
"description": "NF-e",
"type": "@ManyOf",
"schema": {
"id": "Código",
"number": "Número da Chave NF-e"
}
},
"geracaoLoteListaMalas": {
"description": "Malas",
"type": "@ManyOf",
"schema": {
"id": "Código",
"number": "Número da Mala"
}
},
"geracaoLoteListaVolumeManifesto": {
"description": "Volumes Manifestados",
"type": "@ManyOf",
"schema": {
"id": "Código",
"quanty": "Quantidade",
"typePacking": {
"description": "Volumes Manifestados",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
}
}
},
"geracaoLoteListaChassi": {
"description": "Chassi",
"type": "@ManyOf",
"schema": {
"id": "Código",
"number": "Número do Chassi"
}
},
"geracaoLoteListaMercadoriaPerigosa": {
"description": "Mercadorias Perigosas",
"type": "@ManyOf",
"schema": {
"id": "Código",
"typeDangerousGoods": {
"description": "Mercadorias Perigosas",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
}
}
},
"geracaoLoteCamera": {
"description": "Cameras",
"type": "@ManyOf",
"schema": {
"id": "Código",
"georreferenciamentoCamera": {
"description": "Cameras",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
}
}
},
"geracaoLoteIntegration": {
"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
indisponibilidade-equipamento/audit/:indisponibilidade-equipamento-id
Obter informações de interações no registro de Indisponibilidade de Equipamento
GET
http://cftv.barradorio.com.br:8080/api/indisponibilidade-equipamento/audit/:indisponibilidade-equipamento-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [indisponibilidadeEquipamento.indisponibilidadeEquipamento.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"indisponibilidade-equipamento-id": "Código"
}
}
Query Input
{
"description": "Registro do(a) Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"indisponibilidadeEquipamentoAudits": {
"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
indisponibilidade-equipamento/collection/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/indisponibilidade-equipamento/collection/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [indisponibilidadeEquipamento.indisponibilidadeEquipamento.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
indisponibilidade-equipamento/collection/options/integration-status
Opções de Situação
GET
http://cftv.barradorio.com.br:8080/api/indisponibilidade-equipamento/collection/options/integration-status
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [indisponibilidadeEquipamento.indisponibilidadeEquipamento.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Situação",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
indisponibilidade-equipamento/collection
Coleção de Indisponibilidade de Equipamento com informações resumidas e possibilidade de filtro
GET
http://cftv.barradorio.com.br:8080/api/indisponibilidade-equipamento/collection
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [indisponibilidadeEquipamento.indisponibilidadeEquipamento.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Registro do(a) Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100.",
"order-by": "Atributo de Ordenação. indisponibilidadeEquipamento.id, indisponibilidadeEquipamento.created, indisponibilidadeEquipamento.updated, integrationStatus.name, branch.name, indisponibilidadeEquipamento.internalKey, indisponibilidadeEquipamento.occurrence, indisponibilidadeEquipamento.operatorCpf, indisponibilidadeEquipamento.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) Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"indisponibilidadeEquipamentos": {
"description": "Indisponibilidade de Equipamento",
"type": "@ManyOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"integrationStatus": {
"description": "Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"branch": {
"description": "Indisponibilidade de Equipamento",
"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
indisponibilidade-equipamento/create/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/indisponibilidade-equipamento/create/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [indisponibilidadeEquipamento.indisponibilidadeEquipamento.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
indisponibilidade-equipamento/create/options/geo-equipamento
Opções de Equipamento em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/indisponibilidade-equipamento/create/options/geo-equipamento
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [indisponibilidadeEquipamento.indisponibilidadeEquipamento.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Equipamento em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
indisponibilidade-equipamento/create
Criar um(a) Indisponibilidade de Equipamento. Transmitir um evento para cada indisponibilidade e retorno à normalidade de cada equipamento definido. Não considerar indisponibilidades do tipo “house keeping”, casos de manutenção preventiva, rápida e, muitas vezes, diária de equipamentos.
POST
http://cftv.barradorio.com.br:8080/api/indisponibilidade-equipamento/create
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [indisponibilidadeEquipamento.indisponibilidadeEquipamento.create]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Body Input
{
"description": "Registro do(a) Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"indisponibilidadeEquipamento": {
"description": "Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Indisponibilidade de Equipamento",
"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",
"geoEquipamento": {
"description": "Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"available": "Disponivel precisa ser verdadeiro ou falso, Disponivel é obrigatório",
"datetimeAvailableForecast": "Previsão de Disponibilidade precisa ser data e hora (Y-m-d H:i:s)",
"reason": "Motivo de Indisponibilidade precisa ser um texto, Motivo de Indisponibilidade precisa ter 100 caracteres"
}
}
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
indisponibilidade-equipamento/delete/:indisponibilidade-equipamento-id
Deletar Indisponibilidade de Equipamento
DELETE
http://cftv.barradorio.com.br:8080/api/indisponibilidade-equipamento/delete/:indisponibilidade-equipamento-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [indisponibilidadeEquipamento.indisponibilidadeEquipamento.delete]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"indisponibilidade-equipamento-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
indisponibilidade-equipamento/edit/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/indisponibilidade-equipamento/edit/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [indisponibilidadeEquipamento.indisponibilidadeEquipamento.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
indisponibilidade-equipamento/edit/options/geo-equipamento
Opções de Equipamento em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/indisponibilidade-equipamento/edit/options/geo-equipamento
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [indisponibilidadeEquipamento.indisponibilidadeEquipamento.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Equipamento em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
indisponibilidade-equipamento/edit/:indisponibilidade-equipamento-id
Editar um(a) Indisponibilidade de Equipamento. Transmitir um evento para cada indisponibilidade e retorno à normalidade de cada equipamento definido. Não considerar indisponibilidades do tipo “house keeping”, casos de manutenção preventiva, rápida e, muitas vezes, diária de equipamentos.
POST
http://cftv.barradorio.com.br:8080/api/indisponibilidade-equipamento/edit/:indisponibilidade-equipamento-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [indisponibilidadeEquipamento.indisponibilidadeEquipamento.edit]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"indisponibilidade-equipamento-id": "Código"
}
}
Body Input
{
"description": "Registro do(a) Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"indisponibilidadeEquipamento": {
"description": "Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Indisponibilidade de Equipamento",
"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",
"geoEquipamento": {
"description": "Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"available": "Disponivel precisa ser verdadeiro ou falso, Disponivel é obrigatório",
"datetimeAvailableForecast": "Previsão de Disponibilidade precisa ser data e hora (Y-m-d H:i:s)",
"reason": "Motivo de Indisponibilidade precisa ser um texto, Motivo de Indisponibilidade precisa ter 100 caracteres"
}
}
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
indisponibilidade-equipamento/get/:indisponibilidade-equipamento-id
Obter Indisponibilidade de Equipamento com todos os detalhes de suas informações
GET
http://cftv.barradorio.com.br:8080/api/indisponibilidade-equipamento/get/:indisponibilidade-equipamento-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [indisponibilidadeEquipamento.indisponibilidadeEquipamento.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"indisponibilidade-equipamento-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"indisponibilidadeEquipamento": {
"description": "Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"integrationStatus": {
"description": "Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"branch": {
"description": "Indisponibilidade de Equipamento",
"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",
"geoEquipamento": {
"description": "Indisponibilidade de Equipamento",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"available": "Disponivel",
"datetimeAvailableForecast": "Previsão de Disponibilidade",
"reason": "Motivo de Indisponibilidade",
"indisponibilidadeEquipamentoIntegration": {
"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
inspecao-nao-evasiva/audit/:inspecao-nao-evasiva-id
Obter informações de interações no registro de Inspeção não Invasiva
GET
http://cftv.barradorio.com.br:8080/api/inspecao-nao-evasiva/audit/:inspecao-nao-evasiva-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [inspecaoNaoEvasiva.inspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"inspecao-nao-evasiva-id": "Código"
}
}
Query Input
{
"description": "Registro do(a) Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"inspecaoNaoEvasivaAudits": {
"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
inspecao-nao-evasiva/collection/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/inspecao-nao-evasiva/collection/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [inspecaoNaoEvasiva.inspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
inspecao-nao-evasiva/collection/options/integration-status
Opções de Situação
GET
http://cftv.barradorio.com.br:8080/api/inspecao-nao-evasiva/collection/options/integration-status
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [inspecaoNaoEvasiva.inspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Situação",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
inspecao-nao-evasiva/collection
Coleção de Inspeção não Invasiva com informações resumidas e possibilidade de filtro
GET
http://cftv.barradorio.com.br:8080/api/inspecao-nao-evasiva/collection
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [inspecaoNaoEvasiva.inspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Registro do(a) Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100.",
"order-by": "Atributo de Ordenação. inspecaoNaoEvasiva.id, inspecaoNaoEvasiva.created, inspecaoNaoEvasiva.updated, integrationStatus.name, branch.name, inspecaoNaoEvasiva.internalKey, inspecaoNaoEvasiva.occurrence, inspecaoNaoEvasiva.operatorCpf, inspecaoNaoEvasiva.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) Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"inspecaoNaoEvasivas": {
"description": "Inspeção não Invasiva",
"type": "@ManyOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"integrationStatus": {
"description": "Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"branch": {
"description": "Inspeção não Invasiva",
"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
inspecao-nao-evasiva/create/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/inspecao-nao-evasiva/create/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [inspecaoNaoEvasiva.inspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
inspecao-nao-evasiva/create/options/inspecao-nao-evasiva-camera/georreferenciamento-camera
Opções de Camera em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/inspecao-nao-evasiva/create/options/inspecao-nao-evasiva-camera/georreferenciamento-camera
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [inspecaoNaoEvasiva.inspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Camera em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
inspecao-nao-evasiva/create/options/inspecao-nao-evasiva-conhecimento/type-lading
Opções de Tipo de Conhecimento
GET
http://cftv.barradorio.com.br:8080/api/inspecao-nao-evasiva/create/options/inspecao-nao-evasiva-conhecimento/type-lading
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [inspecaoNaoEvasiva.inspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Conhecimento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
inspecao-nao-evasiva/create/options/inspecao-nao-evasiva-conhecimento/type-manifest
Opções de Tipo do Manifesto
GET
http://cftv.barradorio.com.br:8080/api/inspecao-nao-evasiva/create/options/inspecao-nao-evasiva-conhecimento/type-manifest
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [inspecaoNaoEvasiva.inspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo do Manifesto",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
inspecao-nao-evasiva/create/options/inspecao-nao-evasiva-containers-uld/container-type
Opções de Tipo de Container
GET
http://cftv.barradorio.com.br:8080/api/inspecao-nao-evasiva/create/options/inspecao-nao-evasiva-containers-uld/container-type
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [inspecaoNaoEvasiva.inspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Container",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
inspecao-nao-evasiva/create/options/georreferenciamento-scanner
Opções de Scanner em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/inspecao-nao-evasiva/create/options/georreferenciamento-scanner
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [inspecaoNaoEvasiva.inspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Scanner em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
inspecao-nao-evasiva/create
Criar um(a) Inspeção não Invasiva. Enviar imediatamente após a inspeção. Um evento para cada conjunto PLACA/CONTÊINER/VOLUME escaneados.
POST
http://cftv.barradorio.com.br:8080/api/inspecao-nao-evasiva/create
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [inspecaoNaoEvasiva.inspecaoNaoEvasiva.create]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Body Input
{
"description": "Registro do(a) Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"inspecaoNaoEvasiva": {
"description": "Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Inspeção não Invasiva",
"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",
"plate": "Placa precisa ser um texto, Placa precisa ter 50 caracteres",
"plateByOcr": "Captura da Placa via OCR precisa ser verdadeiro ou falso, Captura da Placa via OCR é obrigatório",
"platePhotoFile": "Foto da Placa precisa ser um texto, Foto da Placa precisa ter 180 caracteres, Trata-se do nome do arquivo que está salvo no sistema de arquivos da aplicação",
"empty": "Vazio precisa ser verdadeiro ou falso",
"scannerImageDatetimeScan": "Imagem Scanner - Data\/Hora SCAN precisa ser data e hora (Y-m-d H:i:s), Imagem Scanner - Data\/Hora SCAN é obrigatório",
"scannerImageDatetimeLastChanges": "Imagem Scanner - Data\/Hora Última Modificação precisa ser data e hora (Y-m-d H:i:s), Imagem Scanner - Data\/Hora Última Modificação é obrigatório",
"scannerImageFilename": "Imagem Scanner - Nome do Arquivo precisa ser um texto, Imagem Scanner - Nome do Arquivo é obrigatório, Imagem Scanner - Nome do Arquivo precisa ter 200 caracteres",
"scannerImageFile": "Imagem Scanner - Arquivo precisa ser um texto, Imagem Scanner - Arquivo precisa ter 180 caracteres, Imagem Scanner - Arquivo é obrigatório, Trata-se do nome do arquivo que está salvo no sistema de arquivos da aplicação",
"scannerImageLocationKey": "Imagem Scanner - Chave de Localização precisa ser um texto, Imagem Scanner - Chave de Localização precisa ter 200 caracteres",
"scannerImageFileMetadata": "Imagem Scanner - Arquivo Metadata XML precisa ser um texto, Imagem Scanner - Arquivo Metadata XML precisa ter 180 caracteres, Trata-se do nome do arquivo que está salvo no sistema de arquivos da aplicação",
"georreferenciamentoScanner": {
"description": "Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"inspecaoNaoEvasivaCoordenadasAlerta": {
"description": "Coordenadas de Alerta",
"type": "@ManyOf",
"schema": {
"positionX": "Posição X precisa ser um número, Posição X é obrigatório",
"positionY": "Posição Y precisa ser um número, Posição Y é obrigatório",
"positionXEnd": "Posição X 2 precisa ser um número, Posição X 2 é obrigatório",
"positionYEnd": "Posição Y 2 precisa ser um número, Posição Y 2 é obrigatório"
}
},
"inspecaoNaoEvasivaConhecimento": {
"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"
}
}
}
},
"inspecaoNaoEvasivaListaNfe": {
"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"
}
},
"inspecaoNaoEvasivaListaCargo": {
"description": "Carga",
"type": "@ManyOf",
"schema": {
"cargoIdentification": "Número da Carga precisa ser um texto, Número da Carga é obrigatório, Número da Carga precisa ter 100 caracteres"
}
},
"inspecaoNaoEvasivaSemitrailer": {
"description": "Semirreboque",
"type": "@ManyOf",
"schema": {
"orcPlate": "Captura por OCR precisa ser verdadeiro ou falso, Captura por OCR é obrigatório",
"plate": "Placa precisa ser um texto, Placa é obrigatório, Placa precisa ter 50 caracteres",
"platePhotoFile": "Foto da Placa precisa ser um texto, Foto da Placa precisa ter 180 caracteres, Trata-se do nome do arquivo que está salvo no sistema de arquivos da aplicação"
}
},
"inspecaoNaoEvasivaContainersUld": {
"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",
"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",
"orcPlate": "Captura por OCR precisa ser verdadeiro ou falso, Captura por OCR é obrigatório",
"containerUldPhotoFile": "Foto do Container\/ULD precisa ser um texto, Foto do Container\/ULD precisa ter 180 caracteres, Trata-se do nome do arquivo que está salvo no sistema de arquivos da aplicação"
}
},
"inspecaoNaoEvasivaListaChassi": {
"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"
}
},
"inspecaoNaoEvasivaCamera": {
"description": "Cameras",
"type": "@ManyOf",
"schema": {
"georreferenciamentoCamera": {
"description": "Cameras",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
}
}
}
}
},
"preCargasUtilizadas": {
"description": "Preload",
"type": "@OneOf",
"schema": {
"veiculo": "Veiculo",
"semirreboque": "Semirreboque",
"container": "Container"
}
}
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
inspecao-nao-evasiva/delete/:inspecao-nao-evasiva-id
Deletar Inspeção não Invasiva
DELETE
http://cftv.barradorio.com.br:8080/api/inspecao-nao-evasiva/delete/:inspecao-nao-evasiva-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [inspecaoNaoEvasiva.inspecaoNaoEvasiva.delete]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"inspecao-nao-evasiva-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
inspecao-nao-evasiva/edit/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/inspecao-nao-evasiva/edit/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [inspecaoNaoEvasiva.inspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
inspecao-nao-evasiva/edit/options/inspecao-nao-evasiva-camera/georreferenciamento-camera
Opções de Camera em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/inspecao-nao-evasiva/edit/options/inspecao-nao-evasiva-camera/georreferenciamento-camera
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [inspecaoNaoEvasiva.inspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Camera em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
inspecao-nao-evasiva/edit/options/inspecao-nao-evasiva-conhecimento/type-lading
Opções de Tipo de Conhecimento
GET
http://cftv.barradorio.com.br:8080/api/inspecao-nao-evasiva/edit/options/inspecao-nao-evasiva-conhecimento/type-lading
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [inspecaoNaoEvasiva.inspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Conhecimento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
inspecao-nao-evasiva/edit/options/inspecao-nao-evasiva-conhecimento/type-manifest
Opções de Tipo do Manifesto
GET
http://cftv.barradorio.com.br:8080/api/inspecao-nao-evasiva/edit/options/inspecao-nao-evasiva-conhecimento/type-manifest
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [inspecaoNaoEvasiva.inspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo do Manifesto",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
inspecao-nao-evasiva/edit/options/inspecao-nao-evasiva-containers-uld/container-type
Opções de Tipo de Container
GET
http://cftv.barradorio.com.br:8080/api/inspecao-nao-evasiva/edit/options/inspecao-nao-evasiva-containers-uld/container-type
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [inspecaoNaoEvasiva.inspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Container",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
inspecao-nao-evasiva/edit/options/georreferenciamento-scanner
Opções de Scanner em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/inspecao-nao-evasiva/edit/options/georreferenciamento-scanner
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [inspecaoNaoEvasiva.inspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Scanner em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
inspecao-nao-evasiva/edit/:inspecao-nao-evasiva-id
Editar um(a) Inspeção não Invasiva. Enviar imediatamente após a inspeção. Um evento para cada conjunto PLACA/CONTÊINER/VOLUME escaneados.
POST
http://cftv.barradorio.com.br:8080/api/inspecao-nao-evasiva/edit/:inspecao-nao-evasiva-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [inspecaoNaoEvasiva.inspecaoNaoEvasiva.edit]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"inspecao-nao-evasiva-id": "Código"
}
}
Body Input
{
"description": "Registro do(a) Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"inspecaoNaoEvasiva": {
"description": "Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"branch": {
"description": "Inspeção não Invasiva",
"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",
"plate": "Placa precisa ser um texto, Placa precisa ter 50 caracteres",
"plateByOcr": "Captura da Placa via OCR precisa ser verdadeiro ou falso, Captura da Placa via OCR é obrigatório",
"platePhotoFile": "Foto da Placa precisa ser um texto, Foto da Placa precisa ter 180 caracteres, Trata-se do nome do arquivo que está salvo no sistema de arquivos da aplicação",
"empty": "Vazio precisa ser verdadeiro ou falso",
"scannerImageDatetimeScan": "Imagem Scanner - Data\/Hora SCAN precisa ser data e hora (Y-m-d H:i:s), Imagem Scanner - Data\/Hora SCAN é obrigatório",
"scannerImageDatetimeLastChanges": "Imagem Scanner - Data\/Hora Última Modificação precisa ser data e hora (Y-m-d H:i:s), Imagem Scanner - Data\/Hora Última Modificação é obrigatório",
"scannerImageFilename": "Imagem Scanner - Nome do Arquivo precisa ser um texto, Imagem Scanner - Nome do Arquivo é obrigatório, Imagem Scanner - Nome do Arquivo precisa ter 200 caracteres",
"scannerImageFile": "Imagem Scanner - Arquivo precisa ser um texto, Imagem Scanner - Arquivo precisa ter 180 caracteres, Imagem Scanner - Arquivo é obrigatório, Trata-se do nome do arquivo que está salvo no sistema de arquivos da aplicação",
"scannerImageLocationKey": "Imagem Scanner - Chave de Localização precisa ser um texto, Imagem Scanner - Chave de Localização precisa ter 200 caracteres",
"scannerImageFileMetadata": "Imagem Scanner - Arquivo Metadata XML precisa ser um texto, Imagem Scanner - Arquivo Metadata XML precisa ter 180 caracteres, Trata-se do nome do arquivo que está salvo no sistema de arquivos da aplicação",
"georreferenciamentoScanner": {
"description": "Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"inspecaoNaoEvasivaCoordenadasAlerta": {
"description": "Coordenadas de Alerta",
"type": "@ManyOf",
"schema": {
"id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente",
"positionX": "Posição X precisa ser um número, Posição X é obrigatório",
"positionY": "Posição Y precisa ser um número, Posição Y é obrigatório",
"positionXEnd": "Posição X 2 precisa ser um número, Posição X 2 é obrigatório",
"positionYEnd": "Posição Y 2 precisa ser um número, Posição Y 2 é obrigatório"
}
},
"inspecaoNaoEvasivaConhecimento": {
"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"
}
}
}
},
"inspecaoNaoEvasivaListaNfe": {
"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"
}
},
"inspecaoNaoEvasivaListaCargo": {
"description": "Carga",
"type": "@ManyOf",
"schema": {
"id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente",
"cargoIdentification": "Número da Carga precisa ser um texto, Número da Carga é obrigatório, Número da Carga precisa ter 100 caracteres"
}
},
"inspecaoNaoEvasivaSemitrailer": {
"description": "Semirreboque",
"type": "@ManyOf",
"schema": {
"id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente",
"orcPlate": "Captura por OCR precisa ser verdadeiro ou falso, Captura por OCR é obrigatório",
"plate": "Placa precisa ser um texto, Placa é obrigatório, Placa precisa ter 50 caracteres",
"platePhotoFile": "Foto da Placa precisa ser um texto, Foto da Placa precisa ter 180 caracteres, Trata-se do nome do arquivo que está salvo no sistema de arquivos da aplicação"
}
},
"inspecaoNaoEvasivaContainersUld": {
"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",
"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",
"orcPlate": "Captura por OCR precisa ser verdadeiro ou falso, Captura por OCR é obrigatório",
"containerUldPhotoFile": "Foto do Container\/ULD precisa ser um texto, Foto do Container\/ULD precisa ter 180 caracteres, Trata-se do nome do arquivo que está salvo no sistema de arquivos da aplicação"
}
},
"inspecaoNaoEvasivaListaChassi": {
"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"
}
},
"inspecaoNaoEvasivaCamera": {
"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) Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
inspecao-nao-evasiva/get/:inspecao-nao-evasiva-id
Obter Inspeção não Invasiva com todos os detalhes de suas informações
GET
http://cftv.barradorio.com.br:8080/api/inspecao-nao-evasiva/get/:inspecao-nao-evasiva-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [inspecaoNaoEvasiva.inspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"inspecao-nao-evasiva-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"inspecaoNaoEvasiva": {
"description": "Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"integrationStatus": {
"description": "Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"branch": {
"description": "Inspeção não Invasiva",
"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",
"plate": "Placa",
"plateByOcr": "Captura da Placa via OCR",
"platePhotoFile": "Foto da Placa",
"empty": "Vazio",
"scannerImageDatetimeScan": "Imagem Scanner - Data\/Hora SCAN",
"scannerImageDatetimeLastChanges": "Imagem Scanner - Data\/Hora Última Modificação",
"scannerImageFilename": "Imagem Scanner - Nome do Arquivo",
"scannerImageFile": "Imagem Scanner - Arquivo",
"scannerImageLocationKey": "Imagem Scanner - Chave de Localização",
"scannerImageFileMetadata": "Imagem Scanner - Arquivo Metadata XML",
"georreferenciamentoScanner": {
"description": "Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"inspecaoNaoEvasivaCoordenadasAlerta": {
"description": "Coordenadas de Alerta",
"type": "@ManyOf",
"schema": {
"id": "Código",
"positionX": "Posição X",
"positionY": "Posição Y",
"positionXEnd": "Posição X 2",
"positionYEnd": "Posição Y 2"
}
},
"inspecaoNaoEvasivaConhecimento": {
"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"
}
}
}
},
"inspecaoNaoEvasivaListaNfe": {
"description": "NF-e",
"type": "@ManyOf",
"schema": {
"id": "Código",
"number": "Número da Chave NF-e"
}
},
"inspecaoNaoEvasivaListaCargo": {
"description": "Carga",
"type": "@ManyOf",
"schema": {
"id": "Código",
"cargoIdentification": "Número da Carga"
}
},
"inspecaoNaoEvasivaSemitrailer": {
"description": "Semirreboque",
"type": "@ManyOf",
"schema": {
"id": "Código",
"orcPlate": "Captura por OCR",
"plate": "Placa",
"platePhotoFile": "Foto da Placa"
}
},
"inspecaoNaoEvasivaContainersUld": {
"description": "Containers ULD",
"type": "@ManyOf",
"schema": {
"id": "Código",
"containerNumber": "Número do Container",
"containerType": {
"description": "Containers ULD",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"uld": "ULD",
"tara": "Tara do Veículo",
"orcPlate": "Captura por OCR",
"containerUldPhotoFile": "Foto do Container\/ULD"
}
},
"inspecaoNaoEvasivaListaChassi": {
"description": "Chassi",
"type": "@ManyOf",
"schema": {
"id": "Código",
"number": "Número do Chassi"
}
},
"inspecaoNaoEvasivaCamera": {
"description": "Cameras",
"type": "@ManyOf",
"schema": {
"id": "Código",
"georreferenciamentoCamera": {
"description": "Cameras",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
}
}
},
"inspecaoNaoEvasivaIntegration": {
"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
inspecao-nao-evasiva/preload/:branch-id
Obter Inspeção não Invasiva Pre Carregada com o Ultimo Registro Lancado em Pre Carga
GET
http://cftv.barradorio.com.br:8080/api/inspecao-nao-evasiva/preload/:branch-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [inspecaoNaoEvasiva.inspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"branch-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"plate": "Placa",
"platePhotoFile": "Foto da Placa",
"occurrence": "Data\/Hora de Ocorrência",
"empty": "Vazio",
"scannerImageDatetimeScan": "Imagem Scanner - Data\/Hora SCAN",
"scannerImageDatetimeLastChanges": "Imagem Scanner - Data\/Hora Última Modificação",
"scannerImageFilename": "Imagem Scanner - Nome do Arquivo",
"scannerImageFile": "Imagem Scanner - Arquivo",
"inspecaoNaoEvasivaContainersUld": {
"description": "Preload",
"type": "@ManyOf",
"schema": {
"containerNumber": "Número do Container",
"containerType": {
"description": "Preload",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"uld": "ULD",
"tara": "Tara do Veículo",
"orcPlate": "Captura por OCR",
"containerUldPhotoFile": "Foto do Container\/ULD"
}
},
"inspecaoNaoEvasivaSemitrailer": {
"description": "Preload",
"type": "@ManyOf",
"schema": {
"plate": "Placa",
"orcPlate": "Captura por OCR",
"platePhotoFile": "Foto da Placa"
}
},
"preCargasUtilizadas": {
"description": "Preload",
"type": "@OneOf",
"schema": {
"veiculo": "Veiculo",
"semirreboque": "Semirreboque",
"container": "Container"
}
}
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
inspecao-nao-evasiva/report/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/inspecao-nao-evasiva/report/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [inspecaoNaoEvasiva.inspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
inspecao-nao-evasiva/report
Relatório de Inspeção não Invasiva com informações resumidas e possibilidade de filtro
GET
http://cftv.barradorio.com.br:8080/api/inspecao-nao-evasiva/report
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [inspecaoNaoEvasiva.inspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Registro do(a) Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"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 Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
person/audit/:person-id
Obter informações de interações no registro de Pessoa
GET
http://cftv.barradorio.com.br:8080/api/person/audit/:person-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [person.person.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Pessoa",
"type": "@OneOf",
"schema": {
"person-id": "Código"
}
}
Query Input
{
"description": "Registro do(a) Pessoa",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Pessoa",
"type": "@OneOf",
"schema": {
"personAudits": {
"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
person/collection
Coleção de Pessoa com informações resumidas e possibilidade de filtro
GET
http://cftv.barradorio.com.br:8080/api/person/collection
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [person.person.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Registro do(a) Pessoa",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100.",
"order-by": "Atributo de Ordenação. person.id, person.documentRegistry, person.name, person.nameShort, person.email, person.phonePrimary",
"order-type": "Tipo de Ordenação no Atributo. ASC ou DESC. Padrão DESC",
"filter-id": "Código",
"filter-documentRegistry-contains": "Documento (CPF\/CNPJ)",
"filter-name-contains": "Nome",
"filter-email-contains": "E-mail"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Pessoa",
"type": "@OneOf",
"schema": {
"persons": {
"description": "Pessoa",
"type": "@ManyOf",
"schema": {
"id": "Código",
"documentRegistry": "Documento (CPF\/CNPJ)",
"name": "Nome",
"nameShort": "Razão Social",
"email": "E-mail",
"phonePrimary": "Telefone"
}
},
"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
person/create/options/person-branch/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/person/create/options/person-branch/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [person.person.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
person/create/options/person-type
Opções de Tipo de Pessoa
GET
http://cftv.barradorio.com.br:8080/api/person/create/options/person-type
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [person.person.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Pessoa",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
person/create
Criar um(a) Pessoa
POST
http://cftv.barradorio.com.br:8080/api/person/create
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [person.person.create]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Body Input
{
"description": "Registro do(a) Pessoa",
"type": "@OneOf",
"schema": {
"person": {
"description": "Pessoa",
"type": "@OneOf",
"schema": {
"personType": {
"description": "Pessoa",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"documentRegistry": "Documento (CPF\/CNPJ) precisa ter apenas dígitos, Documento (CPF\/CNPJ) é obrigatório, Documento (CPF\/CNPJ) precisa ter 14 caracteres",
"name": "Nome precisa ser um texto, Nome é obrigatório, Nome precisa ter 120 caracteres",
"nameShort": "Razão Social precisa ser um texto, Razão Social precisa ter 120 caracteres",
"documentState": "Inscrição Estadual precisa ser um texto, Inscrição Estadual precisa ter 14 caracteres",
"notes": "Observações precisa ser um texto, Observações precisa ter 255 caracteres",
"email": "E-mail precisa ser um texto, E-mail precisa ter 160 caracteres",
"phonePrimary": "Telefone precisa ser um texto, Telefone é obrigatório, Telefone precisa ter 15 caracteres",
"phoneSecondary": "Telefone Adicional precisa ser um texto, Telefone Adicional precisa ter 15 caracteres",
"addressZipcode": "CEP precisa ser um texto, CEP precisa ter 8 caracteres",
"addressUf": "UF precisa ser um texto, UF precisa ter 120 caracteres",
"addressCity": "Cidade precisa ser um texto, Cidade precisa ter 80 caracteres",
"addressDistrict": "Bairro precisa ser um texto, Bairro precisa ter 80 caracteres",
"addressStreet": "Rua precisa ser um texto, Rua precisa ter 120 caracteres",
"addressNumber": "Número precisa ser um texto, Número precisa ter 12 caracteres",
"addressComplements": "Complemento precisa ser um texto, Complemento precisa ter 40 caracteres",
"personBranch": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"branch": {
"description": "Filial",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
}
}
}
}
}
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Pessoa",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
person/delete/:person-id
Deletar Pessoa
DELETE
http://cftv.barradorio.com.br:8080/api/person/delete/:person-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [person.person.delete]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Pessoa",
"type": "@OneOf",
"schema": {
"person-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Pessoa",
"type": "@OneOf",
"schema": {
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
person/edit/options/person-branch/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/person/edit/options/person-branch/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [person.person.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
person/edit/options/person-type
Opções de Tipo de Pessoa
GET
http://cftv.barradorio.com.br:8080/api/person/edit/options/person-type
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [person.person.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Pessoa",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
person/edit/:person-id
Editar um(a) Pessoa
POST
http://cftv.barradorio.com.br:8080/api/person/edit/:person-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [person.person.edit]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Pessoa",
"type": "@OneOf",
"schema": {
"person-id": "Código"
}
}
Body Input
{
"description": "Registro do(a) Pessoa",
"type": "@OneOf",
"schema": {
"person": {
"description": "Pessoa",
"type": "@OneOf",
"schema": {
"personType": {
"description": "Pessoa",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"documentRegistry": "Documento (CPF\/CNPJ) precisa ter apenas dígitos, Documento (CPF\/CNPJ) é obrigatório, Documento (CPF\/CNPJ) precisa ter 14 caracteres",
"name": "Nome precisa ser um texto, Nome é obrigatório, Nome precisa ter 120 caracteres",
"nameShort": "Razão Social precisa ser um texto, Razão Social precisa ter 120 caracteres",
"documentState": "Inscrição Estadual precisa ser um texto, Inscrição Estadual precisa ter 14 caracteres",
"notes": "Observações precisa ser um texto, Observações precisa ter 255 caracteres",
"email": "E-mail precisa ser um texto, E-mail precisa ter 160 caracteres",
"phonePrimary": "Telefone precisa ser um texto, Telefone é obrigatório, Telefone precisa ter 15 caracteres",
"phoneSecondary": "Telefone Adicional precisa ser um texto, Telefone Adicional precisa ter 15 caracteres",
"addressZipcode": "CEP precisa ser um texto, CEP precisa ter 8 caracteres",
"addressUf": "UF precisa ser um texto, UF precisa ter 120 caracteres",
"addressCity": "Cidade precisa ser um texto, Cidade precisa ter 80 caracteres",
"addressDistrict": "Bairro precisa ser um texto, Bairro precisa ter 80 caracteres",
"addressStreet": "Rua precisa ser um texto, Rua precisa ter 120 caracteres",
"addressNumber": "Número precisa ser um texto, Número precisa ter 12 caracteres",
"addressComplements": "Complemento precisa ser um texto, Complemento precisa ter 40 caracteres",
"personBranch": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente",
"branch": {
"description": "Filial",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
}
}
}
}
}
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Pessoa",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
person/get/:person-id
Obter Pessoa com todos os detalhes de suas informações
GET
http://cftv.barradorio.com.br:8080/api/person/get/:person-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [person.person.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Pessoa",
"type": "@OneOf",
"schema": {
"person-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Pessoa",
"type": "@OneOf",
"schema": {
"person": {
"description": "Pessoa",
"type": "@OneOf",
"schema": {
"id": "Código",
"personType": {
"description": "Pessoa",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"documentRegistry": "Documento (CPF\/CNPJ)",
"name": "Nome",
"nameShort": "Razão Social",
"documentState": "Inscrição Estadual",
"notes": "Observações",
"email": "E-mail",
"phonePrimary": "Telefone",
"phoneSecondary": "Telefone Adicional",
"addressZipcode": "CEP",
"addressUf": "UF",
"addressCity": "Cidade",
"addressDistrict": "Bairro",
"addressStreet": "Rua",
"addressNumber": "Número",
"addressComplements": "Complemento",
"personBranch": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Código",
"branch": {
"description": "Filial",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
}
}
}
}
}
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
person/receita/:cnpj
Obter informações de um CNPJ
GET
http://cftv.barradorio.com.br:8080/api/person/receita/:cnpj
URI Input
{
"description": "Registro do(a) CNPJ",
"type": "@OneOf",
"schema": {
"cnpj": "CNPJ"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) CNPJ",
"type": "@OneOf",
"schema": {
"nome": "Razão Social",
"fantasia": "Fantasia"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
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/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/pesagem-veiculo-carga/collection/options/branch
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pesagem-veiculo-carga/collection/options/conveyor-belts
Opções de Correias Transportadoras
GET
http://cftv.barradorio.com.br:8080/api/pesagem-veiculo-carga/collection/options/conveyor-belts
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Correias Transportadoras",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pesagem-veiculo-carga/collection/options/ducts-type
Opções de Duto
GET
http://cftv.barradorio.com.br:8080/api/pesagem-veiculo-carga/collection/options/ducts-type
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Duto",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pesagem-veiculo-carga/collection/options/integration-status
Opções de Situação
GET
http://cftv.barradorio.com.br:8080/api/pesagem-veiculo-carga/collection/options/integration-status
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Situação",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
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/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/pesagem-veiculo-carga/create/options/branch
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pesagem-veiculo-carga/create/options/pesagem-veiculo-carga-camera/georreferenciamento-camera
Opções de Camera em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/pesagem-veiculo-carga/create/options/pesagem-veiculo-carga-camera/georreferenciamento-camera
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Camera em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pesagem-veiculo-carga/create/options/pesagem-veiculo-carga-conhecimento/type-lading
Opções de Tipo de Conhecimento
GET
http://cftv.barradorio.com.br:8080/api/pesagem-veiculo-carga/create/options/pesagem-veiculo-carga-conhecimento/type-lading
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Conhecimento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pesagem-veiculo-carga/create/options/pesagem-veiculo-carga-conhecimento/type-manifest
Opções de Tipo do Manifesto
GET
http://cftv.barradorio.com.br:8080/api/pesagem-veiculo-carga/create/options/pesagem-veiculo-carga-conhecimento/type-manifest
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo do Manifesto",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pesagem-veiculo-carga/create/options/pesagem-veiculo-carga-containers-uld/container-type
Opções de Tipo de Container
GET
http://cftv.barradorio.com.br:8080/api/pesagem-veiculo-carga/create/options/pesagem-veiculo-carga-containers-uld/container-type
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Container",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pesagem-veiculo-carga/create/options/conveyor-belts
Opções de Correias Transportadoras
GET
http://cftv.barradorio.com.br:8080/api/pesagem-veiculo-carga/create/options/conveyor-belts
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Correias Transportadoras",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pesagem-veiculo-carga/create/options/ducts-type
Opções de Duto
GET
http://cftv.barradorio.com.br:8080/api/pesagem-veiculo-carga/create/options/ducts-type
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Duto",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pesagem-veiculo-carga/create/options/georreferenciamento-balanca
Opções de Balança em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/pesagem-veiculo-carga/create/options/georreferenciamento-balanca
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Balança em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
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/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/pesagem-veiculo-carga/edit/options/branch
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pesagem-veiculo-carga/edit/options/pesagem-veiculo-carga-camera/georreferenciamento-camera
Opções de Camera em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/pesagem-veiculo-carga/edit/options/pesagem-veiculo-carga-camera/georreferenciamento-camera
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Camera em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pesagem-veiculo-carga/edit/options/pesagem-veiculo-carga-conhecimento/type-lading
Opções de Tipo de Conhecimento
GET
http://cftv.barradorio.com.br:8080/api/pesagem-veiculo-carga/edit/options/pesagem-veiculo-carga-conhecimento/type-lading
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Conhecimento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pesagem-veiculo-carga/edit/options/pesagem-veiculo-carga-conhecimento/type-manifest
Opções de Tipo do Manifesto
GET
http://cftv.barradorio.com.br:8080/api/pesagem-veiculo-carga/edit/options/pesagem-veiculo-carga-conhecimento/type-manifest
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo do Manifesto",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pesagem-veiculo-carga/edit/options/pesagem-veiculo-carga-containers-uld/container-type
Opções de Tipo de Container
GET
http://cftv.barradorio.com.br:8080/api/pesagem-veiculo-carga/edit/options/pesagem-veiculo-carga-containers-uld/container-type
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Container",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pesagem-veiculo-carga/edit/options/conveyor-belts
Opções de Correias Transportadoras
GET
http://cftv.barradorio.com.br:8080/api/pesagem-veiculo-carga/edit/options/conveyor-belts
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Correias Transportadoras",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pesagem-veiculo-carga/edit/options/ducts-type
Opções de Duto
GET
http://cftv.barradorio.com.br:8080/api/pesagem-veiculo-carga/edit/options/ducts-type
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Duto",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pesagem-veiculo-carga/edit/options/georreferenciamento-balanca
Opções de Balança em Georreferenciamento
GET
http://cftv.barradorio.com.br:8080/api/pesagem-veiculo-carga/edit/options/georreferenciamento-balanca
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": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Balança em Georreferenciamento",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
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
pre-carga-inspecao-nao-evasiva/audit/:pre-carga-inspecao-nao-evasiva-id
Obter informações de interações no registro de Pre Carga Inspeção não Invasiva
GET
http://cftv.barradorio.com.br:8080/api/pre-carga-inspecao-nao-evasiva/audit/:pre-carga-inspecao-nao-evasiva-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [preCargaInspecaoNaoEvasiva.preCargaInspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"pre-carga-inspecao-nao-evasiva-id": "Código"
}
}
Query Input
{
"description": "Registro do(a) Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"preCargaInspecaoNaoEvasivaAudits": {
"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
pre-carga-inspecao-nao-evasiva/collection/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/pre-carga-inspecao-nao-evasiva/collection/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [preCargaInspecaoNaoEvasiva.preCargaInspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pre-carga-inspecao-nao-evasiva/collection/options/driver-pre-carga-inspecao-nao-evasiva
Opções de Conector
GET
http://cftv.barradorio.com.br:8080/api/pre-carga-inspecao-nao-evasiva/collection/options/driver-pre-carga-inspecao-nao-evasiva
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [preCargaInspecaoNaoEvasiva.preCargaInspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Conector",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pre-carga-inspecao-nao-evasiva/collection/options/inspecao-nao-evasiva
Opções de Inspeção não Invasiva
GET
http://cftv.barradorio.com.br:8080/api/pre-carga-inspecao-nao-evasiva/collection/options/inspecao-nao-evasiva
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [preCargaInspecaoNaoEvasiva.preCargaInspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Inspeção não Invasiva",
"type": "@ManyOf",
"schema": {
"id": "Identificação\/Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pre-carga-inspecao-nao-evasiva/collection/options/type-pre-carga-inspecao-nao-evasiva
Opções de Tipo
GET
http://cftv.barradorio.com.br:8080/api/pre-carga-inspecao-nao-evasiva/collection/options/type-pre-carga-inspecao-nao-evasiva
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [preCargaInspecaoNaoEvasiva.preCargaInspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pre-carga-inspecao-nao-evasiva/collection
Coleção de Pre Carga Inspeção não Invasiva com informações resumidas e possibilidade de filtro
GET
http://cftv.barradorio.com.br:8080/api/pre-carga-inspecao-nao-evasiva/collection
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [preCargaInspecaoNaoEvasiva.preCargaInspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Registro do(a) Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100.",
"order-by": "Atributo de Ordenação. preCargaInspecaoNaoEvasiva.id, preCargaInspecaoNaoEvasiva.created, preCargaInspecaoNaoEvasiva.updated, driverPreCargaInspecaoNaoEvasiva.name, typePreCargaInspecaoNaoEvasiva.name, preCargaInspecaoNaoEvasiva.capturedWord, branch.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-driverPreCargaInspecaoNaoEvasiva-id": "Conector",
"filter-typePreCargaInspecaoNaoEvasiva-id": "Tipo",
"filter-capturedWord-contains": "Palavra",
"filter-branch-id": "Filial"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"preCargaInspecaoNaoEvasivas": {
"description": "Pre Carga Inspeção não Invasiva",
"type": "@ManyOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"driverPreCargaInspecaoNaoEvasiva": {
"description": "Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"typePreCargaInspecaoNaoEvasiva": {
"description": "Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"capturedWord": "Palavra",
"branch": {
"description": "Pre Carga Inspeção não Invasiva",
"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
pre-carga-inspecao-nao-evasiva/create/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/pre-carga-inspecao-nao-evasiva/create/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [preCargaInspecaoNaoEvasiva.preCargaInspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pre-carga-inspecao-nao-evasiva/create/options/driver-pre-carga-inspecao-nao-evasiva
Opções de Conector
GET
http://cftv.barradorio.com.br:8080/api/pre-carga-inspecao-nao-evasiva/create/options/driver-pre-carga-inspecao-nao-evasiva
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [preCargaInspecaoNaoEvasiva.preCargaInspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Conector",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pre-carga-inspecao-nao-evasiva/create/options/inspecao-nao-evasiva
Opções de Inspeção não Invasiva
GET
http://cftv.barradorio.com.br:8080/api/pre-carga-inspecao-nao-evasiva/create/options/inspecao-nao-evasiva
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [preCargaInspecaoNaoEvasiva.preCargaInspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Inspeção não Invasiva",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"internalKey": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pre-carga-inspecao-nao-evasiva/create/options/type-pre-carga-inspecao-nao-evasiva
Opções de Tipo
GET
http://cftv.barradorio.com.br:8080/api/pre-carga-inspecao-nao-evasiva/create/options/type-pre-carga-inspecao-nao-evasiva
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [preCargaInspecaoNaoEvasiva.preCargaInspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pre-carga-inspecao-nao-evasiva/create
Criar um(a) Pre Carga Inspeção não Invasiva
POST
http://cftv.barradorio.com.br:8080/api/pre-carga-inspecao-nao-evasiva/create
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [preCargaInspecaoNaoEvasiva.preCargaInspecaoNaoEvasiva.create]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Body Input
{
"description": "Registro do(a) Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"preCargaInspecaoNaoEvasiva": {
"description": "Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"driverPreCargaInspecaoNaoEvasiva": {
"description": "Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"typePreCargaInspecaoNaoEvasiva": {
"description": "Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"capturedWord": "Palavra precisa ser um texto, Palavra precisa ter 190 caracteres",
"capturedPhoto": "Foto precisa ser um texto, Foto precisa ter 180 caracteres, Trata-se do nome do arquivo que está salvo no sistema de arquivos da aplicação",
"branch": {
"description": "Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"used": "Utilizado precisa ser verdadeiro ou falso, Utilizado é obrigatório",
"inspecaoNaoEvasiva": {
"description": "Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"metadata": "Metadados precisa ser um texto, Metadados é obrigatório"
}
}
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pre-carga-inspecao-nao-evasiva/delete/:pre-carga-inspecao-nao-evasiva-id
Deletar Pre Carga Inspeção não Invasiva
DELETE
http://cftv.barradorio.com.br:8080/api/pre-carga-inspecao-nao-evasiva/delete/:pre-carga-inspecao-nao-evasiva-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [preCargaInspecaoNaoEvasiva.preCargaInspecaoNaoEvasiva.delete]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"pre-carga-inspecao-nao-evasiva-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pre-carga-inspecao-nao-evasiva/edit/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/pre-carga-inspecao-nao-evasiva/edit/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [preCargaInspecaoNaoEvasiva.preCargaInspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pre-carga-inspecao-nao-evasiva/edit/options/driver-pre-carga-inspecao-nao-evasiva
Opções de Conector
GET
http://cftv.barradorio.com.br:8080/api/pre-carga-inspecao-nao-evasiva/edit/options/driver-pre-carga-inspecao-nao-evasiva
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [preCargaInspecaoNaoEvasiva.preCargaInspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Conector",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pre-carga-inspecao-nao-evasiva/edit/options/inspecao-nao-evasiva
Opções de Inspeção não Invasiva
GET
http://cftv.barradorio.com.br:8080/api/pre-carga-inspecao-nao-evasiva/edit/options/inspecao-nao-evasiva
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [preCargaInspecaoNaoEvasiva.preCargaInspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Inspeção não Invasiva",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"internalKey": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pre-carga-inspecao-nao-evasiva/edit/options/type-pre-carga-inspecao-nao-evasiva
Opções de Tipo
GET
http://cftv.barradorio.com.br:8080/api/pre-carga-inspecao-nao-evasiva/edit/options/type-pre-carga-inspecao-nao-evasiva
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [preCargaInspecaoNaoEvasiva.preCargaInspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pre-carga-inspecao-nao-evasiva/edit/:pre-carga-inspecao-nao-evasiva-id
Editar um(a) Pre Carga Inspeção não Invasiva
POST
http://cftv.barradorio.com.br:8080/api/pre-carga-inspecao-nao-evasiva/edit/:pre-carga-inspecao-nao-evasiva-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [preCargaInspecaoNaoEvasiva.preCargaInspecaoNaoEvasiva.edit]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"pre-carga-inspecao-nao-evasiva-id": "Código"
}
}
Body Input
{
"description": "Registro do(a) Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"preCargaInspecaoNaoEvasiva": {
"description": "Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"driverPreCargaInspecaoNaoEvasiva": {
"description": "Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"typePreCargaInspecaoNaoEvasiva": {
"description": "Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"capturedWord": "Palavra precisa ser um texto, Palavra precisa ter 190 caracteres",
"capturedPhoto": "Foto precisa ser um texto, Foto precisa ter 180 caracteres, Trata-se do nome do arquivo que está salvo no sistema de arquivos da aplicação",
"branch": {
"description": "Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"used": "Utilizado precisa ser verdadeiro ou falso, Utilizado é obrigatório",
"inspecaoNaoEvasiva": {
"description": "Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"metadata": "Metadados precisa ser um texto, Metadados é obrigatório"
}
}
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pre-carga-inspecao-nao-evasiva/get/:pre-carga-inspecao-nao-evasiva-id
Obter Pre Carga Inspeção não Invasiva com todos os detalhes de suas informações
GET
http://cftv.barradorio.com.br:8080/api/pre-carga-inspecao-nao-evasiva/get/:pre-carga-inspecao-nao-evasiva-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [preCargaInspecaoNaoEvasiva.preCargaInspecaoNaoEvasiva.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"pre-carga-inspecao-nao-evasiva-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"preCargaInspecaoNaoEvasiva": {
"description": "Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"driverPreCargaInspecaoNaoEvasiva": {
"description": "Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"typePreCargaInspecaoNaoEvasiva": {
"description": "Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"capturedWord": "Palavra",
"capturedPhoto": "Foto",
"branch": {
"description": "Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"used": "Utilizado",
"inspecaoNaoEvasiva": {
"description": "Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"internalKey": "Descrição"
}
},
"metadata": "Metadados"
}
}
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
pre-carga-inspecao-nao-evasiva/preload/neural/:tenant-id/:branch-id
Criar um(a) Pre Carga Inspeção não Invasiva pelo Neural Server
POST
http://cftv.barradorio.com.br:8080/api/pre-carga-inspecao-nao-evasiva/preload/neural/:tenant-id/:branch-id
URI Input
{
"description": "Registro do(a) Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"tenant-id": "Inquilino",
"branch-id": "Filial"
}
}
Body Input
{
"description": "Registro do(a) Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"infoplate": {
"description": "Registro do(a) Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"DateHour": "DateHour",
"Engine": "Engine",
"Plate": "Plate",
"PlateDescription": "PlateDescription",
"CardID": "CardID",
"Container": "Container",
"ExtraInfo": "ExtraInfo",
"Confidence": "Confidence",
"Country": "Country",
"CountryID": "CountryID",
"ProcTime": "ProcTime",
"CharHeight": "CharHeight",
"CamID": "CamID",
"CamName": "CamName",
"ImageLeft": "ImageLeft",
"ImageTop": "ImageTop",
"ImageWidth": "ImageWidth",
"ImageHeight": "ImageHeight",
"Path": "Path",
"DirectionVector": "DirectionVector",
"imgSize": "imgSize",
"img": "img",
"imgSizeCut": "imgSizeCut",
"imgCut": "imgCut",
"ComputerID": "ComputerID",
"Feedback": "Feedback",
"EventID": "EventID",
"IncidenceID": "IncidenceID",
"nFrame": "nFrame",
"aviFileName": "aviFileName",
"Code": "Code",
"Speed": "Speed",
"GPSLat": "GPSLat",
"GPSLon": "GPSLon",
"List": "List",
"ListName": "ListName",
"CharConfidence": "CharConfidence",
"VehicleMake": "VehicleMake",
"VehicleModel": "VehicleModel",
"VehicleClass": "VehicleClass",
"VehicleColor": "VehicleColor",
"LaneName": "LaneName",
"LaneID": "LaneID",
"RedLightState": "RedLightState",
"RedLightPosTime": "RedLightPosTime",
"LocationID": "LocationID",
"Angle": "Angle",
"VehicleType": "VehicleType",
"Char0TopX": "Char0TopX",
"Char0TopY": "Char0TopY",
"Char0BottomX": "Char0BottomX",
"Char0BottomY": "Char0BottomY",
"CharNTopX": "CharNTopX",
"CharNTopY": "CharNTopY",
"CharNBottomX": "CharNBottomX",
"CharNBottomY": "CharNBottomY",
"Evidences": "Evidences"
}
}
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Pre Carga Inspeção não Invasiva",
"type": "@OneOf",
"schema": {
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
track-events/vehicle-cargo-shipment/options/branch
Opções de Filial
GET
http://cftv.barradorio.com.br:8080/api/track-events/vehicle-cargo-shipment/options/branch
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [trackEvents.vehicleCargoShipment]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Filial",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
track-events/vehicle-cargo-shipment
Rastreio de Veículo/Carga/Embarque
GET
http://cftv.barradorio.com.br:8080/api/track-events/vehicle-cargo-shipment
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [trackEvents.vehicleCargoShipment]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Registro do(a) Rastreio",
"type": "@OneOf",
"schema": {
"filter-branch-id": "Filial",
"filter-date-vehicle-schedule": "Data de Agendamento do Veículo",
"filter-time-vehicle-schedule": "Hora de Agendamento do Veículo",
"filter-lot-number": "Numero do Lote",
"filter-driver-cpf": "CPF do Motorista",
"filter-vehicle-plate": "Placa do Veículo"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
user/audit/:user-id
Obter informações de interações no registro de Usuário
GET
http://cftv.barradorio.com.br:8080/api/user/audit/:user-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [user.user.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Usuário",
"type": "@OneOf",
"schema": {
"user-id": "Código"
}
}
Query Input
{
"description": "Registro do(a) Usuário",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Usuário",
"type": "@OneOf",
"schema": {
"userAudits": {
"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
user/collection/options/person
Opções de Pessoa
GET
http://cftv.barradorio.com.br:8080/api/user/collection/options/person
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [user.user.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Pessoa",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
user/collection/options/pu-crt-type
Opções de Tipo de Certificado
GET
http://cftv.barradorio.com.br:8080/api/user/collection/options/pu-crt-type
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [user.user.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Certificado",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
user/collection
Coleção de Usuário com informações resumidas e possibilidade de filtro
GET
http://cftv.barradorio.com.br:8080/api/user/collection
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [user.user.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Registro do(a) Usuário",
"type": "@OneOf",
"schema": {
"page": "Página",
"pagination": "Paginação. Máximo 100.",
"order-by": "Atributo de Ordenação. user.id, user.name, user.email, person.name, crtType.name",
"order-type": "Tipo de Ordenação no Atributo. ASC ou DESC. Padrão DESC",
"filter-id": "Código",
"filter-name-contains": "Nome",
"filter-email-contains": "E-mail",
"filter-person-id": "Pessoa",
"filter-puCrtType-id": "Tipo de Certificado"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Usuário",
"type": "@OneOf",
"schema": {
"users": {
"description": "Usuário",
"type": "@ManyOf",
"schema": {
"id": "Código",
"name": "Nome",
"email": "E-mail",
"person": {
"description": "Usuário",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"puCrtType": {
"description": "Usuário",
"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
user/create/options/user-access-profile/access-profile
Opções de Perfil de Acesso
GET
http://cftv.barradorio.com.br:8080/api/user/create/options/user-access-profile/access-profile
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [user.user.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Valores",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição",
"accessProfileResource": {
"description": "Valores",
"type": "@ManyOf",
"schema": {
"resource": {
"description": "Valores",
"type": "@OneOf",
"schema": {
"id": "Código",
"alias": "Pseudônimo"
}
}
}
}
}
},
"total": "Total de Registros"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
user/create/options/person
Opções de Pessoa
GET
http://cftv.barradorio.com.br:8080/api/user/create/options/person
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [user.user.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Pessoa",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
user/create/options/pu-crt-type
Opções de Tipo de Certificado
GET
http://cftv.barradorio.com.br:8080/api/user/create/options/pu-crt-type
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [user.user.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Certificado",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
user/create/options/user-resource/resource
Opções de Recurso
GET
http://cftv.barradorio.com.br:8080/api/user/create/options/user-resource/resource
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [user.user.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Recurso",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
user/create
Criar um(a) Usuário
POST
http://cftv.barradorio.com.br:8080/api/user/create
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [user.user.create]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Body Input
{
"description": "Registro do(a) Usuário",
"type": "@OneOf",
"schema": {
"user": {
"description": "Usuário",
"type": "@OneOf",
"schema": {
"name": "Nome precisa ser um texto, Nome é obrigatório, Nome precisa ter 160 caracteres",
"email": "E-mail precisa ser um texto, E-mail é obrigatório, E-mail precisa ter 160 caracteres",
"userActive": "Usuário Ativo precisa ser verdadeiro ou falso, Usuário Ativo é obrigatório",
"person": {
"description": "Usuário",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"userMaster": "Usuário Gerente precisa ser verdadeiro ou falso, Usuário Gerente é obrigatório",
"puCrt": "Certificado precisa ser um texto, Certificado precisa ter 180 caracteres, Trata-se do nome do arquivo que está salvo no sistema de arquivos da aplicação",
"puCrtType": {
"description": "Usuário",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"puCrtPassword": "Senha do Certificado precisa ser um texto, Senha do Certificado precisa ter 25 caracteres",
"puCrtValidity": "Validade do Certificado precisa ser data e hora (Y-m-d H:i:s)",
"userAccessProfile": {
"description": "Perfil de Acesso",
"type": "@ManyOf",
"schema": {
"accessProfile": {
"description": "Perfil de Acesso",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
}
}
},
"userResource": {
"description": "Recursos Customizados",
"type": "@ManyOf",
"schema": {
"resource": {
"description": "Recursos Customizados",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
}
}
}
}
}
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Usuário",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
user/delete/:user-id
Deletar Usuário
DELETE
http://cftv.barradorio.com.br:8080/api/user/delete/:user-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [user.user.delete]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Usuário",
"type": "@OneOf",
"schema": {
"user-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Usuário",
"type": "@OneOf",
"schema": {
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
user/edit/options/user-access-profile/access-profile
Opções de Perfil de Acesso
GET
http://cftv.barradorio.com.br:8080/api/user/edit/options/user-access-profile/access-profile
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [user.user.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Valores",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição",
"accessProfileResource": {
"description": "Valores",
"type": "@ManyOf",
"schema": {
"resource": {
"description": "Valores",
"type": "@OneOf",
"schema": {
"id": "Código",
"alias": "Pseudônimo"
}
}
}
}
}
},
"total": "Total de Registros"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
user/edit/options/person
Opções de Pessoa
GET
http://cftv.barradorio.com.br:8080/api/user/edit/options/person
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [user.user.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Pessoa",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
user/edit/options/pu-crt-type
Opções de Tipo de Certificado
GET
http://cftv.barradorio.com.br:8080/api/user/edit/options/pu-crt-type
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [user.user.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Query Input
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"contains": "Contém",
"page": "Pagina",
"pagination": "Paginação. Máximo 100."
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Tipo de Certificado",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros",
"page": "Página",
"pages": "Total de Páginas",
"pagination": "Páginação. Máximo 100."
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
user/edit/options/user-resource/resource
Opções de Recurso
GET
http://cftv.barradorio.com.br:8080/api/user/edit/options/user-resource/resource
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [user.user.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Opções",
"type": "@OneOf",
"schema": {
"options": {
"description": "Recurso",
"type": "@ManyOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"total": "Total de Registros"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
user/edit/:user-id
Editar um(a) Usuário
POST
http://cftv.barradorio.com.br:8080/api/user/edit/:user-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [user.user.edit]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Usuário",
"type": "@OneOf",
"schema": {
"user-id": "Código"
}
}
Body Input
{
"description": "Registro do(a) Usuário",
"type": "@OneOf",
"schema": {
"user": {
"description": "Usuário",
"type": "@OneOf",
"schema": {
"name": "Nome precisa ser um texto, Nome é obrigatório, Nome precisa ter 160 caracteres",
"email": "E-mail precisa ser um texto, E-mail é obrigatório, E-mail precisa ter 160 caracteres",
"userActive": "Usuário Ativo precisa ser verdadeiro ou falso, Usuário Ativo é obrigatório",
"person": {
"description": "Usuário",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"userMaster": "Usuário Gerente precisa ser verdadeiro ou falso, Usuário Gerente é obrigatório",
"puCrt": "Certificado precisa ser um texto, Certificado precisa ter 180 caracteres, Trata-se do nome do arquivo que está salvo no sistema de arquivos da aplicação",
"puCrtType": {
"description": "Usuário",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
},
"puCrtPassword": "Senha do Certificado precisa ser um texto, Senha do Certificado precisa ter 25 caracteres",
"puCrtValidity": "Validade do Certificado precisa ser data e hora (Y-m-d H:i:s)",
"userAccessProfile": {
"description": "Perfil de Acesso",
"type": "@ManyOf",
"schema": {
"id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente",
"accessProfile": {
"description": "Perfil de Acesso",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
}
}
},
"userResource": {
"description": "Recursos Customizados",
"type": "@ManyOf",
"schema": {
"id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente",
"resource": {
"description": "Recursos Customizados",
"type": "@OneOf",
"schema": {
"id": "Identificação"
}
}
}
}
}
}
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Usuário",
"type": "@OneOf",
"schema": {
"id": "Código",
"message": "Mensagem"
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message
user/get/:user-id
Obter Usuário com todos os detalhes de suas informações
GET
http://cftv.barradorio.com.br:8080/api/user/get/:user-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [user.user.read]
{
"description": "Autenticação",
"type": "@OneOf",
"schema": {
"token": "Token de autenticação de usuário"
}
}
URI Input
{
"description": "Registro do(a) Usuário",
"type": "@OneOf",
"schema": {
"user-id": "Código"
}
}
Output
{
"type": "success",
"content": "@"
}
where output @ is
{
"description": "Registro do(a) Usuário",
"type": "@OneOf",
"schema": {
"user": {
"description": "Usuário",
"type": "@OneOf",
"schema": {
"id": "Código",
"created": "Data de Cadastro",
"updated": "Data de Atualização",
"name": "Nome",
"email": "E-mail",
"userActive": "Usuário Ativo",
"person": {
"description": "Usuário",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"userMaster": "Usuário Gerente",
"puCrt": "Certificado",
"puCrtType": {
"description": "Usuário",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
},
"puCrtPassword": "Senha do Certificado",
"puCrtValidity": "Validade do Certificado",
"userAccessProfile": {
"description": "Perfil de Acesso",
"type": "@ManyOf",
"schema": {
"id": "Código",
"accessProfile": {
"description": "Perfil de Acesso",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
}
}
},
"userResource": {
"description": "Recursos Customizados",
"type": "@ManyOf",
"schema": {
"id": "Código",
"resource": {
"description": "Recursos Customizados",
"type": "@OneOf",
"schema": {
"id": "Identificação",
"name": "Descrição"
}
}
}
}
}
}
}
}
Output Exception
{
"type": "exception",
"message": "@"
}
where ouput exception @ is equal the string message