WS_GUARDIAN


TOLEDO DO BRASIL INDÚSTRIA DE BALANÇAS LTDA.

GUARDIAN - Web Service - Versão : 6.17.128

Web Service responsável pela interface entre o Guardian e um Sistema de Retaguarda, Legado ou ERP. Por isso os Web Metodos que podem ser utilizados nas Integrações entre sistemas estarão indicados nessa documentação com a Tag [INTERFACE].

ATENÇÃO!!!

- Os Web Métodos indicados com a Tag [OBSOLETOS], preferencialmente, não deve ser utilizados pois estão disponíveis apenas para compatibilização com versões anteriores do Guardian.

ANTES DE CONSUMIR OS WEB MÉTODOS

- Antes de consumir os web métodos, deve-se configurar a conexão com o banco de dados, através do programa CFG_WS_GUARDIAN.exe. O mesmo encontra-se na pasta BIN do diretório virtual (...inetpub\wwwroot\WS_GUARDIAN_PLUS).

CAMPOS E PARÂMETROS TIPO DATA E HORA

- Todas as datas, com campos ou parâmetros no formato DATA E HORA estão sendo trafegadas no seguinte formato: yyyy-MM-ddThh:mm:ss:FFF exemplo : 2012-01-14T15:58:00.237

O padrão de formato FFF suprime o caracter 0 à direita. A diferença é ilustrada no exemplo a seguir.
Exemplo 1:
    Entrada: 2008-07-16 08:32:45:000
    Resultado: 2008-07-16 08:32:45
Exemplo 2:
    Entrada: 2008-07-16 08:32:45:100
    Resultado: 2008-07-16 08:32:45:1
Exemplo 3:
    Entrada: 2008-07-16 08:32:45:110
    Resultado: 2008-07-16 08:32:45:11
Exemplo 4:
    Entrada: 2008-07-16 08:32:45:111
    Resultado: 2008-07-16 08:32:45:111
Todas as datas, com campos ou parâmetros no formato STRING estão sendo trafegadas no seguinte formato: dd/MM/yyyy hh:mm:ss:FFF.

CAMPO TIPO DOUBLE

- Campos e parâmetros definidos como Double no wsdl, estão documentados como Decimal. Para efeito de cálculo, o Guardian tratará como Decimal. Quando for utilizar estes campos, informar sempre valores Decimais, conforme configuração de precisão do Guardian.

ELEMENTO COM VALOR “NULO”

- Quando um elemento estiver definido como “maxOccurs = “1” minOccurs = “1” nillable = “true” />” , e quem estiver invocando o método não tiver conteúdo para passar, ou não utilizar uma determinada funcionalidade, temos duas opções de implementa - la:

1-) Suprimir o elemento em questão do XML, que o WebServices Guardian vai tratar deste elemento;

2-) Ou a opção é instanciar xmlns:xsi = http://www.w3.org/2001/XMLSchema-instance no Envelope do XML e atribuir o valor xsi:nil=“true” ao elemento.

Exemplo:
No caso do elemento < s:element minOccurs = “1” maxOccurs = “1” name = “UtilizaContador” type = “s:boolean” />

O XML deve estar assim: < UtilizaContador:xsi: nil = “true”/> ou suprimi-lo no XML

O XML nunca deve estar assim:< UtilizaContador > ou < B >< font color = red>< UtilizaContador />

NOVOS ELEMENTOS E COMPATIBILIDADE ENTRE VERSÕES

- É possível e comum que entre uma versão e outra de Guardian sejam adicionados novos elementos (campos) nas estruturas dos Web Métodos existentes.

Tais elementos não são obrigatórios mesmo que no WSDL eles apareçam com MinOccurs=1, pois o tratamento é dados internamente dentro do Web Service.

Essas diferenças não causam quebra de uma versão para outra.

Caso algum problema, que não esteja de acordo com esse ponto, seja encontrado, entre em contado com o responsável pelo seu projeto na Toledo do Brasil.

DICAS DE DESEMPENHO

1-) Cada chamada de um MESMO web método deve ser limitada a um segundo, podendo ser mais que isto mas não menos. Esta é uma orientação conservadora já que alguns Web Métodos são leves e rápidos e outros demandam mais processamento ou I/O.
Exemplos:
    Web método ExportaTicketsMarcados é chamado 4 vezes seguidas em um mesmo segundo (errado)
    Web método ExportaTicketsMarcados é chamado e imediatamente em seguida ConfirmaLeituraTicketsMarcados (são métodos diferentes, não há problema)

2-) Alguns web métodos foram desenvolvidos para uso em par, o uso diferente disto pode causar perda significativa de performance:
Exemplos:
    Ao utilizar o ExportaTicketUnico, utilizar o ConfirmaTicketUnico
    Ao utilizar o ExportaTicketsMarcados, utilizar o ConfirmaLeituraTicketsMarcados

3-) Quando utilizado Web Métodos que acumulam informações (ex: ExportaTicketsMarcados), não é aconselhavel acumular grande número de informações para exportação, isto porquê o XML retornado por cada ticket pode ser grande e combinado a seguidas exportações, pode impactar o WS, OS e o sistema legado:
Como qualquer web método que retorna grandes quantidades de texto, a quantidade de informação que pode ser acumulada depende da relação 'poder de processamento' x 'intensidade de uso' de cada maquina e o limite deve ser testado.
Exemplos:
    O web método ExportaTicketsMarcados é chamado seguidas vezes, mas o ConfirmaLeituraTicketsMarcados nenhuma vez. (errado)
    O web método ExportaTicketsMarcados é chamado uma vez e o ConfirmaLeituraTicketsMarcados é chamado em seguida. (não há problema)

WEB METODOS

Método Status
AcionaCancela Disponível
AcionaCancela_G4 Obsoleto
AlteraTicketGuardian Disponível
CadastraTicket Obsoleto
CadastraTicketGuardian Disponível
CancelaUltimaOperacaoAtiva Disponível
CapturaPeso Disponível
CapturaPeso_G4 Obsoleto
ConfirmaLeituraTicketsMarcados Disponível
ConfirmaTicketUnico Disponível
ConfirmaVeiculosQuePossamTerPassadoSemPesarPelaBalanca Disponível
ConsultaIntervencoesManuaisTicket * Disponível
ConsultaLogAplicacao Disponível
ConsultaLogPerifericos Disponível
ConsultaMovimentoOCR Disponível
ConsultaPedidoDeExecucao Disponível
ConsultarLogAuditoria Disponível
ConsultaTicketsPorPeriodo Disponível
DadosDoTicket_G4 Obsoleto
EnviaMensagemDisplay Disponível
EnviaMensagem_G4 Obsoleto
ExportaTicketParametro Disponível
ExportaTicketPeriodo Obsoleto
ExportaTicketUnico Disponível
ExportaTicketsMarcados Disponível
ExportaVeiculosQuePossamTerPassadoSemPesarPelaBalanca Disponível
FilaAdicionaVeiculo Disponível
FilaConsultaVeiculo Disponível
FilaRemoveVeiculo Disponível
IdentificaVagao Obsoleto
IdentificaVeiculoNoPonto Disponível
ImportaTicketPreCadastro Obsoleto
ImprimeEtiqueta Disponível
LiberarTicket Disponível
ManutencaoTicket Disponível
MarcarParaCancelar Disponível
MarcarParaNaoValidarOcr Disponível
MarcaTickeParaNaoValidarOcr Disponível
ObtemVersaoWS Disponível
RefazUltimaOperacao Obsoleto
RefazUltimaOperacaoAtiva Disponível
RefazUltimaOperacaoII Obsoleto
RemontaFluxo Disponível
RetornaVeiculosQuePossamTerPassadoSemPesarPelaBalanca Disponível
SimulaPesagemAvulsaSemAutomacao Disponível
TrocaFluxoTicket Disponível
SolicitaFotoAvulsa Disponível
SolicitaRetornoFotoAvulsa Disponível

