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

Conceito

O objetivo deste web service é permitir o lançamento de eventos a um determinado colaborador, da mesma forma que a tela de Eventos p/ Colaborador (FRLANEMP), do módulo Administração de Pessoal.

Processo

1. Na chamada do web service, informe a Empresa, Tipo de Colaborador e Número do Cadastro;
2. Informe uma data de referência para buscar o cálculo vigente dentro do período de Folha,
3. Tenha o código do evento previamente cadastrado dentro do Gestão de Pessoas | HCM;
   • A referência do evento pode ser tanto em horas como em quantidades.
4. Tenha, também, o valor total do evento representando o total de lançamentos, que irá na Folha de Pagamento.

Em relação ao comportamento de Duplos, ou seja, registros de lançamentos inseridos que têm a mesma chave (Empresa, Cálculo, Tipo de Colaborador, Tabela de Eventos, Código do Evento), há os seguintes tipos:

• C – Considera somente último registro;
• S – Soma o novo registro aos registros anteriores, consolidando em um único;
• L – Lançar duplicado, inserindo um novo registro sequencial ao já existente.

Fluxo de operação do web service

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

• Síncrono: http://example.com/g5-senior-services/rubi_Synccom_senior_g5_rh_fp_eventoscolaborador?wsdl
• Assíncrono: http://example.com/g5-senior-services/rubi_Asynccom_senior_g5_rh_fp_eventoscolaborador?wsdl
• Agendado: http://example.com/g5-senior-services/rubi_Scheduledcom_senior_g5_rh_fp_eventoscolaborador?wsdl

Portas

• EventosColaborador

EventosColaborador

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:EventosColaborador>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <registro>
          <sequencia>Integer</sequencia>
          <campo>
            <nome>String</nome>
            <valor>String</valor>
            <status>Integer</status>
            <mensagem>String</mensagem>
          </campo>
          <status>
            <codigo>String</codigo>
            <mensagem>String</mensagem>
          </status>
        </registro>
        <operacao>String</operacao>
      </parameters>
    </ser:EventosColaborador>
  </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome	Preenchimento	Tipo	Descrição
