Precisa de apoio?
Gestão de Pessoas - Manual do Usuário > Integrações com outros sistemas > Web services > Benefícios e Tarefeiros > Com.senior.g5.rh.bs.integracao

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

Este web service permite a execução da rotina Integração de Benefícios e Tarefeiros, em Recursos > Webservices > Configuração de Web Services Escaláveis.

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 identificado o tipo no parâmetro <encryption>, conforme seus valores possíveis.

WSDL

Portas

Escalonar

Web service que realiza o processo de Integração de Benefícios e Tarefeiros de forma escalonada.

Necessita autenticação: Sim.

Situação de versão: Atual.

Versão: 1.

Versão atual: 1.

Requisição:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
 <soapenv:Body>
  <ser:Escalonar>
   <user>String</user>
   <password>String</password>
   <encryption>Integer</encryption>
   <parameters>
    <numEmp>Integer</numEmp>
    <valAss>String</valAss>
    <gruEmp>Integer</gruEmp>
    <codCal>Integer</codCal>
    <valGer>String</valGer>
    <codLot>String</codLot>
    <datIni>DateTime</datIni>
    <valSol>String</valSol>
    <lotExc>String</lotExc>
    <datFim>DateTime</datFim>
    <menEmp>String</menEmp>
    <abrCad>String</abrCad>
    <eveDup>String</eveDup>
    <resCis>String</resCis>
    <abrFil>String</abrFil>
    <jurEmp>String</jurEmp>
    <abrLoc>String</abrLoc>
    <parEmp>String</parEmp>
    <abrSin>String</abrSin>
    <resEmp>String</resEmp>
    <abrTCo>String</abrTCo>
    <diaVia>String</diaVia>
    <abrTsa>String</abrTsa>
    <menAss>String</menAss>
    <abrSit>String</abrSit>
    <desAss>String</desAss>
    <abrEtb>String</abrEtb>
    <resAss>String</resAss>
    <abrCar>String</abrCar>
    <menEmpCon>String</menEmpCon>
    <abrVin>String</abrVin>
    <auxCre>String</auxCre>
    <abrVal>String</abrVal>
    <auxBab>String</auxBab>
    <abrSeg>String</abrSeg>
    <auxPre>String</auxPre>
    <abrPos>String</abrPos>
   </parameters>
  </ser:Escalonar>
 </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome Preenchimento Tipo Descrição
numEmp Obrigatório Integer Empresa ativa.
valAss Opcional String

Integrar vale compras assinalados.

Valores válidos:
- "S - Sim";
- "N - Não".

gruEmp Opcional Integer Grupo de empresas.
codCal Obrigatório Integer Código de cálculo.
valGer Opcional String Integrar vale compras gerados.

Valores válidos:
-"S - Sim";
- "N - Não".

codLot Opcional Integer Lote de colaboradores.
datIni Obrigatório DateTime

Período inicial.

Máscara: DD/MM/YYYY.

valSol Opcional String Integrar vale compras solicitados.

Valores válidos:
- "S - Sim";
- "N - Não".

lotExc Opcional Integer Lote de exceções de colaboradores.
datFim Obrigatório DateTime

Período final.

Máscara: DD/MM/YYYY.

menEmp Opcional String

Integrar mensalidades de empréstimos.

Valores válidos:
- "S - Sim";
- "N - Não".

abrCad Opcional String Abrangência de colaborador.
eveDup Opcional String

Duplos.

Valores válidos:
- "C - Considera último";
- "D - Despreza último"; ou
- "S - Soma último aos anteriores".

resCis Opcional String

Integrar mensalidades de empréstimos consignados.

Valores válidos:
- "S - Sim";
- "N - Não".

abrFil Opcional String Abrangência de filial.
jurEmp Opcional String

Integrar os juros de empréstimos.

Valores válidos:
- "S - Sim";
- "N - Não".

abrLoc Opcional String Abrangência de local.
parEmp Opcional String

Integrar os empréstimos.

Valores válidos:
- "S - Sim";
- "N - Não".

abrSin Opcional String Abrangência de sindicato.
resEmp Opcional String

Integrar os empréstimos das rescisões.

Valores válidos:
- "S - Sim";
- "N - Não".

abrTCo Opcional String Abrangência de tipo de contrato.
diaVia Opcional String

Integrar diárias de viagens.

Valores válidos:
- "S - Sim";
- "N - Não".

abrTsa Opcional String Abrangência de tipo de salário.
menAss Opcional String

