Documentação do serviço com.unimedbh.IntegracaoLMS

Porta InformaProcessamento (Regra)

TR - Informa Processamento de Notas / Frequencia no evento

Necessita autenticação: Sim

Situação da 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:InformaProcessamento>

<user>String</user>

<password>String</password>

<encryption>Integer</encryption>

<parameters>

<processamentos>

<numEmp>Integer</numEmp>

<tipCol>Integer</tipCol>

<numCad>Integer</numCad>

<codEvn>Integer</codEvn>

<staTus>String</staTus>

</processamentos>

</parameters>

</ser:InformaProcessamento>

</soapenv:Body>

 </soapenv:Envelope>

Obs.: Envelope SOAP utilizado para requisições síncronas ou assíncronas. Para serviços agendados, basta incluir os parâmetros de agendamento no envelope, entre "encryption" e "parameters".

Atributos do parâmetro "parameters":

Nome	Obrigatório	Descrição
processamentos
processamentos.numEmp		Empresa do Colaborador Processado Mascara: 9[4]
processamentos.tipCol		Tipo de Colaborador Processado Mascara: 1[9] Enumeração Senior 1 - Colaborador 2 - Terceiro 3 - Parceiro
processamentos.numCad		Matrícula do Colaborador Processado Mascara: 9[9]
processamentos.codEvn		Código do Evento Mascara: 9[9]
processamentos.staTus		Indica se a nota/frequencia do colaborador foi processada com sucesso. Enumeração: S - Sim N - Não

Resposta:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ser="http://services.senior.com.br">

<soapenv:Body>

<ser:InformaProcessamentoResponse>

<result>

<processamentos>

<numEmp>Integer</numEmp>

<tipCol>Integer</tipCol>

<numCad>Integer</numCad>

<codEvn>Integer</codEvn>

<staTus>String</staTus>

</processamentos>

<erroExecucao>String</erroExecucao>

</result>
	
</ser:InformaProcessamentoResponse>

</soapenv:Body>

 </soapenv:Envelope>

Obs.: 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.

Atributos da resposta:

Nome	Obrigatório	Descrição
erroExecucao		Erro de execução
processamentos
processamentos.numEmp		Empresa do Colaborador Processado Mascara: 9[4]
processamentos.tipCol		Tipo de Colaborador Processado Mascara: 1[9] Enumeração Senior 1 - Colaborador 2 - Terceiro 3 - Parceiro
processamentos.numCad		Matrícula do Colaborador Processado Mascara: 9[9]
processamentos.codEvn		Código do Evento Mascara: 9[9]
processamentos.staTus		Indica se a nota/frequencia do colaborador foi processada com sucesso. Enumeração: S - Sim N - Não

Porta CadastroEvento (Regra)

TR - LMS - Cadastro de Eventos LMS

Necessita autenticação: Sim

Situação da 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:CadastroEvento>

<user>String</user>

<password>String</password>

<encryption>Integer</encryption>

<parameters>

<codEvn>Integer</codEvn>

<nomEvn>String</nomEvn>

<ideEvn>String</ideEvn>

<codCua>String</codCua>

<datIni>String</datIni>

<datFim>String</datFim>

<carHor>String</carHor>

<qtdVag>Integer</qtdVag>

<tipRea>Integer</tipRea>

<sitEvn>String</sitEvn>

<datCan>String</datCan>

<medCua>Double</medCua>

<nomCua>String</nomCua>

<praRea>Integer</praRea>

<codOpe>String</codOpe>

</parameters>

</ser:CadastroEvento>

</soapenv:Body>

 </soapenv:Envelope>

Obs.: Envelope SOAP utilizado para requisições síncronas ou assíncronas. Para serviços agendados, basta incluir os parâmetros de agendamento no envelope, entre "encryption" e "parameters".

Atributos do parâmetro "parameters":

