Histórico da Página

Visão Geral do Programa

O objetivo deste dataserver é possibilitar a inclusão e alteração de Professores através de webservice. As informações incluídas ou alteradas poderão ser visualizadas no cadastro de professor no TOTVS Gestão Educacional.

Através do dataserver "EduProfessorData" é possível, por meio do método SaveRecord, realizar a manutenção das informações dos professores no TOTVS Gestão Educacional.

Dica

Os serviços REST identificarão a base de dados a ser utilizada através da tag DefaultDB, que informa o Alias que será utilizado no acesso. Essa tag deve existir no arquivo de configuração do Host (RM.Host.Service.exe.config ou RM.Host.exe.config):

<add key=”DefaultDB” value=”<ALIAS_DO_BANCO_RM>

A variável <ALIAS_DO_BANCO_RM> deverá ser substituída pelo nome do alias cadastrado para acesso ao banco de dados.

Exemplo:

A porta 8051 é padrão no sistema e caso seja alterada na tag HttpPort no arquivo de configuração do Host, precisa ser alterada no link acima.

Método SaveRecord

Este método realiza a inclusão ou alteração de um professor. Como informações obrigatórias, devem ser informados os código da coligada e do professor, além dos outros campos configurados como obrigatórios.

O sistema irá realizar a inclusão de um professor, caso o código informado não exista na base.

Se o código de professor existir na coligada informada, esse terá as informações alteradas de acordo com o que será passado no arquivo XML.

Observação: Caso sejam passadas para o dataserver informações para campos complementares, devem ser utilizados os mesmo códigos da coligada e do professores para que o sistema consiga entender que se referem ao professor que se deseja alterar.

Utilização do WebService

Inclusão do professor

Para realizar inclusão de um professor, deve ser utilizado a operação de SaveRecord.

Deve ser passado um XML contendo todos os campos que serão cadastrados, como informação, para o professor.

Caso o código e professor informado não exista, será incluído um novo professor. Caso contrário, o mesmo terá suas informações atualizadas.

O XML deve conter a tabela SPROFESSOR com os campos CODCOLIGADA e CODPROF como informações da chave para o cadastro do professor e, também, os campos obrigatórios para seu cadastro.

O cadastro de um professor gera uma nova pessoa nova base.Dessa forma, é necessário que as informações obrigatórias para a validação de unicidade de uma pessoa sejam informadas no XML.

Essa validação pode variar com a necessidade de se informar o nome, a data de nascimento, o estado natal e sua naturalidade ou o CPF, conforme parametrização do módulo de Gestão de Pessoa.

Exemplo de XML para inclusão de um professor

Bloco de código

language	xml
collapse	true

		<tot:SaveRecord>
			<!--Optional:-->
			<tot:DataServerName>EduProfessorData</tot:DataServerName>
			<!--Optional:-->
			<tot:XML>
				<![CDATA[
					<EduProfessor>
					  <SProfessor>
						<CODCOLIGADA>1</CODCOLIGADA>
						<CODPROF>CL01</CODPROF>
						<NOME>Carla Lucilene</NOME>
						<CODPESSOA>4115</CODPESSOA>
						<CODIGO>4115</CODIGO>
						<SEXO>F</SEXO>
						<DTNASCIMENTO>1980-07-22T00:00:00</DTNASCIMENTO>
						<CPF>43612246500</CPF>
						<APELIDO>Carla</APELIDO>
						<ESTADOCIVIL>S</ESTADOCIVIL>
						<ESTADONATAL>MG</ESTADONATAL>
						<NATURALIDADE>Belo Horizonte</NATURALIDADE>
						<EMAIL>[email protected]</EMAIL>
						<CODUSUARIO>CL01</CODUSUARIO>
						<USERID>ab2c6149-c110-41a1-b2c4-1979984dbb56</USERID>
						<GRAUINSTRUCAO>7</GRAUINSTRUCAO>
					  </SProfessor>
					  <SProfessorCompl>
						<CODCOLIGADA>1</CODCOLIGADA>
						<CODPROF>CL01</CODPROF>
						<EMAILINSTITUCIONAL>[email protected]</EMAILINSTITUCIONAL>
					  </SProfessorCompl>
					</EduProfessor>
				]]>
			</tot:XML>
			<!--Optional:-->
			<tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1</tot:Contexto>
		</tot:SaveRecord>

Nota

Para que o sistema carregue corretamente os parâmetros do sistema, é necessário que sejam inclusas as informações do contexto: Coligada, Filial e Tipo de curso.

Essas informações devem ser separadas pelo caractere ";".

Exemplo do retorno da inclusão do Professor

Bloco de código

language	xml
collapse	true

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <SaveRecordResponse xmlns="http://www.totvs.com/">
         <SaveRecordResult>1;CL01</SaveRecordResult>
      </SaveRecordResponse>
   </s:Body>
</s:Envelope>

Informações
Caso a inclusão seja realizada com sucesso, será mostrado o código da coligada e o código do professor inserido no item SaveRecordResult

Alteração de Professores

Para realizar inclusão de um professor, deve ser utilizado a operação de SaveRecord.

Deve ser passado um XML contendo todos os campos que serão atualizado no cadastro do professor.

O XML deve conter a tabela SPROFESSOR com os campos CODCOLIGADA e CODPROF como informações da chave para a atualização de cadastro do professor.

Exemplo de XML para alteração de informações do Professor

Bloco de código

language	xml
collapse	true

<tot:SaveRecord>
	<!--Optional:-->
	<tot:DataServerName>EduProfessorData</tot:DataServerName>
	<!--Optional:-->
	<tot:XML>
		<![CDATA[
			<EduProfessor>
			  <SProfessor>
				<CODCOLIGADA>1</CODCOLIGADA>
				<CODPROF>CL01</CODPROF>
				<NOME>Carla Lucilene</NOME>
			  </SProfessor>
			  <SProfessorCompl>
				<CODCOLIGADA>1</CODCOLIGADA>
				<CODPROF>CL01</CODPROF>
				<EMAILINSTITUCIONAL>[email protected]</EMAILINSTITUCIONAL>
			  </SProfessorCompl>
			</EduProfessor>
		]]>
	</tot:XML>
	<!--Optional:-->
	<tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1</tot:Contexto>
</tot:SaveRecord>

Exemplo do retorno da alteração do cadastro do Professor

Bloco de código

language	xml
collapse	true

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <SaveRecordResponse xmlns="http://www.totvs.com/">
         <SaveRecordResult>1;CL01</SaveRecordResult>
      </SaveRecordResponse>
   </s:Body>
</s:Envelope>

Informações
Caso a alteração seja realizada com sucesso, será mostrado o código da coligada e o código do professor no item SaveRecordResult

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 3

Nova versão 4

Chave

Visão Geral do Programa

Método SaveRecord

Utilização do WebService

Exemplo de XML para inclusão de um professor

Exemplo do retorno da inclusão do Professor

Exemplo do retorno da alteração do cadastro do Professor