Este conteúdo não recebe atualizações, pois é referente a uma versão do sistema que foi descontinuada. Acesse a documentação da versão 6.10.3 aqui
Gestão de Pessoas - Manual do Usuário > Integrações com outros sistemas > Web services > Benefícios e Tarefeiros > Com.senior.g5.rh.bs.utils

Web service com.senior.g5.rh.bs.utils

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

Portas

GetMenuItems

Menus disponíveis no sistema

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:GetMenuItems>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <onlyInvokable>String</onlyInvokable>
        <ignoreSeparators>String</ignoreSeparators>
        <ignoreSGI>String</ignoreSGI>
      </parameters>
    </ser:GetMenuItems>
  </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome Preenchimento Tipo Descrição
onlyInvokable Opcional String Se informados os valores "1" ou "T", retorna apenas menus que chamam telas que podem ser invocadas externamente.
ignoreSeparators Opcional String Se informados os valores "1" ou "T", ignora os ítens separadores.
ignoreSGI Opcional String Se informados os valores "1" ou "T", ignora os ítens que representam telas personalizadas.

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:GetMenuItemsResponse>
      <result>
        <xmlResult>String</xmlResult>
        <erroExecucao>String</erroExecucao>
      </result>
    </ser:GetMenuItemsResponse>
  </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.
xmlResult Opcional Blob Retorno no formato XML que representa a estrutura de menus disponíveis no sistema.

GetLeafMenuItemsSet

Conjunto de ítens folha dos menus disponíveis no sistema

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:GetLeafMenuItemsSet>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <onlyInvokable>String</onlyInvokable>
        <ignoreSeparators>String</ignoreSeparators>
        <ignoreSGI>String</ignoreSGI>
      </parameters>
    </ser:GetLeafMenuItemsSet>
  </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome Preenchimento Tipo Descrição
onlyInvokable Opcional String Se informados os valores "1" ou "T", retorna apenas menus que chamam telas que podem ser invocadas externamente.
ignoreSeparators Opcional String Se informados os valores "1" ou "T", ignora os ítens separadores.
ignoreSGI Opcional String Se informados os valores "1" ou "T", ignora os ítens que representam telas personalizadas.

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:GetLeafMenuItemsSetResponse>
      <result>
        <leafMenuItemsSet>
          <name>String</name>
          <kind>String</kind>
          <caption>String</caption>
          <fullPath>String</fullPath>
        </leafMenuItemsSet>
        <erroExecucao>String</erroExecucao>
      </result>
    </ser:GetLeafMenuItemsSetResponse>
  </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.
leafMenuItemsSet Opcional Set Conjunto de todos os ítems folha que representam telas que podem ser chamadas externamente no BA e WA.
leafMenuItemsSet.name Opcional String Nome do ítem
leafMenuItemsSet.kind Opcional String Tipo do ítem de menu:
submenu = O ítem é um submenu;
separator = Ítem separador;
callform = Ítem que executa formulários do sistema;
sgi = Ítem que executa formulários do SGI;
other = Outros.
leafMenuItemsSet.caption Opcional String Título do ítem, sem caracteres de atalho.
leafMenuItemsSet.fullPath Opcional String Caminho completo do ítem no formato "menu\submenu\submenu".

Este artigo ajudou você?