Web service com.senior.g5.rh.cs.hcm

Web service de integração com o módulo Painel de Gestão.

Tipo de execução

Para cada tipo de execução, existem parâmetros específicos, alguns dos quais podem ser comuns a todas as portas de web service.

Autenticação

Quando for utilizada alguma forma de autenticação na integração de informações por meio de web services, é necessário informar o tipo correspondente no parâmetro <encryption>, conforme os valores possíveis.

WSDL

Portas

AtualizaEnderecoResidencial

Permite atualizar o endereço residencial do colaborador.

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:AtualizaEnderecoResidencial> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <operacao>String</operacao> <empresa>Integer</empresa> <campos> <nomeCampo>String</nomeCampo> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campos> <tipo>Integer</tipo> <cadastro>Integer</cadastro> <dataAlteracao>DateTime</dataAlteracao> <executarRegra>Integer</executarRegra> </parameters> </ser:AtualizaEnderecoResidencial> </soapenv:Body> </soapenv:Envelope>

Parâmetros da requisição:

Nome

Preenchimento

Tipo

Descrição

operacao

Obrigatório

String

I - Incluir;


A - Alterar;


V - Validar;


E - Excluir.


empresa

Obrigatório

Integer

Código da Empresa.

campos

Opcional

Set

Lista de campos.

campos.nomeCampo

Obrigatório

String

Nome

Preenchimento

Tipo

Descrição

datAlt

Opcional

String

Data de alteração

  • Máscara: “dd/mm/yyyy”

tipLgr

Opcional

String

Tipo logradouro

endRua

Opcional

String

Endereço Residencial

endNum

Opcional

String

Número

endCep

Opcional

String

Cep

endCpl

Opcional

String

Complemento

codPai

Opcional

Integer

Código do País

codEst

Opcional

String

Estado

codCid

Opcional

Integer

Código da cidade

codBai

Opcional

Integer

Código do bairro

codRad

Opcional

Integer

Código da região administrativa

nomRad

Opcional

String

Nome da região administrativa

campos.valor

Opcional

String

Valor para o campo informado.

campos.status

Opcional

Integer

Número do Status da Operação dos campos.

campos.mensagem

Opcional

String

Mensagem do status da operação dos campos.

tipo

Obrigatório

Integer

Tipo do Colaborador.

cadastro

Obrigatório

Integer

Cadastro do colaborador.

dataAlteracao

Obrigatório

DateTime

Data do Endereço.

executarRegra

Obrigatório

Integer

Executar regra por processo:


1-Executar;


0-Não executar.

Resposta:

Nota

O envelope SOAP é retornado como resposta para requisições síncronas. Já para requisições assíncronas ou agendamentos, a resposta consiste apenas em uma string chamada result, que retorna o valor “OK” quando a execução ocorre com sucesso ou, em caso de falha, 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:AtualizaEnderecoResidencialResponse> <result> <status> <status>Integer</status> <mensagem>String</mensagem> </status> <campos> <nomeCampo>String</nomeCampo> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campos> <erroExecucao>String</erroExecucao> </result> </ser:AtualizaEnderecoResidencialResponse> </soapenv:Body> </soapenv:Envelope>

Atributos da resposta:

Nome

Preenchimento

Tipo

Descrição

status

Obrigatório

Set

Lista de status.

status.status

Obrigatório

Integer

Número do status da Operação.

status.mensagem

Obrigatório

String

Mensagem do status da operação:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro em campos;


4 - Erro não mapeado;


5 - Registro não existe;


6 - Parâmetro inválido;


7 - Aviso;


8 - Registro já cadastrado.


campos

Obrigatório

Set

Mensagem do Status dos campos.

campos.nomeCampo

Opcional

String

Nome do campo informado

campos.valor

Opcional

String

Valor do campo informado

campos.status

Obrigatório

Integer

Número do Status da Operação dos campos.

campos.mensagem

Obrigatório

String

Mensagem do status da operação dos campos:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro não mapeado;


4 - Campo não existe;


5 - Valor inválido;


6 - Aviso;


7 - Campo obrigatório não preenchido;


8 - Valor informado para o campo não existe ou não está disponível.


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.

CursoFormacao

Permite atualizar a formação acadêmica do colaborador.

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:CursoFormacao> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <campos> <nomeCampo>String</nomeCampo> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campos> <operacao>String</operacao> <pessoa>Integer</pessoa> <sequencia>Integer</sequencia> <executarRegra>Integer</executarRegra> </parameters> </ser:CursoFormacao> </soapenv:Body> </soapenv:Envelope>

Parâmetros da requisição:

Nome

Preenchimento

Tipo

Descrição

campos

Opcional

Set

Lista de campos.

campos.nomeCampo

Obrigatório

String

Nome

Preenchimento

Tipo

Descrição

codPes

Obrigatório

Integer

Código da Pessoa


seqCcs

Obrigatório

Integer

Sequência do Curso Formação

codCuf

Obrigatório

Integer

Código do Curso



  • Máscara: “9999”

nomCuf

Opcional

String

Nome do Curso de Formação

perIni

Opcional

Date

Data inicial



  • Máscara: “dd/mm/yyyy”

perFim

Opcional

Date

Data final



  • Máscara: “dd/mm/yyyy”

codOem

Opcional

Integer

Código da Entidade


nomOem

Opcional

String

Nome da entidade de ensino



  • Máscara: “A(60)”

datPrv

Opcional

Date

Data de previsão para conclusão



  • Máscara: “dd/mm/yyyy”

sitCuf

Obrigatório

Integer

Situação do curso



  • Máscara: “99”

nivCuf

Opcional

Integer

Nível de formação do curso



  • Máscara: “99”

seqNiv

Opcional

Integer

Sequência do Nível



  • Máscara: “99”

fasCuf

Opcional

String

Fase



-Máscara: “AAA”

comCuf

Opcional

String

Comentário

codAcn

Opcional

Integer

Área de conhecimento



  • Máscara: “9.99.99.99-9”

codMin

Opcional

Integer

Código do motivo de interrupção



-Máscara: “999

campos.valor

Opcional

String

Valor para o campo informado.

campos.status

Opcional

Integer

Status

campos.mensagem

Opcional

String

Mensagem

operacao

Obrigatório

String

I-Incluir;


A-Alterar;


V-Validar;


C-Consultar;


E-Excluir.

pessoa

Obrigatório

Integer

Código da Pessoa

sequencia

Obrigatório

Integer

Sequência

executarRegra

Obrigatório

Integer

Executar regra por processo:


1-Executar;


0-Não executar.

Resposta:

