Histórico da Página

...

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

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

...

Este método realiza a consulta de um alunouma nota de etapa. Algumas informações são obrigatórias e devem ser informadas: o código da coligada e o , código da etapa, tipo da etapa, id da turma disciplina e registro acadêmico do aluno.

O sistema irá realizar a consulta da nota de alunoetapa, caso as informações passadas estejam de acordo com algum aluno já alguma nota de etapa já existente no sistema.

Consulta da nota de

...

etapa

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

...

O XML deve conter os campos CODCOLIGADA e RA, CODETAPA, TIPOETAPA, IDTURMADISC e RA como informações da chave para busca do alunoda nota de etapa.

Bloco de código

language	xml
title	Exemplo de XML para consulta de um Aluno
collapse	true

		<tot:ReadRecord>
         <!--Optional:-->
         <tot:DataServerName>EduAlunoData<DataServerName>EduAlunoEtapaData</tot:DataServerName>
         <!--Optional:-->
         <tot:PrimaryKey>1;EB-00384<1;N;4390;MFA2018</tot:PrimaryKey>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=2<1</tot:Contexto>
      </tot:ReadRecord>

Bloco de código

language	xml
title	Exemplo do retorno de consulta de Aluno
collapse	true

<ReadRecordResult><![CDATA[<EduAluno><EduNotaEtapa>
  <SAluno><SNotaEtapa>
    <CODCOLIGADA>1</CODCOLIGADA>
    <RA>EB-00384<<CODETAPA>1</RA>CODETAPA>
    <CODPESSOA>4105<<TIPOETAPA>N</CODPESSOA>TIPOETAPA>
    <CODTIPOCURSO>2<<IDTURMADISC>4390</CODTIPOCURSO>IDTURMADISC>
    <CODIGO>4105<<RA>MFA2018</CODIGO>RA>
    <NOME>Yasmin Marcela Cavalcanti</NOME><NOTAFALTA>80</NOTAFALTA>
    <CPF>38252307671</CPF>
    <SOBRENOME>Cavalcanti</SOBRENOME>
    <APELIDO>Yasmin</APELIDO>
    <DTNASCIMENTO>1994-06-10T00:00:00</DTNASCIMENTO>
    <NACIONALIDADE>10</NACIONALIDADE>
    <ESTADONATAL>MG</ESTADONATAL>
    <NATURALIDADE>Belo Horizonte</NATURALIDADE>
    <NIT>0</NIT>
    <NROFILHOSBRASIL>0</NROFILHOSBRASIL>
    <CONJUGEBRASIL>0</CONJUGEBRASIL>
    <NATURALIZADO>0</NATURALIZADO>
    <FILHOSBRASIL>0</FILHOSBRASIL>
    <INDATENDESPECIALIZADO>00</INDATENDESPECIALIZADO>
    <INDATENDESPECIFICO>00</INDATENDESPECIFICO>
    <INDICADORDERECURSOS>00</INDICADORDERECURSOS>
    <CANHOTO>F</CANHOTO>
    <INVESTTREINANT>0.00</INVESTTREINANT>
    <ESTADOROW>0</ESTADOROW>
    <ROWVALIDA>0</ROWVALIDA>
    <ALUNO>1</ALUNO>
    <PROFESSOR>0</PROFESSOR>
    <CANDIDATO>0</CANDIDATO>
    <USUARIOBIBLIOS>0</USUARIOBIBLIOS>
    <FUNCIONARIO>0</FUNCIONARIO>
    <EXFUNCIONARIO>0</EXFUNCIONARIO>
    <FALECIDO>0</FALECIDO>
    <CODSTATUS>-1</CODSTATUS>
    <FIADOR_SGI>0</FIADOR_SGI>
    <CONJUGE_SGI>0</CONJUGE_SGI>
    <RECCREATEDBY>mestre</RECCREATEDBY>
    <RECCREATEDON>2018-04-03T08:42:41</RECCREATEDON>
    <RECMODIFIEDBY>mestre</RECMODIFIEDBY>
    <RECMODIFIEDON>2018-04-03T08:42:41</RECMODIFIEDON>
    <CODIGO1>4105</CODIGO1>
</EduAluno></SNotaEtapa>
</EduNotaEtapa>]]></ReadRecordResult>

Bloco de código

language	xml
title	Exemplo do retorno sem registros
collapse	true

<ReadRecordResult>&lt;EduAlunoEduNotaEtapa /></ReadRecordResult>

Método SaveRecord

Este método realiza a inclusão ou alteração de um alunouma nota de etapa. Algumas informações são obrigatórias e devem ser informadas: o código da coligada e o registro acadêmico, além dos outros campos que estão configurados como obrigatórios no sistema.

