Ir para o conteúdo

Solicitar Monitoramento V3

Solicitação de Monitoramento (Set_SolicitaMonitoramentoV3)

O método para inclusão de solicitação de monitoramento exige pré requisitos importantes que devem ser observados. Caso não sejam respeitados, a solicitação de monitoramento pode ser rejeitada. Abaixo alguns itens necessários para que a Solicitação de Monitoramento seja aceita no processo de integração:

  • Os veículos (cavalos/caminhões e carretas) devem estar previamente cadastrados e ativos;

  • O conjunto-viagem (cavalo e carretas) não pode estar em viagem ou com outro agendamento;

  • Deverá ter sido solicitado sinal do rastreador em favor da NoxGR para o veiculo trator da viagem;

  • Se o PGR exigir checklist do rastreador, o mesmo deverá ter sido previamente solicitado pelo cliente e ter sido realizado pela equipe NoxGR dentro da data de validade;

  • O(s) condutor(es) deve(m) estar previamente cadastrado(s) e ativo(s);

  • O(s) condutor(es) não pode(m) estar em viagem ou com outro agendamento;

  • Se informado ajudante(es), o(s) mesmo(s) deverá(ão) estar previamente cadastrado(s) e ativo(s) e não estar(em) inserido(s) em outro agendamento em aberto;

  • Caso tenha necessidade de perfil-securitário do(s) condutor(es), deverá ter sido solicitado previamente e estar válido;

  • Caso a viagem tenha exigência de isca ou spy, o rastreador auxiliar deverá ter sido previamente cadastrado no NoxWeb;

  • Caso a viagem tenha exigência de escolta, o veiculo de escolta bem como os agentes de escolta deverão ter sido cadastrados previamente.

O cliente poderá, através da integração autorizar o agendamento de solicitação de monitoramento com checklist sob restrição (sId_AutorizaCklNeg = “S”). Recomendamos que no processo de integração seja construído uma tela para confirmar o procedimento. A utilização funcionalidade será de total responsabilidade do cliente caso a viagem seja agendada sem que os equipamentos estejam funcionando com 100% de sua capacidade. Caso não haja autorização não esteja autorizado, informar “N” nessa TAG e, sendo assim, toda solicitação cujo conjunto-viagem esteja com checklist sob restrição, será rejeitada.

Caso a solicitação seja aceita após a validação, o número do protocolo da solicitação irá retornar na resposta da requisição e, se o cliente tiver evento de e-mail associado para envio da solicitação, a SM será encaminhada por e-mail para o grupo de pessoas definidas pelo cliente.

Campos obrigatórios para inclusão da solicitação de monitoramento (chaves de acesso): iCd_CnpjUnidNeg e sCd_Placa. Se esses atributos não forem enviados ou seu conteúdo for nulo, não haverá processamento da requisição.

*Adicionado o campo iCd_Viagem no xml de retorno, se a SM for concluída com exito retornará nesse campo o número dela,caso contrário retornará 0.

Tabela de detalhamento de campos/grupos para inclusão de solicitação de monitoramento