* Métodos em desenvolvimento não utilizar

ESTRUTURAS E TABELAS

VO PreCadastro
Campo Tipo Obrigatório Descrição Valores Possíveis
Codigo String(30) NÃO Código do Ticket Este campo é obrigatório apenas nas alterações, como o serviço AlteraTicketGuardian
AceitaPesoLiquidoZero Booleano NÃO Quando Verdadeira Indica que o resultado do Peso Líquido na Pesagem Final pode ser 0 para esse veículo Valor padrão: Verdadeiro(True)
PesoAlvo Decimal NÃO Peso Alvo da Dosagem -
Corte Decimal NÃO Peso para Corte da Dosagem -
DosagemLenta Decimal NÃO Peso de início da dosagem lenta -
DataPesagem Data e Hora SIM NÃO UTILIZADO Preencher sempre com uma Data e Hora qualquer
Documentos Lista de VO Documento NÃO Documentos associados -
Emissor VO EmissorIntegracao NÃO Dados do Emissor associado -
FatoresCorrecao Lista de VO ListaFatoresCorrecaoTicket NÃO NÃO UTILIZAR - Em manutenção -
Fluxo String(50) NÃO Código do Fluxo Associado, obrigatório caso seja informado o campo “PontoFluxo” -
Item Lista de VO ItemIntegracao NÃO Itens associados -
Motorista VO MotoristaIntegracao NÃO Motorista associado -
Observacao String(8000) NÃO Observação -
PesoBruto Decimal NÃO Peso bruto do veículo. -
Tara Decimal NÃO Tara do veículo. (OBSOLETO - Utilizar a tara do HistoricoTara) -
PesoBrutoOrigem Decimal NÃO Peso de referência para checagem do peso total na primeira pesagem do veículo -
PesoMinimoOrigem Decimal NÃO Peso mínimo origem -
PesoMaximoOrigem Decimal NÃO Peso máximo origem -
PesoTotalOrigem Decimal NÃO Peso de origem total - Soma de todos os documentos adicionados a lista de documentos do ticket -
PlacaCarreta String(20) SIM Armazena a identificação da carreta e do vagão, quando aplicável -
PlacaVeiculo String(20) NÃO Armazena a identificação do veículo e do vagão, quando aplicável Valor padrão: PlacaCarreta
TagAssociado String(250) NÃO Identificação associada referente ao TAG, Transponder ou Código de Barras -
TipoDoFatorDeCorrecao Inteiro NÃO NÃO UTILIZAR - Em manutenção -
TipoVeiculo String(20) NÃO Tipo do Veículo -
Transportadora VO TransportadoraIntegracao NÃO Dados da Transportadora associada -
UnidadeAposConversao String(10) NÃO Unidade de Medida Após Conversão do Peso -
CamposAdicionais Lista de VO CampoAdicionalTicket NÃO Campos adicionais do Ticket -
OperacaoDaPesagemInicial String NÃO Operação a ser registrada como pesagem inicial. Obrigatório quando for informar peso da pesagem inicial. Equivale ao campo código da tela de operação -
PerifericoDaPesagemInicial String NÃO Balança ou MCA (mesmo que inativos) a ser registrado como utilizado na pesagem inicial. Obrigatório quando for informar peso da pesagem inicial. Equivale ao campo código da tela de periféricos -
PesoDaPesagemInicial Decimal NÃO Peso da Pesagem Inicial. Quando informado o peso obrigatoriamente deve ser maior que 0 (zero).
Atenção, se este campo for informado, os campos OperacaoDaPesagemInicial e PerifericoDaPesagemInicial se tornam obrigatórios!
-
DataDaPesagemInicial Data e Hora NÃO Data e Hora da Pesagem Inicial -
EmbalagensTicket Lista de VO EmbalagensTicket NÃO Embalagem que vai ser associada ao Ticket. Para que as embalagens sejam associadas no Ticket, elas devem estar previamente cadastradas no Guardian. Este Web Método não cadastra Embalagem. -
Usuario Inteiro SIM Usuário que realizou a operação. Deve ser um usuário cadastrado no Guardian. Se não for definido nenhum usuário, será assumido o que estiver configurado como “Usuário responsável pela importação” na configuração geral do Guardian.
NumeroConteineres Inteiro NÃO Quantidade de contêineres informados para este ticket, utilizado para fim de dupla checagem, obrigatóriamente deve bater com a quantidade informada. -
Conteineres Lista de VO Conteiner NÃO Contêineres do ticket -
ReferenciaIntegracao String(30) NÃO Este campo refere-se a um código vindo da integração -
PontosDoFluxo Lista de VO Ponto do fluxo NÃO Lista de Pontos do fluxo -
NumeroTotalCompatimentos Inteiro NÃO Número total de compartimentos -
TipoIdentificacaoCompartimento Inteiro NÃO Tipo de identificação de compartimentos 0 = Sem Controle, 304877 = Identifica compartimento através da lista de documentos, 304878 = Identifica compartimento pelo número total, 304879 = Ambos
MarcardoParaCancelar Booleano NÃO Informa se o ticket está marcado para ser cancelado na última operação do fluxo. true - Indica que o ticket está marcado para cancelar na última operação / false - O ticket não será cancelado na última operação do ticket
OCRMarcardoParaNaoValida Booleano NÃO Este campo quando com o conteúdo verdadeiro indica que o OCR não será validado na identificação no “Ponto de Controle” onde ocorreu o erro de OCR uma unica vez. true - Indica que o OCR não será validado / false - Indica que o OCR será validado
CodigoContrato String NÃO Código do contrato - Ao passar o código do contrato, cria um relacionamento entre contrato e ticket -

VO EmissorIntegracao
Campo Tipo Obrigatório Descrição Valores Possíveis
Sequencial Inteiro NÃO NÃO UTILIZADO -
Codigo String(20) SIM Código do Emissor -
Descricao String(50) SIM Descrição ou Nome do Emissor -
TipoEmissor Inteiro SIM Tipo do Emissor 519 = Fornecedor, 520 = Cliente, 521 = Outros
RazaoSocial String(50) SIM Razão Social do Emissor -
Cnpj String(30) NÃO CNPJ ou CPF -
InscricaoEstadual String(30) NÃO Inscrição Estadual -
Endereco String(50) NÃO Endereço -
Complemento String(30) NÃO Complemento -
Municipio String(30) NÃO Município -
UF String(4) NÃO Unidade Federativa ou Estado da União -
Cep String(10) NÃO CEP -
Telefone String(20) NÃO Telefone -
Email String(50) NÃO Endereço de E-mail -
Observacao String(50) NÃO Observação -
Estado Inteiro NÃO Estado do Emissor 0=Desativado, 1=Ativado(Valor Padrão)
TipoDocumento Inteiro SIM Tipo do Documento para pessoa física (CPF) ou jurídica (CNPJ) 303404 = Física, 303405 = Jurídica
IncluiAtualiza Booleano SIM Indica que os dados passados podem ser incluídos ou alterados no cadastro (true) para incluir caso emissor não esteja cadastrado ou alterar caso já esteja cadastrado, Se (false) ou valor não informado, apenas associa o código do emissor já existente.

