Web service com.senior.g5.rh.sm.SegurancaPPRAPorGHE
Atualmente, o campo tabOrg tem um limite de 4 dígitos (9999) apenas para os usuários que utilizam o banco de dados SQL Server. Para os usuários que utilizam o banco de dados Oracle, o limite do campo tabOrg é de 3 dígitos (999). Para esses usuários, a rotina de organograma com 4 dígitos está em desenvolvimento, com previsão para ser liberada em 29/09/2023.
Tipo de execução
Para cada tipo de execução, existem diferentes parâmetros que podem ser comuns a todas as portas.
Autenticação
Caso seja utilizada alguma forma de autenticação para integração de informações através de web services, é necessário identificado o tipo no parâmetro <encryption>, conforme seus valores possíveis.
WSDL
- Síncrono: http://example.com/g5-senior-services/sm_Synccom_senior_g5_rh_sm_SegurançaPPRAPorGHE?wsdl
- Assíncrono: http://example.com/g5-senior-services/sm_Asynccom_senior_g5_rh_sm_SegurançaPPRAPorGHE?wsdl
- Agendado: http://example.com/g5-senior-services/sm_Scheduledcom_senior_g5_rh_sm_SegurançaPPRAPorGHE?wsdl
Porta
SegurançaPPRAPorGHE
Através deste serviço, é possível incluir, alterar e excluir o cadastro de PPRAs.
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:SegurançaPPRAPorGHE> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <numEmp>Integer</numEmp> <tabOrg>Integer</tabOrg> <wGD583RCP> <tipOpe>String</tipOpe> <revisao>String</revisao> <descricao>String</descricao> <inicio>DateTime</inicio> <termino>DateTime</termino> </wGD583RCP> <wGD583RSP> <tipOpe>String</tipOpe> <inicio>DateTime</inicio> <respLTCAT>String</respLTCAT> <termino>DateTime</termino> </wGD583RSP> <wGD583FIL> <tipOpe>String</tipOpe> <empresa>Integer</empresa> <filial>Integer</filial> <inicio>DateTime</inicio> <termino>DateTime</termino> </wGD583FIL> <atiGHE>String</atiGHE> <intLau>String</intLau> <datAlt>DateTime</datAlt> <codPRA>Integer</codPRA> <estCar>Integer</estCar> <atiCar>String</atiCar> <conLau>String</conLau> <metErg>String</metErg> <desCad>String</desCad> <infExa>String</infExa> <iDCAti>String</iDCAti> <obsCom>String</obsCom> <tipOpe>String</tipOpe> <codPes>Integer</codPes> <codPes>Integer</codPes> <atiPos>String</atiPos> <jusExa>String</jusExa> <estPos>Integer</estPos> <jusCat>String</jusCat> <iDPAti>String</iDPAti> <jusAss>String</jusAss> <jusGer>String</jusGer> <anoCad>String</anoCad> </parameters> </ser:SegurançaPPRAPorGHE> </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 |
tabOrg | Opcional | Integer | Ao cadastrar um PPRA não é possível alterar o código da Tabela de Organograma quando este PPRA
já está vinculado a alguma Revisão de GHE que possui locais informados Um mesmo cadastro de PPRA só pode ter empresas com o mesmo organograma. Ao alterar o organograma de uma empresa vinculada a um Cadastro de PPRA, esta empresa fica sem Cadastro de PPRA definido, e nas filiais desta empresa, o cadastro deve ser fechado com a última data da informação alterada -Obrigatório -Edição 9[4] |
wGD583RCP | Opcional | Set | Em todo cadastro de PPRA é obrigatório cadastrar ao menos uma revisão
Permite informar: -Código da Revisão do Cadastro de PPRA: -Edição A[10] -Descrição de referência da revisão do Cadastro de PPRA: -Obrigatório -Edição A[60] -Data de início da revisão do PPRA: -O sistema não permite o cadastro de mais de uma revisão válida em um mesmo período. -Obrigatório -Edição DD/MM/YYYY -Data de término da revisão do PPRA: -Opcional -Edição DD/MM/YYYY |
wGD583RCP.tipOpe | Opcional | String | Tipo da operação a ser efetuada para um lançamento (uma linha).
- Máscara: U - Valores: "I" - Inclusão "A" - Alteração "E" - Exclusão - Obs.: Se não for informado, será considerado "Alteração". |
wGD583RCP.revisao | Opcional | String | Código da seguradora.
- Chave - Máscara: 9[8] |
wGD583RCP.descricao | Opcional | String | Código do plano de saúde.
- Chave - Máscara: 999 |
wGD583RCP.inicio | Opcional | DateTime | Data da inclusão do colaborador no plano.
- Chave - Máscara: DD/MM/YYYY |
wGD583RCP.termino | Opcional | DateTime | Data término do colaborador no plano.
- Não Obrigatório - Máscara: DD/MM/YYYY |
wGD583RSP | Opcional | Set | Permite definir os responsáveis pelo laudo ambiental (LTCAT), que podem ser válidos para todas as filiais ligadas ao Cadastro do PPRA
Permite informar: Data Ínicio em que assumiu a responsabilidade: -O sistema não permite o cadastro de mais de um responsável do LTCAT em um mesmo período. -Obrigatório -Edição DD/MM/YYYY Código da Pessoa responsável pelo LTCAT: -Quando o GHE é utilizado, o responsável pelo LTCAT da filial é substituído por este do Cadastro do PPRA. -Obrigatório -Edição 9[9] Data em que encerrou a responsabilidade do LTCAT: -Opcional -Edição DD/MM/YYYY |
wGD583RSP.tipOpe | Opcional | String | Tipo da operação a ser efetuada para um lançamento (uma linha).
- Máscara: U - Valores: "I" - Inclusão "A" - Alteração "E" - Exclusão - Obs.: Se não for informado, será considerado "Alteração". |
wGD583RSP.inicio | Opcional | DateTime | Data da inclusão do colaborador no plano.
- Chave - Máscara: DD/MM/YYYY |
wGD583RSP.respLTCAT | Opcional | String | Código da seguradora.
- Chave - Máscara: 9[8] |
wGD583RSP.termino | Opcional | DateTime | |
wGD583FIL | Opcional | Set | Permite informar o nome e função das pessoas participaram desta eleição.
O campo que corresponde a função é opcional. O Campo função apresenta as seguintes opções : 1 - Presidente Mesa 2 - Membro da Mesa 3 - Secretário 4 - Vice-Presidente 5 - Representante Empresa 9 - Outros |
wGD583FIL.tipOpe | Opcional | String | Tipo da operação a ser efetuada para um lançamento (uma linha).
- Máscara: U - Valores: "I" - Inclusão "A" - Alteração "E" - Exclusão - Obs.: Se não for informado, será considerado "Alteração". |
wGD583FIL.empresa | Opcional | Integer | Data da inclusão do colaborador no plano.
- Chave - Máscara: DD/MM/YYYY |
wGD583FIL.filial | Opcional | Integer | |
wGD583FIL.inicio | Opcional | DateTime | Código da seguradora.
- Chave - Máscara: 9[8] |
wGD583FIL.termino | Opcional | DateTime | |
atiGHE | Opcional | String | Defina se o sistema deve buscar as atividades de risco do cadastro de GHE
Valores: - Sim - Não -Opcional -Edição A[1] |
intLau | Opcional | String | Texto com a Introdução a ser utilizado no modelo LTCAT Máscara: 500 |
datAlt | Opcional | DateTime | Data de Alteração do histórico eSocial Máscara: DD/MM/YYYY |
codPRA | Obrigatório | Integer | Código do Cadastro do PPRA
-Obrigatório -Edição 9[9] |
estCar | Opcional | Integer | Ao cadastrar um PPRA não é possível alterar o código da Estrutura de Cargos
quando este PPRA já está vinculado a alguma Revisão de GHE que possui cargos informados Um mesmo cadastro de PPRA só pode ter empresas com a mesma estrutura de cargos. Ao alterar a estrutura de cargos de uma empresa vinculada a um Cadastro de PPRA, esta empresa fica sem Cadastro de PPRA definido, e nas filiais desta empresa, o cadastro deve ser fechado com a última data da informação alterada. -Obrigatório -Edição 9[4] |
atiCar | Opcional | String | Esta opção só fica ativa quando o sistema está configurado para utilizar a Descrição de Cargos de forma histórica. Defina se o sistema deve buscar as atividades de risco do cadastro de cargo
Valores: - Sim - Não -Opcional -Edição A[1] |
conLau | Opcional | String | Texto com a Conclusão a ser utilizado no modelo LTCAT Máscara: 500 |
metErg | Opcional | String | Descrição da metodologia utilizada para o levantamento dos riscos ergonômicos Máscara: 999 |
desCad | Opcional | String | Descrição do Cadastro de PPRA
-Obrigatório -Edição A[60] |
infExa | Opcional | String | Selecione se os GHEs do PPRA permitem informar exames.
Valores: - Sim - Não -Obrigatório -Edição U[1] |
iDCAti | Opcional | String | Este campo só fica habilitado quando o campo Atividade Cargo está definido como Sim.
Só é possível informar itens da Estrutura de Cargos definida para o PPRA. Para inserir vários itens, separe-os por vírgula -Opcional -Edição A[100] |
obsCom | Opcional | String | Observação(ões) complementar(es) referente(s) a registros ambientais Máscara: 999 |
tipOpe | Obrigatório | String | Tipo da operação a ser efetuada na integração
Valores: I - Inclusão A - Alteração E - Exclusão Se não for informado, será considerado "inclusão" |
codPes | Opcional | Integer | Pessoa responsável por assinar o PPP
-Opcional -Edição 9[9] |
atiPos | Opcional | String | Código da filial.
- Chave |
jusExa | Opcional | String | Este campo deve ser utilizado quando no campo Informar Exame é escolhida a opção N,
porém é opcional incluir esta informação -Opcional -Edição A[200] |
estPos | Opcional | Integer | Código da filial.
- Chave |
jusCat | Opcional | String | Justificativa para constar no campo CAT do PPP
-Opcional -Edição A[200] |
iDPAti | Opcional | String | Código da filial.
- Chave |
jusAss | Opcional | String | Justificativa para uso de assinatura eletrônica no PPP
-Opcional -Edição A[200] |
jusGer | Opcional | String | Justificativa geral p/ constar antes data emissão do PPP
-Opcional -Edição A[3000] |
anoCad | Opcional | String | Se desejar, inclua informações adicionais sobre o PPRA.
-Opcional -Edição A[2000] |
Resposta:
Observação
Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:SegurançaPPRAPorGHEResponse>
<result>
<erroExecucao>String</erroExecucao>
</result>
</ser:SegurançaPPRAPorGHEResponse>
</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. |