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 > UtilizaContador > B > font > 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étodos em desenvolvimento não utilizar
ESTRUTURAS E TABELAS
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 | - |
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 | - |
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. |
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 |
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. |
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 | - |
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 |
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 | - |
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) | - |
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 | - |
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. | - |
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 | - |
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 |
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 | - |
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 |
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 | - |
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 | - |
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 | - |
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 | - |
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 | - |
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 | - |
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 | - |
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 | - |
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 |
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 | - |
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 | - |
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 | - |
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 | - |
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 |
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. | - |
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) | - |
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 | - |
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 | - |
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 | - |
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 | - |
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. | - |
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. | - |
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 | - |
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. | - |
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. | - |
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. | - |
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. | - |
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. | - |
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. | - |
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. | - |
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. | - |
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 | - |
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 | - |
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. | - |
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. | - |
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. | - |
WEB METODOS
The following operations are supported. For a formal definition, please review the Service Description.
-
AcionaCancela
[INTERFACE]
Método responsável por solicitar acionamento de Cancela para o Guardian.
Esse método é síncrono para colocar pedido de execução na fila e assíncrono na execução do comando.
Para saber o estado da execução do comando utilize o método ConsultaEstadoComando.
Para o correto funcionamento desse Web Método os Eventos Avulsos devem estar configurados da seguinte forma:
- Evento avulso 01 – Abrir Cancela A
- Evento avulso 02 – Abrir Cancela B
- Evento avulso 03 – Fechar Cancela A
- Evento avulso 04 – Fechar Cancela B
- Evento avulso 05 – Abrir Cancela A e B
- Evento avulso 06 – Fechar Cancela A e B
Para pontos de controle de operações de acesso, configure os eventos avulsos do Lado A
Parâmetros de entrada:
- PontoControlePonto (String - Obrigatório) = Código do Ponto de Controle Associado a Cancela.
- Lado (String - Obrigatório) = Lado automação onde a cancela que deseja-se acionar está posicionada. Valores possíveis : 'A' = Lado A, 'B' = Lado B, 'E' = Lado de Entrada onde o veículo foi identificado, 'S' = Lado de Saída oposta ao lado que o veículo foi identificado, 'T' = Todas a cancelas associadas.
- Comando(String - Obrigatório) = Comando que se deseja que a cancela execute. Valores possíveis : 'A' = Abrir, 'F' = Fechar.
Retornos:
- Retorno da Função (Inteiro) = ID do comando na Fila.
- Erro (Inteiro) = Código de Erro Caso Falhe. Valores possíveis: 0 = Não houve erro, Diferente de 0 = Erros variados.
- ErroMSG (String) = Descrição do erro -
AcionaCancela_G4
[OBSOLETO]MÉTODO DE COMPATIBILIZAÇÂO COM O GUARDIAN 4 - PREFERENCIALMENTE UTILIZE O MÉTODO AcionaCancela!
Este método é responsável por:
Adicionar um comando de abertura ou fechamento de cancela na fila de execuções.
Deve-se indicar o lado da cancela cadastro do Guardian, sendo A para lado A
B para lado B, E para Entrada, S para Saída
E os comando possíveis são: A para Abrir e F para Fechar
Este método retorna dentro do parâmetro Erro, 0 (zero) se a execução foi correta
e diferente de 0 (zero) se houve qualquer problema da execução, nesse caso o parâmetro
mensagem estará preenchido com uma descrição do problema
-
AlteraTicketGuardian
[INTERFACE]
Este método é responsável por:
Alterar dados de um Ticket em qualquer estado desde que seja diferente de cancelado.
Obs: Este método depende de configuração, para tal, nas configurações do Guardian:
1-) Botão Sistema (Configuração Geral do Guardian)
2-) Aba Aplicação
3-) Na combox Estação responsável pela integração de dados, selecionar uma estação de controle que esteja configurada para permitir pré-cadastro.As descrições dos campos podem ser conferidas nos VOs: VO_PreCadastro, VO_PontosDoFluxo.
Algumas regras do AlteraTicketGuardian:
- Se o campo PesoTotalOrigem (obsoleto para este web método) for preenchido, atualizará o campo do ticket com o valor enviado; caso contrário, olhará a somatória do peso dos documentos preenchidos; se a lista de documentos também for enviada vazia, manterá o peso já cadastrado.
- Se a tag for enviada nula, manterá a já cadastrada; Se for vazia, irá limpar a tag do ticket; Se for preenchida, atualizará com a nova tag.
Fluxo customizado - Quando o campo fluxo e a lista de pontos do fluxo forem preenchidos indica que o ticket terá um fluxo customizado.
O fluxo customizado deve seguir as seguintes regras:
- O fluxo passado por parâmetro deverá ser cadastrado anteriormente no Guardian sem pontos.
- Se não for passado a Estação de Controle no ponto do fluxo, o Guardian assumirá como padrão a estação cadastrada na configuração geral, aba integração, campo 'Estação padrão das atualizações de fluxo por WebService'
- Se já existir um fluxo no ticket, os pontos do fluxo anterior com o status pendente serão cancelados, e os realizados serão mantidos.
Parâmetros de entrada:
- DadosTicket (VO PreCadastro - Obrigatório) = Dados do Ticket.
- Peso total de Origem - obrigatório o preenchimento para validar a tolerância por 'peso mínimo' e 'peso máximo'.
- CfgAlteracao (VO CfgAlteracao - Obrigatório = Configuração da alteração.
Retornos:
- Retorno da Função (Ticket) = Retorna estrutura do ticket inserido no banco.
- Erro (Inteiro) = Código de Erro Caso Falhe. Valores possíveis:
303221 = Não houve erro
303224 = Falha ao alterar ticket
303040 = Registro inexistente
303776 = O WebService não está na mesma versão do banco de dados, favor fazer a sincronização das versões
303776 = Erro de Validação!
303660 = Já existe um ticket aberto (Neste caso se aplica apenas para tag duplicada)
1 = Erro não esperado
- ErroMSG (String) = Descrição do erro -
CadastraTicket
[INTERFACE]
Este método é responsável por:
Importar dados de um Ticket em estado de Pré-Cadastro ou Pesagem Inicial Executada.
Para se importar um ticket com pesagem inicial já executada, deve-se preencher todos os campos da estrutura referentes a pesagem inicial.
Parâmetros de entrada:
- DadosTicket (VO PreCadastro - Obrigatório) = Dados do Ticket.
- produto (String - Obrigatório) = Nome do Produto para Validação. Preencha com 'WS G'.
- código (String - Obrigatório) = Código do Produto para Validação. Preencha com '01'.
Retornos:
- Retorno da Função (Booleano) = Verdadeiro se o Ticket foi incluído com sucesso.
- Erro (Inteiro) = Código de Erro Caso Falhe. Valores possíveis: 303221 = Não houve erro, Diferente de 303221 = Erros variados.
- ErroMSG (String) = Descrição do erro -
CadastraTicketGuardian
[INTERFACE]
Este método é responsável por:
Importar dados de um Ticket em estado de Pré-Cadastro ou Pesagem Inicial Executada.
Para se importar um ticket com pesagem inicial já executada, deve-se preencher todos os campos da estrutura referentes a pesagem inicial.
Fluxo customizado - Quando o campo fluxo e a lista de pontos do fluxo forem preenchidos indica que o ticket terá um fluxo customizado.
As descrições dos campos pode ser conferido nos VOs: VO_PreCadastro, VO_PontosDoFluxo.
O fluxo customizado deve seguir as seguintes regras:O fluxo customizado deve seguir as seguintes regras:
- O fluxo passado por parâmetro deverá ser cadastrado anteriormente no Guardian sem pontos.
- Se não for passado a Estação de Controle no ponto do fluxo, o Guardian assumirá como padrão a estação cadastrada na configuração geral, aba integração, campo 'Estação padrão das atualizações de fluxo por WebService'
Parâmetros de entrada:
- DadosTicket (VO PreCadastro - Obrigatório) = Dados do Ticket.
Retornos:
- Retorno da Função (Ticket) = Retorna estrutura do ticket inserido no banco.
- Erro (Inteiro) = Código de Erro Caso Falhe. Valores possíveis: 303221 = Não houve erro, Diferente de 303221 = Erros variados.
- ErroMSG (String) = Descrição do erro -
CancelaUltimaOperacaoAtiva
[INTERFACE]Este método é responsável por:
Permitir Cancelar a última operação do Ticket.É aplicado apenas em casos de Tickets diferentes de Cancelados.
Se houver apenas uma operação ativa no Ticket e este método for chamado, o ticket será cancelado.
Esse Web Metodo poderá ser executado N vezes no mesmo ticket cancelando todas as operações do Ticket.
Em Tickets encerrados o mesmo ser[a reaberto o Ticket.
Porem será, verificado se não existe outro Ticket aberto com a mesma Placa ou TAG. Nesse caso deverá retornar erro.
O sistema tentará encontrar o Ticket na seguinte ordem de prioridade, de acordo com o parametro que for preenchido:
- 1º Código do Ticket
- 2º Último Ticket da Placa
- 3º Último Ticket do TAGParâmetros de entrada:
- ticketCodigo (String - Opcional desde que “ticketPlaca” ou “ticketTAG” esteja preenchidas) = Código ou Número do Ticket.
- ticketPlaca (String - Opcional desde que “ticketCodigo” ou “ticketTAG” esteja preenchidas) = Placa da carreta/vagão.
- ticketTAG (String - Opcional desde que “ticketCodigo” ou “ticketPlaca” esteja preenchidas) = TAG, Transponder ou Código de Barras de Identificação Associada do Ticket.
Parâmetros de saída:
- SaiErro (Inteiro - Opcional) = Retorna o número do erro, em caso se sucesso retorna 0.
- SaiErroMSG(string - Opcional) = Retorna a descrição do erro, em caso se sucesso retorna vazio.
Retornos:
- Retorno da Função (Booleano) = Retorna Verdadeiro (True) em caso de Sucesso da operação. -
CapturaPeso
[INTERFACE]
Método é responsável por Adicionar um comando de captura de peso na fila de execuções.
Caso o Guardian capture um peso válido no informado Ponto de Controle dentro de um tempo hábil informado no parametro TimeoutLeitura
esse peso é retonado dentro do parâmetro Peso.
Entende-se por peso válido, N pesos estáveis de acordo com configuração do Guardian,
com sensores desobstruídos, acima do peso mínimo
Deve-se chamar esse método até que o peso seja capturado.
O método considera válido também o último peso capturado nos últimos X segundos informados no parâmetro TempoValidadePesoBom (preencha normalmente com 5 segundos).
O método pode aguarda um tempo informado no parâmetro TimeoutLeitura em segundos até que o sistema consiga capturar esse peso (preencha normalmente com 5 segundos) .
Este método não depende da existência de um MCA configurado no ponto de controle.
Parâmetros de entrada:
- PontoControlePonto (String - Obrigatório) = Código do Ponto de Controle Associado a Balança.
- TempoValidadePesoBom (Inteiro - Obrigatório) = Tempo de Validade de um Peso Bom Capturado em Segundos. -Preferencialmente utilizar 5 segundos.
- TimeoutLeitura (String - Obrigatório) = Tempo máximo (em segundos) de retorno do método enquanto o sistema tenta capturar um Peso Bom. - Preferencialmente utilizar 5 segundos.
- produto (String - Obrigatório) = Nome do Produto para Validação. Preencha com 'WS G'.
- código (String - Obrigatório) = Código do Produto para Validação. Preencha com '01'.
- segmento inicial (String - Opcional) = utilizado para balança segmentada, passe o segmento incial que deseja obter o peso.
- segmento final (String - Opcional) = utilizado para balança segmentada, passe o segmento final que deseja obter o peso.
Retornos:
- Peso (Float) = Peso Bom Capturado.
- Erro (Inteiro) = Código de Erro Caso Falhe. Valores possíveis: 0 = Não houve erro, 1 = Não foi possível capturar Peso Bom em tempo hábil, Diferente de 0 e 1 = Erros variados.
- ErroMSG (String) = Descrição do erro -
CapturaPeso_G4
[OBSOLETO]MÉTODO DE COMPATIBILIZAÇÂO COM O GUARDIAN 4 - PREFERENCIALMENTE UTILIZE O MÉTODO CapturaPeso!
Este método é responsável por:
Adicionar um comando de captura de peso na fila de execuções.
Caso o Guardian capture um peso válido dentro de um tempo hábil definido na configuração
esse peso é retonado dentro do parâmetro Peso.
Entende-se por peso válido, N pesos estáveis de acordo com configuração do Guardian,
com sensores desobstruídos, acima do peso mínimo
Deve-se chamar esse método até que o peso seja capturado.
O método considera válido também o último peso capturado nos últimos X segundos configurados.
Este método retorna dentro do parâmetro Erro, o (zero) se a execução foi correta.
Este método não depende da existência de um MCA configurado no ponto de controle.
Retorna 1 (um) se não foi possível capturar o peso no período válido.Retorna maior que 1 (um) se houve qualquer outro problema na execução, nesse caso o parametro
mensagem estará preenchido com uma descrição do problema
-
ConfirmaLeituraTicketsMarcados
[INTERFACE]
Método responsável por descartar os Tickets já lidos no ExportaTicketsMarcados.
Caso o Método ExportaTicketsMarcados seja chamado seguidamente sem chamar este método, os tickets exportados serão acumulados e retornados junto com os novos tickets.
Retornos:
- Erro (Inteiro) = Código de Erro Caso Falhe. Valores possíveis: 0 = Não houve erro, Diferente de 0 = Erros variados.
- ErroMSG (String) = Descrição do erro -
ConfirmaTicketUnico
[INTERFACE]
Método responsável desmarcar para exportação um único ticket já exportado.
Deve ser chamado para utilizar o método ExportaTicketUnico
Parâmetros de entrada:
- SequencialTicket - Inteiro = Sequencial do ticket que foi exportado.
- nomeSistema - Código do do Sistema Integração para o qual o Ticket foi marcado. Nomalmente utilize 'WS GUARDIAN'.
- Falhou - Boolean - Preencher Verdadeiro (true) caso senha havido algum problema com a leitura desse Ticket.
- produto - Nome do Produto para Validação. Preencha com 'WS G'.
- código - Código do Produto para Validação. Preencha com '01'.
Retornos:
- Retorno da Função - Verdadeiro (True) caso o Ticket tenha sido desmarcado com Sucesso.
-
ConfirmaVeiculosQuePossamTerPassadoSemPesarPelaBalanca
[INTERFACE]
Este método é responsável por:
Confirmar o recebimento dos dados do método: RetornaVeiculosQuePossamTerPassadoSemPesarPelaBalanca
Retornos:
- True, se sucesso na operação, caso contrário, false
- Erro (Inteiro) = Código de Erro Caso Falhe. Valores possíveis: 0 = Não houve erro, Diferente de 0 = Erros variados.
- ErroMSG (String) = Descrição do erro -
ConsultaIntervencoesManuaisTicket
[INTERFACE]
EM DESENVOLVIMENTO - Não utilizar
Este método é responsável por:
Consultar intervenções manuais ocorridas em um Ticket.
É aplicado apenas em casos de Tickets abertos, ou seja, diferentes de Cancelados e Encerrados.
O sistema tentará encontrar o Ticket na seguinte ordem de prioridade, de acordo com o parametro que for preenchido:
- 1º Código do Ticket - 2º Último Ticket da Placa - 3º Último Ticket do TAG Parâmetros de entrada:
- ticketCodigo (String - Opcional) = Código ou Número do Ticket.
- ticketPlaca (String - Opcional) = Placa da carreta/vagão.
- ticketTAG (String - Opcional) = TAG, Transponder ou Código de Barras de Identificação Associada do Ticket.
- fluxoCodigo - Código do fluxo que o ticket irá assumir - produto (String - Obrigatório) = Nome do Produto para Validação. Preencha com 'WS G'.
- código (String - Obrigatório) = Código do Produto para Validação. Preencha com '01'.
Retornos:
- DataSet com dados das intervenções manuais do Ticket
-
ConsultaLogAplicacao
[INTERFACE]
Método responsavel por consultar os logs da aplicação de acordo com os parametros.
Parâmetros de entrada:
- dateInicial (Data e Hora - Obrigatório) = Data de Inicio da Pesquisa.
- dateFinal (Data e Hora - Obrigatório) = Data Final da Pesquisa.
- categoria (Inteiro - Obrigatório) = Categoria dos logs.
- TODAS = -1;
- Execução Aplicação = 1
- Exception Serviço = 2
- Exception Genérico = 3
- Erro Tolerância = 4
- Erro WebService = 5
- Debug Carrega Dado = 6
- Validação OCR = 7
- Erro Pesagem = 8
- Debug Pesagem Ferroviária = 9
- Marcado Para Cancelar = 303775
- Acionamento Manual = 303196
- Auditoria Contingencia = 1589
- Contingencia = 303155
- Integração Padrão = 304592
- Integração WebServices = 304644
- tipo (Inteiro - Obrigatório) = Tipo dos Logs. TODOS = -1.
- sistemaDeIntegracao (String - Opcional) = Sistema de integração que gerou o log.
- produto (String - Obrigatório) = Nome do Produto para Validação. Preencha com 'WS G'.
- código (String - Obrigatório) = Código do Produto para Validação. Preencha com '01'.
Retornos:
- Retorna da Função (Lista de VO LogAplicacao) = Registros de Log.
- Erro (Inteiro) = Código de Erro Caso Falhe. Valores possíveis: 0 = Não houve erro, Diferente de 0 = Erros variados.
- ErroMSG (String) = Descrição do erro - TODAS = -1;
-
ConsultaLogPerifericos
[INTERFACE]
Método responsavel por consultar logs dos perifericos gerados de acordo com os parametros passados.
Parâmetros de entrada:
- OperadorLogin (String - Opcional) = Usuário responsável pela operação do periférico. Normalmente o usuário utilizado para “Logar” no serviço.
- Periferico (String - Opcional) = Código do periférico que gerou o log. Normalmente código do MCA.
- dateInicial (Data e Hora - Obrigatório) = Data de Inicio da Pesquisa.
- dateFinal (Data e Hora - Obrigatório) = Data Final da Pesquisa.
- categoria (Inteiro - Obrigatório) = Categoria dos logs.- TODAS = -1;
- Execução Aplicação = 1
- Exception Serviço = 2
- Exception Genérico = 3
- Erro Tolerância = 4
- Erro WebService = 5
- Debug Carrega Dado = 6
- Validação OCR = 7
- Erro Pesagem = 8
- Debug Pesagem Ferroviária = 9
- Marcado Para Cancelar = 303775
- Acionamento Manual = 303196
- Auditoria Contingencia = 1589
- Contingencia = 303155
- Integração Padrão = 304592
- Integração WebServices = 304644
- produto (String - Obrigatório) = Nome do Produto para Validação. Preencha com 'WS G'.
- código (String - Obrigatório) = Código do Produto para Validação. Preencha com '01'.
Retornos:
- Retorna da Função (Lista de VO LogPeriferico) = Registros de Log.
- Erro (Inteiro) = Código de Erro Caso Falhe. Valores possíveis: 0 = Não houve erro, Diferente de 0 = Erros variados.
- ErroMSG (String) = Descrição do erro - TODAS = -1;
-
ConsultaMovimentoOCR
[INTERFACE]
Método responsavel por consultar movimento de operacões executadas com OCR de acordo com os parametros.
Parâmetros de entrada:
- ticketCodigo (String - Opcional desde que “ticketPlaca” ou “ticketTAG” esteja preenchidas) = Número do Ticket'.
- ticketPlaca (String - Opcional desde que “ticketCodigo” ou “ticketTAG” esteja preenchidas) = Placa da carreta/vagão Cadastrada no Ticket.
- ticketTAG (String - Opcional desde que “ticketCodigo” ou “ticketPlaca” esteja preenchidas) = TAG Cadastrada no Ticket.
- placaOCR (String - Opcional) = Placa obtida pelo OCR.
- dateInicial (Data e Hora - Obrigatório) = Data de Inicio da Pesquisa.
- dateFinal (Data e Hora - Obrigatório) = Data Final da Pesquisa.
- pontoControleDesc (String - Opcional) = Código do Ponto de Controle que a operação foi executada.
- usuarioNome (String - Opcional) = Obsoleto, não preencher. Campo não é mais utilizado.
- produto (String - Obrigatório) = Nome do Produto para Validação. Preencha com 'WS G'.
- código (String - Obrigatório) = Código do Produto para Validação. Preencha com '01'.
Retornos:
- Retorna da Função (Lista de VO Ticket) = Registros de ticket e operaçoes com OCR.
- Erro (Inteiro) = Código de Erro Caso Falhe. Valores possíveis: 0 = Não houve erro, Diferente de 0 = Erros variados.
- ErroMSG (String) = Descrição do erro -
ConsultaPedidoDeExecucao
[INTERFACE]
Método responsável por consultar o estado de um pedido de execução de tarefa.
Quando o retorno for igual a 303639 indica que a solicitação pesquisada já saiu da fila.
Se é uma solicitação recente ela foi executada corretamente.
Se é uma solicitação antiga ela pode já ter sido removida da fila por limpeza.
Parâmetros de entrada:
- ID (Inteiro - Obrigatório) = ID da solicitação na Fila.
Retornos:
- Retorno da Função (Inteiro) = Estados que podem ser : 303606 - Pendente, 303607 - Aguardando termino da execução, 303608 - Erro na execução, 303639 - Já execudado ou não encontrado.
- Erro (Inteiro) = Código de Erro Caso Falhe. Valores possíveis: 0 = Não houve erro, Diferente de 0 = Erros variados.
- ErroMSG (String) = Descrição do erro -
ConsultaSolicitacaoExecucao
[INTERFACE]
Método responsável por consultar o estado de um pedido de execução de tarefa.
Quando o retorno for igual a 303639 indica que a solicitação pesquisada já saiu da fila.
Se é uma solicitação recente ela foi executada corretamente.
Se é uma solicitação antiga ela pode já ter sido removida da fila por limpeza.
Parâmetros de entrada:
- ID (Inteiro - Obrigatório) = ID da solicitação na Fila.
Retornos:
- Retorno da Função (Inteiro) = Estados que podem ser : 303606 - Pendente, 303607 - Aguardando termino da execução, 303608 - Erro na execução, 303639 - Já execudado ou não encontrado.
- Erro (Inteiro) = Código de Erro Caso Falhe. Valores possíveis: 0 = Não houve erro, Diferente de 0 = Erros variados.
- ErroMSG (String) = Descrição do erro -
ConsultaTicketsPorPeriodo
Exportação ou Consulta de Ticket por período de acordo com a data de abertura do ticket.
Parâmetros de entrada:
- dataInicial (Data e Hora - Obrigatório) = Data de Início da Pesquisa.
- dataFinal (Data e Hora - Obrigatório) = Data Final da Pesquisa.
- produto (String - Obrigatório) = Nome do Produto para Validação. Preencha com 'WS G'.
- código (String - Obrigatório) = Código do Produto para Validação. Preencha com '01'.
Retornos:
- Retorno da Função (Lista de VO Ticket).
- Erro (Inteiro) = Código de Erro Caso Falhe. Valores possíveis: 0 = Não houve erro, Diferente de 0 = Erros variados.
- ErroMSG (String) = Descrição do erro -
ConsultarLogAuditoria
[INTERFACE]
Este método é responsável por:
Consultar os logs de auditoria.
Parâmetros de entrada:
- Entidade ConsultaLogAuditoriaIN contendo 2 parametros obrigatórios (Datas) e o restante opcional, utilizado no filtro da pesquisa. - produto (String - Obrigatório) = Nome do Produto para Validação. Preencha com 'WS G'.
- código (String - Obrigatório) = Código do Produto para Validação. Preencha com '01'.
Retornos:
- Uma lista do tipo ConsultaLogAuditoriaOUT com mais parametros informativos.
Parametro Informativo>
- Verifique a propriedade MensagemRetornoWebService, pois ela contém a(s) mensagen(s) de Erro(s) ou Sucesso -
DadosDoTicket_G4
[OBSOLETO]
MÉTODO DE COMPATIBILIZAÇÂO COM O GUARDIAN 4 - PREFERENCIALMENTE UTILIZE OUTROS MÉTODOS!Este método é responsável por:
- Incluir o Ticket;
- Disparar pesagem;
- Consultar dados do ticket
As ações serão tomadas dependendo da sinalização que houver em cada um dos objetos.
Valores entram pelo ImportaTicketG4 e saem pelo ExportaTicketG4.
Os três objetos possuem um campo chamado “Flag”, que sinaliza que ação deve ser
executada. Os valores dos “Flags” para a execução da ação de cada objeto são:
Parâmetros de entrada:
- Senha (String).
- TicketEntrada(ImportaTicketG4)
- TicketSaida(out ExportaTicketG4)
- Erro(out int)
- Mensagem(out String)
Este método retorna dentro do parâmetro Erro, o (zero) se a execução foi correta
e diferente de 0 (zero) se houve qualquer problema da execução, nesse caso o parâmetro
mensagem estará preenchido com uma descrição do problema
-
EnviaMensagemDisplay
[INTERFACE]
Método responsável por enviar uma mensagem para um display.
Esse método é assíncrono, colocando um pedido de envio de mensagem para o display na fila de execução.
Para saber o estado da execução do comando utilize o método ConsultaEstadoComando.
Parâmetros de entrada:
- PontoControlePonto (String - Obrigatório) = Código do Ponto de Controle Associado a Cancela.
- Posicao (Inteiro - Obrigatório) = Posição no display na configuração do Guardian. Valores possíveis :1 - Posição 1, 2 - Posição 2, 0 - Indiferente.
- Mensagem (String - Opcional) = Mensagem para o Display, se não preenchido ou em branco limpa a mensagem.
- Tempo (Inteiro - Obrigatório) = Tempo de exibição em segundos, 0 indefinido.
Retornos:
- Retorno da Função (Inteiro) = ID do comando na Fila.
- Erro (Inteiro) = Código de Erro Caso Falhe. Valores possíveis: 0 = Não houve erro, Diferente de 0 = Erros variados.
- ErroMSG (String) = Descrição do erro -
EnviaMensagem_G4
[OBSOLETO]
MÉTODO DE COMPATIBILIZAÇÂO COM O GUARDIAN 4 - PREFERENCIALMENTE UTILIZE OUTRO MÉTODO!
Este método é responsável por:
Adicionar uma mensagem a ser enviada para o display na fila de execuções.
O tempo deve ser indicado em segundos e se for igual a zero então a mensagem ficará sendo exibida até a próxima.
Parâmetros de entrada:
- Senha (String - Opcional) = Obsoleto, não preencher, existe apenas para manter compatibilidade.
- Terminal (String - Obrigatório) Código do Ponto de Controle.
- Endereco (Inteiro - Opcional) = Obsoleto, não preencher, existe apenas para manter compatibilidade.
- CodigoRedeSpider (String - Opcional) = Obsoleto, não preencher, existe apenas para manter compatibilidade.
- MensagemDisplay (String - Obrigatório) = Mensagem que será exibida no display.
- Tempo (Inteiro - Obrigatório) = Tempo de duração da mensagem em segundos.
Retornos:
- Erro (Inteiro) = Código de Erro Caso Falhe. Valores possíveis:
0 = Execução correta, se diferente deste valor o parâmetro mensagem estará preenchido com uma descrição do problema.
1 = Erro não esperado.
303776 = O WebService não está na mesma versão do banco de dados, favor fazer a sincronização das versões.
303595 = Ponte de Controle(Terminal) não encontrado.
303634 = Falha ao salvar solicitação, verifique os Logs.
- Mensagem (String) = Mensagem contendo a descrição do erro.
-
ExportaTicketParametro
[INTERFACE]
Este método é responsável por:
Exportação ou Consulta de Ticket por parâmetros.
O sistema tentará encontrar o Ticket na seguinte ordem de prioridade, de acordo com o parâmetro que for preenchido:
- 1º Código do Ticket
- 2º Último Ticket da Placa
- 3º Último Ticket do TAG
Parâmetros de entrada:
- ticketCodigo (String - Opcional) = Código ou Número do Ticket.
- ticketPlaca (String - Opcional) = Placa da carreta/vagão.
- ticketTAG (String - Opcional) = TAG, Transponder ou Código de Barras de Identificação Associada do Ticket.
- produto (String - Obrigatório) = Nome do Produto para Validação. Preencha com 'WS G'.
- código (String - Obrigatório) = Código do Produto para Validação. Preencha com '01'.
Retornos:
- Retorno da Função (Lista de VO Ticket) = Lista dos tickets disponíveis, com suas operações e possíveis erros de cada operação.
- Erro (Inteiro) = Código de Erro Caso Falhe. Valores possíveis: 0 = Não houve erro, Diferente de 0 = Erros variados.
- ErroMSG (String) = Descrição do erro -
ExportaTicketPeriodo
PREFERENCIALMENTE UTILIZE O MÉTODO ConsultaTicketsPorPeriodo!
Exportação ou Consulta de Ticket por período de acordo com a data de abertura do ticket.
Parâmetros de entrada:
- dataInicial (Data e Hora - Obrigatório) = Data de Início da Pesquisa.
- dataFinal (Data e Hora - Obrigatório) = Data Final da Pesquisa.
- produto (String - Obrigatório) = Nome do Produto para Validação. Preencha com 'WS G'.
- código (String - Obrigatório) = Código do Produto para Validação. Preencha com '01'.
Retornos:
- Retorno da Função (Objeto de VO Ticket) = Último Ticket disponível.
- Erro (Inteiro) = Código de Erro Caso Falhe. Valores possíveis: 0 = Não houve erro, Diferente de 0 = Erros variados.
- ErroMSG (String) = Descrição do erro -
ExportaTicketUnico
[INTERFACE]
Este método é responsável por:
Fazer exportação diferenciar de ticket, selecionando e retornando apenas o primeiro ticket disponível para exportação.
Parâmetros de entrada:
- completa (Booleano - Obrigatório) = NÃO UTILIZADO - Preencha sempre com (false).
- nomeSistema (String - Obrigatório) = Nome do sistema para o qual o ticket está marcado para exportação. Preencher normalmente com 'WS GUARDIAN'.
- Sincronizacao (Booleano - Obrigatório) = Preencha sempre com (false)'.
- produto - Nome do Produto para Validação. Preencha com 'WS G'.
- código (String - Obrigatório) = Código do Produto para Validação. Preencha com '01'.
Retornos:
- Retorno da Função (VO Ticket) = Ticket disponível.
- Erro (Inteiro) = Código de Erro Caso Falhe. Valores possíveis: 0 = Não houve erro, Diferente de 0 = Erros variados.
- ErroMSG (String) = Descrição do erro -
ExportaTicketsMarcados
[INTERFACE]
Este método é responsável por:
Fazer exportação diferencial de tickets, selecionando e retornando todos os tickets disponíveis para exportação para o sistema WS GUARDIAN.
Retornos:
- Retorno da Função (Lista de VO Ticket) = Lista de Tickets disponível.
- Erro (Inteiro) = Código de Erro Caso Falhe. Valores possíveis: 0 = Não houve erro, Diferente de 0 = Erros variados.
- ErroMSG (String) = Descrição do erro -
ExportaVeiculosQuePossamTerPassadoSemPesarPelaBalanca
[INTERFACE]
Este método é responsável por:
Retornar veículos que possam ter passado sem pesar pela balança
Retornos:
- Retorno da Função (Lista de VO HistoricoPassagem) = Lista do Historico de Passagens.
- Erro (Inteiro) = Código de Erro Caso Falhe. Valores possíveis: 0 = Não houve erro, Diferente de 0 = Erros variados.
- ErroMSG (String) = Descrição do erro -
FilaAdicionaVeiculo
[INTERFACE]
Este método é responsável por:
Adicionar um veículo em uma determinada fila.
A pré-condição para a execução deste web método é possuir um ticket cadastrado dentro de uma fila. E o ticket não pode estar no estado de Encerrado, Cancelado e nem Aguardando Liberação.
Para adicionar o veículo na fila é necessário preencher um dos campos da estrutura VODadosFilaAdiciona.
As descrições dos campos podem ser conferidas nos VOs: VODadosFilaAdiciona, VORetornoFilaAdiciona.
Parâmetros de entrada:
- VOConfiguracaoFilaAdiciona (VO ConfiguracaoFilaAdiciona ) = Opcional - Configuração para a tomada de decisão de necessário.
- VODadosFilaAdiciona (VO DadosFilaAdiciona ) = Obrigatório - Conforme a definição da estrutura VODadosFilaAdiciona.
Retornos:
-
- VORetornoFilaAdiciona (VO RetornoFilaAdiciona ) = Retorno do resultado da execução do web método. Erro = 0, indicação de sucesso. Qualquer valor diferente disto indica falha na execução.
-
FilaConsultaVeiculo
[INTERFACE]
Este método é responsável por:
Exibe a fila em que o veiculo informado na estrutura VODadosFilaConsulta se encontra.
As descrições dos campos podem ser conferidos nos VOs: voDadosFila, VORetornoFilaConsulta.
Parâmetros de entrada:
- VOConfiguracaoFilaConsulta (VO ConfiguracaoFilaConsulta ) = Configuração se necessário.
- VODadosFilaConsulta (VO DadosFilaConsulta ) = Obrigatório - Dados do Ticket.
Retornos:
-
- VORetornoFilaConsulta (VO RetornoFilaConsulta ) = Obrigatório - Parametro de OutPut com o resultado do retorno da execução do web método. Erro = 0, indicação de sucesso. Qualquer valor diferente disto indica falha na execução.
-
FilaRemoveVeiculo
[INTERFACE]
Este método é responsável por:
Remover um veículo em uma determinada fila.
Para remover o veículo da fila é necessário preencher um dos campos da estrutura voDadosFilaRemoveVeiculo.
O ticket do veiculo não pode estar no estado de Encerrado, Cancelado e nem aguardando liberação.
As descrições dos campos pode ser conferido nos VOs: VODadosFilaRemoveVeiculo, voRetornoFila.
Parâmetros de entrada:
- VOConfiguracaoFilaRemove (VO ConfiguracaoFilaRemove ) = Configuração se necessário.
- VODadosFilaRemove (VO DadosFilaRemove ) = Obrigatório - Dados do Ticket.
Retornos:
-
- VORetornoFilaRemove (VO RetornoFilaRemove ) = Obrigatório - Parametro de OutPut com o resultado do retorno da execução do web método. Erro = 0, indicação de sucesso. Qualquer valor diferente disto indica falha na execução.
- Erro (Inteiro) = Código de Erro Caso Falhe.
- ErroMSG (String) = Descrição do erro -
IdentificaVagao
[OBSOLETO]
Metodo de compatibilização com o Guardian 4.IMPORTANTE: Se exitir o arquivo BDG4.XML a conexão com o banco será feita utilizado os dados desse arquivo e
serão utilizada as regras de negócio do Guardian 4. Caso contrário se feita a conexão com o Guardian 6 normalmente.
Então para ser conectar com o Guardian 4 crier um arquivo BD.XML com a conexão para um banco de Guardian 4 e renomei o arquivo para BDG4.XML.
Para se conectar ao Guardian 6 o arquivo BDG4.XML deve ser apagado. Este método é responsável por:
Importar o pré-cadastramento do vagão.
Parâmetros de entrada:
- infoCarregamento (InformaCarregamento): Dados relacionados ao carregamento.
Retornos:
- Retorno da Função (Int) = 0 : erro desconhecido - 1 : sucesso 2 : vagao ja cadastrado. -
IdentificaVeiculoNoPonto
[INTERFACE]
DESCRIÇÃO
- Método responsável por identificar um veículo no ponto de controle determinado. Ou fazer um acesso sem periférico.
PARÂMETROS DE ENTRADA
PARÂMETRO TIPO OBRIGATÓRIO DESCRIÇÃO VALORES POSSÍVEIS pontoControle string true Ponto de controle no qual o veículo vai ser identificado ticketCodigo string false Código do Ticket ticketPlaca string false Placa da carreta ou vagão ticketTAG string false Identificador do ticket (Transponder, Código de barras ou TAG) lado string true Lado que o veículo será identificado. A ou B
PESQUISA
- A pesquisa do ticket será realizada através dos parâmetros Ticket, Placa da carreta ou Identificador. Sendo que a pesquisa será executada na seguinte ordem:
1º Código do Ticket 2º Placa da carreta 3º Identificador .
- Só serão identificados tickets com estado diferente de: 3 - Encerrado, 6 - Cancelado e 10 - Bloqueado
MCA COM LEITOR HABILITADO
- PRÉ REQUISITOS
- Identificador associado ao ticket
- MCA em pleno funcionamento associado ao ponto de controle informado na chamada do método.
- Ticket ou veículo cadastrados no Guardian
CONSULTA DE ERROS
- Caso a identificação do veículo não seja realizada com sucesso somente será possível realizar a consulta do erro através da tela de consulta de logs de aplicativos.
- Neste tipo de cenário onde temos MCA COM LEITOR HABILITADO não será possível realizar consultas através do método: ConsultaPedidoDeExecucao
MCA SEM LEITOR HABILITADO
- PRÉ REQUISITOS
- MCA em pleno funcionamento associado ao ponto de controle informado na chamada do método.
- Ticket ou veículo cadastrados no Guardian
- CONSULTA DE ERROS
- Caso a identificação do veículo não seja realizada com sucesso será possível consultar a causa através da tela de consulta de logs de aplicativos ou pelo método:
- ConsultaPedidoDeExecucao
ACESSO SEM PERIFÉRICO
- PRÉ REQUISITOS
- Ponto de controle informado na chamada do método configurado corretamente.
- Não pode ter MCA ou Leitor associado ao Ponto de Controle.
- Opção 1
- - Ticket ou veículo cadastrados no Guardian.
- Opção 2
- - Abrir ticket apartir do identificador. Neste caso a configuração da operação com a propriedade “Abrir ticket de um identificador não associado (Sem intervenção humana)” configurada. O web método irá abrir um ticket na identificação, utilizando nas placas o valor do Identificar do ticket. Caso não seja informado o identificador o Guardian não irá fazer nada. Qualquer valor informado nas placas será desconciderado nesta situação.
- CONSULTA DE ERROS
- Caso a identificação do veículo não seja realizada com sucesso será possível consultar a causa através da tela de consulta de logs de aplicativos ou pelo método:
- ConsultaPedidoDeExecucao
RETORNOS DA FUNÇÃO
- Erro TIPO: Inteiro DEFINIÇÃO: Código de erro em caso de falha. VALORES POSSÍVEIS: 0 = Não houve erro, Diferente de 0 = Erros variados
- ErroMSG TIPO: String DEFINIÇÃO: Descrição do erro
- ImportaTicketPreCadastro
[INTERFACE]
Este método é responsável por:
Importar dados de um Ticket em estado de Pré-Cadastro ou Pesagem Inicial Executada.
Parâmetros de entrada:
- DadosTicket (VO PreCadastro - Obrigatório) = Dados do Ticket.
- produto (String - Obrigatório) = Nome do Produto para Validação. Preencha com 'WS G'.
- código (String - Obrigatório) = Código do Produto para Validação. Preencha com '01'.
Retornos:
- Retorno da Função (Booleano) = Verdadeiro se o Ticket foi incluído com sucesso.
- Erro (Inteiro) = Código de Erro Caso Falhe. Valores possíveis: 303221 = Não houve erro, Diferente de 303221 = Erros variados.
- ErroMSG (String) = Descrição do erro- ImprimeEtiqueta
[INTERFACE]
Este método é responsável por:Realizar uma solicitação de impressão de etiqueta do tipo IG 200, para que o Guardian Service a imprima.
A pré-condição para a execução do web método é que, o Guardian esteja configurado corretamente para imprimir a etiqueta, independentemente do web service.
As configurações mais relevantes são:
- Estação Responsável pela integração;
- Usuário Responsável pela Integração;
- Ponto de Controle com o respectivo impressor, onde será impressa a etiqueta;
- Impressor IG 200 configurado;
- Etiqueta que será impressa, quando necessário;
Este web método irá funcionar de duas maneiras:
- Com Ticket: nesta situação além dos parâmetros obrigatórios, informa-se os parâmetros do ticket e da etiqueta.
É com base nestas informações que a etiqueta(conteúdo e layout) será impressa. Neste caso o parâmetro ScriptEtiqueta deverá estar obrigatoriamente vazio;
- Sem Ticket(etiqueta avulsa): nesta situação além dos parâmetros obrigatórios, deve-se preencher obrigatoriamente o parâmetro ScriptEtiqueta.
Ele deve ser preenchido com o conteúdo e layout da etiqueta que se deseja imprimir.
Neste caso, mesmo que os parâmetros de Ticket e Etiqueta estiverem preenchidos, sistema irá desconsiderar essas informações.
Para solicitar a impressão é necessário preencher os campos da estrutura VODadosImprimeEtiqueta de acordo com a sua definição. As descrições dos campos pode ser conferido nos VOs: VODadosImprimeEtiqueta, VORetornoImprimeEtiqueta.
Parâmetros de entrada:
- VOConfiguracaoImprimeEtiqueta (VO ConfiguracaoImprimeEtiqueta ) = Opcional - Configuração para a tomada de decisão de necessário.
- VODadosImprimeEtiqueta (VO DadosImprimeEtiqueta ) = Obrigatório - Conforme a definição da estrutura VODadosImprimeEtiqueta.
Retornos:
-
- VORetornoImprimeEtiqueta (VO RetornoImprimeEtiqueta ) = Retorno do resultado da execução do web método. Erro = 0, indicação de sucesso. Qualquer valor diferente disto indica falha na execução.
- LiberarTicket
[INTERFACE]
Este método é responsável por:
Liberar Ticket no estado de “Aguardando Liberação”.
Obs: Este webmetodo tem comportamento semelhante ao botão 'Liberar', exibido em operações com intervenção humana e na tela de manutenção de Tickets.
Regras
“Obrigar informar motivo ao liberar erro de OCR” não esteja marcada, o único pré-requisito será o ticket estar no estado “Aguardando Liberação”
Parâmetros de entrada:
- VOConfiguracaoLiberarTicket - Deverá ser nulo.
- DadosLiberacao(VO Dados Liberar Ticket - Obrigátorio)
- VORetornoLiberarTicket (out VO Retorno Liberar Ticket)
• Não contemplado: Bloquear um Ticket após Liberar ou Marcar para Cancelar via Web Método.
- ManutencaoTicket
[INTERFACE]
Este método é responsável por:
Alterar o Estado do Ticket.
O web método de manutenção de ticket poderá alterar qualquer ticket com estado diferente de cancelado.
O sistema tentará encontrar o Ticket na seguinte ordem de prioridade, de acordo com o parâmetro que for preenchido:
- 1º Código do Ticket
- 2º Último Ticket da Placa
- 3º Último Ticket do TAG
Parâmetros de entrada:
- ticketCodigo (String - Opcional) = Código ou Número do Ticket.
- ticketPlaca (String - Opcional) = Placa da carreta/vagão.
- ticketTAG (String - Opcional) = TAG, Transponder ou Código de Barras de Identificação Associada do Ticket.
- numOperacao (Inteiro - Obrigatório) = Número que indica qual operação será realizada no Ticket. Valores possíveis: 1 = Bloquear, 2 = Desbloquear, 3 = Encerrar, 4 = Cancelar, 6 = Reabrir.
- produto (String - Obrigatório) = Nome do Produto para Validação. Preencha com 'WS G'.
- código (String - Obrigatório) = Código do Produto para Validação. Preencha com '01'.
Retornos:
- Retorno da Função (Booleano) = Retorna Verdadeiro (True) em caso de Sucesso de alteração de Estado.
- MarcaTicketParaNaoValidarOcr
[INTERFACE]
Este método é responsável por:
Marcar Ticket para não validar erros de OCR.
Obs 01: Este webmetodo tem comportamento semelhante ao botão 'Marcar para não validar OCR', exibido em operações com intervenção humada e na tela de manutenção de Tickets.
Obs 02: Geralmente utilizado somente na liberação de erros de OCR ocorridos na identificação.
Obs 03: Consultar a ED antes de utilizar este web método.
Regras
Obrigado informar ao menos um dos campos (CodigoDoTicket, Placa ou TAG).
O único pré-requisito será o ticket estar no estado “Aguardando Liberação”Parâmetros de entrada:
- voConfiguracaoMarcarParaNaoValidarOCR - Deverá ser nulo.
- voDadosMarcaParaNaoValidarOCR - (VO Dados Marca Para Não Validar OCR - Obrigátorio)
- voRetornoMarcaParaNaoValidarOCR - (out VO Retorno Marca Para Não Validar OCR)
- MarcarParaCancelar
[INTERFACE]
Este método é responsável por:
Marcar Ticket para cancelar.
Obs: Este webmetodo tem comportamento semelhante ao botão 'Marcar para Cancelar', exibido em operações com intervenção humada e na tela de manutenção de Tickets.
Regras
Obrigado informar ao menos um dos campos (CodigoDoTicket, Placa ou TAG).
O único pré-requisito será o ticket estar no estado “Aguardando Liberação”Parâmetros de entrada:
- voConfiguracaoMarcarParaCancelar - Deverá ser nulo.
- voDadosMarcarParaCancelar -
Código do ticket – string – código do ticket responsável por identificar o ticket que será marcado para cancelar
Placa – string – Placa da Carreta. Responsável por identificar o ticket que será marcado para cancelar.
Tag – string – TAG, Transponder ou Código de Barras de Identificação Associada do Ticket. Responsável por identificar o ticket que será marcado para cancelar
Parâmetros de saída:
- voRetornoMarcarParaCancelar -
Erro – inteiro – número do erro ou em caso de sucesso irá retornar 0
Descricao – string – descrição do erro.
• Não contemplado: Bloquear um Ticket após Liberar ou Marcar para Cancelar via Web Método.
- MarcarParaNaoValidarOcr
[INTERFACE]
Este método é responsável por:
Marcar Ticket para não validar erros de OCR.
Obs: Este webmetodo tem comportamento semelhante ao botão 'Marcar para não validar OCR', exibido em operações com intervenção humada e na tela de manutenção de Tickets.
Este web método não está liberado. Favor entrar em contato com a Engenharia de Desenvolvimento.
Regras
Obrigado informar ao menos um dos campos (CodigoDoTicket, Placa ou TAG).
O único pré-requisito será o ticket estar no estado “Aguardando Liberação”Parâmetros de entrada:
- voConfiguracaoMarcarParaNaoValidarOCR - Deverá ser nulo.
- voDadosMarcarParaNaoValidarOcr -
Código do ticket – string – código do ticket responsável por identificar o ticket que será marcado para cancelar
Placa – string – Placa da Carreta. Responsável por identificar o ticket que será marcado para cancelar.
Tag – string – TAG, Transponder ou Código de Barras de Identificação Associada do Ticket. Responsável por identificar o ticket que será marcado para cancelar
Parâmetros de saída:
- voRetornoMarcarParaNaoValidarOcr -
Erro – inteiro – número do erro ou em caso de sucesso irá retornar 0
Descricao – string – descrição do erro.
- ObtemVersaoWS
[INTERFACE]
Este método é responsável por:
Retorna a versão atual do Web Service, preferencialmente, essa deve ser a mesma versão do Guardian utilizado. Parâmetros de entrada:
- produto (String - Obrigatório) = Nome do Produto para Validação. Preencha com 'WS G'.
- código (String - Obrigatório) = Código do Produto para Validação. Preencha com '01'.
Retornos:
- Retorno da Função (String) = Retorno Versão do programa ou Erro de Validação.
- RefazUltimaOperacao
[OBSOLETO]
Este método é responsável por:
Permitir Refazer a última operação do Ticket.
É aplicado apenas em casos de Tickets diferentes de Cancelados.
Se houver apenas uma operação ativa no Ticket e este método for chamado, o ticket será encerrado.
O sistema tentará encontrar o Ticket na seguinte ordem de prioridade, de acordo com o parametro que for preenchido:
- 1º Código do Ticket - 2º Último Ticket da Placa - 3º Último Ticket do TAG Parâmetros de entrada:
- ticketCodigo (String - Opcional desde que “ticketPlaca” ou “ticketTAG” esteja preenchidas) = Código ou Número do Ticket.
- ticketPlaca (String - Opcional desde que “ticketCodigo” ou “ticketTAG” esteja preenchidas) = Placa da carreta/vagão.
- ticketTAG (String - Opcional desde que “ticketCodigo” ou “ticketPlaca” esteja preenchidas) = TAG, Transponder ou Código de Barras de Identificação Associada do Ticket.
- produto (String - Obrigatório) = Nome do Produto para Validação. Preencha com 'WS G'.
- código (String - Obrigatório) = Código do Produto para Validação. Preencha com '01'.
Retornos:
- Retorno da Função (Booleano) = Retorna Verdadeiro (True) em caso de Sucesso da operação.
- RefazUltimaOperacaoAtiva
[INTERFACE]Este método é responsável por:
Permitir Refazer a última operação do Ticket.É aplicado apenas em casos de Tickets diferentes de Cancelados.
Quando sem fluxo o web método terá o mesmo comportamento do CancelaUltimaOperacaoAtiva , exceto no caso de uma única operação ativa, que deverá retornar erro (ex: caso de Ticket sem fluxo de veículos com tara cadastrada).
Quando com fluxo, o web método irá reinserir a operação cancelada (e as demais operações em caso de fluxo “ou”) no mesmo ponto do fluxo que ela se encontrava.
Com ou sem fluxo, quando a única operação ativa for a operação de pré-cadastro, irá retornar erro.
O sistema tentará encontrar o Ticket na seguinte ordem de prioridade, de acordo com o parametro que for preenchido:
- 1º Código do Ticket
- 2º Último Ticket da Placa
- 3º Último Ticket do TAGParâmetros de entrada:
- ticketCodigo (String - Opcional desde que “ticketPlaca” ou “ticketTAG” esteja preenchidas) = Código ou Número do Ticket.
- ticketPlaca (String - Opcional desde que “ticketCodigo” ou “ticketTAG” esteja preenchidas) = Placa da carreta/vagão.
- ticketTAG (String - Opcional desde que “ticketCodigo” ou “ticketPlaca” esteja preenchidas) = TAG, Transponder ou Código de Barras de Identificação Associada do Ticket.
Parâmetros de saída:
- SaiErro (Inteiro) = Retorna o número do erro, em caso se sucesso retorna 0.
- SaiErroMSG(string) = Retorna a descrição do erro, em caso se sucesso retorna vazio.
Retornos:
- Retorno da Função (Booleano) = Retorna Verdadeiro (True) em caso de Sucesso da operação.
- RefazUltimaOperacaoII
[OBSOLETO]
Este método é responsável por:
Permitir Refazer a última operação do Ticket.
É aplicado apenas em casos de Tickets diferentes de Cancelados.
Se houver apenas uma operação ativa no Ticket e este método for chamado, o ticket será encerrado.
O sistema tentará encontrar o Ticket na seguinte ordem de prioridade, de acordo com o parametro que for preenchido:
- 1º Código do Ticket - 2º Último Ticket da Placa - 3º Último Ticket do TAG Parâmetros de entrada:
- ticketCodigo (String - Opcional desde que “ticketPlaca” ou “ticketTAG” esteja preenchidas) = Código ou Número do Ticket.
- ticketPlaca (String - Opcional desde que “ticketCodigo” ou “ticketTAG” esteja preenchidas) = Placa da carreta/vagão.
- ticketTAG (String - Opcional desde que “ticketCodigo” ou “ticketPlaca” esteja preenchidas) = TAG, Transponder ou Código de Barras de Identificação Associada do Ticket.
- produto (String - Obrigatório) = Nome do Produto para Validação. Preencha com 'WS G'.
- código (String - Obrigatório) = Código do Produto para Validação. Preencha com '01'.
Parâmetros de saída:
- SaiErro (Inteiro - Opcional) = Retorna o número do erro, em caso se sucesso retorna 0.
- SaiErroMSG(string - Opcional) = Retorna a descrição do erro, em caso se sucesso retorna vazio.
Retornos:
- Retorno da Função (Booleano) = Retorna Verdadeiro (True) em caso de Sucesso da operação.
- RemontaFluxo
[INTERFACE]
Este método é responsável por:
Remonta Fluxo Ticket.
Cancela todos pontos do fluxo, depois remonta o fluxo.
O sistema tentará encontrar o Ticket na seguinte ordem de prioridade, de acordo com o parametro que for preenchido:
- 1º Código do Ticket
- 2º Último Ticket da Placa
- 3º Último Ticket do TAG
Parâmetros de entrada:
- ticketCodigo (String - Opcional) = Código ou Número do Ticket.
- ticketPlaca (String - Opcional) = Placa da carreta/vagão.
- ticketTAG (String - Opcional) = TAG, Transponder ou Código de Barras de Identificação Associada do Ticket.
- codigoFluxo (String - Obrigatório) = Código no novo fluxo do ticket.
- produto (String - Obrigatório) = Nome do Produto para Validação. Preencha com 'WS G'.
- codigo (String - Obrigatório) = Código do Produto para Validação. Preencha com '01'.
Retorno:
- Retorno da Função (Booleano) = Retorna Verdadeiro (True) em caso de Sucesso da operação.
- RetornaVeiculosQuePossamTerPassadoSemPesarPelaBalanca
[INTERFACE]
Este método é responsável por:
Retornar veículos que possam ter passado sem pesar pela balança
Parâmetros de entrada:
- dataInicio (Data e Hora - Obrigatório) = Data de Inicio da Pesquisa.
- dataFim (Data e Hora - Obrigatório) = Data Final da Pesquisa.
Retornos:
- Retorno da Função (Lista de VO HistoricoPassagem) = Lista do Historico de Passagens.
- Erro (Inteiro) = Código de Erro Caso Falhe. Valores possíveis: 0 = Não houve erro, Diferente de 0 = Erros variados.
- ErroMSG (String) = Descrição do erro- SimulaPesagemAvulsaSemAutomacao
[INTERFACE]
WebMétodo responsavel por:
Simular uma 'PESAGEM AVULSA' de um veículo pré-cadastrado em um determinado ponto de controle, em uma balança 'SEM AUTOMAÇÃO'
Este WebMétodo foi desenvolvido para funcionar com uma balança associada ao ponto de controle. Ele NÃO FUNCIONA como uma operação do
GUARDIAN, ele apenas grava o peso capturado quando a balança está estavél (Posicionado) como se fosse uma 'PESAGEM AVULSA'.
Nenhum evento é diparado, nenhuma configuração da operação é validada, ele apenas grava as informações no banco.
Este WebMétodo utiliza 'Estação responsável pela integração de dados' e 'Usuário responsável pela integração de dados' que estão
configurados no Config.exe na opção 'Sistema'.
Deverá ter apenas uma 'OPERAÇÃO AVULSA' Configurada. O sistema vai tentar encontrar um Ticket aberto através de um dos parâmetros (Ticket, Placa ou ID) passados, na seguinte ordem:
- 1º Código do Ticket
- 2º Último Ticket da Placa
- 3º Último Ticket do TAG
Funciona somente Parâmetros de entrada:- PontoControle (String - Obrigatório) = Ponto de controle no qual o veículo vai ser identificado.
- ticketCodigo (String - Opcional) = Código ou Número do Ticket.
- ticketPlaca (String - Opcional) = Placa da Carreta.
- ticketTAG (String - Opcional) = TAG, Transponder ou Código de Barras de Identificação Associada do Ticket.
- lado (String - Obrigatório) = Lado ao qual o veículo vai ser identificado. Valores possíveis A ou B.- TempoValidadePesoBom (Inteiro - Obrigatório) = Tempo de Validade de um Peso Bom Capturado em Segundos. -Preferencialmente utilizar 5 segundos.
- TimeoutLeitura (String - Obrigatório) = Tempo máximo (em segundos) de retorno do método enquanto o sistema tenta capturar um Peso Bom. - Preferencialmente utilizar 5 segundos.
Retornos:
- Erro (Inteiro) = Código de Erro Caso Falhe. Valores possíveis: 0 = Não houve erro, Diferente de 0 = Erros variados.
- ErroMSG (String) = Descrição do erro- SolicitaFotoAvulsa
[INTERFACE]
Este método é responsável por:
Solicitar o disparo assíncrono de uma fotografia em ponto específico de um ponto e controle (posteriormente, utilize o WebMétodo SolicitaRetornoFotoAvulsa para verificar o resultado desta operação).
Este método não depende da existência de um MCA configurado no ponto de controle.
Parâmetros de entrada:
- codigoPontoControle (String - Obrigatório) = Código do ponto de controle onde se encontra câmera com a qual a foto será tirada.
- posicaoCamera (String - Obrigatório) = Posição de instalação da câmera no ponto de controle (exemplo: P1, P2... P8).
- caminhoFoto (String - Opcional) = Caminho onde a foto será gravada. Se não for informado será assumido o caminho padrão definido na configuração do Guardian.
- nomeFoto (String - Opcional) = Nome com o qual a foto será gravada. Se não for informado será assumido a geração de nome padrão definida na configuração do Guardian.
- produto (String - Obrigatório) = Nome do Produto para Validação. Preencha com 'WS G'.
- código (String - Obrigatório) = Código do Produto para Validação. Preencha com '01'.
Retornos:
- Retorno da Função (int) = Um código de identificação desta solicitação, poderá ser utilizado para obter informação sobre o sucesso desta operação assíncrona.
- Erro (bool) = Código de Erro Caso Falhe. Valores possíveis: 0 = Não houve erro, Diferente de 0 = Erros variados.
- ErroMSG (String) = Descrição do erro retornado.
- SolicitaRetornoFotoAvulsa
[INTERFACE]
Este método é responsável por:
Obter informação sobre o sucesso ou não, IMEDIATAMENTE após o disparo de uma solicitação assíncrona de fotografia avulsa (utilize o WebMétodo SolicitaFotoAvulsa para solicitar o disparo de fotos).
Parâmetros de entrada:
- idSolicitacaoAvulsa (String - Inteiro) = Código de identificação da solicitação de foto avulsa.
- produto (String - Obrigatório) = Nome do Produto para Validação. Preencha com 'WS G'.
- código (String - Obrigatório) = Código do Produto para Validação. Preencha com '01'.
Retornos:
- Retorno da Função (Objeto de VO RetornoFotoAvulsa) = Informações sobre o sucesso ou não de uma operação anteriormente solicida.
- TrocaFluxoTicket
[INTERFACE]
Este método é responsável por:
Alterar o Fluxo Ticket.
A alteração do fluxo é aplicada apenas nos seguintes casos :
- 1º Tickets abertos, ou seja, diferentes de Cancelados e Encerrados.
- 2º O fluxo que está sendo informado no web método, tem que ser diferente do fluxo do ticket em questão.
O sistema tentará encontrar o Ticket na seguinte ordem de prioridade, de acordo com o parametro que for preenchido:
Observação: Caso o fluxo informado no web método seja igual ao fluxo do ticket em questão, o retorno do web método será Verdadeiro (True)
- 1º Código do Ticket
- 2º Último Ticket da Placa
- 3º Último Ticket do TAG
Parâmetros de entrada:
- ticketCodigo (String - Opcional) = Código ou Número do Ticket.
- ticketPlaca (String - Opcional) = Placa da carreta/vagão.
- ticketTAG (String - Opcional) = TAG, Transponder ou Código de Barras de Identificação Associada do Ticket.
- fluxoCodigo (String - Obrigatório) = Código no novo fluxo do ticket. Tem que ser diferente do fluxo atual do Ticket
- produto (String - Obrigatório) = Nome do Produto para Validação. Preencha com 'WS G'.
- codigo (String - Obrigatório) = Código do Produto para Validação. Preencha com '01'.
Retorno:
- Retorno da Função (Booleano) = Retorna Verdadeiro (True) em caso de Sucesso da operação.