VO ItemIntegracao
Campo Tipo Obrigatório Descrição Valores Possíveis
Sequencial Inteiro NÃO NÃO UTILIZADO -
Codigo String(20) SIM Código do Item -
Descricao String(50) NÃO NÃO UTILIZADO -
Nome String(50) SIM Nome do Item -
Informacao String(400) NÃO Informações sobre o item -
PesoUnitario Decimal SIM Peso Unitário Se não utilizado preencher com 0
UnidadeMedida String(10) NÃO Unidade de Medida -
PodeConverter Booleano SIM Se Verdadeiro (true), habilita da conversão de peso para esse item -
FatorConversao Decimal SIM Fator de Conversão Se não utilizado preencher com 0
UnidadeMedidaConversao String(10) NÃO Unidade de Medida após a Conversão -
UtilizaContador Booleano NÃO NÃO UTILIZADO -
InicioContador Inteiro NÃO Valor Inicial do Contador -
FinalContador Inteiro NÃO Valor final do contador, ao atingir esse valor o contador volta para o valor inicial -
PrefixoContador Inteiro NÃO Prefixo do Contador 0 = Dia, 2 = Mês, 3 = Ano
CodigoFatorCorrecao String(20) NÃO Código do Fator de Correção associado -
CodigoFluxo String(50) NÃO Código do Fluxo exclusivo do item -
InicialObrigatoria Booleano SIM Se verdadeiro (true) indica que os tickets que utilizam esse item devem fazer pesagem inicial -
QuantidadeViasRelatorioImpressas Inteiro SIM Quantidade máxima de vias do ticket 0 = Indefinido
Estado Inteiro NÃO Estado do Item 0=Desativado, 1=Ativado(Valor Padrão)
IncluiAtualiza Booleano SIM Indica que os dados passados podem ser incluídos ou alterados no cadastro Sem preenchido Falso (false) o sistema não vai incluir o Ticket se o item não estiver cadastrado
Tipo Inteiro NÃO Indica qual é o tipo de item 1760=Matéria-Prima, 1761=Produto Industrializado, 1762=Produto Manufaturado, 1763=Outro tipo de item

VO MotoristaIntegracao
Campo Tipo Obrigatório Descrição Valores Possíveis
Sequencial Inteiro NÃO NÃO UTILIZADO -
Codigo String(20) SIM Código do Motorista -
Descricao String(50) NÃO NÃO UTILIZADO -
Nome String(50) SIM Nome do Item -
CPF String(20) SIM CPF / Documento Estrangeiro Informe o CPF no caso do motorista ser Brasileiro ou Documento Estrangeiro no caso do motorista não ser Brasileiro. Inclua formatação do documento se necessário.
RG String(20) SIM RG -
Cnh String(20) NÃO CNH -
Estado Inteiro NÃO Estado do Motorista 0=Desativado, 1=Ativado(Valor Padrão)
Observacao String(50) NÃO Observação -
InfoAcompanhantes String(255) NÃO Informação dos Acompanhantes -
Nacionalidade String(50) NÃO Pais de Nacionalidade Informe a descrição do País de origem, se NÃO informado, Brasil é assumido como padrão. O idioma no qual o País é informado deve ser a mesma configurada no Guardian (português é padrão).
DataNascimento Date NÃO Data de Nascimento -
OrgaoExpedidorRG String(50) NÃO Órgão expedidor RG -
UFRG Inteiro NÃO Unidade Federativa do RG Ao enviar o código respeitar a tabela de estado: 1 = ACRE, 2 = ALAGOAS, 3 = AMAZONAS, 4 = AMAPÁ, 5 = BAHIA, 6 = CEARÁ, 7 = DISTRITO FEDERAL, 8 = ESPIRITO SANTO, 9 = GOIÁIS, 10 = MARANHÃO, 11 = MINAS GERAIS, 12 = MATO GROSSO DO SUL, 13 = MATO GROSSO, 14 = PARÁ, 15 = PARAIBA, 16 = PERNAMBUCO, 17 = PIAUI, 18 = PARANÁ, 19 = RIO DE JANEIRO, 20 = RIO GRANDE DO NORTE, 21 = RONDÔNIA, 22 = RORAIMA, 23 = RIO GRANDE DO SUL, 24 = SANTA CATARINA, 25 = SERGIPE, 26 = SÃO PAULO, 27 = TOCATINS
IncluiAtualiza Booleano SIM Indica que os dados passados podem ser incluídos ou alterados no cadastro (true) para incluir caso motorista não esteja cadastrado ou alterar caso o motorista já esteja cadastrado, Se (false) ou valor não informado, apenas associa o código existente do motorista.

VO TransportadoraIntegracao
Campo Tipo Obrigatório Descrição Valores Possíveis
Sequencial Inteiro NÃO NÃO UTILIZADO -
Codigo String(20) SIM Código da Transportadora -
Descricao String(50) SIM Descrição ou Nome da Transportadora -
RazaoSocial String(50) SIM Razão Social da Transportadora -
Cnpj String(30) NÃO CNPJ ou CPF -
InscricaoEstadual String(30) NÃO Inscrição Estadual -
Endereco String(50) NÃO Endereço -
Complemento String(30) NÃO Complemento -
Municipio String(30) NÃO Município -
UF String(4) NÃO Unidade Federativa ou Estado da União -
Cep String(10) NÃO CEP -
Telefone String(20) NÃO Telefone -
Email String(50) NÃO Endereço de E-mail -
Observacao String(50) NÃO Observação -
Estado Inteiro NÃO Estado da Transportadora 0=Desativado, 1=Ativado (Valor Padrão)
TipoDocumento Inteiro NÃO Tipo do Documento para pessoa física (CPF) ou jurídica (CNPJ) 0 = Física( Valor Padrão), 1 = Jurídica
IncluiAtualiza Booleano SIM Indica que os dados passados podem ser incluídos ou alterados no cadastro Sem preenchido Falso (false) o sistema não vai incluir o Ticket se a Transportadora não estiver cadastrada