Nota

O envelope SOAP é retornado como resposta para requisições síncronas. Já para requisições assíncronas ou agendamentos, a resposta consiste apenas em uma string chamada result, que retorna o valor “OK” quando a execução ocorre com sucesso ou, em caso de falha, 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:CursoFormacaoResponse> <result> <campos> <nomeCampo>String</nomeCampo> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campos> <status> <status>Integer</status> <mensagem>String</mensagem> </status> <sequencia>Integer</sequencia> <erroExecucao>String</erroExecucao> </result> </ser:CursoFormacaoResponse> </soapenv:Body> </soapenv:Envelope>

Atributos da resposta:

Nome

Preenchimento

Tipo

Descrição

campos

Opcional

Set

Lista de campo

campos.nomeCampo

Opcional

String

Nome do campo informado

campos.valor

Opcional

String

Valor do campo informado

campos.status

Opcional

Integer

Número do Status da Operação dos campos.

campos.mensagem

Opcional

String

Mensagem do status da operação dos campos:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro não mapeado;


4 - Campo não existe;


5 - Valor inválido;


6 - Aviso;


7 - Campo obrigatório não preenchido;


8 - Valor informado para o campo não existe ou não está disponível.


status

Opcional

Set

Lista de status.

status.status

Opcional

Integer

Número do status da Operação.

status.mensagem

Opcional

String

Mensagem do status da operação:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro em campos;


4 - Erro não mapeado;


5 - Registro não existe;


6 - Parâmetro inválido;


7 - Aviso;


8 - Registro já cadastrado.


sequencia

Opcional

Integer

Sequência

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.

DadosPessoais

Permite atualizar os dados pessoais do colaborador.

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:DadosPessoais> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <operacao>String</operacao> <empresa>Integer</empresa> <campos> <nomeCampo>String</nomeCampo> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campos> <tipo>Integer</tipo> <cadastro>Integer</cadastro> <executarRegra>Integer</executarRegra> </parameters> </ser:DadosPessoais> </soapenv:Body> </soapenv:Envelope>

Parâmetros da requisição:

Nome

Preenchimento

Tipo

Descrição

operacao

Obrigatório

String

A - Alterar;


V - Validar;


C - Consultar.


empresa

Obrigatório

Integer

Código da Empresa.

campos

Opcional

Set

Lista de campos.

campos.nomeCampo

Obrigatório

String

Nome

Preenchimento

Tipo

Descrição

nomFun

Obrigatório

String

Nome completo

- Máscara: “A(40)”

datNas

Opcional

Date

Data de nascimento

- Máscara: “dd/mm/yyyy”

codNac

Obrigatório

Integer

Nacionalidade

- Máscara: “999”

estCiv

Obrigatório

Integer

Estado civil

- Máscara: “9”

tipSex

Obrigatório

String

Sexo



  • Máscara: “U”

graIns

Obrigatório

Integer

Nível de escolaridade(grau de instrução)

cciNas

Opcional

Integer

Naturalidade



  • Máscara: “99.9(5)”

campos.valor

Opcional

String

Valor para o campo informado.

campos.status

Opcional

Integer

Número do Status da Operação dos campos.

campos.mensagem

Opcional

String

Mensagem do status da operação dos campos:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro não mapeado;


4 - Campo não existe;


5 - Valor inválido;


6 - Aviso;


7 - Campo obrigatório não preenchido;


8 - Valor informado para o campo não existe ou não está disponível.


tipo

Obrigatório

Integer

Tipo do Colaborador.

cadastro

Obrigatório

Integer

Cadastro do colaborador.

executarRegra

Opcional

Integer

Executar regra por processo:


1-Executar;


0-Não executar.

Resposta:

Nota

O envelope SOAP é retornado como resposta para requisições síncronas. Já para requisições assíncronas ou agendamentos, a resposta consiste apenas em uma string chamada result, que retorna o valor “OK” quando a execução ocorre com sucesso ou, em caso de falha, 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:DadosPessoaisResponse> <result> <status> <status>Integer</status> <mensagem>String</mensagem> </status> <campos> <nomeCampo>String</nomeCampo> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campos> <erroExecucao>String</erroExecucao> </result> </ser:DadosPessoaisResponse> </soapenv:Body> </soapenv:Envelope>

Atributos da resposta:

Nome

Preenchimento

Tipo

Descrição

status

Obrigatório

Set

Lista de status.

status.status

Obrigatório

Integer

Número do status da Operação.

status.mensagem

Obrigatório

String

Mensagem do status da operação:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro em campos;


4 - Erro não mapeado;


5 - Registro não existe;


6 - Parâmetro inválido;


7 - Aviso;


8 - Registro já cadastrado.


campos

Obrigatório

Set

Mensagem do Status dos campos.

campos.nomeCampo

Opcional

String

Nome do campo informado

campos.valor

Opcional

String

Valor do campo informado

campos.status

Obrigatório

Integer

Número do Status da Operação dos campos.

campos.mensagem

Obrigatório

String

Mensagem do status da operação dos campos:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro não mapeado;


4 - Campo não existe;


5 - Valor inválido;


6 - Aviso;


7 - Campo obrigatório não preenchido;


8 - Valor informado para o campo não existe ou não está disponível.


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.

Deficiencias

Permite manter o registro das deficiências do colaborador.

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:Deficiencias> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <operacao>String</operacao> <empresa>Integer</empresa> <campos> <nomeCampo>String</nomeCampo> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campos> <tipo>Integer</tipo> <cadastro>Integer</cadastro> <deficienciaPrincipal>Integer</deficienciaPrincipal> <beneficiarioReabilitado>String</beneficiarioReabilitado> <executarRegra>Integer</executarRegra> </parameters> </ser:Deficiencias> </soapenv:Body> </soapenv:Envelope>

Parâmetros da requisição:

Nome

Preenchimento

Tipo

Descrição

operacao

Obrigatório

String

A - Alterar;


C - Consultar.


empresa

Obrigatório

Integer

Código da Empresa

campos

Opcional

Set

Lista de campos.

campos.nomeCampo

Obrigatório

String

Nome

Preenchimento

Tipo

Descrição

codDef

Obrigatório

Código da deficiência



  • Máscara: “99”

benRea

Opcional

Beneficiário Reabilitado



  • Máscara: “(S/N)”

decsri

Obrigatório

Código da Deficiência principal do colaborador



  • Máscara: “(S/N)”

campos.valor

Opcional

String

Valor para o campo informado.

campos.status

Opcional

Integer

Número do Status da Operação dos campos.

campos.mensagem