Grupo/Campo Tipo Descrição Observação Obrigatório Permite Alteração Pai Ocorrência
DadosSM Grupo geral da solicitação de monitoramento Necessário apresentar ao menos uma TAG relacionada nesse grupo 1-1
sCd_CnpjUnidNeg String(14) CNPJ da unidade de negócios a qual o veiculo está vinculado Preencher com zeros a esquerda Sim-chave Não 1-1
sCd_Placa String(8) Placa do veiculo trator Formato "AAA-9999" Sim-chave Não 1-1
ControleAgendamento Grupo informações para controle do agendamento Informações não obrigatórias por utilizar valores default para todos os campos Não DadosSM 0-1
sId_AutorizaCklNeg string(1) Identifica se autoriza check negativado Indicar "S" ou "N" para solicitar monitoramento mesmo que o Checklist contenha restrições. Caso não seja informado, o valor default será = "N" Não Não 0-1
sId_UtilizaFormPadrao string(1) Identifica se deve utilizar formação padrão ou será utilizado novo conjunto-viagem "S" = utiliza formação padrão informada em Set_AlteraVeiculo ou Set_AlteraFormPadrao "N" = utiliza formação indicada no grupo ConjuntoViagem. Se não informado, valor default = "N" Não Não 0-1
sId_UtilizaCondPadrao string(1) Identifica se deve utilizar condutor padrão ou será utilizado novo condutor para a viagem "S" = utiliza condutor padrão informado em Set_AlteraVeiculo ou Set_AlteraCondutor ou Set_AlteraCondutorPadrao "N" = utiliza condutor indicado no grupo CondutoresViagem. Se não informado, valor default = "N". Não Não 0-1
sId_CtrlCarga string(1) Identifica se irá controlar processo de carregamento de mercadoria "S" = ao finalizar a solicitação, aguardará controles de inicio e fim de carregamento antes de iniciar a viagem "N" = ao finalizar a solicitação, estará apto para iniciar viagem. Se não informado, valor default = "N". Não Não 0-1
sId_CtrlDescarga string(1) Identifica se irá controlar processo de descarga de mercadoria "S" = ao chegar no destino, aguardará controles de inicio e fim de descarga antes que possa disponibilizar a viagem para ser finalizada "N" = ao chegar no destino, a viagem estará apta para ser finalizada. Se não informado, valor default = "N". Não Não 0-1
ConjuntoViagem Grupo informações da formação conjunto-viagem Informações nesse grupo serão ignoradas caso TAG sId_UtilizaFormPadrao = "S", caso contrario deverá ser informado o conjunto-viagem Não DadosSM 0-1
id_FormacaoCVC num(2) Formação Composição do Conjunto Viagem Validar pela [Tabela de Formação Padrão]. Não Não 0-1
sCd_PlacaCarretaCV Grupo de carretas associadas ao cavalo no conjunto-viagem Não ConjuntoViagem 0-1
sCd_PlacaCarretaCV String(8) Placa da Carreta Formato AAA-9999 Não Não 0-n
CondutoresViagem Grupo informações dos condutores da viagem Obrigatório se TAG sId_UtilizaCondPadrao diferente de "S", caso contrario as informações desse grupo serão ignoradas Não DadosSM 0-1
sNo_CpfCondutorPrinc num(11) CPF do condutor principal do veiculo Completar com zeros a esquerda Não Não 0-1
sNo_CpfCondutorAux num(11) CPF do condutor auxiliar do veiculo Completar com zeros a esquerda Não Não 0-1
DadosAjudantes Grupo informações dos ajudantes da viagem Não DadosSM 0-1
iQt_Ajudantes num(1) Quantidade de ajudantes que seguirá na viagem junto com o(s) condutor(es). Máximo 2 Ajudantes Não Não 0-1
sNo_CpfAjudante Grupo cpf de ajudantes da viagem Não DadosAjudantes 0-1
sNo_CpfAjudante num(11) CPF do Ajudante Completar com zeros a esquerda Não Não 0-2
ControleDDR Grupo informações para transporte com DDR Não DadosSM 0-1
sId_Ddr string(1) Identifica transporte utilizando CARTA DDR. Seguro por conta do Embarcador Validar "S" ou "N". Caso não seja informado ou inválido, utilizará "N" por default. Não Não 0-1
iCd_SeguradoraDdr num(4) Código da seguradora do Embarcador constante na Carta DDR Ver Tabela de Seguradoras Não Não 0-1
sCd_CnpjEmbarcDdr string(14) CNPJ do Embarcador em caso de DDR Completar com zeros a esquerda Não Não 0-1
DadosViagem Grupo informações da viagem Sim DadosSM 1-1
sCd_Rota string(15) Código da Rota Pode ser utilizado o código do integrador. Ver em Tabelas Associativas-Rotas. Se não utilizar código do integrador, o campo utilizará o tipo num(10) Sim Não 1-1
sCd_MunicipioOrigem string(15) Município de origem Município onde iniciará a viagem. Pode ser utilizado o código do integrador ou código do IBGE. Sim Não 1-1
sCd_MunicipioDestino string(15) Município de destino Município onde será encerrada a viagem. Pode ser utilizado o código do integrador ou código do IBGE. Sim Não 1-1
dDh_PrevInicio datetime Data e horário de Previsão de inicio de viagem Formato AAAA-MM-DDTHH:MN:SS Sim Não 1-1
dDh_PrevFim datetime Data e horário de Previsão de fim de viagem Formato AAAA-MM-DDTHH:MN:SS Sim Não 1-1
sId_OperTransp string(1) Operação de Transporte Identifica a Operação de Transportes (D = Distribuição / T = Transferência / C = Coleta / V = Vazio) Sim Não 1-1
nVl_Carga num(9v2) Valor da Carga a transportar Caso a TAG sId_OperTransp seja diferente de "V" esse campo deve ser maior que ZERO, caso contrario desprezará o valor informado considerando = ZERO Sim Não 1-1
sCd_CnpjEmbarcViagem string(14) CNPJ do Embarcador/Cliente Deve ser informado o CNPJ da Origem da mercadoria. Sim Não 1-1
EnderecoOrigem Endereço de origem da viagem Não Não 0-1
sCEP string CEP de origem Não Não 0-1
sNm_Endereco string Campo de Endereço de origem Não Não 0-1
sNo_Endereco string Número de Endereço de origem Não Não 0-1
sNm_Bairro string Bairro de Endereço de origem Não Não 0-1
DadosObsViagem Grupo de informações sobre observações genéricas, ao Operador, para Finalização de Viagem entre outras Não DadosViagem 0-1
sDc_ObsGEN string(1024) Observações genéricas (controle do cliente) Não Não 0-1
sDc_ObsOGR string(1024) Orientação ao Gerenciamento de Risco Não Não 0-1
sDc_ObsOFV string(1024) Observações na finalização de viagem Não Não 0-1
DadosTranspTerceiro Grupo de informações sobre o transportadora da carga (se autônomo ou agregado) Não DadosViagem 0-1
sId_TranspTerceiro string(1) Identifica se utilizará outro transportador (terceiro ou agregado) para conduzir a carga Utilizar "S" ou "N". Caso não seja informado, utilizará "N" por padrão Não Não 0-1
sCd_CnpjTransp string(14) CNPJ do Transportador Terceiro que irá conduzir a carga Completar com zeros a esquerda Não Não 0-1
SequenciaOperacao Grupo de informações de sequenciamento da Operação Será ignorado caso TAG sId_OperTransp = "V" Não DadosViagem 0-n
sId_Operacao string(1) Identifica a operação de transporte E = Entrega / C = Coleta. Se TAG sId_OperTransp = "C" então todas as operações devem ser = "C" Sim Não 1-1
sCd_MunicipioOper string(15) Município destino da operação Município onde será entregue ou coletada a mercadoria. Pode ser utilizado o código do integrador ou código do IBGE. Ver em Tabelas Associativas-Municípios. Sim Não 1-1
sDc_LocalOperacao string(128) Local da Operação Não Não 0-1
sCd_CnpjEmbarcCliente string(14) CNPJ do Embarcador/Cliente/Destinatário Se for uma Coleta informar o CNPJ do Embarcador (Origem), caso contário o CNPJ de onde a mercadoria será entregue (Destino). Sim Não 1-1
sCd_Produto string(15) Produto a transportar/coletar Pode ser utilizado o código do integrador. Ver em Tabelas Associativas-Produtos. Se não utilizar código do integrador, o campo utilizará o tipo num(10) Sim Não 1-1
nVl_Produto num(9v2) Valor do produto a transportar/coletar Sim Não 1-1
dDh_PrevisaoChegada datetime Data e horário de previsão de chegada no destino Formato AAAA-MM-DDTHH:MN:SS Sim Não 1-1
sId_DetNF string(1) Identifica se detalha ou não as notas fiscais dessa sequencia operacional S = Detalha NF / N= Não detalha NF. Padrão igual a "N" se não for informado Não Não 0-1
stDadosNotas Grupo de notas fiscais relacionadas à operação
iNo_NotaFiscal Número da Nota fiscal transportada Não SequenciaOperacao 0-1
sChaveNFe String Chave da Nota Fiscal Eletrônica Se informado deve contar os 44 dígitos da chave da NF-e Não
DadosEscolta Grupo de informações da escolta da viagem Obrigatório caso sId_PossuiEscolta = "S" ou for requerido pela validação do sub-limite (regras na TAG nVl_Produto) Não DadosSM 0-1
sId_PossuiEscolta string(1) Identifica se a viagem possui escoltas Validar "S" ou "N". Caso não seja informado, utilizará "N" como default Não Não 0-1
sCd_CnpjEmpEscolta string(14) CNPJ da empresa responsável pela escolta Completar com zeros a esquerda Sim Não 1-1
sCd_PlacaEscolta string(8) Placa do veículo de escolta Formato "AAA-9999" Sim Não 1-1
sCd_CpfAgenteEscolta Grupo de informações dos agentes de escolta da viagem caso sId_PossuiEscolta = "S" Não DadosEscolta 0-1
sCd_CpfAgenteEscolta Num(11) CPF do agente de escolta Completar com zeros a esquerda Sim Não 1-1
RastreadorAuxiliar Grupo informações do rastreador auxiliar. Ex. Isca, Spy, etc (contingência para rastreamento) Obrigatório caso sId_UtilizaRLAux = "S" ou for requerido pela validação do sub-limite (regras na TAG nVl_Produto) Não DadosSM 0-1
sId_UtilizaRLAux string(1) Identifica se a viagem possui rastreador auxiliar Validar "S" ou "N". Caso não seja informado, utilizará "N" como default Não Não 0-1
sTp_InstRastrLoc string(1) Identifica o tipo de instalação do rastreador/localizador Obrigatório se sId_UtilizaRlAux = "S". Validar: F = Fixo / S = Spy (Móvel) / I = Isca de Carga (móvel) Sim Não 1-1
iCd_TecnologiaRLAux Num(4) Código da Tecnologia de Rastreamento Auxiliar Validar pela Tabela de Tecnologias de Rastreamento Sim Não 1-1
iCd_ModRLAux string(15) Código do modelo do rastreador auxiliar na Tecnologia de Rastreamento Pode ser utilizado o código do integrador. Ver em Tabelas Associativas-Modelos de Rastreadores. Se não utilizar código do integrador, o campo utilizará o tipo num(4) Sim Não 1-1
sCd_SerialRLAux String(20) Código do serial do rastreador auxiliar Sim Não 1-1
FaixasTemperatura Grupo informações de faixa de temperatura para controle em viagem Obrigatório caso TAG sId_CtrlTemperatura = "S" Não DadosSM 0-1
sId_CtrlTemperatura string(1) Identifica se a viagem possui controle de temperatura Validar "S" ou "N". Caso não seja informado, utilizará "N" como default Não Não 0-1
nFx_TemperMin Num(2v2) Temperatura mínima para controle no transporte Obrigatório somente se sId_CtrlTemperatura = "S" Sim Não 1-1
nFx_TemperMax Num(2v2) Temperatura máxima para controle no transporte Obrigatório somente se sId_CtrlTemperatura = "S" Sim Não 1-1
PolylineRota Grupo contendo a rota no formato polyline Utilizado para pré-traçar a rota no sistema
sNmPadrao String Nome da Origem da Polyline Se for uma Polyline gerada pelo Google Maps informar (Google), se for do Here Maps informart (Here)
sPolyline String Polyline codificada da rota
sNm_UserCliente String(20) Nome do usuário(lado do cliente) que está fazendo a Solicitação de monitoramento. Somente para controle do cliente, caso ele precise saber quem fez a SM. Não Não 0-1