VO TICKET
Campo Tipo Obrigatório Descrição Valores Possíveis
CalculoFatorCorrecao Inteiro Sim Chave interna do Fator de Correção Associado -
CamposAdicionais Lista de VO CampoAdicionalTicket Sim Campos adicionais de preenchimento livre do Ticket -
Codigo String(30) Sim Código ou Número do Ticket -
CodigoCalculoFatorCorrecao Inteiro Sim Código do Fator de Correção Associado -
CodigoEmissor String(20) Sim Código do Emissor Associado -
CodigoFluxoTicket String(50) Sim Código do Fluxo Associado -
CodigoTransportadora String(20) Sim Código da Transportadora Associada -
DataPesagem Data e Hora Sim Data de Abertura do Ticket -
Documentos Lista de VO Documento Sim Documentos associados -
EmbalagensTicket Lista de VO EmbalagensTicket Sim Embalagens associadas -
Emissor VO EEmissor Sim Dados do Emissor associado -
Estado Inteiro Sim Estados do Ticket CadastroVeiculo = 0, PreCadastro = 1, Pesagem Inicial = 2, Encerrado = 3, Aguardando Liberação = 4, PesagemFinal = 5, Cancelado = 6, Acesso Veiculo = 7, Pesagem Avulsa = 8, Inspeção = 9, Bloqueado = 10, Pesagem Eixos = 11, Pesagem Dosagem = 12
EstadoAguardando Inteiro Sim Próximo estado do Ticket quando aguardando liberação da Integração Mesmo valores do campo estado
FatoresCorrecao Lista de VO ListaFatoresCorrecaoTicket Sim Fatores de correção associados -
FluxoTicket Inteiro Não Chave do fluxo do Ticket interna do Guardian -
FluxoTicketSequencia Lista de VO FluxoTicketSequencia Sim NÃO UTILIZAR! Em manutenção! -
Item VO EItem Não NÃO UTILIZADO -
ItemTicket Lista de VO ItemTicket Sim Itens associados -
Observacao String(8000) Não Observação -
OperacaoTicket Lista de VO OperacaoTicket Sim Operações realizadas -
PesagemEmContingencia Booleano Sim Caso Verdadeiro (true) indica que houve pesagem em contingência -
PesagemManual Booleano Sim Caso Verdadeiro (true) indica que houve pesagem manual -
PlacaCarreta String(20) Sim Placa da carreta/vagão -
ReimpressaoTicket Lista de VO ReimpressoesTicket Sim Registro de Reimpressões do Ticket (somente reimpressões sem vizualização) -
Sequencial Inteiro de 64 bits Sim Chave primária interna de controle do Guardian -
SequencialDiario Inteiro Sim Número sequencial diário do ticket -
TagAssociado String(250) Sim Identificação associada referente ao TAG, Transponder ou Código de Barras -
TipoFatorCorrecao Inteiro Sim NÃO IMPLEMENTADO -
TipoOperacao Inteiro Sim Tipo de operação realizada, preenchido somente após a pesagem final Recebimento = 1, Expedição = 2
Transportadora VO ETransportadora Sim Dados da Transportadora associada -
IntegracoesOCR Lista de VO IntegracoesOCR Sim Interações realizadas com o OCR -
Sincronizado bool Sim Sincronizado -
DiferencaOrigem decimal Sim Diferença de origem. -
BloqueiaBotoeira bool Sim Informa se bloqueia a botoeira. -
PesagemFerroviaria bool Sim Informa se é uma pesagem ferroviária. -
ReferenciaIntegracao String(30) Não Este campo refere-se a um código vindo da integração. -
NumeroTotalCompartimentos Inteiro Não Total de compartimentos. -
TipoIdentificacaoCompartimento Inteiro Não Tipo da identificação do compartimento. -
OCRMarcardoParaNaoValida Booleano Não Este campo quando com o conteúdo verdadeiro indica que o OCR não será validado na identificação no “Ponto de Controle” onde ocorreu o erro de OCR uma unica vez. -
NumeroConteineres Inteiro Sim Quantidade de contêineres informados para este ticket, utilizado para fim de dupla checagem. -
Conteineres Lista VO Conteiner Não Contêineres do ticket. -
PesoBruto Decimal Não Peso bruto do veículo. -
Tara Decimal Não Tara do veículo. (OBSOLETO - Utilizar a tara do HistoricoTara) -
HistoricoTara VO HistoricoTara Não Histórico de atualização de tara -
Contrato Lista VO Contrato Não Contrato associado ao ticket -

VO CampoAdicionalTicket
Campo Tipo Obrigatório Descrição Valores Possíveis
Numero Inteiro SIM Número do Campo Adicional -
Valor String(50) SIM Valor do campo adicional -
Data Data e Hora NÂO Data da criação do Registro -
Codigo Inteiro NÃO Mesmo valor do campo Número (ATENÇÃO: Não é necessário preencher este campo. Retorno esperado deste campo é Sequencial do registro(PK). CAMPO OBSOLETO) -

VO Documento
Campo Tipo Obrigatório Descrição Valores Possíveis
Data Data e Hora SIM Data da criação do Registro -
Codigo Inteiro NÃO Código sequencial do documento no Ticket -
Descricão String(255) SIM Descrição ou número do documento -
Estado Inteiro SIM Estado do documento 0=Desativado, 1=Ativado
PesoOrigem Decimal SIM Peso do Documento -
PesagemRealizada Boolean SIM Pesagem Realizada -
Tolerancia Double Não Tolerância -

VO EmbalagensTicket
Campo Tipo Obrigatório Descrição Valores Possíveis
Sequencial Inteiro Não Chave interna de controle do Guardian -
Quantidade Decimal Sim Quantidade de Embalagens -
Peso Decimal Sim Peso total das embalagens -
Data Data e Hora Sim Data da criação do Registro -
Codigo String Não Código da embalagem -
CodigoItem String(20) Sim Código do Item -
SequencialItem Int Não Sequencial do Item. Não é preenchido na importação. -
SequencialTck Int Não Chave interna da embalagem do ticket -
CodigoTck Int Não Código do ticket. Não é preenchido na importação. -

VO EEmissor
Campo Tipo Obrigatório Descrição Valores Possíveis
Sequencial Inteiro Não Chave interna de controle do Guardian -
Codigo String(20) Não Código do Emissor -
Descricao String(50) Sim Descrição ou Nome do Emissor -
Tipo Inteiro Sim Chave interna do tipo do Emissor -
RazaoSocial String(50) Sim Razão Social do Emissor -
Cnpj String(30) Não CNPJ ou CPF -
InscricaoEstadual String(30) Não Inscrição Estadual -
Endereco String(50) Não Endereço -
Complemento String(30) Não Complemento -
Municipio String Não Município -
UF Inteiro Não Chave internada da Unidade Federativa ou Estado da União -
Cep String(10) Não CEP -
Telefone String(20) Não Telefone -
Data Data e Hora Não Data e Hora da criação do registro -
Email String(50) Não Endereço de E-mail -
Observacao String(50) Não Observação -
Transportadoras Lista de VO ETransportadora Não Transportadoras associadas ao Emissor -
Estado String Não Estado do Emissor 0=Desativado, 1=Ativado
TipoDocumento String Não Tipo do Documento para pessoa física (CPF) ou jurídica (CNPJ) 0 = Física, 1 = Jurídica

VO ETransportadora
Campo Tipo Obrigatório Descrição Valores Possíveis
Sequencial Inteiro Não Chave interna de controle do Guardian -
Codigo String(20) Não Código da Transportadora -
Descricao String(50) Sim Descrição ou Nome da Transportadora -
RazaoSocial String(50) Sim Razão Social da Transportadora -
Cnpj String(30) Não CNPJ ou CPF -
InscricaoEstadual String(30) Não Inscrição Estadual -
Endereco String(50) Não Endereço -
Complemento String(30) Não Complemento -
Municipio String(30) Não Município -
UF Inteiro Não Chave internada da Unidade Federativa ou Estado da União -
Cep String(10) Não CEP -
Telefone String(20) Não Telefone -
Data Data e Hora Não Data e Hora da criação do registro -
Email String(50) Não Endereço de E-mail -
Observacao String(50) Não Observação -
Estado String Não Estado do Emissor 0=Desativado, 1=Ativado
TipoDocumento String Não Tipo do Documento para pessoa física (CPF) ou jurídica (CNPJ) 0 = Física, 1 = Jurídica