Opcional

String

Mensagem do status da operação dos campos:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro não mapeado;


4 - Campo não existe;


5 - Valor inválido;


6 - Aviso;


7 - Campo obrigatório não preenchido;


8 - Valor informado para o campo não existe ou não está disponível.


tipo

Obrigatório

Integer

Tipo do Colaborador.

cadastro

Obrigatório

Integer

Cadastro do colaborador

deficienciaPrincipal

Opcional

Integer

Deficiência principal do colaborador

beneficiarioReabilitado

Opcional

String

Beneficiário Reabilitado

executarRegra

Opcional

Integer

Executar regra por processo:


1-Executar;


0-Não executar.

Resposta:

Nota

O envelope SOAP é retornado como resposta para requisições síncronas. Já para requisições assíncronas ou agendamentos, a resposta consiste apenas em uma string chamada result, que retorna o valor “OK” quando a execução ocorre com sucesso ou, em caso de falha, 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:DeficienciasResponse> <result> <status> <status>Integer</status> <mensagem>String</mensagem> </status> <campos> <nomeCampo>String</nomeCampo> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campos> <deficienciaPrincipal>Integer</deficienciaPrincipal> <beneficiarioReabilitado>String</beneficiarioReabilitado> <erroExecucao>String</erroExecucao> </result> </ser:DeficienciasResponse> </soapenv:Body> </soapenv:Envelope>

Atributos da resposta:

Nome

Preenchimento

Tipo

Descrição

status

Obrigatório

Set

Lista de status.

status.status

Obrigatório

Integer

Número do status da Operação.

status.mensagem

Obrigatório

String

Mensagem do status da operação:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro em campos;


4 - Erro não mapeado;


5 - Registro não existe;


6 - Parâmetro inválido;


7 - Aviso;


8 - Registro já cadastrado.


campos

Obrigatório

Set

Mensagem do Status dos campos.

campos.nomeCampo

Opcional

String

Nome do campo informado

campos.valor

Opcional

String

Valor do campo informado

campos.status

Obrigatório

Integer

Número do Status da Operação dos campos.

campos.mensagem

Obrigatório

String

Mensagem do status da operação dos campos:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro não mapeado;


4 - Campo não existe;


5 - Valor inválido;


6 - Aviso;


7 - Campo obrigatório não preenchido;


8 - Valor informado para o campo não existe ou não está disponível.


deficienciaPrincipal

Opcional

Integer

Deficiência principal do colaborador

beneficiarioReabilitado

Opcional

String

Beneficiário Reabilitado

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.

Dependentes

Permite atualizar os dados cadastrais dos dependentes do colaborador.

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:Dependentes> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <operacao>String</operacao> <empresa>Integer</empresa> <campos> <nomeCampo>String</nomeCampo> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campos> <tipo>Integer</tipo> <cadastro>Integer</cadastro> <dependente>Integer</dependente> <executarRegra>Integer</executarRegra> </parameters> </ser:Dependentes> </soapenv:Body> </soapenv:Envelope>

Parâmetros da requisição:

Nome

Preenchimento

Tipo

Descrição

operacao

Obrigatório

String

I-Incluir;


A-Alterar;


V-Validar;


C-Consultar;


E-Excluir.

empresa

Obrigatório

Integer

Código da Empresa.

campos

Opcional

Set

Lista de campos.

campos.nomeCampo

Obrigatório

String

Nome

Preenchimento

Tipo

Descrição

graPar

Obrigatório

Integer

Grau de parentesco



  • Máscara: “99”

nomDep

Obrigatório

String

Nome do dependente



  • Máscara: “A(40)”

tipSex

Obrigatório

String

Sexo do dependente



  • Máscara: “99”

nomMae

Opcional

String

Nome da mãe do dependente



  • Máscara: “A(70)”

datNas

Opcional

Date

Data de nascimento



  • Máscara: “dd/mm/yyyy”

locNas

Opcional

Integer

Cidade de nascimento



  • Máscara: “99.9(5)”

matNas

Opcional

String

Matrícula



  • Máscara: “A(40)”

numReg

Opcional

String

Nº Termo



  • Máscara: “A(10)”

numLiv

Opcional

String

Nº do livro



  • Máscara: “A(10)”

numFol

Opcional

String

Nº da folha



  • Máscara: “A(10)”

nomCar

Opcional

String

Nome do cartório



  • Máscara: “A(40)”

nasViv

Opcional

String

Número da declaração de nascido vivo



  • Máscara: “A(20)”

numCid

Opcional

String

Número(RG)



  • Máscara: “A(15)”

emiCid

Opcional

String

Sigla do órgão emissor(RG)



  • Máscara: “A(20)”

estCid

Opcional

String

UF do órgão emissor



  • Máscara: “UU”

dexCid

Opcional

Date

Data de expedição(RG)



  • Máscara: “dd/mm/yyyy”

numCpf

Opcional

Double

Número de inscrição no CPF



  • Máscara: “999.999.999-99”

estCiv

Opcional

Integer

Estado civil do dependente



  • Máscara: 9

graIns

Opcional

String

Grau de instrução do dependente



  • Máscara: “99”

datObi

Opcional

Date

Data do óbito do dependente



  • Máscara: “dd/mm/yyyy”

matObi

Opcional

String

Matrícula(certidão de óbito)



  • Máscara: “A(40)”

numCer

Opcional

String

Nº Termo(certidão de óbito)



  • Máscara: “A(10)”

penJud

Opcional

String

pensão judicial



  • Máscara: “U”

campos.valor

Opcional

String

Valor para o campo informado.

campos.status

Opcional

Integer

Número do Status da Operação dos campos.

campos.mensagem

Opcional

String

Mensagem do status da operação dos campos:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro não mapeado;


4 - Campo não existe;


5 - Valor inválido;


6 - Aviso;


7 - Campo obrigatório não preenchido;


8 - Valor informado para o campo não existe ou não está disponível.


tipo

Obrigatório

Integer

Tipo do Colaborador.

cadastro

Obrigatório

Integer

Cadastro do colaborador.

dependente

Opcional

Integer

Código do dependente

executarRegra

Obrigatório

Integer

Executar regra por processo:


1-Executar;


0-Não executar.

Resposta:

Nota

O envelope SOAP é retornado como resposta para requisições síncronas. Já para requisições assíncronas ou agendamentos, a resposta consiste apenas em uma string chamada result, que retorna o valor “OK” quando a execução ocorre com sucesso ou, em caso de falha, 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:DependentesResponse> <result> <status> <status>Integer</status> <mensagem>String</mensagem> </status> <campos> <nomeCampo>String</nomeCampo> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campos> <dependente>Integer</dependente> <erroExecucao>String</erroExecucao> </result> </ser:DependentesResponse> </soapenv:Body> </soapenv:Envelope>

