Linha RM

Atalhos

Páginas filhas
  • Turma/Disciplinas (WebService)

Visão Geral dos processos WebSevices da Turma/Disciplinas

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

Através do dataserver "EduTurmaDiscData" 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 Turma/Discplina 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 uma turma/disciplina. Algumas informações são obrigatórias e devem ser informadas: o código da coligada e o ID da turma/disciplina.

O sistema irá realizar a consulta de uma turma/disciplina caso as informações passadas estejam de acordo com alguma turma/disciplina já existente no sistema.

Consulta da turma/disciplina

Para realizar a consulta de uma turma/disciplina, 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 e IDTURMADISC como informações da chave para busca da turma/disciplina.


Exemplo de XML para consulta de uma Turma/Disciplina 
		<tot:ReadRecord>
         <!--Optional:-->
         <tot:DataServerName>EduTurmaDiscData</tot:DataServerName>
         <!--Optional:-->
         <tot:PrimaryKey>1;2943</tot:PrimaryKey>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1;CODSISTEMA=S</tot:Contexto>
      </tot:ReadRecord>
Exemplo do retorno de consulta da Turma/Disciplina 
    <ReadRecordResult><![CDATA[<EduTurmaDisc>
  <STurmaDisc>
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDTURMADISC>2943</IDTURMADISC>
    <CODFILIAL>1</CODFILIAL>
    <CODTURMA>Turma B</CODTURMA>
    <IDPERLET>98</IDPERLET>
    <CODDISC>BD</CODDISC>
    <CODTURNO>304</CODTURNO>
    <IDHABILITACAOFILIAL>403</IDHABILITACAOFILIAL>
    <NUMAULASEM>1000</NUMAULASEM>
    <DURACAOAULA>50</DURACAOAULA>
    <MAXALUNOS>25</MAXALUNOS>
    <CODTIPOCURSO>3</CODTIPOCURSO>
    <DTINICIAL>2018-01-01T00:00:00</DTINICIAL>
    <DTFINAL>2018-12-31T00:00:00</DTFINAL>
    <CUSTOMEDIO>5</CUSTOMEDIO>
    <NOME>ADS-BD</NOME>
    <TIPO>P</TIPO>
    <CODCURSO>ADS</CODCURSO>
    <CODHABILITACAO>1</CODHABILITACAO>
    <CODGRADE>1</CODGRADE>
    <ADICIONALNOTURNO>N</ADICIONALNOTURNO>
    <ADICIONALEXTRA>N</ADICIONALEXTRA>
    <DISPONIVELMATRICULA>S</DISPONIVELMATRICULA>
    <GERENCIAL>N</GERENCIAL>
    <ATIVA>S</ATIVA>
    <IDTURMADISCANTIGO>0</IDTURMADISCANTIGO>
    <CODTIPOCURSOPLETIVO>3</CODTIPOCURSOPLETIVO>
    <CODPERLET>2018/01</CODPERLET>
  </STurmaDisc>
  <STURMADISCCOMPL>
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDTURMADISC>2943</IDTURMADISC>
    <BJEXIBOL>S</BJEXIBOL>
  </STURMADISCCOMPL>
</EduTurmaDisc>]]></ReadRecordResult>
Exemplo do retorno sem registros 
<ReadRecordResult>&lt;EduTurmaDisc /></ReadRecordResult>

Método SaveRecord

Este método realiza a inclusão ou alteração de uma turma/disciplina. 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/disciplina, caso o código informado não exista na base.

Se o código da turma/disciplina 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/disciplina que se deseja alterar.

Inclusão da turma/disciplina

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

Levando em consideração que o campo de IDTURMADISC é auto-Incremento, o mesmo deve ser preenchido com o valor 0.

Caso o código e turma/disciplina informada não exista, será incluída uma nova turma/disciplina. Caso contrário, a mesma terá suas informações atualizadas.

O XML deve conter a tabela STURMADISC com os campos CODCOLIGADA e IDTURMADISC como informações da chave para o cadastro da turma/disciplina e, também, os campos obrigatórios para seu cadastro.


