Visão Geral dos processos WebSevices da Turma

O objetivo deste dataserver DataServer é possibilitar a busca, inclusão, alteração e exclusão de turmas através de webserviceWebService. Tudo o que for realizado, poderá ser visualizado no cadastro de turma no TOTVS Gestão Educacional.

Através do dataserver "EduTurmaData" e por meio dos métodos ReadRecord, SaveRecord e DeleteRecord, é possível realizar busca, inclusão, manutenção e exclusão das informações das Turmas no TOTVS Gestão Educacional.

...

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:

<?xml version="1.0"?>
<configuration>
<appSettings>
<add key="JobServer3Camadas" value="false" />
<add key="Port" value="12120" />
<add key="ActionsPath" value="C:\totvs\CorporeRM\RM.Net;" />
<add key="LibPath" value="C:\totvs\CorporeRM\RM.Net" />
<add key="EnableDynamicLocalization" value="false" />
<add key="EnableCompression" value="false" />
<add key="LocalizationLanguage" value="pt-BR" />
<add key="HttpPort" value="8051" />
<add key="DefaultDB" value="CorporeRM" />
</appSettings>
<runtime>
<NetFx40_LegacySecurityPolicy enabled="true" />
<generatePublisherEvidence enabled="false" />
</runtime>
<startup useLegacyV2RuntimeActivationPolicy="true">
<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0" />
</startup>
</configuration>

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.

Se necessário clique aqui para obter ajuda na configuração do Host.

Expandir

title	Índice

Índice

minLevel	2

Nota

Para que o sistema carregue corretamente os parâmetros do sistema no momento de utilização do WebService, é necessário que sejam inclusas as informações do contexto: Coligada, Filial, Tipo de curso e Código do Sistema.

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

Método ReadRecord

Este método realiza a consulta de uma turma. Algumas informações são obrigatórias e devem ser informadas: o código da coligada, o código da filial, o id do periodo período letivo, o código da turma.

O sistema irá realizar a consulta de uma turma , caso as informações passadas , estejam de acordo com alguma turma já existente no sistema.Caso os parâmetros informados no ReadRecord não encontre nenhuma turma cadastrada, o XML de retorno não trará nada.

Consulta da turma

Para realizar a consulta de uma turma, deve ser utilizado a operação de ReadRecord.

Deve ser passado um XML contendo todos os campos de chave primária.

Caso o código e turma a chave informada não existaretorne registro, não será retornado nenhuma turmao resultado será o nome do DataSet. Caso contrário, a mesma terá suas informações exibidas através de um XML.

...

Bloco de código

language	xml
title	Exemplo de XML para consulta de uma turmaTurma
collapse	true

		<tot:ReadRecord>
         <!--Optional:-->
         <tot:DataServerName>EduTurmaData</tot:DataServerName>
         <!--Optional:-->
         <tot:PrimaryKey>1;1;98;Turma B</tot:PrimaryKey>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=3;CODSISTEMA=S;</tot:Contexto>
      </tot:ReadRecord>

Bloco de código

language	xml
title	Exemplo do retorno de consulta da Turma
collapse	true

<ReadRecordResult><![CDATA[<EduTurma>
  <STurma>
    <CODCOLIGADA>1</CODCOLIGADA>
    <CODFILIAL>1</CODFILIAL>
    <IDPERLET>98</IDPERLET>
    <CODTURMA>Turma B</CODTURMA>
    <IDHABILITACAOFILIAL>403</IDHABILITACAOFILIAL>
    <NOMERED>ADS-A</NOMERED>
    <NOME>Análise e Desenvolvimento de Sofware - Turma A</NOME>
    <MAXALUNOS>100</MAXALUNOS>
    <DTINICIAL>2018-01-01T00:00:00</DTINICIAL>
    <DTFINAL>2018-12-31T00:00:00</DTFINAL>
    <CODTIPOCURSO>3</CODTIPOCURSO>
    <CODCURSO>ADS</CODCURSO>
    <CODHABILITACAO>1</CODHABILITACAO>
    <CODGRADE>1</CODGRADE>
    <CODPERLET>2018/01</CODPERLET>
    <DTINICIOPLETIVO>2017-01-01T00:00:00</DTINICIOPLETIVO>
    <NOMECURSO>Análise e Desenvolvimento de Software</NOMECURSO>
    <NOMEHABILITACAO>Bacharelado</NOMEHABILITACAO>
    <DESCGRADE>Tecnologia da Informação</DESCGRADE>
    <TURNO>Matutino</TURNO>
    <CONTROLEVAGAS>0</CONTROLEVAGAS>
  </STurma>
  <STURMACOMPL>
    <CODCOLIGADA>1</CODCOLIGADA>
    <CODFILIAL>1</CODFILIAL>
    <IDPERLET>98</IDPERLET>
    <CODTURMA>Turma B</CODTURMA>
  </STURMACOMPL>
</EduTurma>]]></ReadRecordResult>