VO ItemTicket
Campo Tipo Obrigatório Descrição Valores Possíveis
Sequencial Inteiro Não Chave interna de controle do Guardian -
Codigo String Não Código sequencial do Item no Ticket -
SequencialTck Inteiro de 64 bits Sim Chave interna do Ticket -
CodigoTck String(30) Não Código ou número do Ticket -
SequencialItm Inteiro Não Chave interna do Item -
CodigoItm String(20) Não Código do Item -
Data Data e Hora Sim Data e Hora da criação do registro -
Estado String Não Estado do Item no Ticket 0=Desativado, 1=Ativado
SequencialLot String(50) Sim Sequencial que representa o ID do lote -

VO ListaFatoresCorrecaoTicket
Campo Tipo Obrigatório Descrição Valores Possíveis
Numero Inteiro Sim Numero da Lista de Fator de Correção -
Fator Decimal Sim Valor do Fator de Correção -
Descricao String(50) Sim Descrição do Fator de Correção -
ValorMaximo Decimal Sim Faixa máxima de Peso para Aplicação do Fator -
ValorMinimo Decimal Sim Faixa Mínima de Peso para Aplicação do Fator -
Data Data e Hora Sim Data da Criação do Registro -
Estado String Sim Estado do Fator 0=Desativado, 1=Ativado
Codigo String(20) Não Código da Lista de Fator de Correção -
CodigoItem String(20) Não Código do Item associado ao Fator -

VO OperacaoTicket
Campo Tipo Obrigatório Descrição Valores Possíveis
Sequencial long Não Sequencial da operação executada no Ticket -
Codigo String(20) Sim Código sequencial da operação executada no Ticket -
TicketSequencial String(20) Sim Chave interna do Ticket -
PlacaVeiculo String(20) Sim Placa do Veículo -
Motorista VO EMotorista Sim Dados do Motorista -
UnidadeAposConversao String(10) Sim Unidade de Medida Após Conversão do Peso -
TipoVeiculo String(20) Sim Tipo do Veículo -
Eixo Inteiro Sim OBSOLETO - Não utilizado -
Compartimento Inteiro Sim Número do Compartimento referente a esse registro de pesagem -
FatorCorrecaoLista Decimal Sim Valor do fator correção obtido a partir da lista de fatores de correção da lista -
FatorCorrecaoCalculo Decimal Sim Valor do fator correção obtido a partir da expressão calculada -
Peso Decimal Sim Peso Capturado em kg -
TaraTotal Decimal Sim Representa o peso total das embalagens vazias em kg (Tara do Veículo) -
FatorConversao Decimal Sim Fator de Conversão -
PesoLiqObtido Decimal Sim Representa o peso líquido obtido após a pesagem final em kg -
PesoLiqCorrigido Decimal Sim Representa o peso líquido corrigido após a pesagem final em kg -
PesoLiqCorrigidoCalculo Decimal Sim Representa o peso líquido corrigido pela fórmula após a pesagem final em kg -
PesoLiqConvertido Decimal Sim Representa o peso líquido convertido, apresentado o fator e unidade após conversão após a pesagem final em kg -
PesoBrutoVeiculo Decimal Sim Valor do peso bruto do veículo que registrou a pesagem -
UsuarioLogin String(20) Sim Login do Usuário que registrou a operação -
DataPesagem Data e Hora Sim Data de execução da Operação -
Periferico Inteiro Sim Chave interna do periférico que executou essa operação -
PerifericoCodigo String(20) Sim Código do Periférico que executou essa operação -
PontoDeControle String(20) Sim Código do Ponto de Controle que executou a operação -
EstacaoControle String(20) Sim Código da Estação de Controle que executou a operação -
TipoOperacaoCodigo Inteiro Sim Tipo da Operação executada 1 = Pré-Cadastro, 2 = Pesagem Inicial, 3 = Pesagem Final, 4 = Hsitórico de Passagem, 5 = Acesso, 8 = Pesagem Avulsa, 9 = Inspeção, 10 = Atualização de Tara, 11 = Pesagem por Eixos, 12 = Dosagem
TipoOperacaoDescricao String(1024) Sim Descrição do Tipo da Operação -
OperacaoCodigo String(20) Sim Código da Operação -
Estado Inteiro Sim Estado da operação do ticket 1 - Ativa / 0 - Inativa
Eixos Lista de VO EixoOperacao Não Eixos Capturados na Operação -
DataIdentificacao DateTime Sim Data de identificação para realizar a operação -
TaraDosador Double Sim Tara do veículo capturada na operação de dosagem -
IdentificadoresAdicionais Lista de VO IdentificadorAdicional Sim Identificadores adicionais capturadados na operação -
ErrosOperacoesTicket Lista de VO ErrosOperacoesTicket Não Possíveis erros ocorridos durante uma operação -

VO IdentificadorAdicional
Campo Tipo Obrigatório Descrição Valores Possíveis
TAG String(250) Sim Identificador identificado -
Data Datetime Sim Data da identificação do identificador -
Lado Inteiro Sim Lado que o identificador foi identificado -

VO EixoOperacao
Campo Tipo Obrigatório Descrição Valores Possíveis
Numero Inteiro Sim Número do Eixo (Grupo de Eixos) -
Peso Decimal Sim Peso Capturado do Eixo (Grupo de Eixos) -
PesoOrigem Decimal Sim Peso Nominal do Eixos (Grupo de Eixos) -
Data Data e Hora Sim Data e Hora da Captura do Eixo (Grupo de Eixos) -
Diferenca Decimal Não Diferença entre o peso nominal e o capturado quando acima. -
DiferencaMaximaPermitida Decimal Não Diferença máxima permitida -
Sequencial Integração do OCR Int Não SequencialIntegraçãoOCR -

VO ErrosOperacoesTicket
Campo Tipo Obrigatório Descrição Valores Possíveis
Sequencial Inteiro Sim Sequêncial do erro -
Codigo String Sim Código do erro -
TipoErro Inteiro Sim Tipo de Erro -
Data Data e Hora Sim Data em que ocorreu o erro -
Observação Texto Não Observação sobre o erro -
Estado String Sim Estado do Registro do Erro -
OperacoesTicketSequencial Inteiro Longo Sim Sequencial da operação onde o erro foi ocasionado -
UsuarioSequencial Inteiro Sim Sequencial do usuário com quem ocorreu o erro -
CodigoErroOperacao string Sim Código do erro -
ErrosOperacoesTicketDetalhe Lista de VO ErrosOperacoesTicketDetalhe Não Lista de detalhes de cada erro ocorrido
DescricaoEstado String Não Descrição do estado do erro -
DescricaoTipoErro String Não Descrição do tipo de erro -
MotivoErroOperacao Inteiro Sim Código do Motivo do erro da operação -

VO ErrosOperacoesTicketDetalhe
Campo Tipo Obrigatório Descrição Valores Possíveis
Codigo Texto Sim Representa o sequencial do detalhe do erro -
TipoDetalhe Inteiro Sim Representa o tipo de detalhamento do erro -
ConteudoDetalhe Texto Sim O conteúdo que descreve o erro -
SequencialErrosOperacaoTicket Inteiro Longo Sim Sequencial do detalhe do erro -

