PORTAL DE DOCUMENTAÇÃO
Gestão de Pessoas | HCM - versão 6.10.4

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

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

Dependente_2

Web service de integração que permite cadastrar informações dos dependentes e familiares dos colaboradores.
Disponível nos módulos BS, JR, QL, RS, AP, SM e TR.

**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:Dependente_2>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<tipOpe>String</tipOpe>
<numEmp>Integer</numEmp>
<tipCol>Integer</tipCol>
<numCad>Integer</numCad>
<codDep>Integer</codDep>
<nomDep>String</nomDep>
<datNas>String</datNas>
<nomMae>String</nomMae>
<graPar>Integer</graPar>
<tipDep>Integer</tipDep>
<desDep>String</desDep>
<penJud>String</penJud>
<tipSex>String</tipSex>
<numCpf>String</numCpf>
<estCiv>Integer</estCiv>
<graIns>Integer</graIns>
<limIrf>Integer</limIrf>
<limSaf>Integer</limSaf>
<datInv>String</datInv>
<iniTut>String</iniTut>
<datTut>String</datTut>
<aviImp>String</aviImp>
<auxCre>String</auxCre>
<nomCre>Integer</nomCre>
<depRPP>String</depRPP>
<codFic>String</codFic>
<nomCom>String</nomCom>
<codFor>Integer</codFor>
</parameters>
</ser:Dependente_2>
</soapenv:Body>
</soapenv:Envelope>

**Parâmetros da requisição: **

Nome

Preenchimento

Tipo

Descrição

tipOpe

Obrigatório

String

Tipo da operação a ser efetuada na integração.


  • Obrigatório


Valores:


I - Inclusão


A - Alteração


E - Exclusão

numEmp

Obrigatório

Integer

Código da empresa que será utilizada na integração.


  • Obrigatório

  • Chave

tipCol

Obrigatório

Integer

Informar o tipo de colaborador.


  • Obrigatório

  • Chave


Valores:


1 - Empregado


2 - Terceiro


3 - Parceiro

numCad

Obrigatório

Integer

Indicar um número de cadastro para identificar cada colaborador, terceiro ou parceiro.


  • Obrigatório

  • Chave

codDep

Obrigatório

Integer

Informar o código do dependente.


  • Obrigatório

  • Chave

nomDep

Opcional

String

Informar o nome do dependente.


  • Obrigatório para inclusão

datNas

Opcional

DateTime

Informar a data de nascimento do dependente.
- Obrigatório para inclusão

Máscara: DD/MM/AAAA

  • O preenchimento deste campo é obrigatório somente quando existir algum valor nos campos Idade Limite IR ou Idade Limite Salário Família ou quando o Grau de Parentesco for 1, 11, 14, 15, 17 ou 18.

nomMae

Opcional

String

Informar o nome da mãe.


  • Opcional


  • Somente disponível nos módulos BS e AP.

graPar

Opcional

Integer

Informar o código de parentesco do dependente.


  • Obrigatório para inclusão


Valores:


1 - Filho(a)


2 - Cônjuge


3 - Pai / Mãe


4 - Avô / Avó


5 - Bisavô / Bisavó


6 - Sobrinho(a)


7 - Tio(a)


8 - Neto(a)


9 - Sogro(a)


10 - Genro / Nora


11- Enteado(a)


12- Irmão(ã)


14 - Filho(a) Adotivo(a)


15 - Pensionistas


16 - Companheiro(a)


17 - Tutelado


18 - Menor sob Guarda


19 - Madrasta


20 - Padrasto


21 - Tutor


26 - Curatelado(a)


99 - Outros

tipDep

Opcional

Integer

Informe o código de parentesco do dependente. Obrigatório para inclusão.



Valores:


0 - Não levar Dependente para eSocial


1 - Cônjuge


2 - Companheiro(a)


3 - Filho(a) / Enteado(a)


4 - Irmão(ã) / Neto(a) / Bisneto(a)


5 - Pais / Avós / Bisavós


6 - Menor


7 - Pessoa Incapaz


8 - Filho / Enteado até 24 anos


15- Ex-Cônjuge


99- Agregado / Outros

desDep

Integer

Opcional

