Visão Geral dos processos WebSevices de Alunos

O objetivo deste DataServer é possibilitar a busca e exclusão de alunos através de WebService. Tudo o que for realizado, poderá ser visualizado no cadastro de avaliações descritivas no TOTVS Gestão Educacional.

Através do dataserver "EduExecAvalDescritivaData" e por meio dos métodos ReadRecord e DeleteRecord, é possível realizar busca e exclusão das informações de avaliações descritivas cadastradas 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 avaliação descritiva. Algumas informações são obrigatórias e devem ser informadas: o código da coligada, o id da turma disciplina, o código da etapa, o tipo da etapa, o código da prova, o id interno da prova e o código pessoa do aluno.

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

Consulta de aluno

Para realizar a consulta de uma avaliação descritiva, 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.

XML deve conter os campos CODCOLIGADA, IDTURMADISC, CODETAPA, TIPOETAPA, CODPROVA, ID e CODPESSOA como informações da chave para busca da avaliação.

Exemplo de XML para consulta de uma Avaliação Descritiva
		<tot:ReadRecord>
         <!--Optional:-->
         <tot:DataServerName>EduExecAvalDescritivaData</tot:DataServerName>
         <!--Optional:-->
         <tot:PrimaryKey>1;4632;1;N;1;23358;45871</tot:PrimaryKey>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1;CODSISTEMA=S</tot:Contexto>
      </tot:ReadRecord>
Exemplo do retorno de consulta de uma Avaliação Descritiva
<ReadRecordResult><![CDATA[<EduExecAvalDescritiva >
  <SEXECAVALDESCRITIVA>
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDTURMADISC>4632</IDTURMADISC>
    <CODETAPA>1</CODETAPA>
    <TIPOETAPA>N</TIPOETAPA>
    <CODPROVA>1</CODPROVA>
    <CODPROVATESTIS>AD</CODPROVATESTIS>
    <ID>23358</ID>
    <CODPESSOA>45871</CODPESSOA>
    <AVALIACAOEXECUTADA>S</AVALIACAOEXECUTADA>
  </SEXECAVALDESCRITIVA>
</EduExecAvalDescritiva>]]></ReadRecordResult>
Exemplo do retorno sem registros
<ReadRecordResult>&lt;EduExecAvalDescritivaData /></ReadRecordResult>

Método DeleteRecord

Este método realiza a exclusão de uma avaliação descritiva. Algumas informações são obrigatórias e devem ser informadas: o código da coligada, o id da turma disciplina, o código da etapa, o tipo da etapa, o código da prova, o id interno da prova e o código pessoa do aluno.

O sistema irá realizar a exclusão de uma avaliação caso encontre o registro.

Exclusão de aluno

Para realizar exclusão de uma avaliação, deve ser utilizada a operação de DeleteRecord.

Deve ser passado um XML contendo todos os campos que fazem parte do registro de avaliação descritiva.

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

Exemplo de XML para exclusão de uma Avaliação Descritiva
		<tot:DeleteRecord>
         <!--Optional:-->
         <tot:DataServerName>EduExecAvalDescritivaData</tot:DataServerName>
         <!--Optional:-->
         <tot:XML><![CDATA[<EduExecAvalDescritiva >
  <SEXECAVALDESCRITIVA>
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDTURMADISC>4632</IDTURMADISC>
    <CODETAPA>1</CODETAPA>
    <TIPOETAPA>N</TIPOETAPA>
    <CODPROVA>1</CODPROVA>
    <CODPROVATESTIS>AD</CODPROVATESTIS>
    <ID>23359</ID>
    <CODPESSOA>45871</CODPESSOA>
    <AVALIACAOEXECUTADA>S</AVALIACAOEXECUTADA>
  </SEXECAVALDESCRITIVA>
</EduExecAvalDescritiva>]]></tot:XML>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1;CODSISTEMA=S</tot:Contexto>
      </tot:DeleteRecord>
Exemplo do retorno de exclusão de uma Avaliação Descritiva
 <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