Nome	Obrigatório	Descrição
codEvn		Codigo do Evento Mascara: 9[9]
nomEvn		Nome do Evento Mascara: A[200]
ideEvn		Identificador do Evento Mascara: U[30]
codCua		Código Curso de Aperfeiçoamento Mascara: 9[9]
datIni		Data inicial do Evento Mascara: dd/mm/yyyy
datFim		Data final do Evento Mascara: dd/mm/yyyy
carHor		Carga Horária Total do Evento Mascara: hhhh:mm
qtdVag		Quantidade de Vagas Mascara: 9[4]
tipRea		Tipo Realização Mascara: 9[3]
sitEvn		Situação do Evento Mascara: A[3] Enumeração Senior 1 - Em definição 2 - Em andamento 3 - Completo 4 - Cancelado Para LMS considerar a lista de/para: 1 e 2 - ON 3 e 4 - OFF
datCan		Data do Cancelamento do Evento Mascara: dd/mm/yyyy
medCua		Média Mínima do Evento Mascara: ZZ9,99
nomCua		Nome do curso associado no evento Mascara: A[200]
praRea		Prazo EM DIAS para realização do curso a contar da data da matrícula do participante. Mascara: 9[3]
codOpe		Operação a ser realizada no LMS Enumeração Senior A - Alteração I - Inclusão E - Exclusão

Resposta:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ser="http://services.senior.com.br">

<soapenv:Body>

<ser:CadastroEventoResponse>

<result>

<codRet>Integer</codRet>

<evnLMS>Integer</evnLMS>

<menRet>String</menRet>

<erroExecucao>String</erroExecucao>

</result>
	
</ser:CadastroEventoResponse>

</soapenv:Body>

 </soapenv:Envelope>

Atributos da resposta:

Nome	Obrigatório	Descrição
erroExecucao		Erro de execução
codRet		Código do Retorno Mascara: 9[4] 0 - Sucesso
evnLMS		Codigo do Evento no LMS Mascara: ????
menRet		Mensagem de Retorno Mascara: A[300]

Porta ConsultaParticipante (Regra)

TR - LMS - Consulta Participantes no LMS

Necessita autenticação: Sim

Situação da 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:ConsultaParticipante>

<user>String</user>

<password>String</password>

<encryption>Integer</encryption>

<parameters>

<numEmp>String</numEmp>

<tipCol>Integer</tipCol>

<numCad>String</numCad>

<codPes>String</codPes>

<codEvn>String</codEvn>

<codOpe>String</codOpe>

</parameters>

</ser:ConsultaParticipante>

</soapenv:Body>

 </soapenv:Envelope>

Obs.: Envelope SOAP utilizado para requisições síncronas ou assíncronas. Para serviços agendados, basta incluir os parâmetros de agendamento no envelope, entre "encryption" e "parameters".

Atributos do parâmetro "parameters":

Nome	Obrigatório	Descrição
numEmp		Empresa do participante Mascara: 9[4]
tipCol		Tipo do Participante Mascara: 9[1] Enumeração Senior 1 - Colaborador 2 - Terceiro 3 - Parceiro
numCad		Matrícula do Participante Mascara: 9[9]
codPes		Código da pessoa do Participante Mascara: 9[9]
codEvn		Código do Evento na base Senior Mascara: 9[9]
codOpe		Código da Operação Mascara: 9[9] 1 - Consulta Colaborador Matriculado 2 - Consulta Matriculados no Evento 3 - Consulta Nota/Frequencia Colaborador 4 - Consulta Nota/Frequencia Evento

Resposta:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ser="http://services.senior.com.br">

<soapenv:Body>

<ser:ConsultaParticipanteResponse>

<result>

<matriculados>

<codEvn>String</codEvn>

<numEmp>Integer</numEmp>

<tipCol>Integer</tipCol>

<numCad>String</numCad>

<codPes>Integer</codPes>

<sitCua>String</sitCua>

</matriculados>

<notas>

<codEvn>Integer</codEvn>

<numEmp>Integer</numEmp>

<tipCol>Integer</tipCol>

<numCad>Integer</numCad>

<codPes>Integer</codPes>

<notCua>Double</notCua>

<freCua>Double</freCua>

<sitCua>Integer</sitCua>

<datIni>String</datIni>

<datTer>String</datTer>

</notas>

<codRet>Integer</codRet>

<menRet>String</menRet>

<erroExecucao>String</erroExecucao>

</result>
	
</ser:ConsultaParticipanteResponse>

</soapenv:Body>

 </soapenv:Envelope>

Atributos da resposta:

