Web service Com.senior.g5.co.int.varejo.familia
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_familia?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_int_varejo_familia?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_int_varejo_familia?wsdl
Porta
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Integrações - Varejo - Cadastros - Exportar Famílias
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 2
![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_2> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <codEmp>Integer</codEmp> <consulta> <familia>String</familia> </consulta> <codFil>Integer</codFil> <tipoIntegracao>String</tipoIntegracao> <quantidadeRegistros>Integer</quantidadeRegistros> <identificacaoSistema>String</identificacaoSistema> </parameters> </ser:Exportar_2> </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.familia | String | |
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 |
![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:Exportar_2Response> <result> <origem> <codOri>String</codOri> <desOri>String</desOri> <tipPro>String</tipPro> <familias> <codFam>String</codFam> <desFam>String</desFam> <tPPFAM>String</tPPFAM> <codClf>String</codClf> <sitFam>String</sitFam> <seqInt>Integer</seqInt> <codStr>String</codStr> </familias> </origem> <gridErros> <msgErr>String</msgErr> </gridErros> <finalizaramRegistros>String</finalizaramRegistros> <tipoRetorno>Integer</tipoRetorno> <mensagemRetorno>String</mensagemRetorno> <numeroLote>Integer</numeroLote> <erroExecucao>String</erroExecucao> </result> </ser:Exportar_2Response> </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" |
origem | Set | |
origem.codOri | String | (Obrigatório) - CodOri - String(003) - Código da Origem do Produto |
origem.desOri | String | (Obrigatório) - DesOri - String(040) - Descrição da Origem do Produto |
origem.tipPro | String | (Obrigatório) - TIPPRO - Tipo de produto (C=Comprado, P=Produzido, S=Serviço) |
origem.familias | Set | Informações da família |
origem.familias.codFam | String | (Obrigatório) - CodFam - String(006) - Código da família de produto |
origem.familias.desFam | String | (Obrigatório) - DesFam - String(050) - Descrição da família de produto |
origem.familias.tPPFAM | String | (Obrigatório) - TPPFAM - Tipo de produto (C=Comprado, P=Produzido, S=Serviço) |
origem.familias.codClf | String | (Opcional) - CodClf - String(003) - Código interno da classificação fiscal para os produtos da família |
origem.familias.sitFam | String | (Opcional) - SitFam - String(001) - Situação da família do produto (Ativo ou Inativo) Lista: A = Ativo, I = Inativo |
origem.familias.seqInt | Integer | (Obrigatório) - SeqInt - Number(009) - Sequencial do Registro Integrado |
origem.familias.codStr | String | (Opcional) - CodStr - String(003) - Código interno da situação tributária para os produtos da família |
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 |