O sistema irá realizar a inclusão de um alunode uma nota de etapa, caso o código informado as informações passadas não exista na base.

Se o Registro Acadêmico 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 ao aluno que se deseja alterar.

...

houver um registro já existente com as informações informadas na chave, esse será alterado de acordo com os dados passados no arquivo XML.

Inclusão da nota de etapa

Para realizar inclusão de um alunouma nota de etapa, 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 aluno.Caso o Registro acadêmico informado não exista, será incluído um novo aluno. Caso contrário, o mesmo terá suas informações atualizadas.a nota de etapa.

Se houver um registro já existente com as informações informadas na chave, esse será alterado de acordo com os dados passados.

O XML deve conter a tabela SALUNOSNOTAETAPA com os campos CODCOLIGADA e RA, CODETAPA, TIPOETAPA, IDTURMADISC e RA como informações da chave para o cadastro da nota de aluno eetapa e, também, os campos obrigatórios para seu cadastro.

A inclusão do Aluno irá levar em consideração as configurações de RA informadas no sistema. Para que o RA seja criado automaticamente, deve-se informar "0" para o registro.

Bloco de código

language	xml
title	Exemplo de XML para inclusão de um Aluno
collapse	true

<tot:SaveRecord>
         <!--Optional:-->
         <tot:DataServerName>EduAlunoData<DataServerName>EduAlunoEtapaData</tot:DataServerName>
         <!--Optional:-->
         <tot:XML><![CDATA[<EduAluno><EduNotaEtapa>
  <SAluno><SNotaEtapa>
    <CODCOLIGADA>1</CODCOLIGADA>
    <RA>0<<CODETAPA>1</RA>CODETAPA>
    <CODPESSOA>0<<TIPOETAPA>N</CODPESSOA>TIPOETAPA>
    <CODTIPOCURSO>2<<IDTURMADISC>4390</CODTIPOCURSO>IDTURMADISC>
    <CODIGO>0</CODIGO>
    <NOME>Stella Fernanda Aparício</NOME>
    <CPF>62587463653</CPF>
    <SOBRENOME>Aparício</SOBRENOME>
    <APELIDO>Fernanda</APELIDO>
    <DTNASCIMENTO>1994-06-10T00:00:00</DTNASCIMENTO>
    <NACIONALIDADE>10</NACIONALIDADE>
    <ESTADONATAL>MG</ESTADONATAL>
    <NATURALIDADE>Belo Horizonte</NATURALIDADE>
    <NIT>0</NIT>
    <NROFILHOSBRASIL>0</NROFILHOSBRASIL>
    <CONJUGEBRASIL>0</CONJUGEBRASIL>
    <NATURALIZADO>0</NATURALIZADO>
    <FILHOSBRASIL>0</FILHOSBRASIL>
    <INDATENDESPECIALIZADO>00</INDATENDESPECIALIZADO>
    <INDATENDESPECIFICO>00</INDATENDESPECIFICO>
    <INDICADORDERECURSOS>00</INDICADORDERECURSOS>
    <CANHOTO>F</CANHOTO>
    <INVESTTREINANT>0.00</INVESTTREINANT>
    <ESTADOROW>0</ESTADOROW>
    <ROWVALIDA>0</ROWVALIDA>
    <ALUNO>1</ALUNO>
    <PROFESSOR>0</PROFESSOR>
    <CANDIDATO>0</CANDIDATO>
    <USUARIOBIBLIOS>0</USUARIOBIBLIOS>
    <FUNCIONARIO>0</FUNCIONARIO>
    <EXFUNCIONARIO>0</EXFUNCIONARIO>
    <FALECIDO>0</FALECIDO>
    <CODSTATUS>-1</CODSTATUS>
    <FIADOR_SGI>0</FIADOR_SGI>
    <CONJUGE_SGI>0</CONJUGE_SGI>
    <RECCREATEDBY>mestre</RECCREATEDBY>
    <RECCREATEDON>2018-04-03T08:42:41</RECCREATEDON>
    <RECMODIFIEDBY>mestre</RECMODIFIEDBY>
    <RECMODIFIEDON>2018-04-03T08:42:41</RECMODIFIEDON>
    <CODIGO1>4105</CODIGO1>
  </SAluno>
  <SAlunoCompl>
    <CODCOLIGADA>1</CODCOLIGADA>
    <RA>0</<RA>MFA2018</RA>
    <RECCREATEDBY>mestre<<NOTAFALTA>80</RECCREATEDBY>NOTAFALTA>
    <RECCREATEDON>2018-04-03T08:42:42</RECCREATEDON>
    <RECMODIFIEDBY>mestre</RECMODIFIEDBY>
    <RECMODIFIEDON>2018-04-03T08:42:42</RECMODIFIEDON>
  </SAlunoCompl></SNotaEtapa>
</EduAluno>EduNotaEtapa>]]></tot:XML>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1</tot:Contexto>
      </tot:SaveRecord>