Nome	Obrigatório	Descrição
erroExecucao		Erro de execução
matriculados		Tabela utilizada para retornar os colaboradores matriculados no evento
matriculados.codEvn		Codigo do Evento Mascara: 9[9]
matriculados.numEmp		Empresa do colaborador matriculado no evento Mascara: 9[4]
matriculados.tipCol		Tipo do colaborador matriculado no evento Mascara: 9[1] Enumeração Senior 1 - Colaborador 2 - Terceiro 3 - Parceiro
matriculados.numCad		Matrícula do colaborador Matriculado no evento
matriculados.codPes		Código da pessoa matriculada no evento Mascara:9[9]
matriculados.sitCua		Situalção do Participante no Evento Mascara: 9[2] Enumeração Senior: 1 - Andamento 2 - Completo 3 - Desistente 4 - Suspenso Temporariamente 5 - Reprovado por média 6 - Reprovado por frequência 7 - Nenhum 8 - Transferido 9 - Interrompido 10 - Cancelado
notas		Tabela Utilizada para retornar os participantes que finalizaram o evento
notas.codEvn		Codigo do Evento Mascara: 9[9]
notas.numEmp		Empresa do colaborador que concluiu o evento Mascara: 9[4]
notas.tipCol		Tipo do colaborador que concluiu o evento Mascara: 9[1] Enumeração Senior 1 - Colaborador 2 - Terceiro 3 - Parceiro
notas.numCad		Matrícula do colaborador que concluiu o evento Mascara:9[9]
notas.codPes		Código da pessoa que concluiu o evento Mascara:9[9]
notas.notCua		Nota no Evento Mascara: ZZ9,99
notas.freCua		Frequencia no Evento Mascara: ZZ9,99
notas.sitCua		Situalção do Participante no Evento Mascara: 9[2] Enumeração Senior: 1 - Andamento 2 - Completo 3 - Desistente 4 - Suspenso Temporariamente 5 - Reprovado por média 6 - Reprovado por frequência 7 - Nenhum 8 - Transferido 9 - Interrompido 10 - Cancelado
notas.datIni		Data que o participante iniciou o evento Mascara: dd/mm/yyyy
notas.datTer		Data que o participante terminou o evento Mascara: dd/mm/yyyy
codRet		Código do Retorno Mascara: 9[2] Enumeração Senior 01 - Sucesso 02 - Falha
menRet		Mensagem de Retorno Mascara: A[300]

Porta CadastroParticipanteAgrupado (Regra)

TR - LMS - Cadastra Participantes no LMS - Agrupado

Necessita autenticação: Sim

Situação da 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:CadastroParticipanteAgrupado>

<user>String</user>

<password>String</password>

<encryption>Integer</encryption>

<parameters>

<participantes>

<codEvn>Integer</codEvn>

<numEmp>Integer</numEmp>

<tipCol>Integer</tipCol>

<numCad>Integer</numCad>

<codPes>Integer</codPes>

<sitCua>Integer</sitCua>

<datIni>String</datIni>

<codLMS>Integer</codLMS>

<codRet>Integer</codRet>

<menRet>String</menRet>

<codOpe>String</codOpe>

</participantes>

</parameters>

</ser:CadastroParticipanteAgrupado>

</soapenv:Body>

 </soapenv:Envelope>

Obs.: Envelope SOAP utilizado para requisições síncronas ou assíncronas. Para serviços agendados, basta incluir os parâmetros de agendamento no envelope, entre "encryption" e "parameters".

Atributos do parâmetro "parameters":

Nome	Obrigatório	Descrição
participantes		Tabela Utilizada para enviar e retornar os participantes
participantes.codEvn		Codigo do Evento Mascara: 9[9]
participantes.numEmp		Empresa do colaborador Mascara: 9[4]
participantes.tipCol		Tipo do colaborador Mascara: 9[1] Enumeração Senior 1 - Colaborador 2 - Terceiro 3 - Parceiro
participantes.numCad		Matrícula do colaborador Mascara:9[9]
participantes.codPes		Código da pessoa Mascara:9[9]
participantes.sitCua		Situalção do Participante no Evento Mascara: 9[2] Enumeração Senior: 1 - Andamento 2 - Completo 3 - Desistente 4 - Suspenso Temporariamente 5 - Reprovado por média 6 - Reprovado por frequência 7 - Nenhum 8 - Transferido 9 - Interrompido 10 - Cancelado
participantes.datIni		Data da Matrícula Mascara: dd/mm/yyyy
participantes.codLMS		Retorna Código do participamente no LMS
participantes.codRet		Código do Retorno Mascara: 9[4] Enumeração Senior 0 - Sucesso
participantes.menRet		Mensagem de Retorno Mascara: A[300]
participantes.codOpe		Operação Enumeração: I - Inclusão A - Alteração E - Exclusão