Atributos da resposta:

Nome

Preenchimento

Tipo

Descrição

status

Obrigatório

Set

Lista de status.

status.status

Obrigatório

Integer

Número do status da Operação.

status.mensagem

Obrigatório

String

Mensagem do status da operação:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro em campos;


4 - Erro não mapeado;


5 - Registro não existe;


6 - Parâmetro inválido;


7 - Aviso;


8 - Registro já cadastrado.


campos

Obrigatório

Set

Mensagem do Status dos campos.

campos.nomeCampo

Opcional

String

Nome do campo informado

campos.valor

Opcional

String

Valor do campo informado

campos.status

Obrigatório

Integer

Número do Status da Operação dos campos.

campos.mensagem

Obrigatório

String

Mensagem do status da operação dos campos:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro não mapeado;


4 - Campo não existe;


5 - Valor inválido;


6 - Aviso;


7 - Campo obrigatório não preenchido;


8 - Valor informado para o campo não existe ou não está disponível.


dependente

Opcional

Integer

Código do dependente

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.

DocumentosPessoais

Permite atualizar os documentos pessoais do colaborador.

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:DocumentosPessoais> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <operacao>String</operacao> <empresa>Integer</empresa> <campos> <nomeCampo>String</nomeCampo> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campos> <tipo>Integer</tipo> <cadastro>Integer</cadastro> <executarRegra>Integer</executarRegra> </parameters> </ser:DocumentosPessoais> </soapenv:Body> </soapenv:Envelope>

Parâmetros da requisição:

Nome

Preenchimento

Tipo

Descrição

operacao

Obrigatório

String

A - Alterar;


V - Validar;


C - Consultar.


empresa

Obrigatório

Integer

Código da Empresa.

campos

Opcional

Set

Lista de campos.

campos.nomeCampo

Obrigatório

String

Nome

Preenchimento

Tipo

Descrição

numCpf

Opcional

Double

Número do CPF



  • Máscara “999.999.999-99”

numPis

Obrigatório

Double

Número do PIS/PASEP



  • Máscara: “999.9(5).99.9”

dcdPis

Obrigatório

Date

Data de Cadastramento no PIS/PASEP



  • Máscara: “dd/mm/yyyy”

numCtp

Opcional

Integer

Número da Carteira de Trabalho



  • Máscara: “9(9)”

serCtp

Opcional

String

Série da Carteira de Trabalho



  • Máscara: “(5)”

dexCtp

Opcional

Date

Data de Expedição da Carteira de Trabalho



  • Máscara: “dd/mm/yyyy”

estCtp

Opcional

String

UF da Carteira de Trabalho



  • Máscara: “UU”

digCar

Opcional

String

Dígito da Carteira de Trabalho



  • Máscara: “AA”

numCid

Opcional

String

Número da carteira de identidade



  • Máscara: “A(16)”

emiCid

Opcional

String

Órgão emissor da carteira de identidade



  • Máscara: “U(20)”

estCid

Opcional

String

Estado do órgão emissor



  • Máscara: “UU”

dexCid

Opcional

Date

Data de Expedição da Carteira de Identidade



  • Máscara: “dd/mm/yyyy”

numCnh

Opcional

String

Número da Carteira de Habilitação



  • Máscara: “U(20)”

catCnh

Opcional

String

Categoria da Carteira de Habilitação



  • Máscara: “UUUU”

datCnh

Opcional

Date

Data da Expedição da CNH



  • Máscara: “dd/mm/yyyy”

venCnh

Opcional

Date

Data de Validade da Carteira de Habilitação



  • Máscara: “dd/mm/yyyy”

numPsp

Opcional

String

Número do Passaporte



  • Máscara: “A(20)”

emiPsp

Opcional

String

Emissor do Passaporte



  • Máscara: “A(6)”

demPsp

Opcional

Date

Data de Emissão do Passaporte



  • Máscara: “dd/mm/yyyy”

dvaPsp

Opcional

Date

Data de Validade do Passaporte



  • Máscara: “dd/mm/yyyy”

paiPsp

Opcional

Integer

País de emissão do Passaporte



  • Máscara: “9999”

estPsp

Opcional

String

Estado do Passaporte



  • Máscara: “UU”

numRic

Opcional

Double

Registro Identidade Civil



  • Máscara: “9(13)-9”

dexRic

Opcional

Date

Data de Expedição do RIC



  • Máscara: “dd/mm/yyyy”

emiRic

Opcional

String

Órgão Emissor do RIC



  • Máscara: “A(20)”

cidRic

Opcional

Integer

Cidade de Emissão do RIC



  • Máscara: “99.9(5)”

estRic

Opcional

String

Estado do Órgão Emissor do RIC



  • Máscara: “UU”

numEle

Opcional

String

Número do Título de Eleitor



  • Máscara: “A(13)”

zonEle

Opcional

String

Zona do Título de Eleitor



  • Máscara: “AAA”

secEle

Opcional

String

Seção do Título de Eleitor



  • Máscara: “AAAA”

carSus

Opcional

Double

Cartão Nacional Saúde



  • Máscara: “9(15)”

nasViv

Opcional

String

Declaração de Nascido Vivo



  • Máscara: “A(20)”

numPor

Opcional

String

Número da Portaria de Naturalização



  • Máscara: “A(15)”

datPor

Opcional

Date

Data de Naturalização



  • Máscara: “dd/mm/yyyy”

mATCCV

Opcional

String

Matrícula Certidão Civil



  • Máscara: “A(32)”

matCiv

Opcional

String

Termo/Matrícula da Certidão Civil



  • Máscara: “A(15)”

livCiv

Opcional

String

Livro da Certidão Civil



  • Máscara: “A(6)”

folCiv

Opcional

String

Folha da Certidão Civil



  • Máscara: “A(6)”

demCiv

Opcional

Date

Data de Emissão da Certidão Civil



  • Máscara: “dd/mm/yyyy”

carCiv

Opcional

String

Cartório de Registro da Certidão Civil



  • Máscara: “A(20)”

estCiv

Obrigatório

Integer

Estado da Certidão Civil



  • Máscara: “9”

cidCiv

Opcional

Integer

Cidade da Certidão Civil



  • Máscara: “99.9(5)”

numRes

Opcional

String

Número do Certificado de Reservista



  • Máscara: “A(13)”

catRes

Opcional

String