Descrição Dependência

Obrigatório e exclusivo quando o tipo dependente eSocial for “99 - Agregado/Outros”.

  • Máscara: A[100]

penJud

Opcional

String

Informar se o dependente em questão deve ser considerado como dependente para cálculo de pensão judicial.


  • Opcional


Valores:


S - Sim


N - Não

tipSex

Opcional

String

Informar o sexo do dependente.


  • Obrigatório para inclusão


Valores:


M - Masculino


F - Feminino

numCpf

Opcional

String

Informar o número do CPF do dependente.
- Opcional

* No caso de informar esta opção assegurar-se que seja um CPF válido.
** Não é utilizado nos Módulos: SM, QL, RS,TR.

estCiv

Opcional

Integer

Informar o estado civil do dependente.


  • Opcional


  • Somente disponível no módulo Administração de Pessoal.


Valores:


1 - Solteiro


2 - Casado


3 - Separado Judicialmente/Divorciado


4 - Viúvo


5 - Concubinado


6 - Separado


9 - Outros

graIns

Opcional

Integer

Informar o grau de instrução deste dependente, conforme o que fora definido no menu Tabelas/Gerais/Graus de Instrução.


  • Opcional


  • Somente disponível no módulo Administração de Pessoal.

limIrf

Opcional

Integer

Informar a idade limite final da dependência do dependente para IR. O módulo cancelará a dependência automaticamente, a partir do mês seguinte em que ele completar esta idade.


Quando não houver limite informe 99 e para os que não forem dependentes indicar zeros.


  • Opcional


  • Somente disponível nos módulos AP e BS.


Valor Padrão: 21

limSaf

Opcional

Integer

Informar a idade limite de dependência para SF. O módulo cancelará a dependência automaticamente, no mês seguinte ao da idade limite.


Quando não houver limite informar 99 e para os que não forem dependentes informar zeros.


  • Opcional


  • Somente disponível nos módulos AP e BS.

  • Somente informar se o parâmetro GraPar for 1, 2, 11, 14, 15, 17 ou 18.


Valor Padrão: 14

datInv

Opcional

DateTime

Informar a data do atestado de invalidez, quando houver.


  • Opcional


  • Somente disponível no módulo Administração de Pessoal.


Máscara: DD/MM/AAAA

iniTut

Opcional

DateTime

Informar a data inicial da tutela.


  • Opcional


  • Somente informar se o parâmetro GraPar = 17 (Tutelado).

  • Somente disponível no módulo AP.


Máscara: DD/MM/AAAA

datTut

Opcional

DateTime

Informar a data final da tutela.


  • Opcional


  • Somente informar se o parâmetro GraPar = 17 (Tutelado).

  • Somente disponível no módulo Administração de Pessoal.


Máscara: DD/MM/AAAA

aviImp

Opcional

String

Informar o controle dos avisos emitidos aos colaboradores que possuem dependentes para salário família e não apresentaram o comprovante de vacinação obrigatória no primeiro ano de vida.


  • Obrigatório na inclusão


  • Somente informar se o parâmetro GraPar for 1, 11, 14, 15, 17 ou 18.

  • Somente disponível no módulo Administração de Pessoal.


S - Aviso caderneta de vacinação já emitido


N - Aviso ainda não emitido

auxCre

Opcional

String

Indicar se é dependente de creche, em relação a algum benefício concedido pela empresa ou para geração de relatórios.


  • Opcional


  • Somente informar se o parâmetro GraPar for algum dos seguintes valores: 1, 6, 8, 11, 14, 15, 17 ou 18.

  • Somente disponível nos módulos BS e AP.


Valores:


S - Sim


N - Não

nomCre

Opcional

Integer

informar até quantos meses, o dependente é considerado como dependente creche.


  • Opcional


  • Somente informar se o parâmetro GraPar for algum dos seguintes valores: 1, 6, 8, 11, 14, 15, 17 ou 18.

  • Somente disponível nos módulos BS e AP.

depRPP

Opcional

String

Informar se dependente conta para fins de RPPS

Valores válidos:

S - Sim

N - Não

codFic

Opcional

String

