Web service com.senior.g5.rh.rs.fichaComplementar

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

FichaComplementar_7

Web service de integração que permite preencher informações complementares relativas ao colaborador, terceiro e parceiro.
Disponível em todos os módulo.

**Necessita autenticação: **Sim

**Situação de versão: ** Atual

**Versão: **7

**Requisição: **

<soapenv:Envelope xmlns:soapenv=“http://schemas.xmlsoap.org/soap/envelope/” xmlns:ser=“http://services.senior.com.br”>
<soapenv:Body>
<ser:FichaComplementar>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<numEmp>Integer</numEmp>
<tipPsa>String</tipPsa>
<matIpe>Integer</matIpe>
<tipOpe>String</tipOpe>
<codPsa>String</codPsa>
<altIpe>DateTime</altIpe>
<tipCol>Integer</tipCol>
<matPsa>Double</matPsa>
<sitIpe>Integer</sitIpe>
<numCad>Integer</numCad>
<maSPsa>String</maSPsa>
<ficReg>Integer</ficReg>
<incPsa>DateTime</incPsa>
<tipLgr>String</tipLgr>
<excPsa>DateTime</excPsa>
<endRua>String</endRua>
<endNum>Integer</endNum>
<endCpl>String</endCpl>
<codPai>Integer</codPai>
<codEst>String</codEst>
<codCid>Integer</codCid>
<codBai>Integer</codBai>
<codRad>Integer</codRad>
<nomRad>String</nomRad>
<endCep>Integer</endCep>
<ddiTel>Integer</ddiTel>
<dddTel>Integer</dddTel>
<numTel>String</numTel>
<numRam>String</numRam>
<numDdi2>Integer</numDdi2>
<numDdd2>Integer</numDdd2>
<numTel2>String</numTel2>
<numRam2>String</numRam2>
<emaPar>String</emaPar>
<emaCom>String</emaCom>
<paiNas>Integer</paiNas>
<estNas>String</estNas>
<cciNas>Integer</cciNas>
<docIdn>Integer</docIdn>
<cidEmi>Integer</cidEmi>
<numCid>String</numCid>
<emiCid>String</emiCid>
<estCid>String</estCid>
<dexCid>DateTime</dexCid>
<numEle>String</numEle>
<zonEle>String</zonEle>
<secEle>String</secEle>
<numCnh>String</numCnh>
<orgCnh>String</orgCnh>
<estCnh>String</estCnh>
<catCnh>String</catCnh>
<datCnh>DateTime</datCnh>
<venCnh>DateTime</venCnh>
<priCnh>DateTime</priCnh>
<numRes>String</numRes>
<catRes>String</catRes>
<codPrf>Integer</codPrf>
<regCon>String</regCon>
<sitReg>String</sitReg>
<regMte>String</regMte>
<datExp>DateTime</datExp>
<datVen>DateTime</datVen>
<durCon>Integer</durCon>
<proCon>Integer</proCon>
<ultExm>DateTime</ultExm>
<proExm>DateTime</proExm>
<codQua>Integer</codQua>
<estPad>Integer</estPad>
<claSal>String</claSal>
<nivSal>String</nivSal>
<catVei>Integer</catVei>
<codRlr>Integer</codRlr>
<preTrb>String</preTrb>
<andTrb>String</andTrb>
<nroArm>String</nroArm>
<iniArm>DateTime</iniArm>
<fimArm>DateTime</fimArm>
<nomCom>String</nomCom>
<nomSoc>String</nomSoc>
<nasViv>String</nasViv>
<carSus>String</carSus>
<tipCer>String</tipCer>
<demCiv>DateTime</demCiv>
<matCCv>String</matCCv>
<matCiv>String</matCiv>
<livCiv>String</livCiv>
<folCiv>String</folCiv>
<carCiv>String</carCiv>
<estCiv>String</estCiv>
<cidCiv>Integer</cidCiv>
<numPsp>String</numPsp>
<emiPsp>String</emiPsp>
<estPsp>String</estPsp>
<demPsp>DateTime</demPsp>
<dvaPsp>DateTime</dvaPsp>
<paiPsp>Integer</paiPsp>
<numRic>String</numRic>
<estRic>String</estRic>
<emiRic>String</emiRic>
<cidRic>Integer</cidRic>
<dexRic>DateTime</dexRic>
<claAss>String</claAss>
<objDet>String</objDet>
</parameters>
</ser:FichaComplementar>
</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. Chave
tipPsa	Opcional	String	Tipo do plano de saúde do colaborador, terceiro ou parceiro. Disponível nos módulos: BS e FP
matIpe	Opcional	Integer	Número da matrícula dos estatutários. Disponível no módulo FP
tipOpe	Obrigatório	String	Tipo da operação a ser efetuada na integração “I” - Inclusão “A” - Alteração “E” - Exclusão Se não for informado, será considerado “alteração”
codPsa	Opcional	String	Código do plano de saúde. Disponível nos módulos: BS e FP
altIpe	Opcional	DateTime	Última data de alteração do IPE. Máscara: DD/MM/YYYY Disponível no módulo FP
tipCol	Obrigatório	Integer	Informar o tipo de colaborador, que poderá ser: Chave Valores: 1 - Empregado 2 - Terceiro 3 - Parceiro
matPsa	Opcional	Double	Número da matrícula no plano de saúde. 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”.
sitIpe	Opcional	Integer	Situação IPE dos estatutários. Disponível no módulo FP
numCad	Obrigatório	Integer	Indicar um número de cadastro para identificar cada colaborador, terceiro ou parceiro. Chave
maSPsa	Opcional	String	Número da matrícula no plano de saúde. 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”.
ficReg	Opcional	Integer	Demonstra o número da ficha registro de controle eletrônico. Opcional, se não for informado é determinada uma sequência automaticamente, dependendo da configuração do sistema. Permite indicar um outro número, o da ficha original de registro no Ministério do Trabalho, se desejado. Este parâmetro não pode ser informado caso “TipCol” seja diferente de 1 - Colaborador. Disponível para os módulos: BS, CP e FP
incPsa	Opcional	DateTime	Data da inclusão do colaborador no plano de saúde. Máscara: DD/MM/YYYY Disponível nos módulos: BS e FP
tipLgr	Opcional	String	Indica o tipo de endereço utilizado.
excPsa	Opcional	DateTime	Data da exclusão do colaborador no plano de saúde. Máscara: DD/MM/YYYY Disponível nos módulos: BS e FP
endRua	Opcional	String	Rua ou avenida onde o colaborador, terceiro ou parceiro mora.
endNum	Opcional	Integer	Número da residência do colaborador, terceiro ou parceiro.
endCpl	Opcional	String	Complemento ao endereço do colaborador. Disponível para todos os módulos, exceto: QL, JR, PLR
codPai	Opcional	Integer	Código do país onde o colaborador, parceiro ou terceiro reside.
codEst	Opcional	String	Sigla do estado onde o colaborador, parceiro ou terceiro reside.
codCid	Opcional	Integer	Código da cidade do endereço.
codBai	Opcional	Integer	Bairro onde o colaborador, parceiro ou terceiro reside.
codRad	Opcional	Integer	Código da Região Administrativa onde o colaborador, parceiro ou terceiro reside.
nomRad	Opcional	String	Nome da Região Administrativa onde o colaborador, parceiro ou terceiro reside. Este campo só poderá ser informado quando o código da região for igual a zero e o sistema estiver configurado para aceitar Ramo de Atuação Digitado (R126DEF.PerRad=‘S’).
endCep	Opcional	Integer	Número do CEP (Código de Endereçamento Postal) do endereço do colaborador, parceiro ou terceiro.
ddiTel	Opcional	Integer	Número do ddi residencial ou de contato do colaborador, terceiro ou parceiro.
dddTel	Opcional	Integer	Número do ddd residencial ou de contato do colaborador, terceiro ou parceiro.
numTel	Opcional	String	Número do telefone residencial ou de contato do colaborador, terceiro ou parceiro.
numRam	Opcional	String	Ramal do setor de trabalho na empresa, do colaborador, terceiro ou parceiro.
numDdi2	Opcional	Integer	Número do DDI2 residencial ou de contato do colaborador, terceiro ou parceiro.
numDdd2	Opcional	Integer	Número do DDD2 residencial ou de contato do colaborador, terceiro ou parceiro.
numTel2	Opcional	String	Número do telefone 2, residencial ou de contato do colaborador, terceiro ou parceiro.
numRam2	Opcional	String	Ramal 2 do setor de trabalho na empresa, do colaborador, terceiro ou parceiro.
emaPar	Opcional	String	E-mail particular (endereço particular na Internet). Disponível para todos os módulos, exceto: QL, JR, PLR
emaCom	Opcional	String	E-mail comercial (endereço comercial na Internet). Disponível para todos os módulos, exceto: QL, JR, PLR
paiNas	Opcional	Integer	Código do país de nascimento do colaborador, terceiro ou parceiro.
estNas	Opcional	String	Sigla do estado de nascimento do colaborador, terceiro ou parceiro. Este parâmetro só pode ser definido se o parâmetro paiNas já estiver definido com algum valor.
cciNas	Opcional	Integer	Código da cidade de nascimento do colaborador, terceiro ou parceiro. Disponível para os módulos: CP (se integrado com TR), FP, BS, TR, RS, SM
docIdn	Opcional	Integer	Indica o tipo de documento utilizado. Valores: 1 - Identidade 2 - CPF 3 - CNH 4 - Passaporte 5 - Outros 6 - Sem Documento Disponível para o módulo FP somente na versão internacional (Colômbia)
cidEmi	Opcional	Integer	Código da cidade de emissão do documento. Disponível para o módulo FP somente na versão internacional (Colômbia)
numCid	Opcional	String	Número da carteira de identidade. Disponível a todos os módulo, exceto: CS, QL e PLR
emiCid	Opcional	String	Órgão emissor da carteira de identidade. Disponível para todos os módulos, exceto: QL e PLR
estCid	Opcional	String	Informar a sigla do estado do órgão emissor da identidade. Disponível a todos os módulo, exceto: CS, QL e PLR
dexCid	Opcional	DateTime	Data de emissão da identidade. Máscara: DD/MM/YYYY Disponível a todos os módulo, exceto: CS, QL e PLR
numEle	Opcional	String	Número do título de eleitor. Disponível para os módulos: BS, FP, RS, TR
zonEle	Opcional	String	Zona eleitoral do título. Disponível para os módulos: BS, FP, RS, TR
secEle	Opcional	String	Seção de votação. Disponível para os módulos: BS, FP, RS, TR
numCnh	Opcional	String	Número da carteira de habilitação (motorista). Disponível para os módulos: BS, CP, RS, FP, TR
orgCnh	Opcional	String	Órgão Emissor da CNH. Disponível para os módulos: BS, CP, RS, FP, TR
estCnh	Opcional	String	Estado da Federação Emissor da CNH. Disponível para os módulos: BS, CP, RS, FP, TR
catCnh	Opcional	String	Categoria da carteira de motorista. Disponível para os módulos: BS, CP, RS, FP, TR
datCnh	Opcional	DateTime	Data da habilitação da carteira de motorista. Máscara: DD/MM/YYYY Disponível para os módulos: BS, CP, RS, FP, TR
venCnh	Opcional	DateTime	Data de vencimento da carteira de habilitação. Máscara: DD/MM/YYYY Disponível para os módulos: BS, CP, RS, FP, TR
priCnh	Opcional	DateTime	Data de vencimento da carteira de habilitação. Máscara: DD/MM/YYYY Disponível para os módulos: BS, CP, RS, FP, TR
numRes	Opcional	String	Número da carteira de reservista. Disponível para os módulos: BS, FP, RS, TR
catRes	Opcional	String	Categoria do reservista. Disponível para os módulos: BS, CP, RS, FP, TR
codPrf	Opcional	Integer	Conselho profissional a que pertencem os colaboradores, terceiros e parceiros. Muitas vezes necessário, como no caso de contadores, engenheiros, etc. Disponível para os módulos: CP (se integrado com TR), FP, BS, TR, RS, SM e JR
regCon	Opcional	String	Número de registro no conselho da profissão. Disponível para os módulos: CP (se integrado com TR), FP, BS, TR, RS, SM e JR
sitReg	Opcional	String	Este campo será utilizado na emissão do PPP, na composição do número de registro profissional no conselho de classe. Segundo Instrução Normativa deve ser preenchido com “D”, se for um registro definitivo e com “P”, se for um registro provisório. Caso o colaborador não seja responsável pelas informações do PPP, como registros ambientais e monitoração biológica, não há necessidade desta informação. Disponível para o módulo SM.
datExp	Opcional	DateTime	Data de expedição do registro profissional. Informar o dia, mês e ano da expedição do registro profissional. Disponível para os módulos: CP (se integrado com TR), AP, BS, TR, RS, SM e JR
durCon	Opcional	Integer	Prazo de contrato de experiência, em número de dias. Baseado nesta informação será calculado o vencimento do mesmo, permitindo a emissão de relatórios de prazos vencidos e a vencer e a prorrogação do mesmo. Disponível para os módulos: BS, FP
proCon	Opcional	Integer	Prazo final do contrato de experiência em número de dias. Baseado nesta informação será calculado o vencimento do mesmo, permitindo a emissão de relatórios de prazos vencidos e a vencer e o controle de término do contrato. Disponível para os módulos: BS, FP
ultExm	Opcional	DateTime	Informar a data do último exame médico efetuado pelo colaborador, terceiro ou parceiro. Máscara: DD/MM/YYYY Disponível para os módulos: FP, BS, SM (se estiver integrado com Administração de Pessoal)
proExm	Opcional	DateTime	Data futura de exame médico para controle. Máscara: DD/MM/YYYY Disponível para os módulos: FP, BS, SM (se estiver integrado com Administração de Pessoal)
codQua	Opcional	Integer	Determina a qualificação exigida para determinados cargos, etc. Identificar a qualificação com um código criado pela empresa. Disponível para todos os módulos e para CP se integrado com TR.
estPad	Opcional	Integer	Estrutura de salário padrão para o cargo do colaborador. Será utilizado como um parâmetro em relatório de estudos da situação salarial do seu cargo. Disponível para os módulos: FP, BS
claSal	Opcional	String	Nível padrão para o cargo do colaborador, terceiro ou parceiro. Se EstPad = 0, este parâmetro não deve ser informado. Se o “Tipo do formato” do código indicado em “EstPad” for “M”, este parâmetro não deverá ser informado. Disponível para os módulos: FP, BS
nivSal	Opcional	String	Classe padrão para o cargo, entendida como ideal, a qual será utilizada em relatórios de análise da situação salarial. Se EstPad = 0, este parâmetro não deve ser informado. Disponível para os módulos: FP, BS
catVei	Opcional	Integer	Código da categoria do veículo Valores: 1 - Executivo 2 - Standard 3 - Carga 4 - Coletivo 5 - Misto Carga e Coletivo 9 - Outros Disponível para o módulo RS.
codRlr	Opcional	Integer	Código da religião do colaborador Disponível para o módulo RS.
preTrb	Opcional	String	Nome do prédio onde o colaborador trabalha. Essa informação é útil principalmente ao módulo Ronda Acesso Disponível para o módulo CP
andTrb	Opcional	String	Número do andar do prédio onde o colaborador trabalha. Essa informação é útil principalmente ao módulo Ronda Acesso. Disponível para o módulos CP
nroArm	Opcional	String	Número do armário (Ronda Acesso) Disponível para o módulo SM
iniArm	Opcional	DateTime	Data de início da utilização do armário (Ronda Acesso) Máscara: DD/MM/YYYY Disponível para o módulo SM
fimArm	Opcional	DateTime	Data de término da utilização do armário (Ronda Acesso) Máscara: DD/MM/YYYY Disponível para o módulo SM
nomCom	Opcional	String	Informar o nome completo do colaborador, quando esse ultrapassar as 40 posições padrão do campo Nome do Colaborador no cadastro da Ficha Básica.
nomSoc	Opcional	String	Informar o nome social do colaborador. (70 posições)
nasViv	Opcional	String	Informar o número da Declaração de Nascido Vivo.. Máscara: A[20]
carSus	Opcional	String	Informar o número do Cartão Nacional de Saúde. Máscara: 9[15]
tipCer	Opcional	String	Informar o tipo da certidão civil Lista: 1- Certidão de Nascimento 2- Certidão de Casamento 3- Certidão Ad. de Nascimento Indígena 4- Certidão de Óbito
demCiv	Opcional	DateTime	Data de emissão da certidão Máscara: DD/MM/YYYY
matCCv	Opcional	String	Informe a Matrícula da Certidão Civil. Este campo pode ser informado quando a Emissão da Certidão Civil for igual ou superior a 01/01/2010 e o Tipo de Certidão for diferente de Certidão Ad. De Nascimento Indígena. Máscara: A[32]
matCiv	Opcional	String	Informe o Termo/Matrícula da Certidão Civil Este campo pode ser informado quando a Emissão da Certidão Civil for inferior a data de 01/01/2010 ou o Tipo de Certidão Civil for Certidão Ad. De Nascimento Indígena. Máscara: A[15]
livCiv	Opcional	String	Informe o Livro da Certidão Civil Este campo pode ser informado quando a Emissão da Certidão Civil for inferior a data de 01/01/2010 ou o Tipo de Certidão Civil for Certidão Ad. De Nascimento Indígena. Máscara: A[6]
folCiv	Opcional	String	Informe a Folha da Certidão Civil Este campo pode ser informado quando a Emissão da Certidão Civil for inferior a data de 01/01/2010 ou o Tipo de Certidão Civil for Certidão Ad. De Nascimento Indígena. Máscara: A[6]
carCiv	Opcional	String	Informe o cartório de registro da Certidão Civil Máscara: A[20]
estCiv	Opcional	String	Informe o estado da Certidão Civil. Máscara: A[2]
cidCiv	Opcional	Integer	Informe o código da cidade da Certidão Civil Máscara: 99.99999
numPsp	Opcional	String	Informe o número do Passaporte do colaborador Máscara: A[20]
emiPsp	Opcional	String	Informe o Emissor do Passaporte Máscara: A[6]
estPsp	Opcional	String	Informe o Estado do Passaporte Máscara: A[2] A[4]
demPsp	Opcional	DateTime	Informe a Data de Emissão do Passaporte Máscara: DD/MM/YYYY
dvaPsp	Opcional	DateTime	Informe a Data de Validade do Passaporte. Máscara: DD/MM/YYYY
paiPsp	Opcional	Integer	Informe o código do pais de emissão do passaporte. Máscara: A[4]
numRic	Opcional	String	Informar o número do Registro de Identidade Civil. Máscara: 9999999999-9
estRic	Opcional	String	Informe o Estado de Emissão do Passaporte Máscara: A[2]
emiRic	Opcional	String	Informe o órgão emissor do RIC Máscara: A[6]
cidRic	Opcional	Integer	Informe cidade de emissão do RIC Máscara: 99.99999
dexRic	Opcional	DateTime	Informe a Data expedição do RIC Máscara: DD/MM/YYYY
claAss	Opcional	String	Informar Cláusula Assecuratória.
regMte	Opcional	String	Número do Registro Profissional no MTE Máscara A[30] Este campo está disponível apenas para os módulos: Administração de Pessoal; Recrutamento e Seleção; Segurança e Medicina.
datVen	Opcional	DateTime	Data de vencimento do registro profissional. Informar o dia, mês e ano do vencimento do registro no conselho. Pode ser utilizado para registros provisórios. Disponível para os módulos: CP (se integrado com TR), AP, BS, TR, RS, SM e JR
objDet	Opcional	String	Informe o objeto determinante da contratação por prazo determinado (obra, serviço, safra, etc.). Esta informação é obrigatória para contratos com prazo determinado e vinculados à ocorrência de um fato.

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

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.

Documento

Web service de integração que permite armazenar uma série de documentos dos colaboradores.
Disponível em todos os módulos.