Integrar as mensalidades de assistência médica.

Valores válidos:
- "S - Sim";
- "N - Não".

abrSit Opcional String Abrangência de situação.
desAss Opcional String

Integrar as despesas médicas de assistência médica.

Valores válidos:
- "S - Sim";
- "N - Não".

abrEtb Opcional String Abrangência de estabilidade.
resAss Opcional String

Integrar as parcelas de despesas médicas das rescisões.

Valores válidos:
- "S - Sim";
- "N - Não".

abrCar Opcional String Abrangência de cargo.
menEmpCon Opcional String

Integrar mensalidades de empréstimos consignados.

Valores válidos:
- "S - Sim";
- "N - Não".

abrVin Opcional String Abrangência de vínculo.
auxCre Opcional String

Integrar lançamentos de auxílio-creche.

Valores válidos:
- "S - Sim";
- "N - Não".

Observação: este parâmetro serve também para babá e pré-escola quando tiver definido com "N - Não" no campo Separar Eventos da tela de Definições Auxílio-Creche / Babá / Pré-Escola (FR163DEF).

Observação: este parâmetro também se aplica aos casos de babá e pré-escola, quando estiver definido como "N - Não" no campo Separar Eventos da tela Definições Auxílio-Creche / Babá / Pré-Escola (FR163DEF).

abrVal Opcional String Abrangência de vale.
auxBab Opcional String

Integrar lançamentos de auxílio babá.

Valores válidos:
- "S - Sim";
- "N - Não".

Observação: este parâmetro deve ser informado apenas quando estiver definido como "S - Sim" no campo Separar Eventos da tela Definições Auxílio-Creche / Babá / Pré-Escola (FR163DEF).

abrSeg Opcional String Abrangência de seguradora.
auxPre Opcional String

Integrar lançamentos de auxílio pré-escola.

Valores válidos:
- "S - Sim";
- "N - Não".

Obs: Este parâmetro deve ser informado apenas quando definido com S no campo Separar Eventos da tela de Definições Auxílio Creche / Babá / Pré-Escola

Observação: este parâmetro deve ser informado apenas quando estiver definido como "S - Sim" no campo Separar Eventos da tela Definições Auxílio-Creche / Babá / Pré-Escola (FR163DEF).

abrPos Opcional String Abrangência de posto de trabalho.

Resposta:

Nota

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:EscalonarResponse>
   <result>
     <erroExecucao>String</erroExecucao>
    </result>
   </ser:EscalonarResponse>
  </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.

Gerar

Web service que realiza o processo de Integração de Benefícios e Tarefeiros.

Necessita autenticação: Sim.

Situação de versão: Atual.

Versão: 1.

Versão atual: 1.

Requisição:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
 <soapenv:Body>
  <ser:Gerar>
   <user>String</user>
   <password>String</password>
   <encryption>Integer</encryption>
   <parameters>
    <numEmp>Integer</numEmp>
    <valAss>String</valAss>
    <gruEmp>Integer</gruEmp>
    <codCal>Integer</codCal>
    <valGer>String</valGer>
    <codLot>String</codLot>
    <datIni>DateTime</datIni>
    <valSol>String</valSol>
    <lotExc>String</lotExc>
    <datFim>DateTime</datFim>
    <menEmp>String</menEmp>
    <abrCad>String</abrCad>
    <eveDup>String</eveDup>
    <resCis>String</resCis>
    <abrFil>String</abrFil>
    <jurEmp>String</jurEmp>
    <abrLoc>String</abrLoc>
    <parEmp>String</parEmp>
    <abrSin>String</abrSin>
    <resEmp>String</resEmp>
    <abrTCo>String</abrTCo>
    <diaVia>String</diaVia>
    <abrTsa>String</abrTsa>
    <menAss>String</menAss>
    <abrSit>String</abrSit>
    <desAss>String</desAss>
    <abrEtb>String</abrEtb>
    <resAss>String</resAss>
    <abrCar>String</abrCar>
    <menEmpCon>String</menEmpCon>
    <abrVin>String</abrVin>
    <auxCre>String</auxCre>
    <abrVal>String</abrVal>
    <auxBab>String</auxBab>
    <abrSeg>String</abrSeg>
    <auxPre>String</auxPre>
    <abrPos>String</abrPos>
    </parameters>
  </ser:Gerar>
 </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome Preenchimento Tipo Descrição
numEmp Obrigatório Integer Empresa ativa.
valAss Opcional String

Integrar vale compras assinalados.

