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

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

Programacao

AP - Férias - Programação

**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:Programacao> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <numEmp>Integer</numEmp> <programacoes> <tipOpe>String</tipOpe> <prgDat>String</prgDat> <prgDfe>Double</prgDfe> <prgDAb>Double</prgDAb> <prg13s>String</prg13s> <prgDPg>String</prgDPg> <gerAdt>String</gerAdt> <prgPcl>Integer</prgPcl> <efePrg>String</efePrg> </programacoes> <tipCol>Integer</tipCol> <numCad>Integer</numCad> <iniPer>String</iniPer> </parameters> </ser:Programacao> </soapenv:Body> </soapenv:Envelope>

Parâmetros da requisição:

Nome

Preenchimento

Tipo

Descrição

numEmp

Obrigatório

Integer

Código da empresa que será utilizada na integração.



  • Chave

  • Máscara: 9999

programacoes

Opcional

Set

Programações de Férias.



Este web service considera as seguintes situações:


  • sempre confirmará a exclusão.

  • sempre aceitará período vencido.

  • se fim das férias > término período seguinte o pagamento estará sujeito a multa.

  • permitirá parcelar férias com x anos mesmo não podendo.

  • se existirem períodos anteriores ao período xx a xx com situação em aberto.

programacoes.tipOpe

Obrigatório

String

Tipo da operação a ser efetuada para um lançamento (uma linha).



  • Máscara: U

  • Valores:

“I” - Inclusão


“A” - Alteração


“E” - Exclusão


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

programacoes.prgDat

Obrigatório

DateTime

Data inicial para o gozo das férias.



  • Chave

  • Máscara: DD/MM/YYYY

programacoes.prgDfe

Opcional

Double

Quantidade de dias férias.



  • Máscara: Z9,99

  • Obs.: Em uma inserção, a soma deste parâmetro com a quantidade de dias de abono pecuniário deve ser maior que 0, ou seja, um dos dois parâmetros deve ser informado.

programacoes.prgDAb

Opcional

Double

Quantidade de dias de abono pecuniário.



  • Máscara: Z9,99

  • Obs.: Em uma inserção, a soma deste parâmetro com a quantidade de dias férias deve ser maior que 0, ou seja, um dos dois parâmetros deve ser informado.

programacoes.prg13s

Obrigatório

String

Haverá ou não adiantamento de 13° Salário no recibo de férias.



  • Máscara: U

  • Valores:

“S” - Sim


“N” - Não


  • Obs.: Se o parâmetro não for informado, o sistema utilizará o valor “N”.

programacoes.prgDPg

Opcional

DateTime

Data de pagamento do recibo de férias.



  • Máscara: DD/MM/YYYY

  • Obs.: Se o parâmetro não for informado, o sistema irá calcular a data de pagamento conforme orientação legislativa.

programacoes.gerAdt

Obrigatório

String

Valores do recibo de férias devem ser adiantados no recibo ou não.



  • Máscara: U

  • Valores:

“S” - Sim


“N” - Não


  • Obs.: Se o parâmetro não for informado, o sistema utilizará o valor “S”.

programacoes.prgPcl

Opcional

Integer

Quantidade de parcelas desejadas para integração das férias na folha mensal.



  • Máscara: 99

programacoes.efePrg

Opcional

String

Cadastrar a programação com o status “Efetiva” (S) ou “Provisória” (N).



  • Máscara: U

  • Valores:

“S” - Sim


“N” - Não


  • Obs.: Em uma inclusão, se o parâmetro não for informado, o sistema utilizará o valor “S”. Se o valor for diferente de “S”, o sistema utilizará o valor “N”.

tipCol

Obrigatório

Integer

Tipo de colaborador.



  • Chave

  • Máscara: 9


Valores:


1 - Empregado


2 - Terceiro


3 - Parceiro

numCad

Obrigatório

Integer

Código do Colaborador.



  • Chave

  • Máscara: 999999999

iniPer

Obrigatório

DateTime

Período aquisitivo que receberá a programação de férias.



  • Chave

  • Máscara: DD/MM/YYYY

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