Linha RM

Atalhos

Páginas filhas
  • Plano de Aula (Webservice)

Visão Geral dos processos WebSevices de Plano de Aula

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

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

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


Método ReadRecord

Este método realiza a consulta de um plano de aula. Algumas informações são obrigatórias e devem ser informadas: o código da coligada, o id da turma disciplina e o id do plano de aula.

O sistema irá realizar a consulta do plano de aula, caso as informações passadas estejam de acordo com algum plano de aula já existente no sistema.

Consulta de Plano de Aula

Para realizar a consulta de um plano de aula, 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.

O XML deve conter os campos CODCOLIGADA, IDTURMADISC e IDPLANOAULA como informações da chave para busca do plano de aula.


Exemplo de XML para consulta de um Plano de Aula 
	  <tot:ReadRecord>
         <!--Optional:-->
         <tot:DataServerName>EduPlanoAulaData</tot:DataServerName>
         <!--Optional:-->
         <tot:PrimaryKey>1;4632;311254</tot:PrimaryKey>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODTIPOCURSO=1;CODSISTEMA=S;CODFILIAL=1</tot:Contexto>
      </tot:ReadRecord>
Exemplo do retorno de consulta de Plano de Aula 
<ReadRecordResult><![CDATA[<EduPlanoAula >
  <SPlanoAula>
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDTURMADISC>4632</IDTURMADISC>
    <AULA>1001</AULA>
    <IDHORARIOTURMA>9725</IDHORARIOTURMA>
    <CODFILIAL>1</CODFILIAL>
    <CODHOR>230401</CODHOR>
    <DATA>2037-03-02T00:00:00</DATA>
    <HORAINICIAL>07:10</HORAINICIAL>
    <HORAFINAL>08:00</HORAFINAL>
    <CODTURMA>T1JD</CODTURMA>
    <CODDISC>FDJD</CODDISC>
    <NOMEDISC>Fundamentos do Design de Jogos Digitais</NOMEDISC>
    <DIASEMANA>2</DIASEMANA>
    <CONFIRMADO>N</CONFIRMADO>
    <IDPLANOAULA>311254</IDPLANOAULA>
    <TIPOAULA>T</TIPOAULA>
    <IDPERLET>104</IDPERLET>
    <HORAINICIALREALIZADO>07:10</HORAINICIALREALIZADO>
    <HORAFINALREALIZADO>08:00</HORAFINALREALIZADO>
    <CODTURNO>304</CODTURNO>
  </SPlanoAula>
</EduPlanoAula>]]></ReadRecordResult>
Exemplo do retorno sem registros 
<ReadRecordResult>&lt;EduPlanoAula /></ReadRecordResult>

Método ReadView

Este método realiza a consulta de um plano de aula. Algumas informações são obrigatórias e devem ser informadas:como o contexto e o filtro.

O sistema irá realizar a consulta de plano de aula, caso as informações passadas estejam de acordo com algum plano de aula já existente no sistema.

Consulta de plano de aula

Para realizar a consulta de um plano de aula, deve ser utilizado a operação de ReadView.

Deve ser passado um XML contendo os campos no filtro.

Para visualizar os nomes dos campos do plano de aula acesse: Cadastro de Turma Disciplinas | Anexo > Plano de Aula | Filtro.

Ao selecionar um novo filtro é possível visualizar os nomes dos campos do cadastro do plano de aula. Exemplo de como obter o nome do campo.


Exemplo de XML para consulta de um Plano de Aula 
<tot:ReadView>
         <!--Optional:-->
         <tot:DataServerName>EduPlanoAulaData</tot:DataServerName>
         <!--Optional:-->
         <tot:Filtro>SPLANOAULA.IDPLANOAULA = '311256'</tot:Filtro>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1;CODSISTEMA=S</tot:Contexto>
      </tot:ReadView>
Exemplo de retorno de consulta de Plano de Aula 
<ReadViewResult><![CDATA[<NewDataSet>
  <SPlanoAula>
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDHORARIOTURMA>9725</IDHORARIOTURMA>
    <DIASEMANA>2</DIASEMANA>
    <HORAINICIAL>07:10</HORAINICIAL>
    <HORAFINAL>08:00</HORAFINAL>
    <DATA>2037-03-16T00:00:00</DATA>
    <AULA>1003</AULA>
    <IDTURMADISC>4632</IDTURMADISC>
    <CODTURMA>T1JD</CODTURMA>
    <CODDISC>FDJD</CODDISC>
    <NOMEDISC>Fundamentos do Design de Jogos Digitais</NOMEDISC>
    <CONFIRMADO>N</CONFIRMADO>
    <IDPLANOAULA>311256</IDPLANOAULA>
    <TIPOAULA>T</TIPOAULA>
    <CODHOR>230401</CODHOR>
    <IDPERLET>104</IDPERLET>
  </SPlanoAula>
</NewDataSet>]]></ReadViewResult>


Método SaveRecord

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

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

