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

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>

</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.

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: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 status	Descrição
0	Webservice executado com sucesso. O parâmetro MensagemStatus retornará OK.
1	Executado com erros. O parâmetro MensagemStatus retornará a mensagem de erro.
2	Parâ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.

Nota

O web service não valida os avisos padrão existentes ao realizar a programação em tela, pois o conceito de web service é não possuir interação, considerando que não haverá resposta. Portanto, o comportamento padrão é realizar a inserção da programação sem qualquer validação.

PORTAL DE DOCUMENTAÇÃO
Gestão de Pessoas \| HCM - versão 6.10.4