Bloco de código

language	xml
title	Exemplo do retorno da inclusão de Aluno
collapse	true

<SaveRecordResult>1;8001408<1;N;4390;MFA2018</SaveRecordResult>

Informações
Caso a inclusão seja realizada com sucesso, será mostrado o código da coligada, código da etapa, o tipo da etapa, o id da turma disciplina e o registro acadêmico inserido no item SaveRecordResult.

Alteração da nota de

...

etapa

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

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

O XML deve conter a tabela SALUNOSNOTAETAPA com os campos CODCOLIGADA e RA como , CODETAPA, TIPOETAPA, IDTURMADISC e RA como informações da chave para a atualização do o cadastro de alunoda nota de etapa e, também, os campos obrigatórios para seu cadastro.

Bloco de código

language	xml
title	Exemplo de XML para alteração de informações de Aluno
collapse	true

<tot:SaveRecord>
         <!--Optional:-->
         <tot:DataServerName>EduAlunoData<DataServerName>EduAlunoEtapaData</tot:DataServerName>
         <!--Optional:-->
         <tot:XML><![CDATA[<EduAluno><EduNotaEtapa>
  <SAluno><SNotaEtapa>
    <CODCOLIGADA>1</CODCOLIGADA>
    <RA>0<<CODETAPA>1</RA>CODETAPA>
    <CODPESSOA>0<<TIPOETAPA>N</CODPESSOA>TIPOETAPA>
    <CODTIPOCURSO>2<<IDTURMADISC>4390</CODTIPOCURSO>IDTURMADISC>
    <CODIGO>0</CODIGO>
    <NOME>Stella Fernanda Aparício</NOME>
    <CPF>62587463653</CPF>
    <SOBRENOME>Aparício</SOBRENOME>
    <APELIDO>Fernanda</APELIDO>
    <DTNASCIMENTO>1994-06-12T00:00:00</DTNASCIMENTO>
    <NACIONALIDADE>10</NACIONALIDADE>
    <ESTADONATAL>MG</ESTADONATAL>
    <NATURALIDADE>Belo Horizonte</NATURALIDADE>
    <NIT>0</NIT>
    <NROFILHOSBRASIL>0</NROFILHOSBRASIL>
    <CONJUGEBRASIL>0</CONJUGEBRASIL>
    <NATURALIZADO>0</NATURALIZADO>
    <FILHOSBRASIL>0</FILHOSBRASIL>
    <INDATENDESPECIALIZADO>00</INDATENDESPECIALIZADO>
    <INDATENDESPECIFICO>00</INDATENDESPECIFICO>
    <INDICADORDERECURSOS>00</INDICADORDERECURSOS>
    <CANHOTO>F</CANHOTO>
    <INVESTTREINANT>0.00</INVESTTREINANT>
    <ESTADOROW>0</ESTADOROW>
    <ROWVALIDA>0</ROWVALIDA>
    <ALUNO>1</ALUNO>
    <PROFESSOR>0</PROFESSOR>
    <CANDIDATO>0</CANDIDATO>
    <USUARIOBIBLIOS>0</USUARIOBIBLIOS>
    <FUNCIONARIO>0</FUNCIONARIO>
    <EXFUNCIONARIO>0</EXFUNCIONARIO>
    <FALECIDO>0</FALECIDO>
    <CODSTATUS>-1</CODSTATUS>
    <FIADOR_SGI>0</FIADOR_SGI>
    <CONJUGE_SGI>0</CONJUGE_SGI>
    <RECCREATEDBY>mestre</RECCREATEDBY>
    <RECCREATEDON>2018-04-03T08:42:41</RECCREATEDON>
    <RECMODIFIEDBY>mestre</RECMODIFIEDBY>
    <RECMODIFIEDON>2018-04-03T08:42:41</RECMODIFIEDON>
    <CODIGO1>4105</CODIGO1>
  </SAluno>
  <SAlunoCompl>
    <CODCOLIGADA>1</CODCOLIGADA>
    <RA>0</<RA>MFA2018</RA>
    <RECCREATEDBY>mestre</RECCREATEDBY>
    <RECCREATEDON>2018-04-03T08:42:42</RECCREATEDON>
    <RECMODIFIEDBY>mestre</RECMODIFIEDBY>
    <RECMODIFIEDON>2018-04-03T08:42:42</RECMODIFIEDON>
  </SAlunoCompl>
</EduAluno><NOTAFALTA>70</NOTAFALTA>
  </SNotaEtapa>
</EduNotaEtapa>]]></tot:XML>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1</tot:Contexto>
      </tot:SaveRecord>

