Web service Com.senior.g5.co.int.varejo.motoristas
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://example.com/g5-senior-services/sapiens_Synccom_senior_g5_co_int_varejo_motoristas?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_int_varejo_motoristas?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_int_varejo_motoristas?wsdl
Porta
Integrações - Varejo - Cadastros - Exportar Motoristas
Necessita autenticação: Sim
Situação de 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:Exportar> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <consulta> <codTra>Integer</codTra> <codMtr>String</codMtr> </consulta> <codEmp>Integer</codEmp> <codFil>Integer</codFil> <tipoIntegracao>String</tipoIntegracao> <quantidadeRegistros>Integer</quantidadeRegistros> <identificacaoSistema>String</identificacaoSistema> </parameters> </ser:Exportar> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
consulta | Set | (Obrigatório) - Utilizar para informar quais registros devem ser retornados. Utilizar apenas quando o tipo de integração for específico ("E") |
consulta.codTra | Integer | Inteiro - Código da Transportadora - (Obrigatório se tipo de consulta = "E") |
consulta.codMtr | String | (Opcional) - Inteiro - Código do Motorista - Utilizado somente s tipo de consulta = "E" |
codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
tipoIntegracao | String | (Obrigatório) - String(001) - Tipo de Integração - Lista: T = Todos, A = Somente Alterados, E = Registro Específico |
quantidadeRegistros | Integer | (Opcional) - Number(005) - Quantidade de registros limite para retorno da solicitação. Quando o tipo de integração for "E", este valor não é utilizado. |
identificacaoSistema | String | (Obrigatório) - String(15) - - Identificação do sistema integrado |
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:ExportarResponse> <result> <motorista> <codTra>Integer</codTra> <codMtr>Integer</codMtr> <nomMot>String</nomMot> <cgcCpf>String</cgcCpf> <endMot>String</endMot> <cplEnd>String</cplEnd> <baiMot>String</baiMot> <cepMot>Integer</cepMot> <cepIni>Integer</cepIni> <cidMot>String</cidMot> <sigUfs>String</sigUfs> <fonMot>String</fonMot> <fonMo2>String</fonMo2> <faxMot>String</faxMot> <cxaPst>Integer</cxaPst> <intNet>String</intNet> <usuCad>Double</usuCad> <datCad>String</datCad> <horCad>String</horCad> <usuAtu>Double</usuAtu> <datAtu>String</datAtu> <horAtu>String</horAtu> <sitMot>String</sitMot> <codMot>Integer</codMot> <obsMot>String</obsMot> <usuMot>Double</usuMot> <datMot>String</datMot> <horMot>String</horMot> <codPai>String</codPai> <motFor>Integer</motFor> <numCnh>String</numCnh> <vldCnh>String</vldCnh> <emiCnh>String</emiCnh> <catCnh>String</catCnh> <numRge>String</numRge> <orgRge>String</orgRge> <datRge>String</datRge> <datNas>String</datNas> <conMot>String</conMot> <sitLis>String</sitLis> <numPro>String</numPro> <nenMot>String</nenMot> <metMot>Integer</metMot> <vctMet>Integer</vctMet> <perCom>Double</perCom> <seqInt>String</seqInt> </motorista> <gridErros> <msgErr>String</msgErr> </gridErros> <finalizaramRegistros>String</finalizaramRegistros> <tipoRetorno>Integer</tipoRetorno> <mensagemRetorno>String</mensagemRetorno> <numeroLote>Integer</numeroLote> <erroExecucao>String</erroExecucao> </result> </ser:ExportarResponse> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
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 sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |
motorista | Set | Retorna os dados do Motorista |
motorista.codTra | Integer | (Obrigatório) - CodTra - Number(009) - Código da Transportadora |
motorista.codMtr | Integer | (Obrigatório) - CodMtr - Number(006) - Código do Motorista |
motorista.nomMot | String | (Obrigatório) - NomMot - String(100) - Nome do motorista |
motorista.cgcCpf | String | (Opcional) - CgcCpf - String(011) - Número do CPF do motorista |
motorista.endMot | String | (Opcional) - EndMot - String(100) - Endereço do motorista |
motorista.cplEnd | String | (Opcional) - CplEnd - String(200) - Complemento do endereço do motorista (sala, andar, etc.) |
motorista.baiMot | String | (Opcional) - BaiMot - String(075) - Bairro do motorista |
motorista.cepMot | Integer | (Opcional) - CepMot - Number(008) - CEP do motorista |
motorista.cepIni | Integer | (Opcional) - CepIni - Number(008) - Faixa inicial do CEP da cidade do motorista |
motorista.cidMot | String | (Opcional) - CidMot - String(060) - Cidade do motorista |
motorista.sigUfs | String | (Opcional) - SigUfs - String(002) - Estado do motorista |
motorista.fonMot | String | (Opcional) - FonMot - String(020) - Número do telefone - 1 |
motorista.fonMo2 | String | (Opcional) - FonMo2 - String(020) - Número do telefone - 2 |
motorista.faxMot | String | (Opcional) - FaxMot - String(020) - Número do FAX do motorista |
motorista.cxaPst | Integer | (Opcional) - CxaPst - Number(006) - Número da caixa postal do motorista |
motorista.intNet | String | (Opcional) - IntNet - String(100) - Endereço eletrônico (e-mail) |
motorista.usuCad | Double | (Opcional) - UsuCad - Number(010,0) - Usuário responsável pelo cadastramento |
motorista.datCad | DateTime | (Opcional) - DatCad - Date(DD/MM/YYYY) - Data do cadastramento do motorista |
motorista.horCad | String | (Opcional) - HorCad - Time(HH:MM) - Hora/minuto do cadastramento |
motorista.usuAtu | Double | (Opcional) - UsuAtu - Number(010,0) - Usuário responsável pela última atualização |
motorista.datAtu | DateTime | (Opcional) - DatAtu - Date(DD/MM/YYYY) - Data da última atualização do cadastro |
motorista.horAtu | String | (Opcional) - HorAtu - Time(HH:MM) - Hora/minuto da última atualização do cadastro |
motorista.sitMot | String | (Obrigatório) - SitMot - String(001) - Situação do motorista Lista: D = Disponível, O = Ocupado, B = Bloqueado, I = Inativo |
motorista.codMot | Integer | (Opcional) - CodMot - Number(006) - Código do motivo da situação do motorista |
motorista.obsMot | String | (Opcional) - ObsMot - String(250) - Observação do motivo da situação |
motorista.usuMot | Double | (Opcional) - UsuMot - Number(010,0) - Usuário responsável pelo motivo da situação |
motorista.datMot | DateTime | (Opcional) - DatMot - Date(DD/MM/YYYY) - Data do motivo da situação |
motorista.horMot | String | (Opcional) - HorMot - Time(HH:MM) - Hora do motivo da situação |
motorista.codPai | String | (Opcional) - CodPai - String(004) - Código do país |
motorista.motFor | Integer | (Opcional) - MotFor - Number(009) - Código do motorista como fornecedor |
motorista.numCnh | String | (Opcional) - NumCnh - String(030) - Habilitação do motorista |
motorista.vldCnh | DateTime | (Opcional) - VldCnh - Date(DD/MM/YYYY) - Validade da Habilitação do motorista |
motorista.emiCnh | DateTime | (Opcional) - EmiCnh - Date(DD/MM/YYYY) - Emissão da Habilitação do motorista |
motorista.catCnh | String | (Opcional) - CatCnh - String(002) - Categoria da habilitação do motorista Lista: A = veículo de 2 ou 3 rodas, com motor de propulsão., B = veículo com até 3500 kg e até 8 lugares além do condutor, C = veículo usado no transporte de carga e cujo peso exceda 3500 kg, D = veículo para transporte de passageiro com mais de 8 lugares, E = veículos que se enquadram na categoria "B", "C" ou "D" e a unidade acoplada tenha 6000 kg de peso bruto total ou mais, a lotação exceda 8 lugares ou ainda se enquadre na categoria trailler., AB = Categoria A + Categoria B, AC = Categoria A + Categoria C, AD = Categoria A + Categoria D, AE = Categoria A + Categoria E |
motorista.numRge | String | (Opcional) - NumRge - String(013) - Número do RG (Identidade) |
motorista.orgRge | String | (Opcional) - OrgRge - String(005) - Órgão emissor do RG |
motorista.datRge | DateTime | (Opcional) - DatRge - Date(DD/MM/YYYY) - Data de emissão do RG |
motorista.datNas | DateTime | (Opcional) - DatNas - Date(DD/MM/YYYY) - Data do nascimento do motorista |
motorista.conMot | String | (Opcional) - ConMot - String(001) - Conceito do Motorista |
motorista.sitLis | String | (Opcional) - SitLis - String(001) - Situação do Check List Lista: A = Aprovado, R = Reprovado, N = Não Analisado, I = Ignorado |
motorista.numPro | String | (Opcional) - NumPro - String(015) - Número do prontuário |
motorista.nenMot | String | (Opcional) - NenMot - String(060) - Número do endereço do motorista |
motorista.metMot | Integer | (Opcional) - MetMot - Number(004) - Meta de entregas do motorista no período |
motorista.vctMet | Integer | (Opcional) - VctMet - Number(004) - Data limite para o fechamento da meta mensal de entregas |
motorista.perCom | Double | (Opcional) - PerCom - Number(005,2) - Percentual de comissão a ser pago ao motorista quando ultrapassar a meta |
motorista.seqInt | String | (Obrigatório) - SeqInt - Number(009) - Sequencial do Registro Integrado |
gridErros | Set | (Opcional) - Lista dos erros |
gridErros.msgErr | String | Erros |
finalizaramRegistros | String | (Obrigatório) - String(001) - Indicativo se existem mais informações a serem solicitadas - Lista: S = Sim, N = Não |
tipoRetorno | Integer | (Obrigatório) - Number(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
mensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
numeroLote | Integer | (Obrigatório) - Inteiro - Identificação do Lote de Exportação |