Gestão de Pessoas - Manual do Usuário > Integrações com outros sistemas > Web services > Controle de Ponto e Refeitório > Com.senior.g5.rh.hr.integracoes

Web service com.senior.g5.rh.hr.integracoes

Web service de consulta de pendências e tabelas para integração com outros sistemas.

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

ConfirmarPendencias

Realiza a confirmação de pendências para integração com outros sistemas.

Necessita autenticação: Sim.

Situação da 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:ConfirmarPendencias>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <id>String</id>
        <pendencia>
          <id>String</id>
          <status>String</status>
          <mensagem>String</mensagem>
          <retorno>String</retorno>
        </pendencia>
      </parameters>
    </ser:ConfirmarPendencias>
  </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome Tipo Preenchimento Ajuda
id String Obrigatório Nome da integração, previamente cadastrada no Gestão de Pessoas | HCM.
pendencia Set Obrigatório Pendências que serão confirmadas no Gestão de Pessoas | HCM. Cada ocorrência deste elemento representa uma pendência.
pendencia.id String Obrigatório Id da pendência. Deve ser o mesmo Id retornado pelo web service ConsultaPendencias.
pendencia.status String Obrigatório Status da pendência:
C: Confirmado - OK
E: Confirmado - Erro
pendencia.mensagem String Opcional Mensagem adicional ao status.
pendencia.retorno String Opcional Retorno do processamento.
Se a gravação for executada com sucesso, retornará o valor OK. Caso o contrário, retornará a mensagem de erro.

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:ConfirmarPendenciasResponse>
      <result>
        <pendencia>
          <id>String</id>
          <status>String</status>
          <mensagem>String</mensagem>
          <retorno>String</retorno>
        </pendencia>
        <erroExecucao>String</erroExecucao>
      </result>
    </ser:ConfirmarPendenciasResponse>
  </soapenv:Body>
</soapenv:Envelope>

Atributos da resposta:

Nome Tipo Preenchimento Ajuda
pendencia Set Obrigatório Repete as pendências enviadas na requisição, com o retorno para cada uma. Cada ocorrência deste elemento representa uma pendência.
pendencia.id String Obrigatório Id da pendência.
pendencia.status String Obrigatório Status da pendência.
pendencia.mensagem String Opcional Mensagem adicional ao status.
pendencia.retorno String Opcional Retorno do processamento.
Se a gravação for executada com sucesso, retornará o valor OK. Caso o contrário, retornará a mensagem de erro.
erroExecucao String Opcional Tipo de execução Para cada tipo de execução, existem diferentes parâmetros que podem ser comuns a todas as portas. AutenticaçãoCaso 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.

ConsultarTabelas

Permite consultar dados de tabelas previamente liberadas em Recursos > Web Services > Cadastro Integrações > Consultar Tabelas.

Necessita autenticação: Sim.

Situação da 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:ConsultarTabelas>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <consulta>
          <id>String</id>
          <tabela>String</tabela>
          <campos>String</campos>
          <filtro>
            <campo>String</campo>
            <condicao>String</condicao>
            <valor>String</valor>
          </filtro>
        </consulta>
      </parameters>
    </ser:ConsultarTabelas>
  </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome Tipo Preenchimento Descrição
consulta Set Opcional Cada ocorrência deste elemento representa uma consulta a ser executada pelo sistema.
consulta.id String Opcional Id para facilitar a recuperação do resultado da consulta. Deve ser informada pelo solicitante.
consulta.tabela String Obrigatório Tabela em que a consulta será realizada. A tabela deverá constar no cadastro "Recursos / Web Services / Cadastro Integrações / Consultar Tabelas".
consulta.campos String Opcional Campos de retorno da consulta, separados por vírgula:
Exemplo: NUMEMP,TIPCOL,NUMCAD
Se nenhum campo for especificado, o sistema retornará todos os campos disponíveis para esta consulta.
filtro Set Opcional Cada ocorrência deste elemento representa um filtro a ser aplicado na consulta. Serão permitidos apenas filtros simples (CAMPO - CONDIÇÃO - VALOR LITERAL), não permitindo a utilização de funções (AVG, MAX, SUM, etc...).
Exemplo: NUMEMP = 1
DATALT <= 01/01/2017
VALSAL > 1000.50
NOMFUN = TESTE TESTE
NUMEMP IN 1,2,3
CODCCU IN 'A','B','C'
Estas 3 condições serão adicionadas à consulta utilizando o operador AND.
filtro.campo String Opcional Campo do filtro.
filtro.condicao String Opcional Operador do filtro. Valores válidos: =, <>, >=, >, <=, <, IN
filtro.valor String Opcional Valor literal do filtro. Para alguns tipos de dados, é necessário seguir a seguinte formatação:
Data: DD/MM/YYYY
Números com decimais: 9.99

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:ConsultarTabelasResponse>
      <result>
        <ocorrencia>
          <id>String</id>
          <tabela>String</tabela>
          <dataHora>String</dataHora>
          <mensagem>String</mensagem>
          <resultado>
            <campo>
              <nome>String</nome>
              <valor>String</valor>
            </campo>
          </resultado>
        </ocorrencia>
        <erroExecucao>String</erroExecucao>
      </result>
    </ser:ConsultarTabelasResponse>
  </soapenv:Body>
