Gestão de Pessoas - Manual do Usuário > Integrações com outros sistemas > Web services > Benefícios e Tarefeiros > Com.senior.g5.rh.bs.SqlAbrangenciaUsuario

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

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/bs_Synccom_senior_g5_rh_bs_SqlAbrangenciaUsuario?wsdl
Assíncrono: http://example.com/g5-senior-services/bs_Asynccom_senior_g5_rh_bs_SqlAbrangenciaUsuario?wsdl
Agendado: http://example.com/g5-senior-services/bs_Scheduledcom_senior_g5_rh_bs_SqlAbrangenciaUsuario?wsdl

Porta

SqlAbrangenciaUsuario

Web service para aplicar abrangência de usuário em um comando SQL nativo.

Necessita autenticação: Sim

Situação de versão: Atual

Versão: 2

Requisição:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
  <soapenv:Body>
    <ser:SqlAbrangenciaUsuario>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <sQL>
          <comandoSQL>String</comandoSQL>
          <status>Integer</status>
          <mensagem>String</mensagem>
        </sQL>
      </parameters>
    </ser:SqlAbrangenciaUsuario>
  </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome	Preenchimento	Tipo	Descrição
sQL	Obrigatório	Set	Web service para aplicação de abrangência de usuário em um comando SQL nativo. - Para a aplicação de abrangência de usuário no comando SQL passado por parâmetro é necessário informar o identificador %(TABELA) após a clausula WHERE do comando. Exemplo utilizando a tabela R034FUN para aplicação da abrangência no comando SQL. Entrada: SELECT * FROM R034FUN WHERE %(R034FUN) Saída: SELECT * FROM R034FUN WHERE (NUMEMP=1 OR NUMEMP=3) Os parâmetros Status e mensagem são somente de retorno, após a conversão do comando SQL o parâmetro Status será preenchido da seguinte forma: 0 - Operação efetuada com sucesso 1 - Erro na aplicação de abrangência, neste caso o parâmetro mensagem conterá a mensagem de erro que impediu a conversão do comando. 2 - Aviso, neste caso não houve nenhuma conversão no comando SQL passada por parâmetro, geralmente ocorre esta situação quando no comando SQL não contém o identificador %(TABELA), quando ocorrer este tipo de situação o parâmetro Mensagem conterá a mensagem de aviso.
sQL.comandoSQL	Obrigatório	String	Comando SQL nativo que será aplicado a abrangência de usuário, com base no usuário ativo. - Tipo: Alfanumérico Observação: A abrangência de usuário será substituído pela tag %(TABELA) conforme demonstrado no exemplo abaixo. Exemplo: Comando SQL passado por parâmetro: SELECT * FROM R034FUN WHERE %(R034FUN) Comando convertido: SELECT * FROM R034FUN WHERE (NUMEMP=1 OR NUMEMP=3)
sQL.status	Opcional	Integer	Status da conversão do comando SQL - Parâmetro de saída - Somente leitura Valores: 0 - Operação efetuada com sucesso 1 - Erro na conversão, neste caso o parâmetro de retorno mensagem será preenchido com a mensagem de erro 2 - Aviso, neste caso o parâmetro de retorno mensagem será preenchido com a mensagem de aviso. Observação: A operação 2 - Aviso ocorre quando, por exemplo, não possui comando a ser convertido, neste caso será apresentando uma mensagem informando que o comando não foi convertido. Na utilização deste WebService, o status 2 não impediria a execução de um próximo processo ao contrário do status 1 - erro.
sQL.mensagem	Opcional	String	Mensagem de retorno de uma conversão do SQL. - Parâmetro de saída - Somente leitura Observação: Este parâmetro somente estará com valor quando o status estiver com o valor 1 - Erro ou 2 - Aviso, neste caso este parâmetro irá possuir uma mensagem informando o que aconteceu na conversão do comando SQL.

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:SqlAbrangenciaUsuarioResponse>
      <result>
        <sQL>
          <comandoSQL>String</comandoSQL>
          <status>Integer</status>
          <mensagem>String</mensagem>
        </sQL>
        <erroExecucao>String</erroExecucao>
      </result>
    </ser:SqlAbrangenciaUsuarioResponse>
  </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.
sQL	Obrigatório	Set	Web service para aplicação de abrangência de usuário em um comando SQL nativo. - Para a aplicação de abrangência de usuário no comando SQL passado por parâmetro é necessário informar o identificador %(TABELA) após a clausula WHERE do comando. Exemplo utilizando a tabela R034FUN para aplicação da abrangência no comando SQL. Entrada: SELECT * FROM R034FUN WHERE %(R034FUN) Saída: SELECT * FROM R034FUN WHERE (NUMEMP=1 OR NUMEMP=3) Os parâmetros Status e mensagem são somente de retorno, após a conversão do comando SQL o parâmetro Status será preenchido da seguinte forma: 0 - Operação efetuada com sucesso 1 - Erro na aplicação de abrangência, neste caso o parâmetro mensagem conterá a mensagem de erro que impediu a conversão do comando. 2 - Aviso, neste caso não houve nenhuma conversão no comando SQL passada por parâmetro, geralmente ocorre esta situação quando no comando SQL não contém o identificador %(TABELA), quando ocorrer este tipo de situação o parâmetro Mensagem conterá a mensagem de aviso.
sQL.comandoSQL	Obrigatório	String	Comando SQL nativo que será aplicado a abrangência de usuário, com base no usuário ativo. - Tipo: Alfanumérico Observação: A abrangência de usuário será substituído pela tag %(TABELA) conforme demonstrado no exemplo abaixo. Exemplo: Comando SQL passado por parâmetro: SELECT * FROM R034FUN WHERE %(R034FUN) Comando convertido: SELECT * FROM R034FUN WHERE (NUMEMP=1 OR NUMEMP=3)
sQL.status	Opcional	Integer	Status da conversão do comando SQL - Parâmetro de saída - Somente leitura Valores: 0 - Operação efetuada com sucesso 1 - Erro na conversão, neste caso o parâmetro de retorno mensagem será preenchido com a mensagem de erro 2 - Aviso, neste caso o parâmetro de retorno mensagem será preenchido com a mensagem de aviso. Observação: A operação 2 - Aviso ocorre quando, por exemplo, não possui comando a ser convertido, neste caso será apresentando uma mensagem informando que o comando não foi convertido. Na utilização deste WebService, o status 2 não impediria a execução de um próximo processo ao contrário do status 1 - erro.
sQL.mensagem	Opcional	String	Mensagem de retorno de uma conversão do SQL. - Parâmetro de saída - Somente leitura Observação: Este parâmetro somente estará com valor quando o status estiver com o valor 1 - Erro ou 2 - Aviso, neste caso este parâmetro irá possuir uma mensagem informando o que aconteceu na conversão do comando SQL.