Definir a geração da ficha médica para o dependente.



  • Somente informar se for integrado com o módulo SM.


Se no SM em Medicina/Definições/Ficha Médica/Gerar Ficha Dependente estiver informado:


N - não informar este parâmetro


S - informar no parâmetro: AUTO


C - informar no parâmetro:


CONFIRMA - se quiser gerar a ficha médica


CANCELA - se não quiser gerar a ficha médica


U - informar no parâmetro: NOVO


  • se quiser que o SM gere um novo código da ficha médica

  • senão informe o código da ficha médica que quiser para o dependente

nomCom

Opcional

String

Informar o Nome Completo do Dependentente


  • Opcional

codFor

Opcional

Integer

informar o Código do Fornecedor.


  • Opcional


*Disponível somente no módulo Administração de Pessoal.


*O campo não está disponível quando a empresa ativa possuir integração com o ERP apenas contábil ou não possuir integração com o ERP.

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

Obito

Web service de integração que permite realizar manutenção na guia Óbito do cadastro de Dependentes.
Disponível nos módulos BS, JR, QL, RS, AP, SM e TR.

**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:Obito>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<numEmp>Integer</numEmp>
<tipCol>Integer</tipCol>
<numCad>Integer</numCad>
<codDep>Integer</codDep>
<datObi>String</datObi>
<numCer>String</numCer>
<matObi>String</matObi>
</parameters>
</ser:Obito>
</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 na integração.


  • Obrigatório

  • Chave

tipCol

Obrigatório

Integer

Informar o tipo de colaborador.


  • Obrigatório

  • Chave


Valores:


“1” - Empregado


“2” - Terceiro


“3” - Parceiro

numCad

Obrigatório

Integer

Indicar um número de cadastro para identificar cada colaborador, terceiro ou parceiro.


  • Obrigatório

  • Chave

codDep

Obrigatório

Integer

Informar código do dependente


  • Obrigatório

  • Chave

datObi

Opcional

DateTime

Indicar a data de falecimento do dependente.


  • Opcional


Máscara:


DD/MM/AAAA

numCer

Opcional

String

Indicar o número da certidão de óbito do dependente.


  • Opcional

matObi

Opcional

String

Indicar o número da certidão de óbito do dependente.


  • Opcional

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

Nascimento

Web service de integração que permite realizar manutenção na guia Nascimento do cadastro de Dependentes.
Disponível nos módulos BS, JR, QL, RS, AP, SM e TR.

**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:Nascimento>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<numEmp>Integer</numEmp>
<tipCol>Integer</tipCol>
<numCad>Integer</numCad>
<codDep>Integer</codDep>
<locNas>Integer</locNas>
<nomCar>String</nomCar>
<numLiv>String</numLiv>
<numFol>String</numFol>
<numReg>String</numReg>
<matNas>String</matNas>
<entCer>String</entCer>
<nasViv>String</nasViv>
</parameters>
</ser:Nascimento>
</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 na integração.


  • Obrigatório

  • Chave

  • Máscara: 9999

tipCol

Obrigatório

Integer

Tipo de colaborador.


  • Obrigatório

  • Chave

  • Máscara: 9


Valores:


1 - Empregado


2 - Terceiro


3 - Parceiro

numCad

Obrigatório

Integer

Código do Colaborador.


  • Obrigatório

  • Chave

  • Máscara: 999999999

codDep

Obrigatório

Integer

Código do Dependente.


  • Obrigatório

  • Chave

  • Máscara: 99

locNas

Opcional

Integer

Código da cidade de nascimento do dependente.


  • Opcional

  • Máscara: 99.99999

nomCar

Opcional

String

Nome do cartório de registro do dependente.


  • Opcional

  • Máscara: A[40]

numLiv

Opcional

String

Número do livro de registro do dependente.


  • Opcional

  • Máscara: A[10]

numFol

Opcional

String

Número da folha do livro de registro do dependente.


  • Opcional

  • Máscara: A[10]

numReg

Opcional

String

Número do registro de nascimento do dependente.


  • Opcional

  • Máscara: A[10]

matNas

Opcional

String

Número do registro de nascimento do dependente.


  • Opcional

  • Máscara: A[10]

entCer

Opcional

