Linha RM

Atalhos

Páginas filhas
  • EduNotasData

Visão Geral dos processos WebSevices de Notas de Avaliação

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

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


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


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 de Avaliação ou Matrícula e Avaliação | Notas de Avaliação.

Método ReadRecord

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

O sistema irá realizar a consulta da nota de avaliação, caso as informações passadas estejam de acordo com alguma nota de avaliação já existente no sistema.

Consulta da nota de avaliação

Para realizar a consulta de uma nota de avaliação, 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, CODPROVA, CODETAPA, TIPOETAPA, IDTURMADISC e  RA como informações da chave para busca da nota de avaliação.

Exemplo de XML para consulta de uma nota de avaliação 
	<tot:ReadRecord>
         <!--Optional:-->
         <tot:DataServerName>EduNotasData</tot:DataServerName>
         <!--Optional:-->
         <tot:PrimaryKey>1;1;1;N;4390;MFA2018</tot:PrimaryKey>
         <!--Optional:-->
         <tot:Contexto>CODSISTEMA=S;CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1</tot:Contexto>
      </tot:ReadRecord>
Exemplo do retorno de consulta da nota de avaliação 
<ReadRecordResult><![CDATA[<EduNotas>
  <SNotas>
    <CODCOLIGADA>1</CODCOLIGADA>
    <CODPROVA>1</CODPROVA>
    <CODETAPA>1</CODETAPA>
    <TIPOETAPA>N</TIPOETAPA>
    <IDTURMADISC>4390</IDTURMADISC>
    <RA>MFA2018</RA>
    <NOTA>50</NOTA>
    <NUMACERTOS>0</NUMACERTOS>
    <NUMDIARIO>2</NUMDIARIO>
    <MEDIA>70</MEDIA>
    <VALOR>100</VALOR>
    <DESCPROVA>Avaliação</DESCPROVA>
    <DISPONIVELALUNOS>N</DISPONIVELALUNOS>
    <NOME>Márcia Francisca Alves</NOME>
    <NOMECIVIL>Márcia Francisca Alves</NOMECIVIL>
    <RANOTAS>MFA2018</RANOTAS>
    <NOTAETAPA>80</NOTAETAPA>
    <IDGRUPONOTAS>0</IDGRUPONOTAS>
    <NOTASFALTASWEB>S</NOTASFALTASWEB>
    <DIBLOQNOTAFALTA>N</DIBLOQNOTAFALTA>
    <DESCRICAO>Matriculado</DESCRICAO>
    <MEDIAETAPA>70</MEDIAETAPA>
    <DTINICIODIGITACAO>2018-01-01T00:00:00</DTINICIODIGITACAO>
    <DTLIMITEDIGITACAO>2018-12-31T00:00:00</DTLIMITEDIGITACAO>
    <DATAATUAL>2018-05-14T13:44:35</DATAATUAL>
    <CODPESSOA>45627</CODPESSOA>
    <IDHABILITACAOFILIAL>406</IDHABILITACAOFILIAL>
    <_x0031__x0020_-_x0020_Notas>80</_x0031__x0020_-_x0020_Notas>
    <TotalNotas>80</TotalNotas>
    <TotalFaltas>0</TotalFaltas>
  </SNotas>
</EduNotas>]]></ReadRecordResult>
Exemplo do retorno sem registros 
<ReadRecordResult>&lt;EduNotas /></ReadRecordResult>

Método SaveRecord

Este método realiza a inclusão ou alteração de uma nota de avaliação. Algumas informações são obrigatórias e devem ser informadas: o código da coligada, o código da prova, o código da etapa, o tipo da etapa, o id turma disciplina 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 uma nota de avaliação, caso as informações passadas não exista na base.

Se 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 avaliação

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

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 SNOTAS com os campos CODCOLIGADA, CODPROVA, CODETAPA, TIPOETAPA, IDTURMADISC e  RA como informações da chave para o cadastro da nota de avaliação, também, os campos obrigatórios para seu cadastro.

