Web service com.senior.g5.rh.sm.planoacao
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_planoacao?wsdl
- Assíncrono: http://example.com/g5-senior-services/sm_Asynccom_senior_g5_rh_sm_planoacao?wsdl
- Agendado: http://example.com/g5-senior-services/sm_Scheduledcom_senior_g5_rh_sm_planoacao?wsdl
Porta
PlanoAcao_3
Web service de integração que permite preencher informações de um Plano de Ação. Disponível para o módulo SM.
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 3
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:PlanoAcao> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <tipOpe>String</tipOpe> <datApr>DateTime</datApr> <empExe>Integer</empExe> <numEmp>Integer</numEmp> <redPln>String</redPln> <empApr>Integer</empApr> <tipExe>Integer</tipExe> <codPln>Integer</codPln> <oriPln>Integer</oriPln> <tipApr>Integer</tipApr> <cadExe>Integer</cadExe> <tipPln>String</tipPln> <cadApr>Integer</cadApr> <locExe>String</locExe> <datPln>DateTime</datPln> <locApr>String</locApr> <dscSol>String</dscSol> <codFil>Integer</codFil> <iniApr>DateTime</iniApr> <iniExe>DateTime</iniExe> <empRes>Integer</empRes> <fimApr>DateTime</fimApr> <fimExe>DateTime</fimExe> <tipRes>Integer</tipRes> <dscApr>String</dscApr> <sitPln3>Integer</sitPln3> <cadRes>Integer</cadRes> <priPln2>Integer</priPln2> <indEfi>String</indEfi> <numLoc>String</numLoc> <sitPln2>Integer</sitPln2> <datCon>DateTime</datCon> <codAgt>Integer</codAgt> <priPln3>Integer</priPln3> <plnCol>String</plnCol> <plaAdm>String</plaAdm> <obsPln>String</obsPln> <resCip>String</resCip> <datIni>DateTime</datIni> <datFim>DateTime</datFim> <sitPln>Integer</sitPln> <nomArq>String</nomArq> <priPln>Integer</priPln> <posTra>String</posTra> <objPln>String</objPln> <metQua>String</metQua> <indRes>String</indRes> </parameters> </ser:PlanoAcao> </soapenv:Body> </soapenv:Envelope>
Parâmetros da requisição:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
tipOpe | Opcional | 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" |
datApr | Opcional | DateTime | Data da Aprovação
Informar a data da aprovação de cada plano de ação de acordo com o seu cronograma. -Obrigatório -Edição DD/MM/YYYY |
tipExe | Opcional | Integer | Tipo de Colaborador Responsável Execução
Indicar o tipo de colaborador responsável pelo término da execução do plano de ação: -Valores: 1 Empregado 2 Terceiro 3 Parceiro -Obrigatório -Edição 9[1] |
numEmp | Obrigatório | Integer | Código da empresa que será utilizada na integração.
- Chave |
redPln | Opcional | String | Nome Reduzido do Plano de Ação
Informar a descrição reduzida do plano de ação. -Obrigatório -Edição A[040] |
tipApr | Opcional | Integer | Tipo de Colaborador Responsável Aprovação
Indicar o tipo de colaborador responsável pela aprovação do plano de ação: -Valores: 1 Empregado 2 Terceiro 3 Parceiro -Opcional -Edição 9[1] |
cadExe | Opcional | Integer | Cadastro Responsável Execução
Informar o cadastro do empregado, terceiro ou parceiro responsável pela execução do plano de ação. -Obrigatório -Edição 9[9] |
codPln | Obrigatório | Integer | Código do Plano de Ação
Informar o código do plano de ação -Obrigatório Máscara: |
oriPln | Opcional | Integer | Código da origem do plano de ação
Informar a origem do plano de ação. -Valores: 1 CIPA 2 Brigadas 3 Serviço Segurança 4 Acidente Trabalho 5 Diretoria 6 Supervisão 7 Sugestões 8 PPRA 9 Outros -Obrigatório -Edição 9[2] |
cadApr | Opcional | Integer | Cadastro Responsável Aprovação
Informar o cadastro do empregado, terceiro ou parceiro responsável pela aprovação do plano de ação. -Opcional -Edição 9[9] |
locExe | Opcional | String | Local de Execução
Registrar o local da empresa onde ocorreu a execução do plano. -Opcional -Edição 9[9] |
tipPln | Opcional | String | Código Tipo do Plano de Ação
Informar o tipo de plano de ação. Exemplo: preventiva, inspeção, fiação elétrica, treinamento de brigada, etc. -Obrigatório -Edição 9[3] |
locApr | Opcional | String | Local de Aprovação
Corresponde ao local do responsável pela aprovação do plano. -Opcional -Edição 9[9] |
dscSol | Opcional | String |
Descrição da Solução
|
datPln | Opcional | DateTime | Data do Plano de Ação
Registrar a data de cadastramento do plano de ação. -Obrigatório -Edição DD/MM/YYYY |
iniApr | Opcional | DateTime | Data Início da Execução - Conforme Aprovação
Corresponde a data de início para a aprovação do plano de ação. -Opcional -Edição DD/MM/YYYY |
iniExe | Opcional | DateTime | Data Início da Execução - Conforme Execução
Informar a data de início da execução do plano de ação ou deixar sem data. Somente a partir desta data poderão ser registradas as etapas de execução. -Opcional -Edição DD/MM/YYYY |
codFil | Opcional | Integer | Código da Filial
Informar a filial que está relacionada com este plano. Este campo poderá ser considerado para filtrar a filial conforme abrangência do usuário na pesquisa de registros. -Opcional -Edição 9[6] |
fimApr | Opcional | DateTime | Data Fim da Execução - Conforme Aprovação
Corresponde a data de início para a aprovação do plano de ação. -Opcional -Edição DD/MM/YYYY |
fimExe | Opcional | DateTime | Data Fim da Execução - Conforme Execução
Informar a data limite para a execução do plano de ação ou deixar sem data. -Opcional -Edição DD/MM/YYYY |
tipRes | Opcional | Integer | Tipo de Colaborador Responsável pelo Plano Ação
Indicar o tipo de colaborador responsável pela execução do plano de ação: -Valores: 1 Empregado 2 Terceiro 3 Parceiro -Opcional -Edição 9[1] |
dscApr | Opcional | String | Observação sobre a aprovação
Espaço destinado a comentários sobre a aprovação do plano de ação. -Opcional |
sitPln3 | Opcional | Integer | Situação da Etapa
Indicar a situação do plano: -Valores: 1 Análise 2 Aprovado 3 Andamento 4 Suspenso 5 Cancelado 6 Concluído -Obrigatório -Edição 9[1] |
cadRes | Opcional | Integer | Cadastro Responsável pelo Plano Ação
Indicar o código do colaborador responsável pela execução do plano de ação. -Opcional -Edição 9[9] |
sitPln2 | Opcional | Integer | Situação da Etapa
Indicar a situação do plano: -Valores: 1 Análise 2 Aprovado 3 Andamento 4 Suspenso 5 Cancelado 6 Concluído -Obrigatório -Edição 9[1] |
indEfi | Opcional | String | Identificação de eficácia do plano
Quando ocorrer a conclusão do plano, deverá ser indicado as seguintes opções: -Valores: N Não Solucionado P Parcialmente Solucionado S Solucionado -Opcional -Edição U[1] |
numLoc | Opcional | String | Local do Organograma
Informar o código do local relacionado a este plano de ação. -Obrigatório -Edição 9[9] |
priPln2 | Opcional | Integer | Prioridade do plano de ação |
datCon | Opcional | DateTime | Data de conclusão do plano
Corresponde a data de conclusão do plano de ação -Opcional -Edição DD/MM/YYYY |
codAgt | Opcional | Integer | Código do Agente risco
Informar o código do agente de risco envolvido em cada plano de ação, o qual pode ser pré-cadastrado em Segurança/PPRA/Agentes. -Opcional -Edição 9[6] |
priPln3 | Opcional | Integer | Prioridade do plano de ação |
plnCol | Opcional | String | Descrição do Plano de Ação [Carácter Coletivo]
Espaço para descrever os detalhes de cada plano de ação que deverão ser considerados por todos os envolvidos. -Opcional -Edição A[250] |
plaAdm | Opcional | String | Descrição do Plano de Ação [Carácter Administrativo]
Espaço destinado para informar os detalhes administrativos do plano de ação. -Opcional -Edição A[250] |
obsPln | Opcional | String | Observação do Plano de Ação
Espaço destinado para detalhes adicionais referentes a cada plano de ação. -Opcional |
resCip | Opcional | String | Resumo da Cipa [S,N]
Informar se este plano de ação deve ser considerado na emissão do Anexo I do SESMT a ser entregue trimestralmente à DRT. -Valores: S Sim, considerar na emissão do Anexo I da CIPA N Não considerar no Anexo I da CIPA -Obrigatório -Edição U[1] |
datIni | Opcional | DateTime | Data Início da Execução - Conforme Sugestão Inicial
Corresponde a data inicial em que o plano de ação dever ser executado. -Opcional -Edição DD/MM/YYYY |
datFim | Opcional | DateTime | Data Fim da Execução - Conforme Sugestão Inicial
Corresponde a data final limite de execução do plano de ação. -Opcional -Edição DD/MM/YYYY |
sitPln | Opcional | Integer | Situação da Etapa
Indicar a situação do plano: -Valores: 1 Análise 2 Aprovado 3 Andamento 4 Suspenso 5 Cancelado 6 Concluído -Obrigatório -Edição 9[1] |
nomArq | Opcional | String | Arquivo
Informar o caminho de um arquivo para anexá-lo com informações completares do plano de ação. -Opcional -Edição A[250] |
priPln | Opcional | Integer | Prioridade do plano de ação |
empRes | Opcional | Integer | Empresa do Colaborador Responsável pelo Plano Ação |
empApr | Opcional | Integer | Empresa do Colaborador Responsável pela aprovação do Plano de Ação |
empExe | Opcional | Integer | Empresa do Colaborador Responsável pela execução do Plano de Ação |
posTra | Opcional | String | Código do posto de trabalho relacionado ao plano de ação. Máscara: U[24] |
objPln | Opcional | String | Objetivos do plano de ação. Máscara: A[250] |
metQua | Opcional | String | Meta quantitativa do plano de ação. Máscara: A[50] |
indRes | Opcional | String | Indicadores de resultado para o plano de ação. Máscara: A[100] |
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:PlanoAcaoResponse>
<result>
<erroExecucao>String</erroExecucao>
</result>
</ser:PlanoAcaoResponse>
</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. |