Web service com.senior.g5.rh.tr.reserva

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

Individual

Web service para cadastramento de reservas em cursos de aperfeiçoamento por participantes.

**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:Individual> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <tipOpe>String</tipOpe> <codCua>Integer</codCua> <numEmp>Integer</numEmp> <tipCol>Integer</tipCol> <numCad>Integer</numCad> <datRes>String</datRes> <oriRes>Integer</oriRes> <codMcu>Integer</codMcu> <empRes>Integer</empRes> <tipRes>Integer</tipRes> <cadRes>Integer</cadRes> <perIni>String</perIni> <perFim>String</perFim> <obsRes>String</obsRes> <perDia>String</perDia> <solAux>String</solAux> <codOem>Integer</codOem> <codCid>Integer</codCid> <carHor>String</carHor> <tipRea>Integer</tipRea> <codCla>Integer</codCla> </parameters> </ser:Individual> </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

codCua

Obrigatório

Integer

Informar o curso de aperfeiçoamento.


  • Obrigatório

  • Chave

numEmp

Obrigatório

Integer

Informar a empresa do participante da reserva.


  • Obrigatório

  • Chave

tipCol

Obrigatório

Integer

Informar o tipo do colaborador desta reserva.


  • Obrigatório

  • Chave


Valores:


1 - Empregado


2 - Terceiro


3 - Parceiro

numCad

Obrigatório

Integer

Informar o cadastro do participante.


  • Obrigatório

  • Chave

datRes

Obrigatório

DateTime

Informar o dia, mês e ano da reserva.


  • Obrigatório

  • Chave

  • Máscara: DD/MM/YYYY

oriRes

Opcional

Integer

Informar qual será a origem da reserva.


  • Obrigatório


Valores:


1-Vagas Requisitadas


2-Vagas Orçadas - esta origem compreende os participantes que foram gerados pelo cadastro de Orçamento


3-Vagas Solicitadas


4-Necessidade Cargo


5-Diagnóstico


6-Cipa


7-Avaliação - esta origem não será permitida na geração coletiva, somente pela própria avaliação no módulo CsWeb


8-Plano de desenvolvimento

codMcu

Opcional

Integer

Informar o motivo que justifique a geração da reserva.


  • Obrigatório.

empRes

Opcional

Integer

Informar a empresa do responsável.


  • Opcional


Observações: Na inserção de um novo registro, será sugerida a empresa do colaborador que estiver associado ao usuário que acessou o módulo como responsável.

tipRes

Opcional

Integer

Informar o tipo de colaborador responsável pela geração da reserva.


  • Opcional


Valores:


1 - Empregado


2 - Terceiro


3 - Parceiro



Observações: Na inserção de um novo registro, será sugerido o tipo do colaborador que estiver associado ao usuário que acessou o módulo como responsável.

cadRes

Opcional

Integer

Informar o cadastro do colaborador responsável pela geração da reserva.


  • Opcional


Observações: Na inserção de um novo registro, será sugerido o colaborador que estiver associado ao usuário que acessou o módulo como responsável.

perIni

Opcional

DateTime

Informar o dia, mês e ano do início do curso.


  • Opcional

  • Máscara: DD/MM/YYYY

perFim

Opcional

DateTime

Informar o dia, mês e ano do término do curso.


  • Opcional

  • Máscara: DD/MM/YYYY

obsRes

Opcional

String

Espaço destinado para registrar alguma informação importante.


Esta informação também será registrada no cadastro individual da reserva.


  • Opcional

perDia

Opcional

String

Informar o tipo do período.


  • Opcional


Valores:


M- Matutino


V-Vespertino


N-Noturno


D-Diurno

solAux

Opcional

String

Identificar o tipo de realização do curso.


  • Opcional


Observação: Caso informado o valor S - Sim para este campo deve ser informada a Entidade.

codOem

Opcional

Integer

Informar a entidade onde será realizado o curso.


  • Opcional

Observação: Este campo torna-se obrigatório quando definido para solicitar auxílio.

codCid

Opcional

Integer

Informar a cidade onde será realizado o curso.


  • Opcional

  • Máscara: 99.99999

carHor

Opcional

Time

Informar a quantidade de horas do curso.


  • Opcional

  • Máscara: hhhh:mm

tipRea

Opcional

Integer

Identificar o tipo de realização do curso.


  • Opcional

codCla

Opcional

Integer

Identificar o tipo de realização do curso.


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

Cadastro

Web service para cadastramento inerente às reservas em cursos de aperfeiçoamento.

**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:Cadastro> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <numEmp>Integer</numEmp> <codFes>Integer</codFes> <wGD132REC> <empresa>Integer</empresa> <tipo>Integer</tipo> <cadastro>Integer</cadastro> <observao>String</observao> </wGD132REC> <tipOpe>String</tipOpe> <codCua>Integer</codCua> <codCid>Integer</codCid> <tipOpeGrid>String</tipOpeGrid> <cmpRea>String</cmpRea> <perDia>String</perDia> <seqTre>Integer</seqTre> <perIni>String</perIni> <oriRes>Integer</oriRes> <perFim>String</perFim> <numLoc>String</numLoc> <carHor>String</carHor> <vagRes>Integer</vagRes> <tipRea>Integer</tipRea> <codMcu>Integer</codMcu> <tipCol>Integer</tipCol> <numCad>Integer</numCad> <codDia>Integer</codDia> <obsRet>String</obsRet> </parameters> </ser:Cadastro> </soapenv:Body> </soapenv:Envelope>

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