Exemplo de XML para inclusão de uma Turma/Disciplina 
		<tot:SaveRecord>
         <!--Optional:-->
         <tot:DataServerName>EduTurmaDiscData</tot:DataServerName>
         <!--Optional:-->
         <tot:XML><![CDATA[<EduTurmaDisc>
  <STurmaDisc>
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDTURMADISC>0</IDTURMADISC>
    <CODFILIAL>1</CODFILIAL>
    <CODTURMA>Turma B</CODTURMA>
    <IDPERLET>98</IDPERLET>
    <CODDISC>BD</CODDISC>
    <CODTURNO>304</CODTURNO>
    <IDHABILITACAOFILIAL>403</IDHABILITACAOFILIAL>
    <NUMAULASEM>1000</NUMAULASEM>
    <DURACAOAULA>50</DURACAOAULA>
    <MAXALUNOS>25</MAXALUNOS>
    <CODTIPOCURSO>3</CODTIPOCURSO>
    <DTINICIAL>2018-01-01T00:00:00</DTINICIAL>
    <DTFINAL>2018-12-31T00:00:00</DTFINAL>
    <CUSTOMEDIO>5</CUSTOMEDIO>
    <NOME>ADS-BD</NOME>
    <TIPO>P</TIPO>
    <CODCURSO>ADS</CODCURSO>
    <CODHABILITACAO>1</CODHABILITACAO>
    <CODGRADE>1</CODGRADE>
    <ADICIONALNOTURNO>N</ADICIONALNOTURNO>
    <ADICIONALEXTRA>N</ADICIONALEXTRA>
    <DISPONIVELMATRICULA>S</DISPONIVELMATRICULA>
    <GERENCIAL>N</GERENCIAL>
    <ATIVA>S</ATIVA>
    <IDTURMADISCANTIGO>0</IDTURMADISCANTIGO>
    <CODTIPOCURSOPLETIVO>3</CODTIPOCURSOPLETIVO>
    <CODPERLET>2018/01</CODPERLET>
  </STurmaDisc>
</EduTurmaDisc>]]></tot:XML>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1;CODSISTEMA=S</tot:Contexto>
      </tot:SaveRecord>
Exemplo do retorno da inclusão da Turma/Disciplina 
<SaveRecordResult>1;2943</SaveRecordResult>


Caso a inclusão seja realizada com sucesso, será mostrado o código da coligada e o id da turma/disciplina inserido no item SaveRecordResult.

Alteração de turma/disciplina

Para realizar alteração de uma turma/disciplina, 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/disciplina.

O XML deve conter a tabela STURMADISC com os campos CODCOLIGADA e IDTURMADISC como informações da chave para a atualização do cadastro da turma/disciplina.


Exemplo de XML para alteração de informações da Turma/Disciplina 
<tot:SaveRecord>
         <!--Optional:-->
         <tot:DataServerName>EduTurmaDiscData</tot:DataServerName>
         <!--Optional:-->
         <tot:XML><![CDATA[<EduTurmaDisc>
  <STurmaDisc>
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDTURMADISC>2943</IDTURMADISC>
    <CODFILIAL>1</CODFILIAL>
    <CODTURMA>Turma B</CODTURMA>
    <IDPERLET>98</IDPERLET>
    <CODDISC>BD</CODDISC>
    <CODTURNO>304</CODTURNO>
    <IDHABILITACAOFILIAL>403</IDHABILITACAOFILIAL>
    <NUMAULASEM>100</NUMAULASEM>
    <DURACAOAULA>50</DURACAOAULA>
    <MAXALUNOS>25</MAXALUNOS>
    <CODTIPOCURSO>3</CODTIPOCURSO>
    <DTINICIAL>2018-01-01T00:00:00</DTINICIAL>
    <DTFINAL>2018-12-31T00:00:00</DTFINAL>
    <CUSTOMEDIO>5</CUSTOMEDIO>
    <NOME>ADS-BD</NOME>
    <TIPO>P</TIPO>
    <CODCURSO>ADS</CODCURSO>
    <CODHABILITACAO>1</CODHABILITACAO>
    <CODGRADE>1</CODGRADE>
    <ADICIONALNOTURNO>N</ADICIONALNOTURNO>
    <ADICIONALEXTRA>N</ADICIONALEXTRA>
    <DISPONIVELMATRICULA>S</DISPONIVELMATRICULA>
    <GERENCIAL>N</GERENCIAL>
    <ATIVA>S</ATIVA>
    <IDTURMADISCANTIGO>0</IDTURMADISCANTIGO>
    <CODTIPOCURSOPLETIVO>3</CODTIPOCURSOPLETIVO>
    <CODPERLET>2018/01</CODPERLET>
  </STurmaDisc>
  <STURMADISCCOMPL>
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDTURMADISC>2943</IDTURMADISC>
    <BJEXIBOL>S</BJEXIBOL>
  </STURMADISCCOMPL>
</EduTurmaDisc>]]></tot:XML>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1;CODSISTEMA=S</tot:Contexto>
      </tot:SaveRecord>
