Web service Com.senior.g5.co.int.varejo.representantes
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_representantes?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_int_varejo_representantes?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_int_varejo_representantes?wsdl
Porta
Integrações - Varejo - Cadastros - Exportar Representantes
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:ExportarRepresentantes> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <codEmp>Integer</codEmp> <consultaRepresentante> <codRep>String</codRep> </consultaRepresentante> <codFil>Integer</codFil> <quantidadeRegistros>Integer</quantidadeRegistros> <tipoIntegracao>String</tipoIntegracao> <sigInt>String</sigInt> </parameters> </ser:ExportarRepresentantes> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
consultaRepresentante | Set | Este grupo somente é utilizado na requisição de um registro específico (Tipo de Integração = E " Registro Específico"). Caso seja informando em requisições com Tipo de Integração = A ou T, o conteúdo será ignorado. |
consultaRepresentante.codRep | String | (Obrigatório) - Number(009) - Código do Representante. |
codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
quantidadeRegistros | Integer | (Opcional) - Number(005) - Quantidade de registros limite para retorno da solicitação - Observação: Quando solicitado um tipo de integração E (Específico), a quantidade de registros será ignorada, mesmo se informada. |
tipoIntegracao | String | (Obrigatório) - String(001) - Tipo de Integração - Lista: T = Todos, A = Somente Alterados, E = Registro Específico |
sigInt | String | (Obrigatório) - String(15) - Sigla do Sistema de Integração |
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:ExportarRepresentantesResponse> <result> <tipoRetorno>Integer</tipoRetorno> <representante> <codRep>String</codRep> <nomRep>String</nomRep> <senRep>String</senRep> <tipRep>String</tipRep> <cgcCpf>String</cgcCpf> <datNas>String</datNas> <numRge>String</numRge> <orgRge>String</orgRge> <datRge>String</datRge> <endRep>String</endRep> <nenRep>String</nenRep> <baiRep>String</baiRep> <cidRep>String</cidRep> <sigUfs>String</sigUfs> <cplEnd>String</cplEnd> <fonRep>String</fonRep> <fonRe2>String</fonRe2> <fonRe3>String</fonRe3> <intNet>String</intNet> <sitRep>String</sitRep> <repSup>String</repSup> <carRep>String</carRep> <perDmi>String</perDmi> <perDmt>String</perDmt> <prfUsu>String</prfUsu> <seqInt>Integer</seqInt> <cEP> <cepIni>String</cepIni> <cepFim>String</cepFim> <cepRep>String</cepRep> <endCid>String</endCid> <baiCid>String</baiCid> <nomCid>String</nomCid> <sigUfs>String</sigUfs> <nomUfs>String</nomUfs> <codRai>String</codRai> <codPai>String</codPai> <nomPai>String</nomPai> </cEP> </representante> <mensagemRetorno>String</mensagemRetorno> <resultado> <codRep>String</codRep> <observacao>String</observacao> </resultado> <finalizaramRegistros>String</finalizaramRegistros> <numLot>Integer</numLot> <erroExecucao>String</erroExecucao> </result> </ser:ExportarRepresentantesResponse> </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" |
tipoRetorno | Integer | (Obrigatório) - Number(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
representante | Set | |
representante.codRep | String | (Obrigatório) - Number(009) - Código do Representante. |
representante.nomRep | String | (Obrigatório) - String(100) - Nome do representante. |
representante.senRep | String | (Opcional) - String(010) - Senha do Representante. |
representante.tipRep | String | (Obrigatório) - String(001) - Tipo do representante. - Lista: J = Pessoa Jurídica, F = Pessoa Física. |
representante.cgcCpf | String | (Opcional) - Number(014) - Número do CNPJ ou CPF do representante. |
representante.datNas | String | (Opcional) - Date(DD/MM/YYYY) - Data do nascimento. |
representante.numRge | String | (Opcional) - String(013) - Número do RG. |
representante.orgRge | String | (Opcional) - String(006) - Órgão emissor do RG. |
representante.datRge | String | (Opcional) - Date(DD/MM/YYYY) - Data de emissão do RG. |
representante.endRep | String | (Obrigatório) - String(100) - Endereço do representante. |
representante.nenRep | String | (Opcional) - String(060) - Número do Endereço do Representante. |
representante.baiRep | String | (Opcional) - String(075) - Bairro do representante. |
representante.cidRep | String | (Opcional) - String(060) - Cidade do representante. |
representante.sigUfs | String | (Opcional) - String(002) - Estado do representante. |
representante.cplEnd | String | (Opcional) - String(060) - Complemento do endereço (sala, andar, etc.). |
representante.fonRep | String | (Opcional) - String(020) - Número do telefone - 1. |
representante.fonRe2 | String | (Opcional) - String(020) - Número do telefone - 2. |
representante.fonRe3 | String | (Opcional) - String(020) - Número do telefone - 3. |
representante.intNet | String | (Opcional) - String(100) - Endereço eletrônico (e-mail). |
representante.sitRep | String | (Obrigatório) - String(001) - Situação do representante. - Lista: A = Ativo, I = Inativo |
representante.repSup | String | (Obrigatório) - Number(009) - Código do representante superior do representante. |
representante.carRep | String | (Opcional) - String(020) - Identificação do cartão do representante para utilização no sistema de varejo. |
representante.perDmi | String | (Opcional) - Number(005,2) - Percentual de desconto máximo por item no cupom fiscal. |
representante.perDmt | String | (Opcional) - Number(005,2) - Percentual de desconto máximo no total do cupom fiscal. |
representante.prfUsu | String | (Obrigatório) - Number(001) - Perfil do usuário no sistema de varejo. - Lista: 1 = Vendedor, 2 = Operador de caixa, 3 = Superior, 43 = Administrador |
representante.seqInt | Integer | (Obrigatório) - Number(7) - Sequência do registro |
representante.cEP | Set | (Opcional) - Será enviado se o cliente tiver um CEP cadastrado. |
representante.cEP.cepIni | String | (Obrigatório) - Number(008) - Faixa inicial do CEP da cidade. |
representante.cEP.cepFim | String | (Obrigatório) - Number(008) - Faixa final do CEP da cidade. |
representante.cEP.cepRep | String | (Obrigatório) - Number(008) - CEP do representante. |
representante.cEP.endCid | String | (Opcional) - String(100) - Endereço referente ao CEP (quando faixa de apenas um CEP). |
representante.cEP.baiCid | String | (Opcional) - String(075) - Bairro referente ao CEP Informado (quando faixa de apenas um CEP). |
representante.cEP.nomCid | String | (Obrigatório) - String(060) - Nome da cidade. |
representante.cEP.sigUfs | String | (Obrigatório) - String(002) - Sigla do estado da cidade. |
representante.cEP.nomUfs | String | (Obrigatório) - String(020) - Nome do estado. |
representante.cEP.codRai | String | (Obrigatório) - Number(007) - Código da cidade para a RAIS. |
representante.cEP.codPai | String | (Obrigatório) - String(004) - Código do País. |
representante.cEP.nomPai | String | (Obrigatório) - String(150) - Nome do País. |
mensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
resultado | Set | Neste grupo somente serão retornados resultados onde foi solicitado um Tipo de Integração = E ( Registro Específico) e a requisição não foi atendida. |
resultado.codRep | String | (Obrigatório) - Number(009) - Código do Representante. |
resultado.observacao | String | (Obrigatório) - String(100) - Motivo do registro não ter sido exportado, ou OK para os registros que retonaram com sucesso. |
finalizaramRegistros | String | (Obrigatório) - String(001) - Indicativo se existem mais informações a serem solicitadas - Lista: S = Sim, N = Não |
numLot | Integer | (Obrigatório) - Number(7) - Número do lote |