Cadastrar/Alterar Dados do Veículo V2

Cadastra/Altera Dados do Veículo (Set_AlteraVeiculoV2)

O método funciona para cadastro e alteração de dados do veículo pode ser utilizado para ajustar informações de um único campo ou vários campos da tabela de veículos (caminhões, cavalos mecânicos e carretas) nos cadastros do cliente na empresa NoxGR.

O método também pode ser utilizado para:

Alterar o rastreador do veículo;
Tornar o veículo Ativo ou Inativo;
Alterar forma de faturamento (fixo ou embarque);
Associar carretas em formação padrão (conjunto-viagem);
Associar condutor padrão ao veículo;
Alterar o perfil securitário;
Alterar perfil do veículo (autônomo para agregado, agregado para frota, etc);
Efetuar a substituição do rastreador;
Solicitar inclusão ou exclusão do sinal do rastreador;
Simples alteração de dados do veículo;
Inclusão do veiculo caso o mesmo não exista na base;
Cadastrar Carretas;

Esse método também poderá ser utilizado para solicitação de inclusão de veículo, caso o mesmo ainda não exista na base de dados. Para que essa funcionalidade tenha efeito, todos os dados de inclusão de veículo que são obrigatórios devem ser enviados (note que alguns campos são obrigatórios para inclusão porém não necessariamente precisam ser enviados na integração pois possuem valores “default”) bem como deve haver a informação solicitando a inclusão em caso de inexistência do cadastro (iId_AutoInclusao = “S”).

Caso esteja utilizando esse método na função “alteração” (com sId_AutoInclusao = “N” ou se sId_AutoInclusao não for informado na integração), observar os campos que permitem alteração (ver coluna “permite alteração” na tabela de detalhamento de campos/grupos).

Importante

O processo funciona da seguinte maneira:
1) Cadastro do Cavalo, usando sTp_Veiculo=1
2) Cadastro da Carreta, usando sTp_Veiculo=3
3) Vinculo da Carreta ao cavalo, enviando a estrutura novamente com a placa na tag sCd_PlacaCarreta dentro da string

Atualização V2

Para funcionamento do método de Solicitação de Perfil securitário é necessário realizar a atualização para este método atual do Cadastro/Altera Veículo.

Foram adicionados as tags do conjunto ListaDocumentos para envio de documentos a serem utilizados pela solicitação de Perfil Securitário

Tabela de detalhamento de campos/grupos para alteração/inclusão de veículos

