Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Visão Geral dos processos WebSevices da Turma

O objetivo deste DataServer é possibilitar a busca, inclusão, alteração e exclusão de turmas através de WebService. 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.

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


Expandir
titleÍndice

Índice
minLevel2

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

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 a chave informada não retorne registro, o resultado será o nome do DataSet. Caso contrário, a mesma terá suas informações exibidas através de um XML.

XML deve conter os campos CODCOLIGADACODFILIAL, IDPERLET e CODTURMA como informações da chave para busca da turma.


Bloco de código
languagexml
titleExemplo de XML para consulta de uma Turma
collapsetrue
		<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
languagexml
titleExemplo do retorno de consulta da Turma
collapsetrue
<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
languagexml
titleExemplo do retorno sem registros
collapsetrue
<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 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 inclusão de uma turma, caso o código informado não exista na base.

Se o código da turma existir na coligada informada, essa 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 mesmos códigos obrigatórios para que o sistema consiga entender que se referem à turma que se deseja alterar.

Inclusão da turma

Para realizar inclusão de uma turma, 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 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.

O XML deve conter a tabela STURMA com os campos CODCOLIGADACODFILIAL, 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
languagexml
titleExemplo de XML para inclusão de uma Turma
collapsetrue
		<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>
Bloco de código
languagexml
titleExemplo do retorno da inclusão da Turma
collapsetrue
         <SaveRecordResult>1;1;98;Turma B</SaveRecordResult>


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.

Deve ser passado um XML contendo todos os campos que serão atualizados no cadastro da turma.

XML deve conter a tabela STURMA com os campos CODCOLIGADACODFILIAL, IDPERLET e CODTURMA como informações da chave para a atualização do cadastro da turma.


Bloco de código
languagexml
titleExemplo de XML para alteração de informações da Turma
collapsetrue
<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>99</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>
Bloco de código
languagexml
titleExemplo do retorno da alteração do cadastro da Turma
collapsetrue
         <SaveRecordResult>1;1;98;Turma B</SaveRecordResult>
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 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.

Exclusão da turma

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

Deve ser passado um XML contendo todos os campos que fazem parte do registro da turma.

XML deve conter a tabela STURMA com os campos CODCOLIGADACODFILIAL, 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
languagexml
titleExemplo de XML para exclusão de uma Turma
collapsetrue
		<tot:DeleteRecord>
         <!--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:DeleteRecord>
Bloco de código
languagexml
titleExemplo do retorno de exclusão da Turma
collapsetrue
 <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