Gestão de Pessoas - Manual do Usuário > Integrações com outros sistemas > Web services > Administração de Pessoal > Com.senior.g5.rh.fp.composicaoSalarial

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

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

Calcular

Web service para execução da rotina que simula o cálculo integral da folha mensal.

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:Calcular>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <numEmp>Integer</numEmp>
        <gruEmp>Integer</gruEmp>
        <cmpCal>String</cmpCal>
        <codLot>Integer</codLot>
        <selCmp>Integer</selCmp>
        <abrCad>String</abrCad>
        <abrFil>String</abrFil>
        <abrLoc>String</abrLoc>
        <abrCCu>String</abrCCu>
        <abrSin>String</abrSin>
        <abrTCo>String</abrTCo>
        <abrTsa>String</abrTsa>
        <abrSit>String</abrSit>
        <abrEtb>String</abrEtb>
        <abrVin>String</abrVin>
        <abrCar>String</abrCar>
      </parameters>
    </ser:Calcular>
  </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 no processo.

- Máscara: 9999
gruEmp Opcional Integer Abrangência: Código de grupo de empresas.

- Máscara: 999
cmpCal Obrigatório DateTime Competência que será utilizado para o cálculo.

- Máscara: MM/YYYY
codLot Opcional Integer Abrangência: Código de lote de colaboradores.

- Máscara: 9999
selCmp Opcional Integer Define a competência que será utilizada de acordo com a data da execução.

- Máscara: 9

Este parâmetro não deve ser informado (ou informar 0) caso o parâmetro CmpCal possuir valor.

Valores:
0 - Utiliza a competência informada.

1 - Competência da Data Agendada: Utilizará a competência da data de execução do processo.

2 - Competência Anterior: Utilizará a competência anterior à data de execução do processo.

3 - Competência Posterior: Utilizará a competência posterior à data de execução do processo.
abrCad Opcional String Abrangência: Colaborador (+).

- Máscara: A[200]
abrFil Opcional String Abrangência: Filial (+).

- Máscara: A[200]
abrLoc Opcional String Abrangência: Local ("+").

- Máscara: A[200]
abrCCu Opcional String Abrangência: Centro de Custo ("+").

- Máscara: A[200]
abrSin Opcional String Abrangência: Sindicato (+).

- Máscara: A[200]
abrTCo Opcional String Abrangência: Tipo de Contrato (+).

- Máscara: A[100]
abrTsa Opcional String Abrangência: Tipo de Salário (+).

- Máscara: A[100]
abrSit Opcional String Abrangência: Situação (+).

- Máscara: A[200]
abrEtb Opcional String Abrangência: Estabilidade (+).

- Máscara: A[100]
abrVin Opcional String Abrangência: Vínculo (+).

- Máscara: A[100]
abrCar Opcional String Abrangência: Cargo ("+").

- Máscara: A[200]

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:CalcularResponse>
      <result>
        <erroExecucao>String</erroExecucao>
      </result>
    </ser:CalcularResponse>
  </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.

Escalonar

Web service para execução escalonada da rotina que simula o cálculo integral da folha mensal.

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:Escalonar>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <numEmp>Integer</numEmp>
        <gruEmp>Integer</gruEmp>
        <cmpCal>String</cmpCal>
        <codLot>Integer</codLot>
        <selCmp>Integer</selCmp>
        <abrCad>String</abrCad>
        <abrFil>String</abrFil>
        <abrLoc>String</abrLoc>
        <abrCCu>String</abrCCu>
        <abrSin>String</abrSin>
        <abrTCo>String</abrTCo>
        <abrTsa>String</abrTsa>
        <abrSit>String</abrSit>
        <abrEtb>String</abrEtb>
        <abrVin>String</abrVin>
        <abrCar>String</abrCar>
      </parameters>
    </ser:Escalonar>
  </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 no processo.

- Máscara: 9999
gruEmp Opcional Integer Abrangência: Código de grupo de empresas.

- Máscara: 999
cmpCal Obrigatório DateTime Competência que será utilizado para o cálculo.

- Máscara: MM/YYYY
codLot Opcional Integer Abrangência: Código de lote de colaboradores.

- Máscara: 9999
selCmp Opcional Integer Define a competência que será utilizada de acordo com a data da execução.

- Máscara: 9

Este parâmetro não deve ser informado (ou informar 0) caso o parâmetro CmpCal possuir valor.

Valores:
0 - Utiliza a competência informada.

1 - Competência da Data Agendada: Utilizará a competência da data de execução do processo.

2 - Competência Anterior: Utilizará a competência anterior à data de execução do processo.

3 - Competência Posterior: Utilizará a competência posterior à data de execução do processo.
abrCad Opcional String Abrangência: Colaborador (+).

- Máscara: A[200]
abrFil Opcional String Abrangência: Filial (+).

- Máscara: A[200]
abrLoc Opcional String Abrangência: Local ("+").

- Máscara: A[200]
abrCCu Opcional String Abrangência: Centro de Custo ("+").

- Máscara: A[200]
abrSin Opcional String Abrangência: Sindicato (+).

- Máscara: A[200]
abrTCo Opcional String Abrangência: Tipo de Contrato (+).

- Máscara: A[100]
abrTsa Opcional String Abrangência: Tipo de Salário (+).

- Máscara: A[100]
abrSit Opcional String Abrangência: Situação (+).

- Máscara: A[200]
abrEtb Opcional String Abrangência: Estabilidade (+).

- Máscara: A[100]
abrVin Opcional String Abrangência: Vínculo (+).

- Máscara: A[100]
abrCar Opcional String Abrangência: Cargo ("+").

- Máscara: A[200]

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