Web service Com.senior.g5.co.int.varejo.cep
O serviço tem por finalidade tratar a exportação e importação dos cadastros de CEP.
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.
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
- 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
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
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.
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
- 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
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
- 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_cep?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_int_varejo_cep?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_int_varejo_cep?wsdl
Portas
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Integrações - Varejo - Cadastros - Exportar CEP
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
<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> <codEmp>Integer</codEmp> <consulta> <cep>String</cep> </consulta> <codFil>Integer</codFil> <tipoIntegracao>String</tipoIntegracao> <identificacaoSistema>String</identificacaoSistema> <quantidadeRegistros>Integer</quantidadeRegistros> </parameters> </ser:Exportar> </soapenv:Body> </soapenv:Envelope>
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Nome | Tipo | Descrição |
---|---|---|
codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
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.cep | String | (Obrigatório) - Cep - Number(008) - CEP da cidade |
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 |
identificacaoSistema | String | (Obrigatório) - String(15) - Identificação do sistema integrado |
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. |
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
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> <cep> <cepIni>Integer</cepIni> <cepFim>Integer</cepFim> <codRai>Integer</codRai> <nomCid>String</nomCid> <sigUfs>String</sigUfs> <baiCid>String</baiCid> <endCid>String</endCid> <nomUfs>String</nomUfs> <codIbg>String</codIbg> <seqInt>Integer</seqInt> </cep> <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>
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
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" |
cep | Set | (Obrigatório) - Utilizar para informar quais registros devem ser retornados. Utilizar apenas quando o tipo de integração for específico ("E") |
cep.cepIni | Integer | (Obrigatório) - Number(008) - Faixa inicial do CEP da cidade |
cep.cepFim | Integer | (Obrigatório) - Number(008) - Faixa final do CEP da cidade |
cep.codRai | Integer | (Opcional) - Number(007) - Código da cidade para a RAIS |
cep.nomCid | String | (Obrigatório) - String(060) - Nome da cidade |
cep.sigUfs | String | (Obrigatório) - String(002) - Sigla do estado da cidade |
cep.baiCid | String | (Opcional) - String(075) - Bairro referente ao CEP Informado (quando faixa de apenas um CEP) |
cep.endCid | String | (Opcional) - String(100) - Endereço referente ao CEP (quando faixa de apenas um CEP) |
cep.nomUfs | String | (Obrigatório) - String(020) - Nome do estado |
cep.codIbg | String | (Opcional) - Number(007) - Código da cidade conforme a tabela do IBGE |
cep.seqInt | Integer | (Opcional) - Number(001) - Número seqüencial do registro de exportação |
gridErros | Set | (Opcional) - Lista dos erro |
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 |
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Integrações - Varejo - Cadastros - Importar CEP
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
<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> <cep> <codEmp>Integer</codEmp> <codFil>Integer</codFil> <cepIni>Integer</cepIni> <nomCid>String</nomCid> <sigUfs>String</sigUfs> <baiCid>String</baiCid> <endCid>String</endCid> <codIbg>Integer</codIbg> <ideExt>Integer</ideExt> </cep> <sistemaIntegracao>String</sistemaIntegracao> </parameters> </ser:Importar> </soapenv:Body> </soapenv:Envelope>
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Nome | Tipo | Descrição |
---|---|---|
cep | Set | |
cep.codEmp | Integer | (Obrigatório) - Number(004) - Código da empresa |
cep.codFil | Integer | (Obrigatório) - Number(005) - Código da filial |
cep.cepIni | Integer | (Obrigatório) - Number(008) - Faixa inicial do CEP da cidade |
cep.nomCid | String | (Obrigatório) - String(060) - Nome da cidade |
cep.sigUfs | String | (Obrigatório) - String(002) - Sigla do estado da cidade |
cep.baiCid | String | (Obrigatório) - String(075) - Bairro referente ao CEP Informado (quando faixa de apenas um CEP) |
cep.endCid | String | (Obrigatório) - String(100) - Endereço referente ao CEP (quando faixa de apenas um CEP) |
cep.codIbg | Integer | (Obrigatório) - Number(007) - Código da cidade conforme a tabela do IBGE |
cep.ideExt | Integer | (Obrigatório) - Number(015) - Identificador Externo |
sistemaIntegracao | String | (Obrigatório) - String(15) - Identificação do sistema integrado |
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
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> <tipoRetorno>Integer</tipoRetorno> <retorno> <codEmp>Integer</codEmp> <codFil>Integer</codFil> <cepIni>Integer</cepIni> <ideExt>Integer</ideExt> <tipRet>Integer</tipRet> <msgRet>String</msgRet> </retorno> <mensagemRetorno>String</mensagemRetorno> <erroExecucao>String</erroExecucao> </result> </ser:ImportarResponse> </soapenv:Body> </soapenv:Envelope>
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
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 |
retorno | Set | (Opcional) - Lista dos erro |
retorno.codEmp | Integer | (Obrigatório) - Number(004) - Código da empresa |
retorno.codFil | Integer | (Obrigatório) - Number(005) - Código da filial |
retorno.cepIni | Integer | (Obrigatório) - Number(008) - Faixa inicial do CEP da cidade |
retorno.ideExt | Integer | |
retorno.tipRet | Integer | (Obrigatório) - Number(001) - Tipo de retorno. Valores: 1 - Processado com sucesso; 2 - Ocorreram Erros. |
retorno.msgRet | String | (Opcional) - String(250) - Mensagem de Erro |
mensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |