Atribuição/Troca de Navio
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
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
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/: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