Exemplo do Envio/Retorno para inclusão de solicitação de monitoramento

XML de Envio


<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Set_SolicitaMonitoramentoV3 xmlns="http://tempuri.org/">
      <Login>
        <sUserName>string</sUserName>
        <sPassWord>string</sPassWord>
        <sToken>string</sToken>
      </Login>
      <DadosSM>
        <sCd_CnpjUnidNeg>string</sCd_CnpjUnidNeg>
        <sCd_Placa>string</sCd_Placa>
        <ControleAgendamento>
          <sId_AutorizaCklNeg>string</sId_AutorizaCklNeg>
          <sId_UtilizaFormPadrao>string</sId_UtilizaFormPadrao>
          <sId_UtilizaCondPadrao>string</sId_UtilizaCondPadrao>
          <sId_CtrlCarga>string</sId_CtrlCarga>
          <sId_CtrlDescarga>string</sId_CtrlDescarga>
        </ControleAgendamento>
        <ConjuntoViagem>
          <iId_FormacaoCVC>int</iId_FormacaoCVC>
          <sCd_PlacaCarretaCV>
            <string>string</string>
            <string>string</string>
          </sCd_PlacaCarretaCV>
        </ConjuntoViagem>
        <CondutoresViagem>
          <sNo_CpfCondutorPrinc>string</sNo_CpfCondutorPrinc>
          <sNo_CpfCondutorAux>string</sNo_CpfCondutorAux>
        </CondutoresViagem>
        <DadosAjudantes>
          <iQt_Ajudantes>int</iQt_Ajudantes>
          <sNo_CpfAjudante>
            <string>string</string>
            <string>string</string>
          </sNo_CpfAjudante>
        </DadosAjudantes>
        <ControleDDR>
          <sId_Ddr>string</sId_Ddr>
          <iCd_SeguradoraDdr>int</iCd_SeguradoraDdr>
          <sCd_CnpjEmbarcDdr>string</sCd_CnpjEmbarcDdr>
        </ControleDDR>
        <DadosViagem>
          <sCd_Rota>string</sCd_Rota>
          <sCd_MunicipioOrigem>string</sCd_MunicipioOrigem>
          <sCd_MunicipioDestino>string</sCd_MunicipioDestino>
          <dDh_PrevInicio>dateTime</dDh_PrevInicio>
          <dDh_PrevFim>dateTime</dDh_PrevFim>
          <sId_OperTransp>string</sId_OperTransp>
          <nVl_Carga>decimal</nVl_Carga>
          <sCd_CnpjEmbarcViagem>string</sCd_CnpjEmbarcViagem>
          <EnderecoOrigem>
            <sCEP>string</sCEP>
            <sNm_Endereco>string</sNm_Endereco>
            <sNo_Endereco>string</sNo_Endereco>
            <sNm_Bairro>string</sNm_Bairro>
          </EnderecoOrigem>
          <EnderecoDestino>
            <sCEP>string</sCEP>
            <sNm_Endereco>string</sNm_Endereco>
            <sNo_Endereco>string</sNo_Endereco>
            <sNm_Bairro>string</sNm_Bairro>
          </EnderecoDestino>
          <DadosObsViagem>
            <sDc_ObsGEN>string</sDc_ObsGEN>
            <sDc_ObsOGR>string</sDc_ObsOGR>
            <sDc_ObsOFV>string</sDc_ObsOFV>
          </DadosObsViagem>
          <DadosTranspTerceiro>
            <sId_TranspTerceiro>string</sId_TranspTerceiro>
            <sCd_CnpjTransp>string</sCd_CnpjTransp>
          </DadosTranspTerceiro>
          <SequenciaOperacao>
            <stSequenciaOperacaoV3>
              <sId_Operacao>string</sId_Operacao>
              <sCd_MunicipioOper>string</sCd_MunicipioOper>
              <sDc_LocalOperacao>string</sDc_LocalOperacao>
              <sCd_CnpjEmbarcCliente>string</sCd_CnpjEmbarcCliente>
              <sCEP>string</sCEP>
              <sNm_Endereco>string</sNm_Endereco>
              <sNo_Endereco>string</sNo_Endereco>
              <sNm_Bairro>string</sNm_Bairro>
              <sCd_Produto>string</sCd_Produto>
              <nVl_Produto>decimal</nVl_Produto>
              <dDh_PrevisaoChegada>dateTime</dDh_PrevisaoChegada>
              <sId_DetNF>string</sId_DetNF>
              <DadosNotas>
                <stDadosNotas>
                  <iNo_NotaFiscal>int</iNo_NotaFiscal>
                  <sChaveNFe>string</sChaveNFe>
                </stDadosNotas>
                <stDadosNotas>
                  <iNo_NotaFiscal>int</iNo_NotaFiscal>
                  <sChaveNFe>string</sChaveNFe>
                </stDadosNotas>
              </DadosNotas>
            </stSequenciaOperacaoV3>
            <stSequenciaOperacaoV3>
              <sId_Operacao>string</sId_Operacao>
              <sCd_MunicipioOper>string</sCd_MunicipioOper>
              <sDc_LocalOperacao>string</sDc_LocalOperacao>
              <sCd_CnpjEmbarcCliente>string</sCd_CnpjEmbarcCliente>
              <sCEP>string</sCEP>
              <sNm_Endereco>string</sNm_Endereco>
              <sNo_Endereco>string</sNo_Endereco>
              <sNm_Bairro>string</sNm_Bairro>
              <sCd_Produto>string</sCd_Produto>
              <nVl_Produto>decimal</nVl_Produto>
              <dDh_PrevisaoChegada>dateTime</dDh_PrevisaoChegada>
              <sId_DetNF>string</sId_DetNF>
              <DadosNotas>
                <stDadosNotas>
                  <iNo_NotaFiscal>int</iNo_NotaFiscal>
                  <sChaveNFe>string</sChaveNFe>
                </stDadosNotas>
                <stDadosNotas>
                  <iNo_NotaFiscal>int</iNo_NotaFiscal>
                  <sChaveNFe>string</sChaveNFe>
                </stDadosNotas>
              </DadosNotas>
            </stSequenciaOperacaoV3>
          </SequenciaOperacao>
        </DadosViagem>
        <DadosEscolta>
          <sId_PossuiEscolta>string</sId_PossuiEscolta>
          <sCd_CnpjEmpEscolta>string</sCd_CnpjEmpEscolta>
          <sCd_PlacaEscolta>string</sCd_PlacaEscolta>
          <sCd_CpfAgenteEscolta>
            <string>string</string>
            <string>string</string>
          </sCd_CpfAgenteEscolta>
        </DadosEscolta>
        <RastreadorAuxiliar>
          <sId_UtilizaRLAux>string</sId_UtilizaRLAux>
          <Rastreadores>
            <stRastreadores>
              <sTp_InstRastrLoc>string</sTp_InstRastrLoc>
              <iCd_TecnologiaRLAux>int</iCd_TecnologiaRLAux>
              <iCd_ModRLAux>int</iCd_ModRLAux>
              <sCd_SerialRLAux>string</sCd_SerialRLAux>
            </stRastreadores>
            <stRastreadores>
              <sTp_InstRastrLoc>string</sTp_InstRastrLoc>
              <iCd_TecnologiaRLAux>int</iCd_TecnologiaRLAux>
              <iCd_ModRLAux>int</iCd_ModRLAux>
              <sCd_SerialRLAux>string</sCd_SerialRLAux>
            </stRastreadores>
          </Rastreadores>
        </RastreadorAuxiliar>
        <FaixasTemperatura>
          <sId_CtrlTemperatura>string</sId_CtrlTemperatura>
          <nFx_TemperMin>decimal</nFx_TemperMin>
          <nFx_TemperMax>decimal</nFx_TemperMax>
        </FaixasTemperatura>
        <PolylineRota>
          <sNmPadrao>string</sNmPadrao>
          <sPolyline>string</sPolyline>
        </PolylineRota>
        <sNm_UserCliente>string</sNm_UserCliente>
      </DadosSM>
    </Set_SolicitaMonitoramentoV3>
  </soap:Body>
</soap:Envelope>

XML de Retorno


<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Set_SolicitaMonitoramentoV3Response xmlns="http://tempuri.org/">
      <Set_SolicitaMonitoramentoV3Result>
        <iCd_Viagem>int</iCd_Viagem>
        <sLinkRotograma>string</sLinkRotograma>
        <sLinkTimeLine>string</sLinkTimeLine>
        <Retorno>
          <stResult>
            <sCode>string</sCode>
            <sResult>string</sResult>
          </stResult>
          <stResult>
            <sCode>string</sCode>
            <sResult>string</sResult>
          </stResult>
        </Retorno>
      </Set_SolicitaMonitoramentoV3Result>
    </Set_SolicitaMonitoramentoV3Response>
  </soap:Body>
</soap:Envelope>