Se a chave existir na coligada informada, essa terá as informações alteradas de acordo com o que será passado no arquivo XML.

Alteração de Plano de Aula

Para realizar alteração de um plano de aula, deve ser utilizado a operação de SaveRecord.

Deve ser passado um XML contendo todos os campos que serão atualizados no cadastro de plano de aula.

O XML deve conter a tabela SPLANOAULA com os campos CODCOLIGADA, IDTURMADISC e IDPLANOAULA como informações da chave para a atualização do cadastro de plano de aula.


Exemplo de XML para alteração de informações de Plano de Aula 
<tot:SaveRecord>
         <!--Optional:-->
         <tot:DataServerName>EduPlanoAulaData</tot:DataServerName>
         <!--Optional:-->
         <tot:XML><![CDATA[<EduPlanoAula >
  <SPlanoAula>
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDTURMADISC>4632</IDTURMADISC>
    <AULA>1002</AULA>
    <IDHORARIOTURMA>9725</IDHORARIOTURMA>
    <CODFILIAL>1</CODFILIAL>
    <CODHOR>230401</CODHOR>
    <DATA>2037-03-02T00:00:00</DATA>
    <HORAINICIAL>07:10</HORAINICIAL>
    <HORAFINAL>08:00</HORAFINAL>
    <CODTURMA>T1JD</CODTURMA>
    <CODDISC>FDJD</CODDISC>
    <NOMEDISC>Fundamentos do Design de Jogos Digitais</NOMEDISC>
    <DIASEMANA>2</DIASEMANA>
    <CONFIRMADO>N</CONFIRMADO>
    <IDPLANOAULA>311255</IDPLANOAULA>
    <TIPOAULA>T</TIPOAULA>
    <IDPERLET>104</IDPERLET>
    <HORAINICIALREALIZADO>07:10</HORAINICIALREALIZADO>
    <HORAFINALREALIZADO>08:00</HORAFINALREALIZADO>
    <CODTURNO>304</CODTURNO>
  </SPlanoAula>
</EduPlanoAula>]]></tot:XML>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODTIPOCURSO=3;CODSISTEMA=S;CODFILIAL=1;CODUSUARIO=mestre</tot:Contexto>
      </tot:SaveRecord>
Exemplo do retorno da alteração do cadastro de Plano de Aula 
<SaveRecordResult>1;4632;311255</SaveRecordResult>

Caso a alteração seja realizada com sucesso, será mostrado o código da coligada, o id da turma disciplina e o id do plano de aula no item SaveRecordResult.

Método DeleteRecord

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

O sistema irá realizar a exclusão de um plano de aula caso encontre o registro.

Exclusão de plano de aula

Para realizar exclusão de um plano de aula, deve ser utilizado a operação de DeleteRecord.

Deve ser passado um XML contendo todos os campos que fazem parte do registro de plano de aula.

O XML deve conter a tabela SPLANOAULA com os campos CODCOLIGADA, IDTURMADISC e IDPLANOAULA como informações da chave para o cadastro de plano de aula e, também, os campos obrigatórios para seu cadastro.


Exemplo de XML para exclusão de um Plano de Aula 
		<tot:DeleteRecord>
         <!--Optional:-->
         <tot:DataServerName>EduPlanoAulaData</tot:DataServerName>
         <!--Optional:-->
         <tot:XML><![CDATA[<EduPlanoAula >
  <SPlanoAula>
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDTURMADISC>4632</IDTURMADISC>
    <AULA>1002</AULA>
    <IDHORARIOTURMA>9725</IDHORARIOTURMA>
    <CODFILIAL>1</CODFILIAL>
    <CODHOR>230401</CODHOR>
    <DATA>2037-03-02T00:00:00</DATA>
    <HORAINICIAL>07:10</HORAINICIAL>
    <HORAFINAL>08:00</HORAFINAL>
    <CODTURMA>T1JD</CODTURMA>
    <CODDISC>FDJD</CODDISC>
    <NOMEDISC>Fundamentos do Design de Jogos Digitais</NOMEDISC>
    <DIASEMANA>2</DIASEMANA>
    <CONFIRMADO>N</CONFIRMADO>
    <IDPLANOAULA>311255</IDPLANOAULA>
    <TIPOAULA>T</TIPOAULA>
    <IDPERLET>104</IDPERLET>
    <HORAINICIALREALIZADO>07:10</HORAINICIALREALIZADO>
    <HORAFINALREALIZADO>08:00</HORAFINALREALIZADO>
    <CODTURNO>304</CODTURNO>
  </SPlanoAula>
</EduPlanoAula>]]></tot:XML>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODTIPOCURSO=3;CODSISTEMA=S;CODFILIAL=1;CODUSUARIO=mestre</tot:Contexto>
      </tot:DeleteRecord>
Exemplo do retorno de exclusão de Plano de Aula 
 <DeleteRecordResult>Exclusão de registro(s) realizado com sucesso</DeleteRecordResult>

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

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