Bloco de código

language	xml
title	Exemplo do retorno sem registros
collapse	true

<ReadRecordResult>&lt;EduTurma /></ReadRecordResult>

Método SaveRecord

Este método realiza a inclusão ou alteração de uma turma. Algumas informações são obrigatórias e devem ser informadas: o código da coligada, o código da filial, o id do periodo período letivo, o código da turma, além dos outros campos que estão configurados como obrigatórios no sistema.

...

Observação: Caso sejam passadas para o dataserver informações para campos complementares, devem ser utilizados os mesmos códigos obrigatórios para que o sistema consiga entender que se referem à turma que se deseja alterar.

Utilização do WebService

Inclusão da turma

Para realizar inclusão de uma turma, deve ser utilizado a operação de SaveRecord.

...

Bloco de código

language	xml
title	Exemplo de XML para inclusão de uma turmaTurma
collapse	true

		<tot:SaveRecord>
        	 <!--Optional:-->
       		<tot:DataServerName>EduTurmaData</tot:DataServerName>
        	<!--Optional:-->
        	<tot:XML><![CDATA[<EduTurma>
	<STurma>
	    <CODCOLIGADA>1</CODCOLIGADA>
	    <CODFILIAL>1</CODFILIAL>
	    <IDPERLET>98</IDPERLET>
	    <CODTURMA>Turma B</CODTURMA>
	    <IDHABILITACAOFILIAL>403</IDHABILITACAOFILIAL>
	    <NOMERED>ADS-A</NOMERED>
	    <NOME>Análise e Desenvolvimento de Sofware - Turma A</NOME>
	    <MAXALUNOS>100</MAXALUNOS>
	    <DTINICIAL>2018-01-01T00:00:00</DTINICIAL>
	    <DTFINAL>2018-12-31T00:00:00</DTFINAL>
	    <CODTIPOCURSO>3</CODTIPOCURSO>
	    <CODCURSO>ADS</CODCURSO>
	    <CODHABILITACAO>1</CODHABILITACAO>
	    <CODGRADE>1</CODGRADE>
	    <CODPERLET>2018/01</CODPERLET>
	    <DTINICIOPLETIVO>2017-01-01T00:00:00</DTINICIOPLETIVO>
	    <NOMECURSO>Análise e Desenvolvimento de Software</NOMECURSO>
	    <NOMEHABILITACAO>Bacharelado</NOMEHABILITACAO>
    	<DESCGRADE>Tecnologia da Informação</DESCGRADE>
	    <TURNO>Matutino</TURNO>
    	<CONTROLEVAGAS>0</CONTROLEVAGAS>
	</STurma>
	<STURMACOMPL>
 	   <CODCOLIGADA>1</CODCOLIGADA>
    	<CODFILIAL>1</CODFILIAL>
 	   <IDPERLET>98</IDPERLET>
  	  <CODTURMA>Turma B</CODTURMA>
  </STURMACOMPL>
</EduTurma>]]></tot:XML>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=3;CODSISTEMA=S;</tot:Contexto>
      </tot:SaveRecord>

...

Informações
Caso a inclusão seja realizada com sucesso, será mostrado o código da coligada, o código da filial, o id do período letivo e o código da turma inserido no item SaveRecordResult.

Alteração de Turmas

Para realizar alteração de uma turma, deve ser utilizado a operação de SaveRecord.

...

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.

Método DeleteRecord

Este método realiza a exclusão de uma turma. Algumas informações são obrigatórias e devem ser informadas: o código da coligada, o código da filial, o id do periodo período letivo, o código da turma, além dos outros campos que estão configurados como obrigatórios no sistema.