Exemplo de XML para inclusão de uma nota de avaliação 
<tot:SaveRecord>
         <!--Optional:-->
         <tot:DataServerName>EduNotasData</tot:DataServerName>
         <!--Optional:-->
         <tot:XML><![CDATA[<EduNotas>
  <SNotas>
    <CODCOLIGADA>1</CODCOLIGADA>
    <CODPROVA>1</CODPROVA>
    <CODETAPA>1</CODETAPA>
    <TIPOETAPA>N</TIPOETAPA>
    <IDTURMADISC>4390</IDTURMADISC>
    <RA>MFA2018</RA>
    <NOTA>50</NOTA>
    <NUMACERTOS>0</NUMACERTOS>
    <NUMDIARIO>2</NUMDIARIO>
    <MEDIA>70</MEDIA>
    <VALOR>100</VALOR>
    <DESCPROVA>Avaliação</DESCPROVA>
    <DISPONIVELALUNOS>N</DISPONIVELALUNOS>
    <NOME>Márcia Francisca Alves</NOME>
    <NOMECIVIL>Márcia Francisca Alves</NOMECIVIL>
    <RANOTAS>MFA2018</RANOTAS>
    <NOTAETAPA>80</NOTAETAPA>
    <IDGRUPONOTAS>0</IDGRUPONOTAS>
    <NOTASFALTASWEB>S</NOTASFALTASWEB>
    <DIBLOQNOTAFALTA>N</DIBLOQNOTAFALTA>
    <DESCRICAO>Matriculado</DESCRICAO>
    <MEDIAETAPA>70</MEDIAETAPA>
    <DTINICIODIGITACAO>2018-01-01T00:00:00</DTINICIODIGITACAO>
    <DTLIMITEDIGITACAO>2018-12-31T00:00:00</DTLIMITEDIGITACAO>
    <DATAATUAL>2018-05-14T13:44:35</DATAATUAL>
    <CODPESSOA>45627</CODPESSOA>
    <IDHABILITACAOFILIAL>406</IDHABILITACAOFILIAL>
    <_x0031__x0020_-_x0020_Notas>80</_x0031__x0020_-_x0020_Notas>
    <TotalNotas>80</TotalNotas>
    <TotalFaltas>0</TotalFaltas>
  </SNotas>
</EduNotas>]]></tot:XML>
         <!--Optional:-->
         <tot:Contexto>CODSISTEMA=S;CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1</tot:Contexto>
      </tot:SaveRecord>
Exemplo do retorno da inclusão da nota de avaliação 
<SaveRecordResult>1;1;1;N;4390;MFA2018</SaveRecordResult>


Caso a inclusão seja realizada com sucesso, será mostrado o código da coligada, código da avaliação, 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 avaliação

Para realizar alteração de uma nota de avaliação, 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 avaliação.

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

Exemplo de XML para alteração de informações da nota de avaliação 
<tot:SaveRecord>
         <!--Optional:-->
         <tot:DataServerName>EduNotasData</tot:DataServerName>
         <!--Optional:-->
         <tot:XML><![CDATA[<EduNotas>
  <SNotas>
    <CODCOLIGADA>1</CODCOLIGADA>
    <CODPROVA>1</CODPROVA>
    <CODETAPA>1</CODETAPA>
    <TIPOETAPA>N</TIPOETAPA>
    <IDTURMADISC>4390</IDTURMADISC>
    <RA>MFA2018</RA>
    <NOTA>50</NOTA>
    <NUMACERTOS>0</NUMACERTOS>
    <NUMDIARIO>2</NUMDIARIO>
    <MEDIA>70</MEDIA>
    <VALOR>100</VALOR>
    <DESCPROVA>Avaliação</DESCPROVA>
    <DISPONIVELALUNOS>N</DISPONIVELALUNOS>
    <NOME>Márcia Francisca Alves</NOME>
    <NOMECIVIL>Márcia Francisca Alves</NOMECIVIL>
    <RANOTAS>MFA2018</RANOTAS>
    <NOTAETAPA>80</NOTAETAPA>
    <IDGRUPONOTAS>0</IDGRUPONOTAS>
    <NOTASFALTASWEB>S</NOTASFALTASWEB>
    <DIBLOQNOTAFALTA>N</DIBLOQNOTAFALTA>
    <DESCRICAO>Matriculado</DESCRICAO>
    <MEDIAETAPA>70</MEDIAETAPA>
    <DTINICIODIGITACAO>2018-01-01T00:00:00</DTINICIODIGITACAO>
    <DTLIMITEDIGITACAO>2018-12-31T00:00:00</DTLIMITEDIGITACAO>
    <DATAATUAL>2018-05-14T13:44:35</DATAATUAL>
    <CODPESSOA>45627</CODPESSOA>
    <IDHABILITACAOFILIAL>406</IDHABILITACAOFILIAL>
    <_x0031__x0020_-_x0020_Notas>80</_x0031__x0020_-_x0020_Notas>
    <TotalNotas>80</TotalNotas>
    <TotalFaltas>0</TotalFaltas>
  </SNotas>
</EduNotas>]]></tot:XML>
         <!--Optional:-->
         <tot:Contexto>CODSISTEMA=S;CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1</tot:Contexto>
      </tot:SaveRecord>
Exemplo do retorno da alteração do cadastro da nota de avaliação 
<SaveRecordResult>1;1;1;N;4390;MFA2018</SaveRecordResult>

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