Web service Com.senior.g5.co.int.padrao.produtocaracteristica
O objetivo deste web service é exportar as características do produto e derivação.
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_int_padrao_produtocaracteristica?wsdl
- Assíncrono: http://servidor:1234/g5-senior-services/sapiens_Asynccom_senior_g5_co_int_padrao_produtocaracteristica?wsdl
- Agendado: http://servidor:1234/g5-senior-services/sapiens_Schedulecom_senior_g5_co_int_padrao_produtocaracteristica?wsdl
Porta
Através desta porta é possível obter uma coleção de dados através dos parâmetros disponíveis.
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:ConsultarGeral> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <codEmp>Integer</codEmp> <CodPro> <codPro>String</codPro> <codDer> <codDer>String</codDer> </codDer> </CodPro> <codFil>Integer</codFil> <identificadorSistema>String</identificadorSistema> <CodCte> <codCte>String</codCte> </CodCte> <indicePagina>Integer</indicePagina> <limitePagina>Integer</limitePagina> </parameters> </ser:ConsultarGeral> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Preenchimento | Ajuda |
---|---|---|---|
codEmp | Integer | Opcional | (Obrigatório) - Number(004) - Código da Empresa |
codPro | Set | Opcional | (Opcional) - Lista de abrangência |
codPro.codPro | String | Opcional | (Opcional) - String(014) - Código do produto |
codDer | Set | Opcional | (Opcional) - Lista de abrangência |
codDer.codDer | String | Opcional | (Opcional) - String(007) - Código Derivação |
codFil | Integer | Opcional | (Obrigatório) - Number(005) - Código da Filial |
identificadorSistema | String | Opcional | (Obrigatório) - String(15) - Sigla do Sistema de Integração |
codCte | Set | Opcional | (Opcional) - Lista de abrangência |
codCte.codCte | String | Opcional | (Opcional) - String(003) - Código da característica do produto |
indicePagina | Integer | Opcional | (Opcional) - Number - Para informações em relação a esse campo, consulte o item Limite de página e índice de página na documentação Configurações especiais. |
limitePagina | Integer | Opcional | (Opcional) - Number - Para informações em relação a esse campo, consulte o item Limite de página e índice de página na documentação Configurações especiais. |
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:ConsultarGeralResponse> <result> <Erros> <mensagemErro>String</mensagemErro> </Erros> <tipoRetorno>Integer</tipoRetorno> <CaracteristicaProduto> <codEmp>Integer</codEmp> <codPro>String</codPro> <codCte>String</codCte> <desCte>String</desCte> <seqCcp>Integer</seqCcp> <desCcp>String</desCcp> <desLiv>String</desLiv> <obsLiv>String</obsLiv> <camposUsuarioCaracteristicaProduto> <campo>String</campo> <valor>String</valor> </camposUsuarioCaracteristicaProduto> </CaracteristicaProduto> <CaracteristicaDerivacao> <codEmp>Integer</codEmp> <codPro>String</codPro> <codDer>String</codDer> <codCte>String</codCte> <desCte>String</desCte> <seqCcp>Integer</seqCcp> <desCcp>String</desCcp> <desLiv>String</desLiv> <obsLiv>String</obsLiv> <camposUsuarioCaracteristicaDerivacao> <campo>String</campo> <valor>String</valor> </camposUsuarioCaracteristicaDerivacao> </CaracteristicaDerivacao> <mensagemRetorno>String</mensagemRetorno> <erroExecucao>String</erroExecucao> </result> </ser:ConsultarGeralResponse> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Preenchimento | Ajuda |
---|---|---|---|
erros | Set | Opcional | (Opcional) - Lista dos erro |
erros.mensagemErro | String | Opcional | (Opcional) - Itens da lista de erros |
tipoRetorno | Integer | Obrigatório | (Obrigatório) - Número(001) - Tipo de Retorno de Processamento - Lista: 0 = Processado, -1 = Erro na Solicitação |
caracteristicaProduto | Set | Opcional | Lista de característica produtos |
caracteristicaProduto.codEmp | Integer | Opcional | Number(004) - Código da empresa |
caracteristicaProduto.codPro | String | Opcional | String(014) - Código do produto |
caracteristicaProduto.codCte | String | Opcional | String(003) - Código da característica do produto |
caracteristicaProduto.desCte | String | Opcional | String(030) - Descrição da característica de produto |
caracteristicaProduto.seqCcp | Integer | Opcional | Number(009) - Número da sequência da característica válido para o produto |
caracteristicaProduto.desCcp | String | Opcional | String(250) - Componente da característica de produto |
caracteristicaProduto.desLiv | String | Opcional | String(250) - Descrição Livre da característica válido para o produto |
caracteristicaProduto.obsLiv | String | Opcional | String(240) - Observação livre da característica de produto |
camposUsuarioCaracteristicaProduto | Set | Opcional | Lista de campos de usuário |
camposUsuarioCaracteristicaProduto.campo | String | Opcional | Nome do campo |
camposUsuarioCaracteristicaProduto.valor | String | Opcional | Valor do campo |
caracteristicaDerivacao | Set | Opcional | Lista de característica derivação |
caracteristicaDerivacao.codEmp | Integer | Opcional | Number(004) - Código da empresa |
caracteristicaDerivacao.codPro | String | Opcional | String(014) - Código do produto |
caracteristicaDerivacao.codDer | String | Opcional | String(007) - Código da Derivação do Produto |
caracteristicaDerivacao.codCte | String | Opcional | String(003) - Código da característica do produto |
caracteristicaDerivacao.desCte | String | Opcional | String(030) - Descrição da característica de produto |
caracteristicaDerivacao.seqCcp | Integer | Opcional | Number(009) - Número da sequência da característica válido para o produto |
caracteristicaDerivacao.desCcp | String | Opcional | String(250) - Componente da característica de produto |
caracteristicaDerivacao.desLiv | String | Opcional | String(250) - Descrição Livre da característica válido para o produto |
caracteristicaDerivacao.obsLiv | String | Opcional | String(240) - Observação livre da característica de produto/derivação |
camposUsuarioCaracteristicaDerivacao | Set | Opcional | Lista de campos de usuário |
camposUsuarioCaracteristicaDerivacao.campo | String | Opcional | Nome do campo |
camposUsuarioCaracteristicaDerivacao.valor | String | Opcional | Valor do campo |
mensagemRetorno | String | Obrigatório | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
erroExecucao | String | Opcional | 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. |