DateTime

Data da entrega da certidão de nascimento.


  • Opcional

  • Máscara: DD/MM/YYYY

nasViv

Opcional

String

Declaração de Nascido Vivo.


  • Opcional

  • Máscara: A[20]

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

Comprovante

Web service de integração que permite realizar manutenção na guia Comprovantes do cadastro de Dependentes.
Disponível nos módulos BS, JR, QL, RS, AP, SM e TR.

**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:Comprovante>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<numEmp>Integer</numEmp>
<tipCol>Integer</tipCol>
<comprovantes>
<tipOpe>String</tipOpe>
<anoEsc>Integer</anoEsc>
<codOem>Integer</codOem>
<depBol>String</depBol>
<datVac>String</datVac>
<serIns>Integer</serIns>
<entMai>String</entMai>
<perMai>Double</perMai>
<entNov>String</entNov>
<perNov>Double</perNov>
</comprovantes>
<numCad>Integer</numCad>
<codDep>Integer</codDep>
</parameters>
</ser:Comprovante>
</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 na integração.


  • Obrigatório

  • Chave

  • Máscara: 9999

tipCol

Obrigatório

Integer

Tipo de colaborador.


  • Obrigatório

  • Chave

  • Máscara: 9


Valores:


1 - Empregado


2 - Terceiro


3 - Parceiro

comprovantes

Opcional

Set

Lista de comprovantes do dependente.

comprovantes.tipOpe

Obrigatório

String

Tipo da operação a ser efetuada para um lançamento (uma linha).


  • Obrigatório

  • Máscara: U

  • Valores:

“I” - Inclusão


“A” - Alteração


“E” - Exclusão


  • Obs.: Se não for informado, será considerado “Alteração”.

comprovantes.anoEsc

Obrigatório

Integer

Ano de Referência.


  • Obrigatório

  • Chave

  • Máscara: 9999

comprovantes.codOem

Opcional

Integer

Código de Empresa da Escola


  • Opcional

  • Máscara: 9[8]

comprovantes.depBol

Opcional

String

Dependente Bolsista.


  • Opcional

  • Máscara: U

  • Valores:

“S” - Sim


“N” - Não

comprovantes.datVac

Opcional

DateTime

Data de entrega do comprovante de vacinação


  • Opcional

  • Máscara: DD/MM/YYYY

comprovantes.serIns

Opcional

Integer

Série do Dependente.


  • Opcional

  • Máscara: 99

  • Valores:

1 - Maternal


2 - Jardim de Infância


3 - Pré-Escola


4 - 1ª Série \ 1º Grau


5 - 2ª Série \ 1º Grau


6 - 3ª Série \ 1º Grau


7 - 4ª Série \ 1º Grau


8 - 5ª Série \ 1º Grau


9 - 6ª Série \ 1º Grau


10 - 7ª Série \ 1º Grau


11 - 8ª Série \ 1º Grau


12 - 9ª Série \ 1º Grau


13 - 1ª Série \ 2º Grau


14 - 2ª Série \ 2º Grau


15 - 3ª Série \ 2º Grau


16 - Faculdade


17 - Outros

comprovantes.entMai

Opcional

DateTime

Data da entrega da frequência de maio.


  • Opcional

  • Máscara: DD/MM/YYYY

comprovantes.perMai

Opcional

Double

Percentual de frequência entregue em maio.


  • Opcional

  • Máscara: ZZ9,99

comprovantes.entNov

Opcional

DateTime

Data da entrega da frequência de novembro.


  • Opcional

  • Máscara: DD/MM/YYYY

comprovantes.perNov

Opcional

Double

Percentual de frequência entregue em novembro.


  • Opcional

  • Máscara: ZZ9,99

numCad

Obrigatório

Integer

Código do Colaborador.


  • Obrigatório

  • Chave

  • Máscara: 999999999

codDep

Obrigatório

Integer

Código do Dependente.


  • Obrigatório

  • Chave

  • Máscara: 99

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

PeriodosIR

Web service de integração que permite realizar manutenção na guia Períodos IR do cadastro de Dependentes.
Disponível nos módulos BS, JR, QL, RS, AP, SM e TR.