Resposta:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ser="http://services.senior.com.br">

<soapenv:Body>

<ser:CadastroParticipanteAgrupadoResponse>

<result>

<participantes>

<codEvn>Integer</codEvn>

<numEmp>Integer</numEmp>

<tipCol>Integer</tipCol>

<numCad>Integer</numCad>

<codPes>Integer</codPes>

<sitCua>Integer</sitCua>

<datIni>String</datIni>

<codLMS>Integer</codLMS>

<codRet>Integer</codRet>

<menRet>String</menRet>

<codOpe>String</codOpe>

</participantes>

<erroExecucao>String</erroExecucao>

</result>
	
</ser:CadastroParticipanteAgrupadoResponse>

</soapenv:Body>

 </soapenv:Envelope>

Atributos da resposta:

Nome	Obrigatório	Descrição
erroExecucao		Erro de execução
participantes		Tabela Utilizada para enviar e retornar os participantes
participantes.codEvn		Codigo do Evento Mascara: 9[9]
participantes.numEmp		Empresa do colaborador Mascara: 9[4]
participantes.tipCol		Tipo do colaborador Mascara: 9[1] Enumeração Senior 1 - Colaborador 2 - Terceiro 3 - Parceiro
participantes.numCad		Matrícula do colaborador Mascara:9[9]
participantes.codPes		Código da pessoa Mascara:9[9]
participantes.sitCua		Situalção do Participante no Evento Mascara: 9[2] Enumeração Senior: 1 - Andamento 2 - Completo 3 - Desistente 4 - Suspenso Temporariamente 5 - Reprovado por média 6 - Reprovado por frequência 7 - Nenhum 8 - Transferido 9 - Interrompido 10 - Cancelado
participantes.datIni		Data da Matrícula Mascara: dd/mm/yyyy
participantes.codLMS		Retorna Código do participamente no LMS
participantes.codRet		Código do Retorno Mascara: 9[4] Enumeração Senior 0 - Sucesso
participantes.menRet		Mensagem de Retorno Mascara: A[300]
participantes.codOpe		Operação Enumeração: I - Inclusão A - Alteração E - Exclusão

Nome	Tipo	Descrição
user	String	Nome do usuário para autenticação.
password	String	Senha do usuário para autenticação.
encryption	Integer	Versão de criptografia - informar sempre zero.
id*	String	Identificador do serviço previamente agendado quando a operação for "Alterar" (operation = 1).
operation*	Integer	Operação a ser realizada: 0 = Adicionar: agenda um novo serviço; 1 = Alterar: altera o agendamento do serviço identificado pelo parâmetro "id".
regularity*	Integer	Periodicidade de execução do serviço, indicando como deve ser tratado o intervalo (parâmetro "interval"): 0: Executa apenas uma vez; 1: O intervalo é medido em minutos; 2: O intervalo é medido em horas; 3: O intervalo é medido em dias; 4: O intervalo é medido em semanas; 5: O intervalo é medido em meses.
interval*	Integer	Intervalo de execução do serviço, de acordo com a periodicidade (parâmetro "regularity").
initDate*	String	Data inicial de execução do serviço. Formato: DD/MM/YYYY.
initTime*	String	Data inicial de execução do serviço. Formato: HH:MM:SS (24 horas).
fixedHour*	String	Hora em que o serviço deve ser executado, quando o parâmetro "regularity" for 3, 4 ou 5.
fixedDay*	Integer	Dia em que o serviço deve ser executado, quando o parâmetro "regularity" for 5.
weekDays*	String	Dias da semana em que o serviço deve ser executado, quando o parâmetro "regularity" for 4. Deve ser informada uma String com o valor decimal de todos os dias concatenados sem nenhum separador, onde "1" representa o domingo e "7" representa o sábado. Exemplo: weekDays = "246" indica que o serviço executa na segunda-feira, na quarta-feira e na sexta-feira.
execLate*	Boolean	Indica se o serviço pode ou não ser executado atrasado.
validDate*	String	Data de validade do serviço, indicando qual a data máxima que ele pode ser executado. Formato: DD/MM/YYYY.
parameters	Complex	Ver descrição na documentação das portas deste serviço.