Categoria do Certificado de Reservista



  • Máscara: “A(5)”

visEst

Opcional

Integer

Classificação da condição do estrangeiro no Brasil



  • Máscara: “99”

dvlEst

Opcional

Date

Data de Validade da Carteira de Estrangeiro



  • Máscara: “dd/mm/yyyy”

regEst

Opcional

String

Carteira de Estrangeiro



  • Máscara: “A(14)”

emiEst

Opcional

String

Órgão emissor do registro de estrangeiro



  • Máscara: “A(20)”

datEst

Opcional

Date

Data de expedição do registro de estrangeiro



  • Máscara: “dd/mm/yyyy”

datChe

Opcional

Date

Data de chegada ao Brasil



  • Máscara: “dd/mm/yyyy”

dvlCtp

Opcional

Date

Data de Validade da Carteira de Trabalho (Estrangeiro)



  • Máscara: “dd/mm/yyyy”

casBra

Obrigatório

String

Casado com Brasileiro



  • Máscara: “U(S/N)”

filCbr

Obrigatório

String

Filhos Brasileiros



  • Máscara: “U(S/N)”

campos.valor

Opcional

String

Valor para o campo informado.

campos.status

Opcional

Integer

Número do Status da Operação dos campos.

campos.mensagem

Opcional

String

Mensagem do status da operação dos campos:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro não mapeado;


4 - Campo não existe;


5 - Valor inválido;


6 - Aviso;


7 - Campo obrigatório não preenchido;


8 - Valor informado para o campo não existe ou não está disponível.


tipo

Obrigatório

Integer

Tipo do Colaborador.

cadastro

Obrigatório

Integer

Cadastro do colaborador.

executarRegra

Opcional

Integer

Executar regra por processo:


1-Executar;


0-Não executar.

Resposta:

Nota

O envelope SOAP é retornado como resposta para requisições síncronas. Já para requisições assíncronas ou agendamentos, a resposta consiste apenas em uma string chamada result, que retorna o valor “OK” quando a execução ocorre com sucesso ou, em caso de falha, 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:DocumentosPessoaisResponse> <result> <status> <status>Integer</status> <mensagem>String</mensagem> </status> <campos> <nomeCampo>String</nomeCampo> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campos> <erroExecucao>String</erroExecucao> </result> </ser:DocumentosPessoaisResponse> </soapenv:Body> </soapenv:Envelope>

Atributos da resposta:

Nome

Preenchimento

Tipo

Descrição

status

Obrigatório

Set

Lista de status.

status.status

Obrigatório

Integer

Número do status da Operação.

status.mensagem

Obrigatório

String

Mensagem do status da operação:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro em campos;


4 - Erro não mapeado;


5 - Registro não existe;


6 - Parâmetro inválido;


7 - Aviso;


8 - Registro já cadastrado.


campos

Obrigatório

Set

Mensagem do Status dos campos.

campos.nomeCampo

Opcional

String

Nome do campo informado

campos.valor

Opcional

String

Valor do campo informado

campos.status

Obrigatório

Integer

Número do Status da Operação dos campos.

campos.mensagem

Obrigatório

String

Mensagem do status da operação dos campos:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro não mapeado;


4 - Campo não existe;


5 - Valor inválido;


6 - Aviso;


7 - Campo obrigatório não preenchido;


8 - Valor informado para o campo não existe ou não está disponível.


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.

EnderecosEletronicos

Permite atualizar os endereços eletrônicos do colaborador.

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:EnderecosEletronicos> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <operacao>String</operacao> <empresa>Integer</empresa> <campos> <nomeCampo>String</nomeCampo> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campos> <tipo>Integer</tipo> <cadastro>Integer</cadastro> <tipoEnderecoEletronico>Integer</tipoEnderecoEletronico> <sequencia>Integer</sequencia> </parameters> </ser:EnderecosEletronicos> </soapenv:Body> </soapenv:Envelope>

Parâmetros da requisição:

Nome

Preenchimento

Tipo

Descrição

operacao

Obrigatório

String

I-Incluir;


A-Alterar;


V-Validar;


C-Consultar;


E-Excluir.


empresa

Obrigatório

Integer

Código da Empresa

campos

Opcional

Set

Lista de campos.

campos.nomeCampo

Obrigatório

String

Nome

Preenchimento

Tipo

Descrição

endEle

Obrigatório

string

Endereço eletrônico



  • Máscara: “A(250)”

campos.valor

Opcional

String

Valor para o campo informado.

campos.status

Opcional

Integer

Número do Status da Operação dos campos.

campos.mensagem

Opcional

String

Mensagem do status da operação dos campos:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro não mapeado;


4 - Campo não existe;


5 - Valor inválido;


6 - Aviso;


7 - Campo obrigatório não preenchido;


8 - Valor informado para o campo não existe ou não está disponível.


tipo

Obrigatório

Integer

Tipo do Colaborador.

cadastro

Obrigatório

Integer

Cadastro do colaborador

tipoEnderecoEletronico

Obrigatório

Integer

Tipo do Endereço Eletrônico

sequencia

Opcional

Integer

Sequência do endereço eletrônico

Resposta:

Nota

O envelope SOAP é retornado como resposta para requisições síncronas. Já para requisições assíncronas ou agendamentos, a resposta consiste apenas em uma string chamada result, que retorna o valor “OK” quando a execução ocorre com sucesso ou, em caso de falha, 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:EnderecosEletronicosResponse> <result> <operacao>String</operacao> <status> <status>Integer</status> <mensagem>String</mensagem> </status> <campos> <nomeCampo>String</nomeCampo> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campos> <sequencia>Integer</sequencia> <erroExecucao>String</erroExecucao> </result> </ser:EnderecosEletronicosResponse> </soapenv:Body> </soapenv:Envelope>

Atributos da resposta:

Nome

Preenchimento

Tipo

Descrição

operacao

Obrigatório

String

I-Incluir;


A-Alterar;


V-Validar;


C-Consultar;


E-Excluir.


status

Obrigatório

Set

Lista de status.

status.status

Obrigatório

Integer

Número do status da Operação.

status.mensagem

Obrigatório

String

Mensagem do status da operação:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro em campos;


4 - Erro não mapeado;


5 - Registro não existe;


6 - Parâmetro inválido;


7 - Aviso;


8 - Registro já cadastrado.


campos

Obrigatório

Set

Mensagem do Status dos campos.

campos.nomeCampo

Opcional

String

Nome do campo informado

campos.valor

Opcional

String

Valor do campo informado

campos.status

Obrigatório

Integer

