Visão Geral dos processos WebServices dos Documentos do Aluno

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

...

Método ReadRecord

Este método realiza a consulta de um documento do aluno. Algumas informações são obrigatórias e devem ser informadas: o código da coligada, identificador do período letivo, registro acadêmico do aluno e o código do documento.

O sistema irá realizar a consulta do documento do aluno, caso as informações passadas estejam de acordo com algum documento do aluno já existente no sistema.

Consulta do documento do aluno

Para realizar a consulta de um documento do aluno, deve ser utilizado a operação de ReadRecord.

...

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 IDDOCFIADOR como informações da chave para busca do documento do fiador.

      <tot:ReadRecord>
         <!--Optional:-->
         <tot:DataServerName>EduDocAlunoData</tot:DataServerName>
         <!--Optional:-->
         <tot:PrimaryKey>1;36;ES-00223;5</tot:PrimaryKey>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1;CODSISTEMA=S</tot:Contexto>
      </tot:ReadRecord>

...

<ReadRecordResult><EduDOCALUNO /></ReadRecordResult>

Método ReadView

Este método realiza a consulta de um aluno para retornar todos os seus documentos. Nesse caso as informações para filtrar de um aluno específico são: o código da coligada e o registro acadêmico do aluno.

O sistema irá realizar a consulta dos documentos do aluno, caso as informações passadas estejam de acordo com algum documento do aluno já existente no sistema.

Consulta os documentos do aluno

Para realizar a consulta os documentos do aluno, deve ser utilizado a operação de ReadView.

...

<ReadViewResult><![CDATA[<NewDataSet>
  <SDOCALUNO>
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDPERLET>36</IDPERLET>
    <CODPERLET>2025/1</CODPERLET>
    <RA>ES-00223</RA>
    <NOME>FABIANA VITÓRIA ALVES</NOME>
    <CODDOCUMENTO>5</CODDOCUMENTO>
    <DESCRICAO>Documento de Identidade</DESCRICAO>
    <DTPREVISTA>2025-12-02T00:00:00</DTPREVISTA>
    <STATUS>1</STATUS>
    <CODUSUARIO>mestre</CODUSUARIO>
    <VALIDADOIA>N</VALIDADOIA>
    <NECESSARIOREVISAOHUMANA>N</NECESSARIOREVISAOHUMANA>
  </SDOCALUNO>
</NewDataSet>]]></ReadViewResult>

Método SaveRecord

Este método realiza a inclusão ou alteração de um documento do aluno. 

...

• No campo Status só pode receber um dos valores 0 - Não Entregue, 1 - Entregue Em Validação, 2 - Recusado, e 3 - Validado
• No campo Arquivo deverá ser informado o arquivo do documento do fiador aluno no formato base64.

Inclusão do documento do aluno

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

...

Alteração de documento do aluno

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

...

Método DeleteRecord

Este método realiza a exclusão de um documento do aluno caso encontre o registro.

Exclusão de documento do aluno

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

...