**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:PeriodosIR>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<numEmp>Integer</numEmp>
<tipCol>Integer</tipCol>
<periodosIr>
<tipOpe>String</tipOpe>
<cmpIni>String</cmpIni>
<cmpFim>String</cmpFim>
</periodosIr>
<numCad>Integer</numCad>
<codDep>Integer</codDep>
</parameters>
</ser:PeriodosIR>
</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 na integração.
- Obrigatório
- Chave
- Máscara: 9999

tipCol

Obrigatório

Integer

Tipo de colaborador.
- Obrigatório
- Chave
- Máscara: 9

Valores:
1 - Empregado
2 - Terceiro
3 - Parceiro

periodosIr

Opcional

Set

Lista de períodos de validade para IR.

periodosIr.tipOpe

Obrigatório

String

Tipo da operação a ser efetuada para um lançamento (uma linha).
- Obrigatório
- Máscara: U
- Valores:
“I” - Inclusão
“A” - Alteração
“E” - Exclusão

Nota

Se nenhum valor for informado para este parâmetro, a operação será considerada como “Alteração”.

periodosIr.cmpIni

Obrigatório

DateTime

Início do período de validade do IRRF.
- Obrigatório
- Chave
- Máscara: MM/YYYY

Nota

Não é possível alterar a data inicial da competência, apenas a final. Para alteração da data inicial é necessário excluir a competência e inseri-la novamente com a nova data de início desejada.

periodosIr.cmpFim

Opcional

DateTime

Fim do período de validade do IRRF.
- Opcional
- Chave
- Máscara: MM/YYYY

numCad

Obrigatório

Integer

Código do Colaborador.


  • Obrigatório

  • Chave

  • Máscara: 999999999

codDep

Obrigatório

Integer

Código do Dependente.
- Obrigatório
- Chave
- Máscara: 99

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

PlanoSaude

Web service de integração que permite realizar manutenção na guia Plano de Saúde do cadastro de Dependentes.
Disponível nos módulos BS, JR, QL, RS, AP, SM e TR.

**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:PlanoSaude>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<numEmp>Integer</numEmp>
<tipCol>Integer</tipCol>
<numCad>Integer</numCad>
<codDep>Integer</codDep>
<numMat>Double</numMat>
<matStr>String</matStr>
<datInc>String</datInc>
<datExc>String</datExc>
</parameters>
</ser:PlanoSaude>
</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 na integração.


  • Obrigatório

  • Chave

  • Máscara: 9999

tipCol

Obrigatório

Integer

Tipo de colaborador.


  • Obrigatório

  • Chave

  • Máscara: 9


Valores:


1 - Empregado


2 - Terceiro


3 - Parceiro

numCad

Obrigatório

Integer

Código do Colaborador.


  • Obrigatório

  • Chave

  • Máscara: 999999999

codDep

Obrigatório

Integer

Código do Dependente.


  • Obrigatório

  • Chave

  • Máscara: 99

numMat

Opcional

Double

Número da matrícula no plano de saúde.


  • Opcional

  • Máscara: 9[16]


Este campo somente fica disponível quando em Diversos > Assinalamentos,


o campo “Utiliza matrícula Alfanumérica” está preenchido com “N - Não”

matStr

Opcional

String

Matrícula no plano de saúde em caracteres.


  • Opcional

  • Máscara: A[20]


Este campo somente fica disponível quando em Diversos > Assinalamentos,


o campo “Utiliza matrícula Alfanumérica” está preenchido com “S - Sim”

datInc

Opcional

DateTime

Data de inclusão no plano de saúde.


  • Opcional

  • Máscara: DD/MM/YYYY

datExc

Opcional

DateTime

Data de exclusão no plano de saúde.


  • Opcional

  • Máscara: DD/MM/YYYY

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

Base de Conhecimento

Portal de Exigências Legais

Documentação em outros idiomas:

English

Español

Senior Store

Universidade Corporativa

Fórum de Produtos

Trabalhe conosco

Blog

Todos os direitos de cópias reservadas para Senior Sistemas S.A.

A reprodução não autorizada desta publicação, no todo ou em parte, constitui violação dos direitos autorais (Lei 9.610/98).