Número do Status da Operação dos campos.

campos.mensagem

Obrigatório

String

Mensagem do status da operação dos campos:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro não mapeado;


4 - Campo não existe;


5 - Valor inválido;


6 - Aviso;


7 - Campo obrigatório não preenchido;


8 - Valor informado para o campo não existe ou não está disponível.


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.

HistoricoCompetencia

Permite manter o registro do nível de proficiência para cada idioma do colaborador.

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:HistoricoCompetencia> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <operacao>String</operacao> <pessoa>Integer</pessoa> <campos> <nomeCampo>String</nomeCampo> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campos> <sequencia>Integer</sequencia> </parameters> </ser:HistoricoCompetencia> </soapenv:Body> </soapenv:Envelope>

Parâmetros da requisição:

Nome

Preenchimento

Tipo

Descrição

operacao

Obrigatório

String

I-Incluir;
A-Alterar;
V-Validar ;
C-Consultar;
E-Excluir.

pessoa

Obrigatório

Integer

Código da Pessoa.

campos

Opcional

Set

Lista de campos.

campos.nomeCampo

Obrigatório

String

Nome

Preenchimento

Tipo

Descrição

datHis

Obrigatório

Date

Data do histórico



  • Máscara: “dd/mm/yyyy”

codCpt

Obrigatório

Integer

Competência



revCpt

Obrigatório

String

Revisão



  • Máscara: “U(10)”

prfApl

Opcional

Integer

Perfil de aplicação



  • Máscara: “9999”

notCpt

Opcional

Double

Nota



  • Máscara: “ZZZ9,9999”

codCpr

Obrigatório

String

Conceito



  • Máscara: “U(10)”

datVal

Opcional

Date

Validade



  • Máscara: “dd/mm/yyyy”

indCer

Obrigatório

String

Certificado



  • Máscara: “U(S/N)”

perCpt

Opcional

Double

% atingido



  • Máscara: “ZZ9,9999”

obsHis

Opcional

String

Observação



oriHis

Opcional

Integer

Origem



  • Máscara: “9”

campos.valor

Opcional

String

Valor para o campo informado.

status.status

Opcional

Integer

Número do status da Operação.

status.mensagem

Opcional

String

Mensagem do status da operação:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro em campos;


4 - Erro não mapeado;


5 - Registro não existe;


6 - Parâmetro inválido;


7 - Aviso;


8 - Registro já cadastrado.


sequencia

Opcional

Integer

Sequência do registro

Resposta:

Nota

O envelope SOAP é retornado como resposta para requisições síncronas. Já para requisições assíncronas ou agendamentos, a resposta consiste apenas em uma string chamada result, que retorna o valor “OK” quando a execução ocorre com sucesso ou, em caso de falha, 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:HistoricoCompetenciaResponse> <result> <status> <status>Integer</status> <mensagem>String</mensagem> </status> <campos> <nomeCampo>String</nomeCampo> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campos> <sequencia>Integer</sequencia> <erroExecucao>String</erroExecucao> </result> </ser:HistoricoCompetenciaResponse> </soapenv:Body> </soapenv:Envelope>

Atributos da resposta:

Nome

Preenchimento

Tipo

Descrição

status

Obrigatório

Set

Lista de status.

status.status

Obrigatório

Integer

Número do status da Operação.

status.mensagem

Obrigatório

String

Mensagem do status da operação:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro em campos;


4 - Erro não mapeado;


5 - Registro não existe;


6 - Parâmetro inválido;


7 - Aviso;


8 - Registro já cadastrado.


campos

Obrigatório

Set

Mensagem do Status dos campos.

campos.nomeCampo

Opcional

String

Nome do campo informado

campos.valor

Opcional

String

Valor do campo informado

campos.status

Obrigatório

Integer

Número do Status da Operação dos campos.

campos.mensagem

Obrigatório

String

Mensagem do status da operação dos campos:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro não mapeado;


4 - Campo não existe;


5 - Valor inválido;


6 - Aviso;


7 - Campo obrigatório não preenchido;


8 - Valor informado para o campo não existe ou não está disponível.


sequencia

Opcional

Integer

Sequência do registro

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.

HistoricoCompetenciaEvidencias

Permite manter o registro do nível de proficiência para cada idioma do colaborador - Evidências.

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:HistoricoCompetenciaEvidencias> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <operacao>String</operacao> <pessoa>Integer</pessoa> <campos> <nomeCampo>String</nomeCampo> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campos> <sequencia>Integer</sequencia> <competencia>Integer</competencia> <revisao>String</revisao> <perfilAplicacao>Integer</perfilAplicacao> <evidencia>Integer</evidencia> </parameters> </ser:HistoricoCompetenciaEvidencias> </soapenv:Body> </soapenv:Envelope>

Parâmetros da requisição:

Nome

Preenchimento

Tipo

Descrição

operacao

Obrigatório

String

I-Incluir;


A - Alterar;


V - Validar;


C - Consultar;


E-Excluir.


pessoa

Obrigatório

Integer

Código da Pessoa.

campos

Opcional

Set

Lista de campos.

campos.nomeCampo

Obrigatório

String

Nome

Preenchimento

Tipo

Descrição

codTpr

Obrigatório

Integer

Tabela de proficiência



  • Máscara: “9999”

codCpr

Obrigatório

String

Conceito



  • Máscara: “U(10)”

notEvd

Opcional

Double

Nota



  • Máscara: “ZZZ9,9999”

campos.valor

Opcional

String

Valor para o campo informado.

campos.status

Opcional

Integer

Número do Status da Operação dos campos.

campos.mensagem

Opcional

String

Mensagem do status da operação dos campos:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro não mapeado;


4 - Campo não existe;


5 - Valor inválido;


6 - Aviso;


7 - Campo obrigatório não preenchido;


8 - Valor informado para o campo não existe ou não está disponível.


sequencia

Obrigatório

Integer

Sequência do registro

competencia

Obrigatório

Integer

Código da Competência

revisao

Obrigatório

String

Revisão Competência

perfilAplicacao

Obrigatório

Integer

Código do perfil de aplicação

evidencia

Obrigatório

Integer

Código do perfil de aplicação

Resposta:

Nota

O envelope SOAP é retornado como resposta para requisições síncronas. Já para requisições assíncronas ou agendamentos, a resposta consiste apenas em uma string chamada result, que retorna o valor “OK” quando a execução ocorre com sucesso ou, em caso de falha, 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:HistoricoCompetenciaEvidenciasResponse> <result> <status> <status>Integer</status> <mensagem>String</mensagem> </status> <campos> <nomeCampo>String</nomeCampo> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campos> <erroExecucao>String</erroExecucao> </result> </ser:HistoricoCompetenciaEvidenciasResponse> </soapenv:Body> </soapenv:Envelope>

