Linha RM

Atalhos

Páginas filhas
  • EduAlunoEtapaData

Versões comparadas

Versão antiga 1

changes.mady.by.user Guilherme Luiz Senra Ribeiro Campolina

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Allysson Mezencio Dos Santos

Gravado em

Chave

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

Visão Geral dos processos WebSevices de

...

Nota/Falta de Etapa

O objetivo deste DataServer é possibilitar a busca, inclusão , alteração e exclusão de alunos e alteração de notas/faltas de 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/faltas de etapa no TOTVS Gestão Educacional.

...

Expandir
titleÍndice

Índice
minLevel2

Caso o usuário informado na autenticação, não possua permissão ao menu, o processo não poderá ser executado.

O caminho da permissão, para que o usuário realize o processo, é: Matrícula e Avaliação | Mais | Digitação por Aluno | Notas e Faltas de Etapa ou Matrícula e Avaliação | Notas e Faltas de Etapa.

Método ReadRecord

Este método realiza a consulta de um alunouma nota/falta 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/falta de etapa já existente no sistema.

Consulta da nota/falta de

...

etapa

Para realizar a consulta de um alunouma nota/falta de etapa, 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/falta de etapa.

Para realizar a consulta de uma falta, deve-se informar o TIPOETAPA como "F".

Bloco de código
languagexml
titleExemplo de XML para consulta de um Alunouma nota/falta de etapa
collapsetrue
		<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
languagexml
titleExemplo do retorno de consulta da nota/falta de Alunoetapa
collapsetrue
<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
languagexml
titleExemplo do retorno sem registros
collapsetrue
<ReadRecordResult>&lt;EduAlunoEduNotaEtapa /></ReadRecordResult>

Método SaveRecord

Este método realiza a inclusão ou alteração de um alunode uma nota/falta 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, além dos outros campos que estão configurados como obrigatórios no sistema.

O sistema irá realizar a inclusão de um aluno, caso o código informado de uma nota/falta de etapa, caso 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.

Inclusão de aluno

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/falta de etapa

Para realizar inclusão de uma nota/falta de etapaPara realizar inclusão de um aluno, 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/falta 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 de aluno eda nota/falta de etapa 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 automaticamentePara realizar a inclusão de uma falta, deve-se informar o TIPOETAPA como "0F" para o registro.

Bloco de código
languagexml
titleExemplo de XML para inclusão de um Alunouma nota/falta de etapa
collapsetrue
<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</RECCREATEDBY>
    <RECCREATEDON>2018-04-03T08:42:42</RECCREATEDON>
    <RECMODIFIEDBY>mestre</RECMODIFIEDBY>
    <RECMODIFIEDON>2018-04-03T08:42:42</RECMODIFIEDON>
  </SAlunoCompl>
</EduAluno><NOTAFALTA>80</NOTAFALTA>
  </SNotaEtapa>
</EduNotaEtapa>]]></tot:XML>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;,CODFILIAL=1;,CODTIPOCURSO=1,CODSISTEMA=1<S</tot:Contexto>
      </tot:SaveRecord>
Bloco de código
languagexml
titleExemplo do retorno da inclusão de Aluno
collapsetrue
<SaveRecordResult>1;8001408</SaveRecordResult>
Informações

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

Alteração de aluno

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

...

XML

...

O XML deve conter a tabela SALUNO com os campos CODCOLIGADA e RA como informações da chave para a atualização do cadastro de aluno.

Bloco de código
languagexml
titleExemplo de XML para alteração de informações de Alunopara inclusão de uma nota/falta de etapa (turma mista)
collapsetrue
<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<<IDTURMADISCORIGEM>3970</CODIGO>IDTURMADISCORIGEM>
    <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>80</NOTAFALTA>
  </SNotaEtapa>
</EduNotaEtapa>]]></tot:XML>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;,CODFILIAL=1;,CODTIPOCURSO=1,CODSISTEMA=1<S</tot:Contexto>
      </tot:SaveRecord>

Observação: O campo IDTURMADISCORIGEM deve estar preenchido com o identificador da turma mista.
Bloco de código
languagexml
titleExemplo do retorno da alteração do cadastro de Alunoda inclusão da nota/falta de etapa
collapsetrue
<SaveRecordResult>1;8001408<;1;N;4390;MFA2018</SaveRecordResult>


Informações

Caso a alteração 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.

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

Alteração da nota/falta de etapa

Para realizar alteração de uma nota/falta de etapaPara realizar exclusão de um aluno, deve ser utilizado a operação de DeleteRecordSaveRecord.

Deve ser passado um XML contendo todos os campos que fazem parte do registro de alunoserão atualizados no cadastro da nota/falta de etapa.

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

Para realizar a alteração de uma falta, deve-se informar o TIPOETAPA como "F".

Bloco de código
languagexml
titleExemplo de XML para exclusão de um Alunoalteração de informações da nota/falta de etapa
collapsetrue
		<tot:DeleteRecord>SaveRecord>
         <!--Optional:-->
         <tot:DataServerName>EduAlunoData<DataServerName>EduAlunoEtapaData</tot:DataServerName>
         <!--Optional:-->
         <tot:XML><![CDATA[<EduAluno><EduNotaEtapa>
  <SAluno><SNotaEtapa>
    <CODCOLIGADA>1</CODCOLIGADA>
    <RA>8001408<<CODETAPA>1</RA>CODETAPA>
    <CODPESSOA>45087<<TIPOETAPA>N</CODPESSOA>TIPOETAPA>
    <CODTIPOCURSO>2<<IDTURMADISC>4390</CODTIPOCURSO>IDTURMADISC>
    <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>MFA2018</RA>
    <RECCREATEDBY>mestre</RECCREATEDBY>
    <RECCREATEDON>2018-04-03T08:42:42</RECCREATEDON>
    <RECMODIFIEDBY>mestre</RECMODIFIEDBY>
    <RECMODIFIEDON>2018-04-03T08:42:42</RECMODIFIEDON><NOTAFALTA>70</NOTAFALTA>
  </SAlunoCompl>SNotaEtapa>
</EduAluno>EduNotaEtapa>]]></tot:XML>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=3;CODSISTEMA=S;<1</tot:Contexto>
      </tot:DeleteRecord>SaveRecord>
Bloco de código
languagexml
titleExemplo do retorno de exclusão de Alunoda alteração do cadastro da nota/falta de etapa
collapsetrue
 <DeleteRecordResult>Exclusão de registro(s) realizado com sucesso</DeleteRecordResult>
<SaveRecordResult>1;8001408</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.

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