Exemplo do retorno da alteração do cadastro da Turma/Disciplina 
<SaveRecordResult>1;2943</SaveRecordResult>

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

Método DeleteRecord

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

O sistema irá realizar a exclusão de uma turma/disciplina caso encontre o registro.

Exclusão da turma/disciplina

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

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

O XML deve conter a tabela STURMADISC com os campos CODCOLIGADA e IDTURMADISC como informações da chave para o cadastro da turma/disciplina e, também, os campos obrigatórios para seu cadastro.


Exemplo de XML para exclusão de uma Turma/Disciplina 
		<tot:DeleteRecord>
         <!--Optional:-->
         <tot:DataServerName>EduTurmaDiscData</tot:DataServerName>
         <!--Optional:-->
         <tot:XML><![CDATA[<EduTurmaDisc>
  <STurmaDisc>
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDTURMADISC>2943</IDTURMADISC>
    <CODFILIAL>1</CODFILIAL>
    <CODTURMA>Turma B</CODTURMA>
    <IDPERLET>98</IDPERLET>
    <CODDISC>BD</CODDISC>
    <CODTURNO>304</CODTURNO>
    <IDHABILITACAOFILIAL>403</IDHABILITACAOFILIAL>
    <NUMAULASEM>500</NUMAULASEM>
    <DURACAOAULA>50</DURACAOAULA>
    <MAXALUNOS>25</MAXALUNOS>
    <CODTIPOCURSO>3</CODTIPOCURSO>
    <DTINICIAL>2018-01-01T00:00:00</DTINICIAL>
    <DTFINAL>2018-12-31T00:00:00</DTFINAL>
    <CUSTOMEDIO>5</CUSTOMEDIO>
    <NOME>ADS-BD</NOME>
    <TIPO>P</TIPO>
    <CODCURSO>ADS</CODCURSO>
    <CODHABILITACAO>1</CODHABILITACAO>
    <CODGRADE>1</CODGRADE>
    <ADICIONALNOTURNO>N</ADICIONALNOTURNO>
    <ADICIONALEXTRA>N</ADICIONALEXTRA>
    <DISPONIVELMATRICULA>S</DISPONIVELMATRICULA>
    <GERENCIAL>N</GERENCIAL>
    <ATIVA>S</ATIVA>
    <IDTURMADISCANTIGO>0</IDTURMADISCANTIGO>
    <CODTIPOCURSOPLETIVO>3</CODTIPOCURSOPLETIVO>
    <CODPERLET>2018/01</CODPERLET>
  </STurmaDisc>
  <STURMADISCCOMPL>
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDTURMADISC>2943</IDTURMADISC>
    <BJEXIBOL>S</BJEXIBOL>
  </STURMADISCCOMPL>
</EduTurmaDisc>]]></tot:XML>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1;CODSISTEMA=S</tot:Contexto>
      </tot:DeleteRecord>
Exemplo do retorno de exclusão da Turma/Disciplina 
 <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