Web service com.senior.g5.rh.bs.auxilio

Tipo de execução

Para cada tipo de execução, existem parâmetros específicos, alguns dos quais podem ser comuns a todas as portas de web service.

Autenticação

Quando for utilizada alguma forma de autenticação na integração de informações por meio de web services, é necessário informar o tipo correspondente no parâmetro <encryption>, conforme os valores possíveis.

WSDL

Porta

Lancamento

BS - Auxílio Creche - Lançamento

**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:Lancamento> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <numEmp>Integer</numEmp> <wGD163CRE> <tipOpe>String</tipOpe> <tipCol>String</tipCol> <datPag>String</datPag> <valMen>Double</valMen> <codOem>Integer</codOem> <tipPdo>String</tipPdo> <datCre>String</datCre> <valRee>Double</valRee> <obsRee>String</obsRee> </wGD163CRE> <tipCol>Integer</tipCol> <numCad>Integer</numCad> <datIni>String</datIni> <datFim>String</datFim> <codDep>Integer</codDep> </parameters> </ser:Lancamento> </soapenv:Body> </soapenv:Envelope>

Parâmetros da requisição:

Nome

Preenchimento

Tipo

Descrição

numEmp

Opcional

Integer

Código da empresa que será utilizada na integração. Máscara: 9999

wGD163CRE

Opcional

Set

Lançamento dos Auxílios.

wGD163CRE.tipOpe

Opcional

String

Tipo da operação a ser efetuada para um lançamento (uma linha). Máscara: U. Valores possíveis:


“I” - Inclusão


“A” - Alteração


“E” - Exclusão



Obs.: Se não for informado, será considerado “Alteração”.

wGD163CRE.tipCol

Opcional

String

Tipo do auxílio. Máscara: U. Valores possíveis:


“C” - Creche


“B” - Babá

wGD163CRE.datPag

Opcional

DateTime

Data de pagamento da mensalidade à instituição. Máscara: DD/MM/YYYY

wGD163CRE.valMen

Obrigatório

Double

Valor da mensalidade. Máscara: ZZZZZZZZ9,99

wGD163CRE.codOem

Opcional

Integer

Código do estabelecimento escolar que recebe a mensalidade. A instituição deverá ser cadastrada no item Empresas/Outras Empresas/Cadastro e possuir o Tipo de Uso = 12. Máscara: 9[8]

wGD163CRE.tipPdo

Opcional

String

Período em que o dependente esteve sob os cuidados da instituição. Máscara: U. Valores:


“I” - Integral


“M” - Matutino


“V” - Vespertino


“N” - Noturno

wGD163CRE.datCre

Opcional

DateTime

Data de realização do reembolso ao colaborador. Máscara: DD/MM/YYYY

wGD163CRE.valRee

Opcional

Double

Valor do reembolso que será feito pela empresa ao colaborador. Máscara: ZZZZZZZZ9,99

wGD163CRE.obsRee

Opcional

String

Observação sobre o lançamento. Máscara: A[40]

tipCol

Opcional

Integer

Tipo de colaborador. Máscara: 9. Valores:


1 - Empregado


2 - Terceiro


3 - Parceiro

numCad

Opcional

Integer

Código do Colaborador. Máscara: 999999999

datIni

Opcional

DateTime

Data Inicial. Máscara: DD/MM/YYYY. Para informar a data zero ou vazia = 00/00/0000

datFim

Opcional

DateTime

Data Final. Máscara: DD/MM/YYYY. Para informar a data zero ou vazia = 00/00/0000

codDep

Opcional

Integer

Código do dependente. Máscara: 99

Resposta:

Nota

O envelope SOAP é retornado como resposta para requisições síncronas. Já para requisições assíncronas ou agendamentos, a resposta consiste apenas em uma string chamada result, que retorna o valor “OK” quando a execução ocorre com sucesso ou, em caso de falha, 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:LancamentoResponse> <result> <erroExecucao>String</erroExecucao> </result> </ser:LancamentoResponse> </soapenv:Body> </soapenv:Envelope>

Atributos da resposta:

Nome

Preenchimento

Tipo

Descrição

erroExecucao

Opcional

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 sucesso;

  • A mensagem do erro ocorrido no servidor.

Este artigo ajudou você?