Bloco de código

language	xml
title	Exemplo do retorno da alteração do cadastro de Aluno
collapse	true

<SaveRecordResult>1;8001408</SaveRecordResult>

Informações
Caso a alteração inclusão seja realizada com sucesso, será mostrado o código da coligada e o registro acadêmico no item SaveRecordResult.

Método DeleteRecord

Este método realiza a exclusão de um aluno. Algumas informações são obrigatórias e devem ser informadas: o código da coligada e o registro acadêmico, além dos outros campos que estão configurados como obrigatórios no sistema.

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

Exclusão de aluno

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

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

O XML deve conter a tabela SALUNO com os campos CODCOLIGADA e RA como informações da chave para o cadastro de aluno e, também, os campos obrigatórios para seu cadastro.

Bloco de código

language	xml
title	Exemplo de XML para exclusão de um Aluno
collapse	true

		<tot:DeleteRecord>
         <!--Optional:-->
         <tot:DataServerName>EduAlunoData</tot:DataServerName>
         <!--Optional:-->
         <tot:XML><![CDATA[<EduAluno>
  <SAluno>
    <CODCOLIGADA>1</CODCOLIGADA>
    <RA>8001408</RA>
    <CODPESSOA>45087</CODPESSOA>
    <CODTIPOCURSO>2</CODTIPOCURSO>
    <CODIGO>45087</CODIGO>
    <NOME>Stella Fernanda Aparício</NOME>
    <CPF>62587463653</CPF>
    <SOBRENOME>Aparício</SOBRENOME>
    <APELIDO>Fernanda</APELIDO>
    <DTNASCIMENTO>1994-06-12T00:00:00</DTNASCIMENTO>
    <NACIONALIDADE>10</NACIONALIDADE>
    <ESTADONATAL>MG</ESTADONATAL>
    <NATURALIDADE>Belo Horizonte</NATURALIDADE>
    <NIT>0</NIT>
    <NROFILHOSBRASIL>0</NROFILHOSBRASIL>
    <CONJUGEBRASIL>0</CONJUGEBRASIL>
    <NATURALIZADO>0</NATURALIZADO>
    <FILHOSBRASIL>0</FILHOSBRASIL>
    <INDATENDESPECIALIZADO>00</INDATENDESPECIALIZADO>
    <INDATENDESPECIFICO>00</INDATENDESPECIFICO>
    <INDICADORDERECURSOS>00</INDICADORDERECURSOS>
    <CANHOTO>F</CANHOTO>
    <INVESTTREINANT>0.00</INVESTTREINANT>
    <ESTADOROW>0</ESTADOROW>
    <ROWVALIDA>0</ROWVALIDA>
    <ALUNO>1</ALUNO>
    <PROFESSOR>0</PROFESSOR>
    <CANDIDATO>0</CANDIDATO>
    <USUARIOBIBLIOS>0</USUARIOBIBLIOS>
    <FUNCIONARIO>0</FUNCIONARIO>
    <EXFUNCIONARIO>0</EXFUNCIONARIO>
    <FALECIDO>0</FALECIDO>
    <CODSTATUS>-1</CODSTATUS>
    <FIADOR_SGI>0</FIADOR_SGI>
    <CONJUGE_SGI>0</CONJUGE_SGI>
    <RECCREATEDBY>mestre</RECCREATEDBY>
    <RECCREATEDON>2018-04-03T08:42:41</RECCREATEDON>
    <RECMODIFIEDBY>mestre</RECMODIFIEDBY>
    <RECMODIFIEDON>2018-04-03T08:42:41</RECMODIFIEDON>
    <CODIGO1>4105</CODIGO1>
  </SAluno>
  <SAlunoCompl>
    <CODCOLIGADA>1</CODCOLIGADA>
    <RA>8001408</RA>
    <RECCREATEDBY>mestre</RECCREATEDBY>
    <RECCREATEDON>2018-04-03T08:42:42</RECCREATEDON>
    <RECMODIFIEDBY>mestre</RECMODIFIEDBY>
    <RECMODIFIEDON>2018-04-03T08:42:42</RECMODIFIEDON>
  </SAlunoCompl>
</EduAluno>]]></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 de Aluno
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, código da etapa, o tipo da etapa, o id da turma disciplina e o registro acadêmico inserido no item SaveRecordResult.

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 1

Nova versão 2

Chave

Consulta da nota de

etapa

Método SaveRecord

Inclusão da nota de etapa

Alteração da nota de

etapa

Método DeleteRecord

Exclusão de aluno