Atributos da resposta:

Nome

Preenchimento

Tipo

Descrição

status

Obrigatório

Set

Lista de status.

status.status

Obrigatório

Integer

Número do status da Operação.

status.mensagem

Obrigatório

String

Mensagem do status da operação:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro em campos;


4 - Erro não mapeado;


5 - Registro não existe;


6 - Parâmetro inválido;


7 - Aviso;


8 - Registro já cadastrado.


campos

Obrigatório

Set

Mensagem do Status dos campos.

campos.nomeCampo

Opcional

String

Nome do campo informado

campos.valor

Opcional

String

Valor do campo informado

campos.status

Obrigatório

Integer

Número do Status da Operação dos campos.

campos.mensagem

Obrigatório

String

Mensagem do status da operação dos campos:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro não mapeado;


4 - Campo não existe;


5 - Valor inválido;


6 - Aviso;


7 - Campo obrigatório não preenchido;


8 - Valor informado para o campo não existe ou não está disponível.


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.

HistoricoTreinamentos

Permite manter o histórico de treinamentos do colaborador.

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:HistoricoTreinamentos> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <campos> <nomeCampo>String</nomeCampo> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campos> <operacao>String</operacao> <pessoa>Integer</pessoa> <sequencia>Integer</sequencia> <executarRegra>Integer</executarRegra> </parameters> </ser:HistoricoTreinamentos> </soapenv:Body> </soapenv:Envelope>

Parâmetros da requisição:

Nome

Preenchimento

Tipo

Descrição

campos

Opcional

Set

Lista de campos.

campos.nomeCampo

Opcional

String

Nome

Preenchimento

Tipo

Descrição

codCua

Obrigatório

Integer

Código do curso



  • Máscara: “9(9)”

nomCua

Opcional

String

Nome do Curso



  • Máscara: “A(200)”

perIni

Opcional

Date

Data inicial



  • Máscara: “dd/mm/yyyy”

perFim

Opcional

Date

Data final



  • Máscara: “dd/mm/yyyy”

codOem

Opcional

Integer

Código da Entidade de Ensino



  • Máscara: “9(8)”

nomOem

Opcional

String

Nome da Entidade de Ensino



  • Máscara: “A(60)”

sitCua

Obrigatório

Integer

Situação do curso



  • Máscara: “99”

tipCer

Opcional

String

Tipo de Certificado



  • Máscara: “U”

medCua

Opcional

Double

Média



  • Máscara: “ZZ9,99”

freCua

Opcional

Double

Frequência do curso



  • Máscara: “ZZ9,99”

carHor

Opcional

String

Carga horária



  • Máscara: “hhhh:mm”

idiCua

Obrigatório

String

Forma de Aquisição do Curso



  • Máscara: “U”

comCua

Opcional

String

Comentário do curso de aperfeiçoamento



  • Máscara: “A(250)”

campos.valor

Opcional

String

Valor para o campo informado.

campos.status

Opcional

Integer

Número do Status da Operação dos campos.

campos.mensagem

Opcional

String

Mensagem do status da operação dos campos.

operacao

Obrigatório

String

I-Incluir;


A-Alterar;


V-Validar;


C-Consultar;


E-Excluir.


pessoa

Obrigatório

Integer

Código da Pessoa.

executarRegra

Opcional

Integer

Resposta:

Nota

O envelope SOAP é retornado como resposta para requisições síncronas. Já para requisições assíncronas ou agendamentos, a resposta consiste apenas em uma string chamada result, que retorna o valor “OK” quando a execução ocorre com sucesso ou, em caso de falha, 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:HistoricoTreinamentosResponse> <result> <campos> <nomeCampo>String</nomeCampo> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campos> <status> <status>Integer</status> <mensagem>String</mensagem> </status> <sequencia>Integer</sequencia> <erroExecucao>String</erroExecucao> </result> </ser:HistoricoTreinamentosResponse> </soapenv:Body> </soapenv:Envelope>

Atributos da resposta:

Nome

Preenchimento

Tipo

Descrição

status

Opcional

Set

Lista de status.

status.status

Opcional

Integer

Número do status da Operação.

status.mensagem

Opcional

String

Mensagem do status da operação:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro em campos;


4 - Erro não mapeado;


5 - Registro não existe;


6 - Parâmetro inválido;


7 - Aviso;


8 - Registro já cadastrado.


campos

Opcional

Set

Mensagem do Status dos campos.

campos.nomeCampo

Opcional

String

Nome do campo informado

campos.valor

Opcional

String

Valor do campo informado

campos.status

Opcional

Integer

Número do Status da Operação dos campos.

campos.mensagem

Opcional

String

Mensagem do status da operação dos campos:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro não mapeado;


4 - Campo não existe;


5 - Valor inválido;


6 - Aviso;


7 - Campo obrigatório não preenchido;


8 - Valor informado para o campo não existe ou não está disponível.


sequencia

Opcional

Integer

Indica a sequência do histórico de aperfeiçoamento quando alterar ou excluir um registro. Na inclusão não é necessário informar, o sistema sempre gera automaticamente.

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.

MeusContatos

Permite atualizar os contatos do colaborador.

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:MeusContatos> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <operacao>String</operacao> <empresa>Integer</empresa> <campos> <nomeCampo>String</nomeCampo> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campos> <tipo>Integer</tipo> <cadastro>Integer</cadastro> <executarRegra>Integer</executarRegra> </parameters> </ser:MeusContatos> </soapenv:Body> </soapenv:Envelope>

Parâmetros da requisição:

Nome

Preenchimento

Tipo

Descrição

operacao

Obrigatório

String

I - Incluir;


A - Alterar;


V - Validar;


C - Consultar;


E - Excluir.


empresa

Obrigatório

Integer

Código da Empresa.

campos

Opcional

Set

Lista de campos.

campos.nomeCampo

Opcional

String

Nome

Preenchimento

Tipo

Descrição

ddiCel

Opcional

Integer

Código DDI do celular



  • Máscara: “999”

dddCel

Opcional

Integer

Código DDD do celular



  • Máscara: “999”

numCel

Opcional

String

Número do celular



  • Máscara: “A(20)”

ddiCom

Opcional

Integer

Código DDI do telefone comercial



  • Máscara: “999”

dddCom

Opcional

Integer

Código DDD do telefone comercial



  • Máscara: “999”

telCom

Opcional

