Conferência Física

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

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

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/: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