English
Español
Integrações com outros sistemas > Web services > Web services disponíveis no Gestão Empresarial > Com.senior.g5.co.int.varejo.chequepresente
Web service com.senior.g5.co.int.varejo.chequepresente
Web service para gestão e gravação de Cartões Presente no sistema de varejo. Permite o registro, emissão e configuração de cartões presente, com definição de valores e datas de validade.
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.
Campos que representam valores monetários, quantidade e percentual e estão declarados como String
- 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
Exemplo:
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.
Campos que representam valores monetários, quantidade e percentual e não estão declarados como String
- 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
Exemplo:
- 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_chequepresente?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_int_varejo_chequepresente?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_int_varejo_chequepresente?wsdl
Portas
Gravar
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:Gravar>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<dadosGravar>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<carPre>String</carPre>
<vlrCar>String</vlrCar>
<vlrInc>String</vlrInc>
<datEmi>String</datEmi>
<datVal>String</datVal>
</dadosGravar>
<tipoProcessamento>Integer</tipoProcessamento>
</parameters>
</ser:Gravar>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Descrição |
|---|---|---|
| dadosGravar | Set | Conjunto de dados para gravação do cartão presente |
| dadosGravar.codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| dadosGravar.codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| dadosGravar.carPre | String | (Obrigatório) - String(020) - Código do Cartão Presente |
| dadosGravar.vlrCar | String | (Obrigatório) - Number(15,2) - Valor do Cartão Presente |
| dadosGravar.vlrInc | String | (Opcional) - Number(15,2) - Valor do Incremento do Cartão Presente |
| dadosGravar.datEmi | String | (Obrigatório) - Date - Data de Emissão do Cartão Presente |
| dadosGravar.datVal | String | (Obrigatório) - Date - Data de Validade do Cartão Presente |
| tipoProcessamento | Integer | (Obrigatório) - Number(001) - Tipo de Processamento - Lista: 1 = Inclusão, 2 = Alteração |
Resposta
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:GravarResponse>
<result>
<retornosGravar>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<carPre>String</carPre>
<retorno>String</retorno>
</retornosGravar>
<tipoRetorno>Integer</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:GravarResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
| 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" |
| retornosGravar | Set | |
| retornosGravar.codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| retornosGravar.codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| retornosGravar.carPre | String | (Obrigatório) - String(020) - Código do Cartão Presente |
| retornosGravar.retorno | String | (Obrigatório) - String(020) - Retorno do processamento |
| 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 |
Consumo
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:Consumo>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<dadosComsumo>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<carPre>String</carPre>
<datRes>String</datRes>
<vlrUti>String</vlrUti>
</dadosComsumo>
<tipoProcessamento>Integer</tipoProcessamento>
</parameters>
</ser:Consumo>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Descrição |
|---|---|---|
| dadosComsumo | Set | Conjunto de dados para consumo do cartão presente |
| dadosComsumo.codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| dadosComsumo.codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| dadosComsumo.carPre | String | (Obrigatório) - String(020) - Código do Cartão Presente |
| dadosComsumo.datRes | String | (Obrigatório) - Date - Data do Último Resgate efetuado no Cartão Presente |
| dadosComsumo.vlrUti | String | (Obrigatório) - Number(15,2) - Valor Utilizado do Cartão Presente |
| tipoProcessamento | Integer | (Obrigatório) - Number(001) - Tipo de Processamento - Lista: 1 = Consumo |
Resposta:
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:ConsumoResponse>
<result>
<retornosConsumo>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<carPre>String</carPre>
<retorno>String</retorno>
</retornosConsumo>
<tipoRetorno>Integer</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:ConsumoResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
| 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" |
| retornosConsumo | Set | Conjunto de dados de retorno do consumo do cartão presente |
| retornosConsumo.codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| retornosConsumo.codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| retornosConsumo.carPre | String | (Obrigatório) - String(020) - Código do Cartão Presente |
| retornosConsumo.retorno | String | (Obrigatório) - String(100) - Retorno do processamento |
| 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 |
Consultar
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:Consultar>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<tipoProcessamento>Integer</tipoProcessamento>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<carPre>String</carPre>
</parameters>
</ser:Consultar>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Descrição |
|---|---|---|
| tipoProcessamento | Integer | (Obrigatório) - Number(001) - Tipo de Processamento - Lista: 1 = Consulta, 2 = Busca |
| codEmp | Integer | (Opcional) - Number(004) - Código da Empresa |
| codFil | Integer | (Opcional) - Number(005) - Código da Filial |
| carPre | String | (Obrigatório) - String(020) - Código do Cartão Presente |
Resposta:
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:ConsultarResponse>
<result>
<retornosConsulta>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<vlrSal>String</vlrSal>
<datVal>String</datVal>
</retornosConsulta>
<retornosBusca>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<carPre>String</carPre>
<vlrCar>String</vlrCar>
<vlrSal>String</vlrSal>
<datVal>String</datVal>
</retornosBusca>
<tipoRetorno>Integer</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:ConsultarResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
| 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" |
| retornosConsulta | Set | |
| retornosConsulta.codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| retornosConsulta.codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| retornosConsulta.vlrSal | String | (Obrigatório) - Number(15,2) - Valor de Saldo do Cartão Presente |
| retornosConsulta.datVal | String | (Obrigatório) - Date - Data de Validade do Cartão Presente |
| retornosBusca | Set | |
| retornosBusca.codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| retornosBusca.codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| retornosBusca.carPre | String | (Obrigatório) - String(020) - Código do Cartão Presente |
| retornosBusca.vlrCar | String | (Obrigatório) - Number(15,2) - Valor do Cartão Presente |
| retornosBusca.vlrSal | String | (Obrigatório) - Number(15,2) - Valor de Saldo do Cartão Presente |
| retornosBusca.datVal | String | (Obrigatório) - Date - Data do Último Resgate efetuado no Cartão Presente |
| 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 |
English
Español