VO EEmissor
Campo Tipo Obrigatório Descrição Valores Possíveis
Sequencial Inteiro Não Chave interna de controle do Guardian -
Codigo String(20) Não Código do Emissor -
Descricao String(50) Sim Descrição ou Nome do Emissor -
Tipo Inteiro Sim Chave interna do tipo do Emissor -
RazaoSocial String(50) Sim Razão Social do Emissor -
Cnpj String(30) Não CNPJ ou CPF -
InscricaoEstadual String(30) Não Inscrição Estadual -
Endereco String(50) Não Endereço -
Complemento String(30) Não Complemento -
Municipio String Não Município -
UF Inteiro Não Chave internada da Unidade Federativa ou Estado da União -
Cep String(10) Não CEP -
Telefone String(20) Não Telefone -
Data Data e Hora Não Data e Hora da criação do registro -
Email String(50) Não Endereço de E-mail -
Observacao String(50) Não Observação -
Transportadoras Lista de VO ETransportadora Não Transportadoras associadas ao Emissor -
Estado String Não Estado do Emissor 0=Desativado, 1=Ativado
TipoDocumento String Não Tipo do Documento para pessoa física (CPF) ou jurídica (CNPJ) 0 = Física, 1 = Jurídica

VO ReimpressoesTicket
Campo Tipo Obrigatório Descrição Valores Possíveis
Codigo String(10) Sim Código Sequencial da Reimpressão do Ticket -
Data Data e Hora Sim Data e Hora da Reimpressão -
Observacao String(255) Não Observação sobre o motivo da Reimpressão -
CodigoUsuario String(20) Sim Código do Usuário que reimprimiu o Ticket -

VO LogAplicacao
Campo Tipo Obrigatório Descrição Valores Possíveis
Categoria Inteiro Sim Categoria do Log -
Codigo String(20) Não NÃO UTILIZADO -
Data Data e Hora Não Data e Hora do registro do Log -
Funcao String(240) Sim Função do Sistema que gerou do Log -
Informacao String(2147483647) Sim Informações do Log -
Sequencial Inteiro 64 bits Não Sequencial do Log -
SistemaDeIntegracao String(50) Sim Sistema de Integração que Gerou o Log -
Tipo Inteiro Sim Tipo do Log -

VO IntegracaoOCR
Campo Tipo Obrigatório Descrição Valores Possíveis
Sequencial Inteiro de 64 bits Sim Cámpo chave sequencial -
Data Data e Hora de Captura do OCR Sim Data e Hora do registro do Log -
PontoDeControle String(20) Sim Ponto de Controle onde a operação foi executada -
RegraDoOCR String(8000) Sim Regra do OCR aplicada para validação -
PlacaOCR String(20) Sim Placa capturada pelo OCR -
PlacaConvergente Inteiro Sim Verifica se o OCR validou a placa 1 OCR OK, 0 OCR não validou
CodigoOperacao String(20) Sim Código da Operação Envolvida -
CaminhoCompletoDaFoto String Sim Caminho e nome do arquivo da foto -
TipoDaPlaca int Sim Tipo da placa validada no OCR 303712 = Placa da carreta, 303713 = Placa do veículo, 303714 = Placa do vagão, 306772 = Contêiner, 303715 = OCR não identificado
SequencialOperacaoTicket int Sim Sequencial único para identificar a operação que foi realizada em determinado ticket. -
PlacaDoGuardian string Sim Placa do Guardian correspondente ao OCR -

VO HistoricoPassagem
Campo Tipo Obrigatório Descrição Valores Possíveis
Codigo String Não Ordem do HistoricoPassagem -
Media Decimal Sim Média -
Minimo Decimal Sim Mínimo -
Maximo Decimal Sim Máximo -
Data DataTime Sim Data e Hora do registro -
Periferico Inteiro Sim Periférico -
EstacaoControle Inteiro Sim Estação de Controle -
OperacaoTicket Inteiro Sim Sequencial da operação do ticket -
OperacaoTicketEntidade EOperacoesTicket Sim Entidade Operacao Ticket -
TAG String Sim Tag associada ao registro de pesagem -
Estado Inteiro Sim Estado da passagem: 304169 = aguardando confirmação de pesagem e 304170 pesagem confirmada -
EstacaoControleCodigo String Sim Código Estação de Controle -
PerifericoCodigo String Sim Código Periférico -
PontoDeControleCodigo String Sim Código do Ponto de Controle -
FlagPossivelIdentificacao Bool Sim Código do Ponto de Controle -
OperacaoTicketEntidade VO OperacaoTicket Sim Código do Ponto de Controle -

VO CfgAlteracao
Campo Tipo Obrigatório Descrição Valores Possíveis
IgnoraTransportadora Bool Sim Se verdadeiro (true ou 1) indica que o ticket deverá ter sua transportadora desassociada, para manter a transportadora associada ao Ticket preencher com falso (0 ou false). O campo transportadora da estrutura de pré-cadastro não precisa estar preenchido. true ou false, 1 ou 0
IgnoraEmissor Bool Sim Se verdadeiro (true ou 1) indica que o ticket deverá ter seu emissor desassociado, para manter a emissor associada ao Ticket preencher com falso (0 ou false). O campo emissor da estrutura de pré-cadastro não precisa estar preenchido. true ou false, 1 ou 0
IgnoraItens Bool Sim Se verdadeiro (true ou 1) indica que o ticket deverá ter seus itens desassociados, para manter os itens associados ao Ticket preencher com falso (0 ou false). A lista de itens da estrutura de pré-cadastro não precisa estar preenchida. Caso o ticket possua mais de 1 item e se queira alterar 1 ou mais itens, mas não se queira alterar todos mesmo assim é necessário enviar todos os itens novamente ou o item que não foi enviado será desassociado independentemente do conteúdo deste campo. true ou false, 1 ou 0
IgnoraDocumentos Bool Sim Se verdadeiro (true ou 1) indica que o ticket deverá ter seus documentos desassociados, para manter os documentos associados ao Ticket preencher com falso (0 ou false). A lista de documentos da estrutura de pré-cadastro não precisa estar preenchida. Caso o ticket possua mais de 1 documento e se queira alterar apenas 1 ou mais documentos, mas não queira alterar todos mesmo assim é necessário enviar todos os documentos novamente ou o documento que não foi enviado será desassociado independentemente do conteúdo deste campo. true ou false, 1 ou 0
IgnoraMotorista Bool Sim Se verdadeiro (true ou 1) indica que o ticket deverá ter seu motorista desassociado, para manter o motorista associado ao Ticket preencher com falso (0 ou false). O campo motorista da estrutura de pré-cadastro não precisa estar preenchido. true ou false, 1 ou 0
IgnoraFatorCorrecao Bool Sim Se verdadeiro (true ou 1) indica que o ticket deverá ter seus fatores de correção desassociados, para manter os fatores de correção associados ao Ticket preencher com falso (0 ou false). A lista de fatores de correção da estrutura de pré-cadastro não precisa estar preenchida. Caso o ticket possua mais de 1 fator de correção e se queira alterar apenas 1 ou mais fatores de correção, mas não se queira alterar todos, mesmo assim é necessário enviar todos os fatores de correção novamente ou o fator de correção que não foi enviado será desassociado independentemente do conteúdo deste campo. true ou false, 1 ou 0
IgnoraCamposAdicionais Bool Sim Se verdadeiro (true ou 1) indica que o ticket deverá ter seus campos adicionais desassociados, para manter os campos adicionais associados ao Ticket preencher com falso (0 ou false). A lista de campos adicionais da estrutura de pré-cadastro não precisa estar preenchida. Caso o ticket possua mais de 1 campo adicional e se queira alterar apenas 1 ou mais campos adicionais, mas não se queira alterar todos, mesmo assim é necessário enviar todos os campos adicionais novamente ou o campo adicional que não foi enviado será desassociado independentemente do conteúdo deste campo. true ou false, 1 ou 0
IgnoraConteineres Bool Sim Se verdadeiro (true ou 1) indica que o ticket deverá ter seus contêineres desassociados, para manter os contêineres associados ao Ticket preencher com falso (0 ou false). A lista de contêineres da estrutura de pré-cadastro não precisa estar preenchida. Caso o ticket possua mais de 1 contêiner e se queira alterar apenas 1 ou mais contêineres, mas não se queira alterar todos, mesmo assim é necessário enviar todos os contêineres novamente ou o contêiner que não foi enviado será desassociado independentemente do conteúdo deste campo. true ou false, 1 ou 0
IgnoraFluxo Bool Sim Se verdadeiro (true ou 1) indica que o ticket deverá ter seu fluxo desassociado, para manter o fluxo associada ao Ticket preencher com falso (0 ou false). O campo fluxo da estrutura de pré-cadastro não precisa estar preenchido. true ou false, 1 ou 0

