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.matriculaesocial

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

Web service que permite cadastrar, alterar e excluir a matrícula dos colaboradores no eSocial.

Disponível nos módulos CP e SM.

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(s)

MatriculaESocial

Necessita autenticação: Sim.

Situação da versão: Atual.

Versão: 1.

Versão atual: 1.

Requisição:

<soapenv:Envelope xmlns:ser="http://services.senior.com.br" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Body>
    <ser:MatriculaESocial>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <numEmp>Integer</numEmp>
        <tipCol>Integer</tipCol>
        <numCad>Integer</numCad>
        <matEso>String</matEso>
        <tipOpe>String</tipOpe>
      </parameters>
    </ser:MatriculaESocial>
  </soapenv:Body>
</soapenv:Envelope>
		

Parâmetros da requisição:

Nome Preenchimento Tipo Descrição
numEmp Obrigatório Integer Código da empresa que será utilizado na integração.
- Chave
tipCol Obrigatório Integer Informar o tipo de colaborador.
- Chave

Valores
1 - Empregado;
2 - Terceiro;
3 - Parceiro.
numCad Obrigatório Integer Informar o número de cadastro do colaborador, terceiro ou parceiro.
- Chave
matEso Opcional String

Matrícula do colaborador no eSocial.
- Máscara: A[30]

tipOpe Opcional String Tipo da operação a ser efetuada na integração:
"I" - Inclusão;
"A" - Alteração;
"E" - Exclusão.

Se não o parâmetro for informado, será considerado como "A" - Alteração.

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:ser="http://services.senior.com.br" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Body>
    <ser:MatriculaESocialResponse>
      <result>
        <erroExecucao>String</erroExecucao>
      </result>
    </ser:MatriculaESocialResponse>
  </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ê?