Web service Com.senior.g5.co.ger.cad.veiculo
Este web service permite a importar ou excluir os dados de veículos.
Tipo de execução
Para cada tipo de execução, existem diferentes parâmetros que podem ser comuns a todas as portas.
Autenticação
Caso seja utilizada alguma forma de autenticação para integração de informações através de web services, é necessário identificar o tipo no parâmetro <encryption>, conforme seus valores possíveis.
Campos numéricos
Orientação válida para qualquer campo de web service que possui objetivo de receber valores, independentemente do seu tipo ser Integer, Double e String. Estas orientações devem ser seguidas nas requisições efetuadas via SOAP e em execuções efetuadas através do SGI, relatórios e regras LSP.
- Envio no formato ZZZZ,ZZ
- É fundamental não enviar os campos numéricos com separador de milhar, pois ocorrerá erro ao executar a requisição
- Obrigatória a utilização do separador decimal com vírgula, e não com ponto
- Obrigatória a utilização do zero a direita. Por exemplo, se o valor for 350,20, a requisição deve ser enviada com este exato valor. Se o valor enviado for enviado como 350,2, o sistema não irá interpretar a requisição adequadamente
number(005,2) = 350,20 - o sistema espera que o número digitado contenha até 3 casas antes da vírgula e obrigatoriamente duas após;
number(015,2): 35000,20 - o sistema espera que o número digitado contenha até 13 casas antes da vírgula e obrigatoriamente duas após;
number(008,4) = 3200,2074 - o sistema espera que o número digitado contenha até 4 casas antes da vírgula e obrigatoriamente duas após.
- Envio no formato ZZZZ.ZZ
- É fundamental não enviar os campos numéricos com separador de milhar, pois ocorrerá erro ao executar a requisição
- Obrigatória a utilização do separador decimal com ponto, e não com vírgula
- number(005,2) = 350.20 - o sistema espera que o número digitado contenha até 3 casas antes da vírgula e obrigatoriamente duas após;
- number(015,2): 35000.20 - o sistema espera que o número digitado contenha até 13 casas antes da vírgula e obrigatoriamente duas após;
- number(008,4) = 3200.2074 - o sistema espera que o número digitado contenha até 4 casas antes da vírgula e obrigatoriamente duas após.
WSDL
- Síncrono: `http://servidor:1234/g5-senior-services/sapiens_Synccom_senior_g5_co_ger_cad_veiculo?wsdl`
- Assíncrono: `http://servidor:1234/g5-senior-services/sapiens_Asynccom_senior_g5_co_ger_cad_veiculo?wsdl`
- Agendado: `http://servidor:1234/g5-senior-services/sapiens_Schedulecom_senior_g5_co_ger_cad_veiculo?wsdl`
Portas
Necessita autenticação: Sim.
Situação da versão: Atual.
Versão: 1.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:Importar> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <Veiculo> <codTra>Integer</codTra> <plaVei>String</plaVei> <ufsVei>String</ufsVei> <cepVei>Integer</cepVei> <codMar>Integer</codMar> <codMod>Integer</codMod> <anoVei>String</anoVei> <codCor>Integer</codCor> <codTip>Integer</codTip> <pesMax>Double</pesMax> <numCer>String</numCer> <chaVei>String</chaVei> <codVia>String</codVia> <claVei>String</claVei> <datCom>DateTime</datCom> <datVen>DateTime</datVen> <sitVei>String</sitVei> <tarVei>Double</tarVei> <numRen>String</numRen> <visIni>DateTime</visIni> <visFim>DateTime</visFim> <visVsa>DateTime</visVsa> <volMax>Double</volMax> <codMot>Integer</codMot> <obsMot>String</obsMot> <seqCav>Integer</seqCav> <eenVei>String</eenVei> <forFre>Integer</forFre> <ctrEnt>String</ctrEnt> <qtdPor>Integer</qtdPor> <proVei>String</proVei> <tipRod>String</tipRod> <tipCrr>String</tipCrr> <nrnTrc>String</nrnTrc> </Veiculo> </parameters> </ser:Importar> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Preenchimento | Ajuda |
---|---|---|---|
veiculo | Set | Opcional | Lista de veículos |
veiculo.codTra | Integer | Opcional | Number(009) - Código da Transportadora |
veiculo.plaVei | String | Opcional | String(010) - Placa do veículo |
veiculo.ufsVei | String | Opcional | String(002) - Sigla do estado do veículo |
veiculo.cepVei | Integer | Opcional | Number(008) - CEP da cidade do veículo |
veiculo.codMar | Integer | Opcional | Number(004) - Código da marca do veículo |
veiculo.codMod | Integer | Opcional | Number(004) - Código do modelo do veículo |
veiculo.anoVei | String | Opcional | String(010) - Ano do veículo |
veiculo.codCor | Integer | Opcional | Number(004) - Código da Cor |
veiculo.codTip | Integer | Opcional | Number(004) - Código do tipo de veículo |
veiculo.pesMax | Double | Opcional | Number(011,2) - Peso Máximo |
veiculo.numCer | String | Opcional | String(030) - Certificado do Proprietário |
veiculo.chaVei | String | Opcional | String(050) - Chassi do veículo |
veiculo.codVia | String | Opcional | String(003) - Código da via de transporte do veículo |
veiculo.claVei | String | Opcional | String(001) - Classificação do veículo - [ C=Cavalo;R=Reboque ] |
veiculo.datCom | DateTime | Opcional | Date(DD/MM/YYYY) - Data da compra do veículo |
veiculo.datVen | DateTime | Opcional | Date(DD/MM/YYYY) - Data da Venda do Veículo |
veiculo.sitVei | String | Opcional | String(001) - Situação do veículo - [ A=Ativo;I=Inativo ] |
veiculo.tarVei | Double | Opcional | Number(011,2) - Tara do veículo |
veiculo.numRen | String | Opcional | String(020) - Renavam |
veiculo.visIni | DateTime | Opcional | Date(DD/MM/YYYY) - Data início vistoria |
veiculo.visFim | DateTime | Opcional | Date(DD/MM/YYYY) - Data final da vistoria |
veiculo.visVsa | DateTime | Opcional | Date(DD/MM/YYYY) - Data da inspeção do veículo na empresa |
veiculo.volMax | Double | Opcional | Number(011,2) - Volume máximo do veículo |
veiculo.codMot | Integer | Opcional | Number(006) - Código do motivo da situação do veículo |
veiculo.obsMot | String | Opcional | String(250) - Observação do motivo da situação |
veiculo.seqCav | Integer | Opcional | Number(006) - Sequência de cadastramento do veículo |
veiculo.eenVei | String | Opcional | String(018) - Código do endereço do veículo |
veiculo.forFre | Integer | Opcional | Number(009) - Código do fornecedor para geração título de frete |
veiculo.ctrEnt | String | Opcional | String(001) - Indicativo se o veículo faz parte do controle de entrega de mercadorias - [ S=Sim;N=Não ] |
veiculo.qtdPor | Integer | Opcional | Number(004) - Quantidade portas do veículo para utilizar lacres |
veiculo.proVei | String | Opcional | String(001) - Tipo do proprietário do veículo - [ P=Próprio;T=Terceiro ] |
veiculo.tipRod | String | Opcional | String(002) - Tipo de rodado do veículo - [ 01=Truck;02=Toco;03=Cavalo mecânico;04=Van;05=Utilitário;06=Outros ] |
veiculo.tipCrr | String | Opcional | String(002) - Tipo de carroceria do veículo - [ 00=Não aplicável;01=Aberta;02=Fechada/Baú;03=Granelera;04=Porta conteiner;05=Sider ] |
veiculo.nrnTrc | String | Opcional | String(014) - Registro nacional de transportadores rodoviários de carga - RNTRC |
Observação
Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ImportarResponse> <result> <Retornos> <codTra>Integer</codTra> <plaVei>String</plaVei> <tipoRetorno>String</tipoRetorno> <mensagemRetorno>String</mensagemRetorno> </Retornos> <tipoRetorno>Integer</tipoRetorno> <mensagemRetorno>String</mensagemRetorno> <erroExecucao>String</erroExecucao> </result> </ser:ImportarResponse> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Ajuda |
---|---|---|
retornos | Opcional | (Obrigatório) - Lista de retornos |
retornos.codTra | Integer | (Obrigatório) - Código da Transportadora |
retornos.plaVei | String | (Obrigatório) - Placa do veículo |
retornos.tipoRetorno | String | (Obrigatório) - Número(001) - Tipo de Retorno de Processamento - Lista: 0 = Processado, -1 = Erro na Solicitação |
retornos.mensagemRetorno | String | (Opcional) - Descrição do erro |
tipoRetorno | Integer | (Obrigatório) - Número(001) - Tipo de Retorno de Processamento - Lista: 0 = Processado, -1 = Erro na Solicitação |
mensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
erroExecucao | String | Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores: - Vazio ou nulo, indicando que a execução foi feita com sucesso; - A mensagem do erro ocorrido no servidor. |
Necessita autenticação: Sim.
Situação da versão: Atual.
Versão: 1.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:Excluir> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <Veiculo> <codTra>Integer</codTra> <plaVei>String</plaVei> </Veiculo> </parameters> </ser:Excluir> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Preenchimento | Ajuda |
---|---|---|---|
veiculo | Set | Opcional | Lista de veículos |
veiculo.codTra | Integer | Opcional | Number(009) - Código da Transportadora |
veiculo.plaVei | String | Opcional | String(010) - Placa do veículo |
Observação
Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ExcluirResponse> <result> <tipoRetorno>Integer</tipoRetorno> <Retorno> <codTra>Integer</codTra> <plaVei>String</plaVei> <tipoRetorno>Integer</tipoRetorno> <mensagemRetorno>String</mensagemRetorno> </Retorno> <mensagemRetorno>String</mensagemRetorno> <erroExecucao>String</erroExecucao> </result> </ser:ExcluirResponse> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Ajuda |
---|---|---|
tipoRetorno | Integer | (Obrigatório) - Número(001) - Tipo de Retorno de Processamento - Lista: 0 = Processado, -1 = Erro na Solicitação |
retorno | Set | Lista de veículos |
retorno.codTra | Integer | Number(009) - Código da Transportadora |
retorno.plaVei | String | String(010) - Placa do veículo |
retorno.tipoRetorno | Integer | (Obrigatório) - Número(001) - Tipo de Retorno de Processamento - Lista: 0 = Processado, -1 = Erro na Solicitação |
retorno.mensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
mensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
erroExecucao | String | Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores: - Vazio ou nulo, indicando que a execução foi feita com sucesso; - A mensagem do erro ocorrido no servidor. |