Nome

Preenchimento

Tipo

Descrição

numEmp

Obrigatório

Integer

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


  • Obrigatório

  • Chave

codFes

Opcional

Integer

Informar a Entidade de Ensino desejável a qual ministrará o curso.


Deve estar cadastrado em Empresas/Outras Empresas com tipo de uso 3 (entidade de ensino).


  • Opcional

wGD132REC

Opcional

Set

Informar a empresa, tipo e cadastro do colaborador que deverá ser treinado com o atendimento da reserva e algum comentário que se fizer necessário.

wGD132REC.empresa

Opcional

Integer

Informar a empresa do colaborador que deverá ser treinado com o atendimento da reserva.


  • Obrigatório

wGD132REC.tipo

Opcional

Integer

Informar o tipo do colaborador que deverá ser treinado com o atendimento da reserva.


  • Obrigatório


Valores:


1 - Empregado


2 - Terceiro


3 - Parceiro

wGD132REC.cadastro

Opcional

Integer

Informar o cadastro do colaborador que deverá ser treinado com o atendimento da reserva.


  • Obrigatório

wGD132REC.observao

Opcional

String

Comentário que se fizer necessário.


  • Opcional

tipOpe

Opcional

String

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


  • Obrigatório


Valores:


I - Inclusão


A - Alteração


E - Exclusão

codCua

Obrigatório

Integer

Informar o código do curso de aperfeiçoamento.


  • Obrigatório

  • Chave

codCid

Opcional

Integer

Informar a cidade onde o curso deveria ser ministrado.


  • Opcional

  • Máscara: 99.99999

tipOpeGrid

Opcional

String

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


  • Obrigatório


Valores:


I - Inclusão


A - Alteração


E - Exclusão

cmpRea

Obrigatório

DateTime

Registrar a competência em que está sendo feita a reserva.


  • Obrigatório

  • Chave

  • Máscara: MM/YYYY

perDia

Opcional

String

Identificar o período no qual a maior parte do curso deveria ser ministrada.


  • Opcional


Valores:


M - Matutino


V - Vespertino


N - Noturno


D - Diurno

seqTre

Obrigatório

Integer

Identificar a sequência da reserva dentro da competência para o curso de aperfeiçoamento.


  • Obrigatório

  • Chave

perIni

Opcional

DateTime

Informar a data desejável para o início do curso.


  • Opcional

  • Máscara: DD/MM/YYYY

oriRes

Opcional

Integer

Identificar a origem da reserva, a fim de facilitar sua identificação.


  • Obrigatório


Valores:


1 - Vagas Requisitadas


2 - Vagas Orçadas


3 - Vagas Solicitadas


4 - Necessidade Cargo


5 - Diagnostico


6 - Cipa


7 - Avaliação


8 - Plano de Desenvolvimento

perFim

Opcional

DateTime

Informar a data desejável para o término do curso.


  • Opcional

  • Máscara: DD/MM/YYYY

numLoc

Opcional

String

Identificar o código do local no organograma da empresa a que se refere esta reserva.


  • Obrigatório

carHor

Opcional

Time

Identificar a carga horária desejável para o curso da reserva.


  • Opcional

  • Máscara: hhhh:mm


Observações: O campo é preenchido automaticamente na inserção.


O valor do campo é buscado automaticamente do cadastro de Cursos de Aperfeiçoamento.

vagRes

Opcional

Integer

Informar o número de vagas que deverão ser preenchidas com esta reserva.


  • Obrigatório

tipRea

Opcional

Integer

Identificar o tipo de realização do curso.


  • Opcional


Observações: O campo é preenchido automaticamente na inserção.


O valor do campo é buscado automaticamente do cadastro de Cursos de Aperfeiçoamento.

codMcu

Opcional

Integer

Identificar o motivo da reserva. Este motivo deverá ser cadastrado em Tabelas/Motivos/Curso.


  • Obrigatório

tipCol

Opcional

Integer

Registrar o tipo do colaborador responsável pela reserva


  • Opcional


Valores:


1 - Empregado


2 - Terceiro


3 - Parceiro



Observação: Caso não informar valor para este campo não deve ser informado valor para o campo “responsável”.

numCad

Opcional

Integer

Informar o cadastro do colaborador responsável pela reserva.


  • Opcional


Observações: O campo torna-se obrigatório caso for informado um tipo de responsável e caso não for informado um tipo de responsável, o campo dever ficar nulo.

codDia

Opcional

Integer

Quando se tratar de reserva com origem Diagnóstico, informar o código do diagnóstico que resultou na reserva.


  • Opcional


Observações: Pode ser informado quando a origem for 5 - Diagnostico.

obsRet

Opcional

String

Campo destinado a alguma informação relativa a reserva.


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