registro	Opcional	Set
registro.sequencia	Opcional	Integer	Identificador para facilitar a recuperação do resultado. Deve ser informado pelo solicitante. Serve para executar a operação em lotes, onde cada sequência equivale a um registro, sendo possível a alimentação de várias sequências, com determinados campos equivalente a um registro cada. Caso ocorra um erro, será validado sequência a sequência, gerando erro ou sucesso por registro.
campo	Opcional	Set
campo.Nome e campo.Valor	Opcional	String	De acordo com a tabela abaixo, o campo.Nome corresponde à coluna Nome, e o campo.Valor corresponde às demais informações. Nome Obr Tipo Descrição Observações NUMEMP Sim Integer Número da empresa Será validado se existe cadastrado na base de dados, gerando exceção caso seja inválido ou não informado. TIPCOL Sim Integer Tipo de Colaborador Será validado se existe cadastrado na base de dados, gerando exceção caso seja inválido ou não informado. Valores permitidos: 1 – Empregado; 2 – Terceiro; 3 – Parceiro. NUMCAD Sim Integer Número do Cadastro do Colaborador Será validado se existe cadastrado na base de dados, gerando exceção caso seja inválido ou não informado. REFEVE Sim Number Referência do Evento Será validado se o valor foi informado, e se é maior que zero, gerando exceção. VALEVE Sim Number Valor do Evento Será validado se o valor foi informado, e se é maior que zero, gerando exceção. DATREF Sim Date Data de Referência Será validado se o valor foi informado, se a data é válida e se existe um cálculo vinculado à data da folha com a data informada, gerando exceção. CODEVE Sim Integer Código do evento Será validado se existe cadastrado na base de dados, gerando exceção caso seja inválido ou não informado. TIPREG Sim Alfa Tipo de Registro Valores permitidos: C – Considera último; S – Soma aos anteriores; L – Lançar duplicado. CODRAT Não Integer Código de Rateio Não deve ser informado se o assinalamento Rateio MO Cálculo no cadastro da empresa estiver com o valor "N - (não usa rateio)", ou será gerada uma exceção. Se o assinalamento estiver com valores "C - Centro de custo" ou "L - local", será validado se existe cadastrado na base de dados e se tem vínculo com um Local ou Centro de Custo (conforme assinalamento no cadastro da empresa), gerando exceção caso seja inválido. Se não for informado, será lançado como 0.
campo.status	Opcional	Integer	Status do retorno da requisição ao web service. 0: OK; 1: Consistência de negócio; 2: Consistência customizados; 3: Erro nos campos; 4: Erro não mapeado; 5: Registro inexistente; 6: Parâmetro inválido; 7: Aviso; 8: Registro já cadastrado.
campo.mensagem	Opcional	String	Mensagem de consistência do campo. Se o valor consistente, retornará OK. Caso contrário, retornará a mensagem de erro.
status	Opcional	Set
status.codigo	Opcional	String	Código da mensagem. 0: OK; 1: Consistência de negócio; 2: Consistência customizados; 3: Erro nos campos; 4: Erro não mapeado; 5: Registro inexistente; 6: Parâmetro inválido; 7: Aviso; 8: Registro já cadastrado.
status.mensagem	Opcional	String	Mensagem de retorno da operação. Se a operação for executada corretamente, retornará OK. Caso contrário, retornará a mensagem de erro.
operacao	Opcional	String	Informe a operação que se deseja realizar: I = Inserir

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:EventosColaboradorResponse>
      <result>
        <registro>
          <sequencia>Integer</sequencia>
          <campo>
            <nome>String</nome>
            <valor>String</valor>
            <status>Integer</status>
            <mensagem>String</mensagem>
          </campo>
          <status>
            <codigo>String</codigo>
            <mensagem>String</mensagem>
          </status>
        </registro>
        <erroAposExecucao>String</erroAposExecucao>
        <erroExecucao>String</erroExecucao>
      </result>
    </ser:EventosColaboradorResponse>
  </soapenv:Body>
</soapenv:Envelope>

Atributos da resposta:

Nome	Preenchimento	Tipo	Descrição
registro	Opcional	Set	Cada ocorrência deste elemento representa uma operação a ser executada pelo sistema.
registro.sequencia	Opcional	Integer	Cada ocorrência deste elemento representa uma operação a ser executada pelo sistema.
campo	Opcional	Set	Repete os campos enviados na requisição, com um retorno para cada um. Cada ocorrência deste elemento representa um campo.
campo.nome	Opcional	String	Nome do campo.
campo.valor	Opcional	String	Valor referente ao campo informado.
campo.status	Opcional	Integer	Status do retorno da requisição ao web service. 0: OK; 1: Consistência de negócio; 2: Consistência customizados; 3: Erro nos campos; 4: Erro não mapeado; 5: Registro inexistente; 6: Parâmetro inválido; 7: Aviso; 8: Registro já cadastrado
campo.mensagem	Opcional	String	Mensagem de consistência do campo. Se o valor consistente, retornará OK. Caso contrário, retornará a mensagem de erro.
status	Opcional	Set	Mensagens de retorno da operação. Cada ocorrência deste elemento representa uma mensagem de retorno.
status.codigo	Opcional	String	Código da mensagem. 0: OK; 1: Consistência de negócio; 2: Consistência customizados; 3: Erro nos campos; 4: Erro não mapeado; 5: Registro inexistente; 6: Parâmetro inválido; 7: Aviso; 8: Registro já cadastrado;
status.mensagem	Opcional	String	Mensagem de consistência do campo. Se o valor consistente, retornará OK. Caso contrário, retornará a mensagem de erro.
erroAposExecucao	Opcional	String	-
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 no ocorrido no servidor.