Grupo/Campo	Tipo	Descrição	Observação	Obrig	Permite Alteração	Pai	Ocor
DadosAV		Grupo geral da alteração	Necessário apresentar ao menos uma TAG relacionada nesse grupo				1-1
sCd_CnpjUnidNeg	Num(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	Formato AAA-9999	Sim-chave	Não		1-1
sTp_Veiculo	String(1)	Tipo de veiculo	1= Cavalo/ 2= Caminhão/ 3= Veiculo de Carga(carreta)	Sim-chave	Não		1-1
sId_AutoInclusao	String(1)	Autorização de inclusão	S = inclusão automática / N = não permite inclusão	Não	Não		0-1
DadosVeiculo		Grupo informações do Veículo	Necessário apresentar ao menos uma TAG relacionada nesse grupo	Não		DadosAV	1-1
sCd_ExclusivoCliente	String(15)	Código de identificação do cliente para veículo (frota)	Código próprio que o cliente utiliza para identificação	Não	Sim		0-1
iCd_Renavam	Num(11)	Código do RENAVAM	Completar com zeros a esquerda	Não	Sim		0-1
sCd_Chassi	String(17)	Chassi do Veiculo	Se informado deve ter tamanho de 17 caracteres, não iniciar com ZERO e os últimos 4 dígitos devem ser numéricos	Não	Sim		0-1
sNm_Cor	String(30)	Cor do Veiculo	Minimo 4 caracteres	Sim(***)	Sim		0-1
iAa_Fabricacao	Num(4)	Ano de Fabricação		Sim(***)	Não		0-1
iAa_Modelo	Num(4)	Ano do Modelo	Maior ou igual ao ano de fabricação	Sim(***)	Não		0-1
iCd_Carroceria(*)	Num(2)	Tipo de Carroceria	Validar pela Tabela de Tipos de Carrocerias. Se não for informado na inclusão utilizará padrão "NAO DEFINIDO"	Sim(***)	Sim		0-1
sCd_ModeloVeiculo(*)	string(15)	Modelo do Veiculo	Somente para sTp_Veiculo = 1 ou 2. Como estamos sempre adicionando novos modelos é necessário realizar uma consulta utilizando o metódo Consulta Modelos. Se não for informado na inclusão, utilizará padrão "indefinido".	Sim(***)	Sim		0-1
sCd_MarcaVeiCarga(**)	String(15)	Marca da Scarreta	Somente para sTp_Veiculo = 3. Ver em Tabela Marcas Carretas. Se não for informado na inclusão utilizará padrão "indefinido". Se não utilizar código do integrador, o campo utilizará o tipo num(4)	Sim(***)			0-1
sId_VeiculoCarga(**)	string(15)	Tipo da Carreta	Somente para sTp_Veiculo = 3. Pode ser Ver em Tabelas Tipos de Carrocerias. Se não for informado na inclusão utilizará padrão "indefinido". Se não utilizar código do integrador, o campo utilizará o tipo num(4)	Sim(***)	Sim		0-1
sId_VincVeiculo	String(1)	Vinculo do Veículo	Validar pela Tabela de Vinculo de Veículo	Sim(***)	Sim		0-1
sCd_MunLicenc	string(15)	Município do Licenciamento	Utilizar o código do IBGE. Disponível em IBGE. Se não for informado na inclusão utilizará padrão "indefinido". Se não utilizar código do integrador, o campo utilizará o tipo num(8)	Sim(***)	Sim		0-1
dDt_Aquisicao	Date	Data de Aquisição	Formato AAAA-MM-DD	Não	Sim		0-1
dDt_Venda	Date	Data de Aquisição	Formato AAAA-MM-DD	Não	Sim		0-1
sId_Ativo	String(1)	Descrição	A = ativo / I = inativo. Se não for informado na inclusão, utilizará padrão="A"	Sim(***)	Sim		0-1
sDc_Obs	String(128)	Observações Gerais	Observação livre	Não	Sim		0-1
sCd_ANTT	string(8)	Código ANTT do Veículo		Sim	Sim		0-1
dDt_ValidadeANTT	date	Data de Validade da ANTT do Veículo		Sim	Sim		0-1
DadosFaturamento		Grupo informações para Faturamento		Não		DadosAV	0-1
sTp_Faturamento(*)	String(1)	Tipo de Faturamento	A = avulso (embarque) ou F = Fixo. Se não for informado na inclusão utilizará padrão="A"	Sim(***)	Sim		1-1
sId_FormaFixo	String(1)	Forma de Cobrança	F= frota / A= Agregado / D= Dedicado / V=Visualização / T=Telemonitorado. Obrigatório caso sTp_Faturamento = F	Não	Sim		0-1
DadosProprietario		Grupo informações dados do proprietário	Somente se for veiculo de terceiro	Não		DadosAV	0-1
sCd_CnpjPropVeiculo	String(14)	CNPJ do proprietário do veiculo (14 dígitos), se for pessoa física, informar o CPF (11 dígitos)	Completar com zeros a esquerda	Não	Sim		0-1
sNm_PropVeiculo	String(60)	Nome do proprietário do veiculo		Não	Sim		1-1
sNo_FonePropVeiculo	String(15)	Telefone do proprietário do veículo		Não	Sim		0-1
DadosSerial		Grupo informações do rastreador	Somente se for veículo trator	Não		DadosAV	0-1
iCd_Tecnologia(*)	Num(4)	Código da Tecnologia de Rastreamento	Validar pela Tabela de Tecnologias de Rastreamento	Sim(***)	Sim		1-1
sCd_ModRastreador(*)	string(15)	Código do modelo do rastreador na Tecnologia de Rastreamento	Ver em Tabela Modelos de Rastreadores. Se não utilizar código do integrador, o campo utilizará o tipo num(4)	Sim(***)	Sim		1-1
sCd_SerialRastreador(*)	String(20)	Código do serial do rastreador	Como Remover um Serial	Sim(***)	Sim		1-1
DadosFormacaoPadrao		Grupo informações da formação padrão conjunto-viagem	Somente se for veículo trator	Não		DadosAV	0-1
sId_FormPadrao(*)	Num(2)	Formação Padrão	Tabela de Formação Padrão	Não	Sim		1-1
sCd_PlacaCarreta		Grupo de carretas associadas a formação padrão		Não		DadosFormacaoPadrao	1-1
sCd_PlacaCarreta(*)	String(8)	Placa da Carreta	Formato AAA-9999	Não	Sim		1-n
DadosCondutorPadrao		Grupo de informações do condutor padrão		Não		DadosAV	0-1
sNo_CpfCondutor(*)	Num(11)	CPF do condutor padrão do veiculo	Completar com zeros a esquerda	Não	Sim		1-1
DadosPerfSecCondutor		Grupo de informações do perfil securitário do condutor padrão	Somente se informado dados do condutor padrão	Não		DadosCondutorPadrao	0-1
iCd_FornecPerfSec	Num(4)	Código do Fornecedor do Perfil Securitário	Tabela de Empresas Perfil Securitário	Não	Sim		1-1
sId_VincCondutorPS	string(1)	Identifica o Vinculo do Condutor	Tabela de Vínculos do Condutor	Não	Sim		1-1
sCd_PesquisaPS	string(20)	Código da pesquisa no fornecedor	Não pode existir código duplicado para um mesmo fornecedor de perfil securitário	Não	Sim		1-1
dDt_PesquisaPS	date	Data da Pesquisa	Formato "AAAA-MM-DD".	Não	Sim		1-1
dDt_ValidadePS	date	Data de Validade	Formato "AAAA-MM-DD". Data de validade não pode ser superior a 365 dias da data da pesquisa para "CLT" ou 180 dias para "Agregados" ou 30 dias para "Terceiros-Autonomos)	Não	Sim		1-1
DadosTransfSinal		Grupo informações para possibilitar inclusão ou exclusão de sinal do veículo		Não		DadosAV	0-1
sId_IncExcSinal	string(1)	Identifica se Deve incluir ou Excluir o Sinal	I = Inclui Sinal, E= Excluir Sinal	Não	Sim		1-1
sCd_CnpjEmpDet	String(14)	CNPJ da empresa detentora do sinal ou que receberá o sinal	Completar com zeros a esquerda	Sim	Sim		1-1
sNm_EmpDet	String(60)	Nome da Empresa	Nome da empresa que receberá o sinal ou da empresa que irá disponibilizar o sinal. Converter para maiúsculas antes de validar	Sim	Sim		1-1
sNm_FantasiaEmpDet	String(25)	Nome Fantasia da Empresa	Nome fantasia da empresa que receberá o sinal ou da empresa que irá disponibilizar o sinal. Converter para maiúsculas antes de validar	Sim	Sim		1-1
sCd_AutotracID	String(12)	ID Autotrac da Empresa	ID Autotrac da empresa que receberá o sinal ou da empresa que irá disponibilizar o sinal. Converter para minúsculas antes de validar	Não	Sim		0-1
sCd_AutotracUA	String(12)	UA Autotrac da Empresa	UA Autotrac da empresa que receberá o sinal ou da empresa que irá disponibilizar o sinal. Converter para minúsculas antes de validar	Não	Sim		0-1
sNo_TelefEmpDet	String(15)	Telefone da empresa	Telefone da empresa que receberá o sinal ou da empresa que irá disponibilizar o sinal	Não	Sim		0-1
sNm_ContatoEmpDet	String(40)	Contato da empresa	Nome do contato que receberá o sinal ou da empresa que irá disponibilizar o sinal. Converter para maiúsculas antes de validar	Sim	Sim		1-1
sDc_EmailCntEmpDet	String(96)	Email do Contato da empresa	Email do contato que receberá o sinal ou da empresa que irá disponibilizar o sinal. Converter para minúsculas antes de validar	Sim	Sim		1-1
sNo_TelefCntEmpDet	String(15)	Telefone do Contato da empresa	Telefone do contato da empresa que receberá o sinal ou da empresa que irá disponibilizar o sinal	Não	Sim		0-1
Responsaveis		Grupo de informações dos Responsaveis		Não	Sim	DadosAv	1-n
stResponsavel		Identificação do Responsável		Não	Sim	Responsaveis	1-1
stTp_Contato	String(48)	Identificação do Tipo de Contato		Não	Sim		1-1
sNm_Contato	String(48)	Numero do Contato do Responsável		Não	Sim		1-1
iCd_DDD	Num(2)	DDD do Número do Contato do Responsável		Não	Sim		1-1
sNo_TelContato	String(48)	Nome do Contato		Não	Sim		1-1
iWhatsApp	int	Contato Whatsapp		Não	Sim		1-1
sDc_Email	String(48)	Email de Contato		Não	Sim		1-1
ListaDocumentos		Grupo de Informações sobre os documentos a serem enviados para Perfil Securitário		Não	Sim		1-1
StDocumentos		Grupo Individual para envio de documento		Não	Sim		1-1
sTipo	String(4)	Tipo de Documento	Enviar parametros: CRLV, MOPP, FOTO ou OUTROS	Não	Sim		1-1
sLink	String(124)	Link do Documento	Link do Upload da imagem, é necessário ser de acesso livre para que o sistema possa baixa-la	Não	Sim		1-1

(*) Somente para veículo trator (Caminhão ou Cavalo Mecânico)

(**) Somente para veículo de carga (carreta)

(***) Obrigatório somente para inclusão

Exemplo do Envio/Retorno para alteração de dados do condutor

XML de Envio

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Set_AlteraVeiculoV2 xmlns="http://tempuri.org/">
      <Login>
        <sUserName>string</sUserName>
        <sPassWord>string</sPassWord>
        <sToken>string</sToken>
      </Login>
      <DadosAV>
        <sCd_CnpjUnidNeg>string</sCd_CnpjUnidNeg>
        <sCd_Placa>string</sCd_Placa>
        <sTp_Veiculo>string</sTp_Veiculo>
        <sId_AutoInclusao>string</sId_AutoInclusao>
        <DadosVeiculo>
          <sCd_ExclusivoCliente>string</sCd_ExclusivoCliente>
          <iCd_Renavam>string</iCd_Renavam>
          <sCd_Chassi>string</sCd_Chassi>
          <sNm_Cor>string</sNm_Cor>
          <iAa_Fabricacao>int</iAa_Fabricacao>
          <iAa_Modelo>int</iAa_Modelo>
          <iCd_Carroceria>int</iCd_Carroceria>
          <sCd_ModeloVeiculo>string</sCd_ModeloVeiculo>
          <sCd_MarcaVeiCarga>string</sCd_MarcaVeiCarga>
          <sId_VeiculoCarga>string</sId_VeiculoCarga>
          <sId_VincVeiculo>string</sId_VincVeiculo>
          <sCd_MunLicenc>string</sCd_MunLicenc>
          <dDt_Aquisicao>date</dDt_Aquisicao>
          <dDt_Venda>date</dDt_Venda>
          <sId_Ativo>string</sId_Ativo>
          <sDc_Obs>string</sDc_Obs>
          <sCd_ANTT>string</sCd_ANTT>
          <dDt_ValidadeANTT>date</dDt_ValidadeANTT>
        </DadosVeiculo>
        <DadosFaturamento>
          <sTp_Faturamento>string</sTp_Faturamento>
          <sId_FormaFixo>string</sId_FormaFixo>
        </DadosFaturamento>
        <DadosProprietario>
          <sCd_CnpjPropVeiculo>string</sCd_CnpjPropVeiculo>
          <sNm_PropVeiculo>string</sNm_PropVeiculo>
          <sNo_FonePropVeiculo>string</sNo_FonePropVeiculo>
        </DadosProprietario>
        <DadosSerial>
          <iCd_Tecnologia>int</iCd_Tecnologia>
          <sCd_ModRastreador>string</sCd_ModRastreador>
          <sCd_SerialRastreador>string</sCd_SerialRastreador>
        </DadosSerial>
        <DadosFormacaoPadrao>
          <sId_FormPadrao>int</sId_FormPadrao>
          <sCd_PlacaCarreta>
            <string>string</string>
            <string>string</string>
          </sCd_PlacaCarreta>
        </DadosFormacaoPadrao>
        <DadosCondutorPadrao>
          <sNo_CpfCondutor>string</sNo_CpfCondutor>
          <DadosPerfSecCondutor>
            <iCd_FornecPerfSec>int</iCd_FornecPerfSec>
            <sId_VincCondutorPS>string</sId_VincCondutorPS>
            <sCd_PesquisaPS>string</sCd_PesquisaPS>
            <dDt_PesquisaPS>date</dDt_PesquisaPS>
            <dDt_ValidadePS>date</dDt_ValidadePS>
          </DadosPerfSecCondutor>
        </DadosCondutorPadrao>
        <DadosTransSinal>
          <sId_IncExcSinal>string</sId_IncExcSinal>
          <sCd_CnpjEmpDet>string</sCd_CnpjEmpDet>
          <sNm_EmpDet>string</sNm_EmpDet>
          <sNm_FantasiaEmpDet>string</sNm_FantasiaEmpDet>
          <sCd_AutotracID>string</sCd_AutotracID>
          <sCd_AutotracUA>string</sCd_AutotracUA>
          <sNo_TelefEmpDet>string</sNo_TelefEmpDet>
          <sNm_ContatoEmpDet>string</sNm_ContatoEmpDet>
          <sDc_EmailCntEmpDet>string</sDc_EmailCntEmpDet>
          <sNo_TelefCntEmpDet>string</sNo_TelefCntEmpDet>
        </DadosTransSinal>
        <Responsaveis>
          <stResponsavel>
            <sTp_Contato>string</sTp_Contato>
            <sNm_Contato>string</sNm_Contato>
            <iCd_DDD>int</iCd_DDD>
            <sNo_TelContato>string</sNo_TelContato>
            <iWhatsApp>int</iWhatsApp>
            <sDc_Email>string</sDc_Email>
          </stResponsavel>
          <stResponsavel>
            <sTp_Contato>string</sTp_Contato>
            <sNm_Contato>string</sNm_Contato>
            <iCd_DDD>int</iCd_DDD>
            <sNo_TelContato>string</sNo_TelContato>
            <iWhatsApp>int</iWhatsApp>
            <sDc_Email>string</sDc_Email>
          </stResponsavel>
        </Responsaveis>
        <ListaDocumentos>
          <stDocumento>
            <sTipo>string</sTipo>
            <sLink>string</sLink>
          </stDocumento>
          <stDocumento>
            <sTipo>string</sTipo>
            <sLink>string</sLink>
          </stDocumento>
        </ListaDocumentos>
      </DadosAV>
    </Set_AlteraVeiculoV2>
  </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_AlteraVeiculoResponse xmlns="http://tempuri.org/">
      <Set_AlteraVeiculoResult>
        <Retorno>
          <stResult>
            <sCode>string</sCode>
            <sResult>string</sResult>
          </stResult>
          <stResult>
            <sCode>string</sCode>
            <sResult>string</sResult>
          </stResult>
        </Retorno>
      </Set_AlteraVeiculoResult>
    </Set_AlteraVeiculoResponse>
  </soap:Body>
</soap:Envelope>

Processos automáticos associados a esse método Na inclusão do veiculo, se informado dados de solicitação de sinal, a integração irá gerar processo de solicitação de inclusão do sinal (informações de empresa detentora do sinal e contato serão obrigatórias)

– Na inclusão/alteração de conjunto padrão, caso não exista checklist válido, a integração irá gerar processo de solicitação de checklist do conjunto informado

Remover Serial

Um serial pode ser removido de duas formas:

1 – O Veículo vai ser Inativado por algum motivo, então o campo sId_Ativo deve conter <sId_Ativo>I</sId_Ativo> e o campo <sId_IncExcSinal> deve conter <sId_IncExcSinal>E</sId_IncExcSinal> para que o Sinal seja excluído.

Caso exista alguma viagem em aberto o processo não será concluído. Se o Veículo não for da Empresa solicitante o serial não será desativado, caso isso ocorra entre em contato com o Atendimento da Nox.

2 – Para apenas remover um Serial as Tags (iCd_Tecnologi e sCd_SerialRastreador) devem conter as seguintes informações:

<iCd_Tecnologia>9999</iCd_Tecnologia>
<sCd_SerialRastreador>EMPTY</sCd_SerialRastreador>.

Caso exista alguma viagem em aberto o processo não será concluído. Se o Veículo não for da Empresa solicitante o serial não será desativado, caso isso ocorra entre em contato com o Atendimento da Nox.