O sistema irá realizar a exclusão de uma turma caso encontre o registro.Se o código da turma existir na coligada informada, essa terá as informações excluídas de acordo com o que será passado no arquivo XML.

...

Exclusão da turma

Para realizar inclusão exclusão de uma turma, deve ser utilizado a operação de DeleteRecord.

Deve ser passado um XML contendo todos os campos que serão cadastrados, como informação, para a turma.Caso o código e turma informada não exista, será incluída uma nova turma. Caso contrário, a mesma terá suas informações atualizadas.fazem parte do registro da turma.

O XML deve conter a tabela STURMA com os campos CODCOLIGADA, CODFILIAL, IDPERLET e CODTURMA como informações da chave para o cadastro da turma e, também, os campos obrigatórios para seu cadastro.

...

Bloco de código

language	xml
title	Exemplo de XML para consulta exclusão de uma turmaTurma
collapse	true

		<tot:ReadRecord>DeleteRecord>
         <!--Optional:-->
         <tot:DataServerName>EduTurmaData</tot:DataServerName>
         <!--Optional:-->
         <tot:PrimaryKey>1;1;98;Turma B</tot:PrimaryKey>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=3;CODSISTEMA=S;</tot:Contexto>
      </tot:ReadRecord>

Bloco de código

language	xml
title	Exemplo do retorno de consulta da Turma
collapse	true

<ReadRecordResult><XML><![CDATA[<EduTurma>
  <STurma>
    <CODCOLIGADA>1</CODCOLIGADA>
    <CODFILIAL>1</CODFILIAL>
    <IDPERLET>98</IDPERLET>
    <CODTURMA>Turma B</CODTURMA>
    <IDHABILITACAOFILIAL>403</IDHABILITACAOFILIAL>
    <NOMERED>ADS-A</NOMERED>
    <NOME>Análise e Desenvolvimento de Sofware - Turma A</NOME>
    <MAXALUNOS>100</MAXALUNOS>
    <DTINICIAL>2018-01-01T00:00:00</DTINICIAL>
    <DTFINAL>2018-12-31T00:00:00</DTFINAL>
    <CODTIPOCURSO>3</CODTIPOCURSO>
    <CODCURSO>ADS</CODCURSO>
    <CODHABILITACAO>1</CODHABILITACAO>
    <CODGRADE>1</CODGRADE>
    <CODPERLET>2018/01</CODPERLET>
    <DTINICIOPLETIVO>2017-01-01T00:00:00</DTINICIOPLETIVO>
    <NOMECURSO>Análise e Desenvolvimento de Software</NOMECURSO>
    <NOMEHABILITACAO>Bacharelado</NOMEHABILITACAO>
    <DESCGRADE>Tecnologia da Informação</DESCGRADE>
    <TURNO>Matutino</TURNO>
    <CONTROLEVAGAS>0</CONTROLEVAGAS>
  </STurma>
  <STURMACOMPL>
    <CODCOLIGADA>1</CODCOLIGADA>
    <CODFILIAL>1</CODFILIAL>
    <IDPERLET>98</IDPERLET>
    <CODTURMA>Turma B</CODTURMA>
  </STURMACOMPL>
</EduTurma>]]></ReadRecordResult>
tot:XML>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=3;CODSISTEMA=S;</tot:Contexto>
      </tot:DeleteRecord>

Bloco de código

language	xml
title	Exemplo do retorno de exclusão da Turma
collapse	true

 <DeleteRecordResult>Exclusão de registro(s) realizado com sucesso</DeleteRecordResult>

Informações

Para mais informações segue o link da documentação padrão de uso de DataServers utilizando WebService:

http://tdn.totvs.com/x/XYlpCw

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 7

Nova versão Atual

Chave

Visão Geral dos processos WebSevices da Turma

Método ReadRecord

Consulta da turma

Método SaveRecord

Utilização do WebService

Inclusão da turma

Alteração de Turmas

Método DeleteRecord

Exclusão da turma

Atalhos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 7

Nova versão Atual

Chave

Visão Geral dos processos WebSevices da Turma

Método ReadRecord

Consulta da turma

Método SaveRecord

Utilização do WebService

Inclusão da turma

Alteração de Turmas

Método DeleteRecord

Exclusão da turma