</soapenv:Envelope>

Atributos da resposta:

Nome Tipo Preenchimento Descrição
ocorrencia Set Opcional Retorno de ocorrências da consulta.
ocorrencia.id String Opcional Id informado para a consulta
ocorrencia.tabela String Opcional Tabela consultada.
ocorrencia.dataHora String Opcional Data e Hora da consulta.
ocorrencia.mensagem String Opcional Inconsistência durante a consulta.
resultado Set Opcional Resultados da ocorrência.
campo Set Opcional Campo do resultado.
campo.nome String Opcional Nome do campo.
campo.valor String Opcional Valor do campo.
erroExecucao String Opcional 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.

ConsultarPendencias

Utilizada para consulta de pendências para integração com outros sistemas.

Observação

A partir da versão 2 da porta com.senior.g5.rh.fp.integracoes.ConsultarPendencias, ocorrerá a aplicação da abrangência do usuário ativo e dos filtros registrados no cadastro de integrações, em: Recursos > Web Services > Cadastro Integrações > Consultar Pendências (FR320INT).

Necessita autenticação: Sim.

Situação da 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:ConsultarPendencias>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <tabela>
          <nome>String</nome>
          <filtro>String</filtro>
        </tabela>
        <id>String</id>
      </parameters>
    </ser:ConsultarPendencias>
  </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome Tipo Preenchimento Descrição
tabela Set Opcional Permite que o serviço consulte pendências de tabelas específicas. Cada ocorrência deste elemento representa uma tabela. Se não for especificado, o serviço retornará as pendências de todas as tabelas monitoradas na integração.
tabela.nome String Opcional Nome da tabela.
tabela.filtro String Opcional Permite informar filtros para os registros que serão monitorados. Ou seja, com os filtros é possível gerar pendências de replicação apenas para registros específicos, como por exemplo, apenas para determinadas empresas. Consulte a documentação do recurso para ver exemplos de como o filtro deve ser construído.
id String Obrigatório Nome da integração, previamente cadastrada no Gestão de Pessoas | HCM.

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:ConsultarPendenciasResponse>
      <result>
        <quantidade>Integer</quantidade>
        <ocorrencia>
          <id>String</id>
          <dataHora>String</dataHora>
          <tabela>String</tabela>
          <operacao>String</operacao>
          <campo>
            <nome>String</nome>
            <valor>String</valor>
          </campo>
        </ocorrencia>
        <erroExecucao>String</erroExecucao>
      </result>
    </ser:ConsultarPendenciasResponse>
  </soapenv:Body>
</soapenv:Envelope>

Atributos da resposta:

Nome Tipo Preenchimento Descrição
quantidade Integer Opcional Quantidade de pendências retornadas.
ocorrencia Set Opcional Cada ocorrência deste elemento representa uma pendência retornada.
ocorrencia.id String Opcional Id da pendência.
ocorrencia.dataHora String Opcional Data e hora da pendência.
ocorrencia.tabela String Opcional Tabela da pendência.
ocorrencia.operacao String Opcional Operação da pendência:
I: Inclusão
U: Alteração
D: Exclusão
campo Set Opcional Valores do registro que originou a pendência. Cada ocorrência deste elemento representa um campo/valor do registro. No caso de exclusão, apenas os campos chave do registro serão retornados.
campo.nome String Opcional Nome do campo.
campo.valor String Opcional Valor do campo.
erroExecucao String Opcional 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ê?