String

Número do Telefone Comercial



  • Máscara: “A(20)”

ddiTel

Opcional

Integer

Código DDI do telefone



  • Máscara: “999”

dddTel

Opcional

Integer

Código DDD do telefone



  • Máscara: “999”

numTel

Opcional

String

Número do telefone



  • Máscara: “A(20)”

nmDdi2

Opcional

Integer

Código DDI do telefone 2



  • Máscara: “999”

nmDdd2

Opcional

Integer

Código DDD do telefone 2



  • Máscara: “999”

nmTel2

Opcional

String

Número do telefone 2



  • Máscara: “A(20)”

emaPar

Opcional

String

Endereço do Correio Eletrônico (E-mail) Particular



  • Máscara: “A(100)”

campos.valor

Opcional

String

Valor para o campo informado.

campos.status

Opcional

Integer

Número do Status da Operação dos campos.

campos.mensagem

Opcional

String

Mensagem do status da operação dos campos:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro não mapeado;


4 - Campo não existe;


5 - Valor inválido;


6 - Aviso;


7 - Campo obrigatório não preenchido;


8 - Valor informado para o campo não existe ou não está disponível.

tipo

Obrigatório

Integer

Tipo do Colaborador.

cadastro

Obrigatório

Integer

Cadastro do colaborador.

executarRegra

Opcional

Integer

Executar regra por processo:


1 - Executar;


0 - Não executar.

Resposta:

Nota

O envelope SOAP é retornado como resposta para requisições síncronas. Já para requisições assíncronas ou agendamentos, a resposta consiste apenas em uma string chamada result, que retorna o valor “OK” quando a execução ocorre com sucesso ou, em caso de falha, 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:MeusContatosResponse> <result> <status> <status>Integer</status> <mensagem>String</mensagem> </status> <campos> <nomeCampo>String</nomeCampo> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campos> <erroExecucao>String</erroExecucao> </result> </ser:MeusContatosResponse> </soapenv:Body> </soapenv:Envelope>

Atributos da resposta:

Nome

Preenchimento

Tipo

Descrição

status

Opcional

Set

Lista de status.

status.status

Opcional

Integer

Número do status da Operação.

status.mensagem

Opcional

String

Mensagem do status da operação:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro em campos;


4 - Erro não mapeado;


5 - Registro não existe;


6 - Parâmetro inválido;


7 - Aviso;


8 - Registro já cadastrado.


campos

Opcional

Set

Mensagem do Status dos campos.

campos.nomeCampo

Opcional

String

Nome do campo informado

campos.valor

Opcional

String

Valor do campo informado

campos.status

Opcional

Integer

Número do Status da Operação dos campos.

campos.mensagem

Opcional

String

Mensagem do status da operação dos campos:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro não mapeado;


4 - Campo não existe;


5 - Valor inválido;


6 - Aviso;


7 - Campo obrigatório não preenchido;


8 - Valor informado para o campo não existe ou não está disponível.


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.

RegistroProfissional

Permite atualizar o registro profissional do colaborador.

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:RegistroProfissional> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <operacao>String</operacao> <empresa>Integer</empresa> <campos> <nomeCampo>String</nomeCampo> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campos> <tipo>Integer</tipo> <cadastro>Integer</cadastro> <executarRegra>Integer</executarRegra> </parameters> </ser:RegistroProfissional> </soapenv:Body> </soapenv:Envelope>

Parâmetros da requisição:

Nome

Preenchimento

Tipo

Descrição

operacao

Obrigatório

String

A - Alterar;


V - Validar;


C - Consultar.


empresa

Obrigatório

Integer

Código da Empresa.

campos

Opcional

Set

Lista de campos.

campos.nomeCampo

Obrigatório

String

Nome

Preenchimento

Tipo

Descrição

codPrf

Opcional

Integer

Nome do conselho profissional



  • Máscara: “999”

sitReg

Opcional

String

Tipo do registro profissional



  • Máscara: “U (P - provisório ou D - definitivo)”

regCon

Opcional

String

Número do registro profissional



  • Máscara: “A(20)”

datExp

Opcional

Date

Data de emissão



  • Máscara: “dd/mm/yyyy”

datVen

Opcional

Date

Data de validade:



  • Máscara: “dd/mm/yyyy”

campos.valor

Opcional

String

Valor para o campo informado.

campos.status

Obrigatório

Integer

Número do Status da Operação dos campos.

campos.mensagem

Obrigatório

String

Mensagem do status da operação dos campos:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro não mapeado;


4 - Campo não existe;


5 - Valor inválido;


6 - Aviso;


7 - Campo obrigatório não preenchido;


8 - Valor informado para o campo não existe ou não está disponível.


tipo

Obrigatório

Integer

Tipo do Colaborador.

cadastro

Obrigatório

Integer

Cadastro do colaborador.

executarRegra

Opcional

Integer

Executar regra por processo:


1-Executar;


0-Não executar.

Resposta:

Nota

O envelope SOAP é retornado como resposta para requisições síncronas. Já para requisições assíncronas ou agendamentos, a resposta consiste apenas em uma string chamada result, que retorna o valor “OK” quando a execução ocorre com sucesso ou, em caso de falha, 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:RegistroProfissionalResponse> <result> <status> <status>Integer</status> <mensagem>String</mensagem> </status> <campos> <nomeCampo>String</nomeCampo> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campos> <erroExecucao>String</erroExecucao> </result> </ser:RegistroProfissionalResponse> </soapenv:Body> </soapenv:Envelope>

Atributos da resposta:

Nome

Preenchimento

Tipo

Descrição

status

Obrigatório

Set

Lista de status.

status.status

Obrigatório

Integer

Número do status da Operação.

status.mensagem

Obrigatório

String

Mensagem do status da operação:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro em campos;


4 - Erro não mapeado;


5 - Registro não existe;


6 - Parâmetro inválido;


7 - Aviso;


8 - Registro já cadastrado.


campos

Obrigatório

Set

Mensagem do Status dos campos.

campos.nomeCampo

Opcional

String

Nome do campo informado

campos.valor

Opcional

String

Valor do campo informado

campos.status

Obrigatório

Integer

Número do Status da Operação dos campos.

campos.mensagem

Obrigatório

String

Mensagem do status da operação dos campos:


0 - OK;


1 - Consistência de negócio;


2 - Consistência customizada;


3 - Erro não mapeado;


4 - Campo não existe;


5 - Valor inválido;


6 - Aviso;


7 - Campo obrigatório não preenchido;


8 - Valor informado para o campo não existe ou não está disponível.


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ê?