Gestão de Pessoas - Manual do Usuário > Integrações com outros sistemas > Web services > Administração de Pessoal > Com.senior.g5.rh.fp.GeracaoProgramacaoFerias

Web service com.senior.g5.rh.fp.GeracaoProgramacaoFerias

Integração com o módulo Painel de Gestão que permite incluir uma programação de férias para o Colaborador.

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

Porta

ProgramacaoFerias

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:ProgramacaoFerias>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <empresa>Integer</empresa>
        <tipoColaborador>Integer</tipoColaborador>
        <cadastroColaborador>Integer</cadastroColaborador>
        <inicioPeriodo>DateTime</inicioPeriodo>
        <inicioFerias>DateTime</inicioFerias>
        <diasFerias>Double</diasFerias>
        <diasAbono>Double</diasAbono>
        <decimoTerceiro>String</decimoTerceiro>
        <apenasConsistir>String</apenasConsistir>
        <parcelasDesconto>Integer</parcelasDesconto>	
      </parameters>
    </ser:ProgramacaoFerias>
  </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome Preenchimento Tipo Descrição
empresa Integer Obrigatório Código da Empresa.
tipoColaborador Integer Obrigatório Tipo do Colaborador.
cadastroColaborador Integer Obrigatório Cadastro do Colaborador.
inicioPeriodo DateTime Opcional Data de início do período aquisitivo.
inicioFerias DateTime Opcional Data de início das férias.
diasFerias Double Opcional Dias de férias.
diasAbono Double Opcional Dias de abono.
decimoTerceiro String Obrigatório Décimo terceiro: "S" para Sim, ou "N" para Não.
apenasConsistir String Opcional

Quando preenchido com a opção "S - Sim" ou "N - Não" a solicitação de férias será apenas submetida a validação das respectivas regras customizadas do Gestão de Pessoas para o contexto de férias, não realizando a persistência.

parcelasDesconto Integer Opcional Quantidade máxima de parcelas do desconto do valor do recibo de férias individuais.

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:ProgramacaoFeriasResponse>
      <result>
        <statusRetorno>Integer</statusRetorno>
        <mensagemStatus>String</mensagemStatus>
        <erroExecucao>String</erroExecucao>
      </result>
    </ser:ProgramacaoFeriasResponse>
  </soapenv:Body>
</soapenv:Envelope>

Atributos da resposta:

Nome Preenchimento Tipo Descrição
statusRetorno Obrigatório Integer Status de Retorno
Código do statusDescrição
0Webservice executado com sucesso. O parâmetro MensagemStatus retornará OK.
1Executado com erros. O parâmetro MensagemStatus retornará a mensagem de erro.
2Parâmetros inválidos. O parâmetro MensagemStatus retornará a mensagem indicando qual parâmetro está incorreto.
mensagemStatus Obrigatório String Mensagem de Retorno
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ê?