VO RetornoFotoAvulsa
Campo Tipo Obrigatório Descrição Valores Possíveis
Status String Sim Status da solicitação 'AguardandoNaFila' = Foto aguardando na fila para ser disparada, 'Processado' = Foto disparada, 'Erro' = Houve erro na solicitação.
MotivoErro String Não Motivo da falha na solicitação de disparo de foto. -
CaminhoFoto String Não Se houve sucesso (Status = 2, caminho onde a fotografia foi gravada. -

VO Conteiner
Campo Tipo Obrigatório Descrição Valores Possíveis
Sequencial Inteiro Não Código Sequencial do Contêiner (Somente para leitura) -
Descricao(50) String Não Descrição do conteúdo do contêiner -
Conteiner String(50) Sim Código de identificação do contêiner -
Data Data e Hora Não Data e Hora do cadastro do registro -
TicketSequencial Inteiro Não Código sequêncial do Ticket ao qual este contêiner pertence. (Somente para leitura) -
Codigo String(50) Não Código de ordenação do contêiner. (Somente para leitura) -

VO HistoricoTara
Campo Tipo Obrigatório Descrição Valores Possíveis
Sequencial Inteiro Sim Código Sequencial do Histórico de tara (Somente para leitura) -
Tara Decimal Sim Valor da tara -
DataInicio Data e Hora Não Data de início da vigência da tara -
DataFim Data e Hora Não Data final da vigência da tara -
Data Data e Hora Sim Data e Hora do cadastro do registro -
Estado Booleano Sim Determina se a tara está ativa ou não -
Sequencial do veículo Inteiro Sim Sequencial a que indica o veículo que a tara está amarrada -
Ponto de controle Inteiro Não Sequencial da operação estação controle que foi realizada a atualização da tara -
Sequencial do periférico String Não Sequencial do periférico que realizou a atualização da tara -
Usuário String Não Usuário que realizou a atualização da tara -

VO Ponto do fluxo
Campo Tipo Obrigatório Descrição Valores Possíveis
Sequencia Inteiro Sim Sequência e agrupamento do ponto, repita este número para agrupar pontos alternativos. -
CodigoOperacao(20) String Sim Código da operação -
EstacaoControle String(20) Não Código da estação de controle -

VO Contrato
Campo Tipo Obrigatório Descrição Valores Possíveis
Codigo String Sim Código do contrato -
Descricao(50) String Sim Descrição do contrato -
Valor Decimal Sim Valor do contrato -
ValorInicioAlerta Decimal Não Quando o saldo do contrato atingir esse valor, acionará o evento de proximidade do fim do contrato -
Estado String Sim Estado do contrato -
SaldoAtual Decimal Sim Saldo atual do contrato -

VO Dados Liberar Ticket
Campo Tipo Obrigatório Descrição Valores Possíveis
Código do ticket string Sim Código do ticket responsável por identificar o ticket que será liberado. -
Placa String Sim Placa da Carreta. Responsável por identificar o ticket que será liberado. -
Tag String Sim TAG, Transponder ou Código de Barras de Identificação Associada do Ticket. Responsável por identificar o ticket que será liberado. -
Justificativas Lista de VO Justificativa Liberar Erro Ocr Sim Lista com as justificativas VO Justificativa Liberar Erro Ocr -

VO Retorno Liberar Ticket
Campo Tipo Obrigatório Descrição Valores Possíveis
Erro inteiro Sim Número do erro geral do Web Método ou em caso de sucesso irá retornar 0. -
Descrição String Sim Descrição do erro. -
JustificativaComErro VO Justificativa Liberar Erro Ocr Não Caso tenha ocorrido erro em uma justificativa específica, deve ser retornado qual justificativa apresentou o problema. -

VO Justificativa Liberar Erro Ocr
Campo Tipo Obrigatório Descrição Valores Possíveis
CodigoErroOperacao String Sim Código do erro que será justificado. (Retornado no VO ErrosOperacoesTicket) -
MotivoErro Inteiro Não Enumerador com os possíveis motivos a serem justificados para os erros de OCR Erro no cadastro = 306830, Placa amassada = 306831, Placa com caractere apagado/ilegível = 306832, Placa suja = 306833, Contêiner com caractere apagado/ilegível = 306834, Contêiner sujo = 306835,Vagão com caractere apagado/ilegível = 306836,Vagão sujo = 306837, Outros (falha da operação) = 306838,Outros (problema no veículo/contêiner) = 306839,Falha do sistema OCR (sensor, câmera, software) = 306840
Observação String Não Observação para complementar informações adicionais para justificar o motivo do erro -
CorrigeCadastro String Não Enum NAO/ALTERAR/INCLUIR/EXCLUIR (em caixa alta)
ValorAlterar String Não Identificação da Placa, Vagão ou Contêiner para quando necessário corrigir o Cadastro do Guardian mas a correção não pode ser feita de forma automática pelo dado encontrado no OCR. -

VO Dados Marca Para Não Validar OCR
Campo Tipo Obrigatório Descrição Valores Possíveis
Código do ticket string Sim Código do ticket responsável por identificar o ticket que será liberado. -
Placa String Sim Placa da Carreta. Responsável por identificar o ticket que será liberado. -
Tag String Sim TAG, Transponder ou Código de Barras de Identificação Associada do Ticket. Responsável por identificar o ticket que será liberado. -
Justificativas Lista de VO Justificativa Marca Para Não Validar OCR Sim Lista com as justificativas VO Justificativa Marca Para Não Validar OCR -

VO Retorno Marca Para Não Validar OCR
Campo Tipo Obrigatório Descrição Valores Possíveis
Erro inteiro Sim Número do erro geral do Web Método ou em caso de sucesso irá retornar 0. -
Descrição String Sim Descrição do erro. -
JustificativaComErro VO Justificativa Marca Para Não Validar OCR Não Caso tenha ocorrido erro em uma justificativa específica, deve ser retornado qual justificativa apresentou o problema. -

VO Justificativa Marca Para Não Validar OCR
Campo Tipo Obrigatório Descrição Valores Possíveis
CodigoErroOperacao String Sim Código do erro que será justificado. (Retornado no VO ErrosOperacoesTicket) -
MotivoErro Inteiro Não Enumerador com os possíveis motivos a serem justificados para os erros de OCR Erro no cadastro = 306830, Placa amassada = 306831, Placa com caractere apagado/ilegível = 306832, Placa suja = 306833, Contêiner com caractere apagado/ilegível = 306834, Contêiner sujo = 306835,Vagão com caractere apagado/ilegível = 306836,Vagão sujo = 306837, Outros (falha da operação) = 306838,Outros (problema no veículo/contêiner) = 306839,Falha do sistema OCR (sensor, câmera, software) = 306840
Observação String Não Observação para complementar informações adicionais para justificar o motivo do erro -
CorrigeCadastro String Não Enum NAO/ALTERAR/INCLUIR/EXCLUIR (em caixa alta)
ValorAlterar String Não Identificação da Placa, Vagão ou Contêiner para quando necessário corrigir o Cadastro do Guardian mas a correção não pode ser feita de forma automática pelo dado encontrado no OCR. -

VO DadosFilaAdiciona
Campo Tipo Obrigatório Descrição Valores Possíveis
TicketCodigo string NÃO Código do Ticket. Este campo não é obrigatório desde que Placa ou Tag esteja preenchido. -
Placa String(20) NÃO Placa da Carreta. Este campo não é obrigatório desde que TicketCodigo ou Tag esteja preenchido. -
Tag Stringt NÃO Identificador Ticket (Tag). Este campo não é obrigatório desde que TicketCodigo ou Placa esteja preenchido. -
CodigoFila Stringt SIM Código da fila onde o veículo vai ser adicionado. -

VO RetornoFilaAdiciona
Campo Tipo Obrigatório Descrição Valores Possíveis
Erro Inteiro NÃO Código do Erro -
Descricao String(20) NÃO Descrição do erro -
FilaTicketEntidade ControleFilaTicket NÃO Retorna a fila onde o veículo se encontra e o ticket quando existirem. -

VO DadosFilaRemove
Campo Tipo Obrigatório Descrição Valores Possíveis
TicketCodigo string NÃO Código do Ticket. Este campo não é obrigatório desde que Placa ou Tag esteja preenchido. -
Placa String(20) NÃO Placa da Carreta. Este campo não é obrigatório desde que TicketCodigo ou Tag esteja preenchido. -
Tag Stringt NÃO Identificador Ticket (Tag). Este campo não é obrigatório desde que TicketCodigo ou Placa esteja preenchido. -

VO RetornoFilaRemove
Campo Tipo Obrigatório Descrição Valores Possíveis
Erro Inteiro NÃO Código do Erro -
Descricao String(20) NÃO Descrição do erro -
FilaTicketEntidade ControleFilaTicket NÃO Retorna a fila onde o veículo se encontra e o ticket quando existirem. -

VO DadosFilaConsulta
Campo Tipo Obrigatório Descrição Valores Possíveis
TicketCodigo string NÃO Código do Ticket. Este campo não é obrigatório desde que Placa ou Tag esteja preenchido. -
Placa String(20) NÃO Placa da Carreta. Este campo não é obrigatório desde que TicketCodigo ou Tag esteja preenchido. -
Tag Stringt NÃO Identificador Ticket (Tag). Este campo não é obrigatório desde que TicketCodigo ou Placa esteja preenchido. -

VO RetornoFilaConsulta
Campo Tipo Obrigatório Descrição Valores Possíveis
Erro Inteiro NÃO Código do Erro -
Descricao String(20) NÃO Descrição do erro -
FilaTicketEntidade ControleFilaTicket NÃO Retorna a fila onde o veículo se encontra e o ticket quando existirem. -

VO ControleFilaTicket
Campo Tipo Obrigatório Descrição Valores Possíveis
Posicao Inteiro NÃO Posição do veículo na fila -
Data Data NÃO Data de inclusão do veículo na fila -
Estado Inteiro NÃO Código do estado da fila -
EstadoDescricao String NÃO Descrição do estado da fila -
CadastroFila CadastroFila NÃO Retorna a fila onde o veículo se encontra. -
TicketSequencial Inteiro NÃO Sequencial do ticket -
TicketEntidade VO Ticket NÃO Ticket do veículo da fila. -
DataAtualizacao Data NÃO Data de atualização do veículo na fila -
MensagemUsuario string NÃO Mensagem enviada ao usuário -

VO CadastroFila
Campo Tipo Obrigatório Descrição Valores Possíveis
Codigo String NÃO Código da fila -
Nome String NÃO Nome d fila -
NumeroTicketsLiberadosAutomaticamente Inteiro NÃO Número de tickets liberados automaticamente. -
Data Data NÃO Data de inclusão da fila -
Estado Inteiro NÃO Código do estado da fila -
EstadoDescricao String NÃO Descrição do estado da fila. -
Mensagem string NÃO Mensagem -
DataAtualizacaoMensagem Data NÃO Data de atualização da mensagem -

VO DadosImprimeEtiqueta
Campo Tipo Obrigatório Descrição Valores Possíveis
TicketCodigo string NÃO Código do Ticket. Este campo não é obrigatório desde que Placa ou Tag esteja preenchido. -
Placa String(20) NÃO Placa da Carreta. Este campo não é obrigatório desde que TicketCodigo ou Tag esteja preenchido. -
Tag Stringt NÃO Identificador Ticket (Tag). Este campo não é obrigatório desde que TicketCodigo ou Placa esteja preenchido. -
CodigoPontoDeControle Stringt SIM Código do Ponto de Controle que irá imprimir a etiqueta. -
CodigoPeriferico Stringt SIM Código do Periférico associado ao Ponto de Controle que irá imprimir a etiqueta. -
CodigoEtiqueta Stringt SIM Código da Etiqueta que será impressa. -
ScriptEtiqueta Stringt NÃO Script da etiqueta, quando é necessário imprimir uma etiqueta avulsa. -

VO RetornoImprimeEtiqueta
Campo Tipo Obrigatório Descrição Valores Possíveis
Erro Inteiro NÃO Código do Erro -
Descricao String(20) NÃO Descrição do erro -
ticketEntidade ticketEntidade NÃO Retorna o ticket que foi enviado para impressão. -
solicitacaoExecucao solicitacaoExecucao NÃO Retorna a solicitação que foi enviada para o Guardian Service. -

VO SolicitacaoExecucao
Campo Tipo Obrigatório Descrição Valores Possíveis
Sequencial INT NÃO Sequencial unico da solicitação de impressão. -
TipoAcionamentoDescricao String(20) NÃO Tipo da solicitação (Imprimir Etiqueta). -
EstadoDescricao Stringt NÃO Descrição do estado da Solicitação. Pendente
Data DateTime NÃO Data que a solicitação de impreção foi realizada. Pendente
CodigoPontoDeControle Stringt SIM Código do Ponto de Controle que irá imprimir a etiqueta. -
CodigoPeriferico Stringt SIM Código do Periférico associado ao Ponto de Controle que irá imprimir a etiqueta. -
< p>

WEB METODOS

The following operations are supported. For a formal definition, please review the Service Description.