Web service com.senior.g5.rh.sm.planodeacao

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

Porta

PlanoDeAcao

Web Service de cadastro de tipos de plano de ação.

**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:PlanoDeAcao> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <numEmp>Integer</numEmp> <tipPln>Integer</tipPln> <desPln>String</desPln> <tipOpe>String</tipOpe> </parameters> </ser:PlanoDeAcao> </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

tipPln

Obrigatório

Integer

Tipo do Plano de Ação.



  • Chave

desPln

Opcional

String

Descrição do Plano de Ação;


tipOpe

Obrigatório

String

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




Valores:


I - Inclusão


A - Alteração


E - Exclusã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:PlanoDeAcaoResponse> <result> <erroExecucao>String</erroExecucao> </result> </ser:PlanoDeAcaoResponse> </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ê?