Valores válidos:
- "S - Sim";
- "N - Não".

gruEmp Opcional Integer Grupo de empresas.
codCal Obrigatório Integer Código de cálculo.
valGer Opcional String Integrar vale compras gerados.

Valores válidos:
-"S - Sim";
- "N - Não".

codLot Opcional Integer Lote de colaboradores.
datIni Obrigatório DateTime

Período inicial.

Máscara: DD/MM/YYYY.

valSol Opcional String Integrar vale compras solicitados.

Valores válidos:
- "S - Sim";
- "N - Não".

lotExc Opcional Integer Lote de exceções de colaboradores.
datFim Obrigatório DateTime

Período final.

Máscara: DD/MM/YYYY.

menEmp Opcional String

Integrar mensalidades de empréstimos.

Valores válidos:
- "S - Sim";
- "N - Não".

abrCad Opcional String Abrangência de colaborador.
eveDup Opcional String

Duplos.

Valores válidos:
- "C - Considera último";
- "D - Despreza último"; ou
- "S - Soma último aos anteriores".

resCis Opcional String

Integrar mensalidades de empréstimos consignados.

Valores válidos:
- "S - Sim";
- "N - Não".

abrFil Opcional String Abrangência de filial.
jurEmp Opcional String

Integrar os juros de empréstimos.

Valores válidos:
- "S - Sim";
- "N - Não".

abrLoc Opcional String Abrangência de local.
parEmp Opcional String

Integrar os empréstimos.

Valores válidos:
- "S - Sim";
- "N - Não".

abrSin Opcional String Abrangência de sindicato.
resEmp Opcional String

Integrar os empréstimos das rescisões.

Valores válidos:
- "S - Sim";
- "N - Não".

abrTCo Opcional String Abrangência de tipo de contrato.
diaVia Opcional String

Integrar diárias de viagens.

Valores válidos:
- "S - Sim";
- "N - Não".

abrTsa Opcional String Abrangência de tipo de salário.
menAss Opcional String

Integrar as mensalidades de assistência médica.

Valores válidos:
- "S - Sim";
- "N - Não".

abrSit Opcional String Abrangência de situação.
desAss Opcional String

Integrar as despesas médicas de assistência médica.

Valores válidos:
- "S - Sim";
- "N - Não".

abrEtb Opcional String Abrangência de estabilidade.
resAss Opcional String

Integrar as parcelas de despesas médicas das rescisões.

Valores válidos:
- "S - Sim";
- "N - Não".

abrCar Opcional String Abrangência de cargo.
menEmpCon Opcional String

Integrar mensalidades de empréstimos consignados.

Valores válidos:
- "S - Sim";
- "N - Não".

abrVin Opcional String Abrangência de vínculo.
auxCre Opcional String

Integrar lançamentos de auxílio-creche.

Valores válidos:
- "S - Sim";
- "N - Não".

Observação: este parâmetro serve também para babá e pré-escola quando tiver definido com "N - Não" no campo Separar Eventos da tela de Definições Auxílio-Creche / Babá / Pré-Escola (FR163DEF).

Observação: este parâmetro também se aplica aos casos de babá e pré-escola, quando estiver definido como "N - Não" no campo Separar Eventos da tela Definições Auxílio-Creche / Babá / Pré-Escola (FR163DEF).

abrVal Opcional String Abrangência de vale.
auxBab Opcional String

Integrar lançamentos de auxílio babá.

Valores válidos:
- "S - Sim";
- "N - Não".

Observação: este parâmetro deve ser informado apenas quando estiver definido como "S - Sim" no campo Separar Eventos da tela Definições Auxílio-Creche / Babá / Pré-Escola (FR163DEF).

abrSeg Opcional String Abrangência de seguradora.
auxPre Opcional String

Integrar lançamentos de auxílio pré-escola.

Valores válidos:
- "S - Sim";
- "N - Não".

Obs: Este parâmetro deve ser informado apenas quando definido com S no campo Separar Eventos da tela de Definições Auxílio Creche / Babá / Pré-Escola

Observação: este parâmetro deve ser informado apenas quando estiver definido como "S - Sim" no campo Separar Eventos da tela Definições Auxílio-Creche / Babá / Pré-Escola (FR163DEF).

abrPos Opcional String Abrangência de posto de trabalho.

Resposta:

Nota

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:GerarResponse>
   <result>
    <erroExecucao>String</erroExecucao>
   </result>
  </ser:GerarResponse>
 </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ê?