Versões comparadas

Chave

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

Visão Geral dos processos WebSevices de Alunos

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

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

...

Expandir
titleÍndice

Índice
minLevel2

Método ReadRecord

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

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

Consulta de aluno

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

...

Bloco de código
languagexml
titleExemplo do retorno sem registros
collapsetrue
<ReadRecordResult>&lt;EduAluno /></ReadRecordResult>

Método ReadView

Este método realiza a consulta de um aluno. Algumas informações são obrigatórias e devem ser informadas:como o contexto e o filtro.O sistema irá realizar a consulta de aluno, caso retorna os dados de um ou mais alunos de acordo com o filtro informado no XML. Entretanto, somente irá retornar se as informações passadas estejam de acordo com algum aluno já existente no sistema.

Consulta de aluno

Para realizar a esta consulta de um aluno, deve ser utilizado a operação de ReadView.

Deve ser passado um XML contendo os campos no filtro.

Para , sendo necessário informar o DataServerName, Filtro e o Contexto. Para visualizar os nomes dos campos para a montagem do filtro do aluno, acesse: Cadastro do Aluno | Filtro, selecione para criar um novo. Ao selecionar um novo filtro é possível visualizar Ao passar o mouse em cima dos itens, serão exibidos os nomes dos campos do cadastro do alunoImage Removed, tais poderão ser utilizados na montagem do filtro no XML. Exemplo de como obter o nome do campo.

Bloco de código
languagexml
titleExemplo de XML para consulta de um Aluno
collapsetrue
      <tot:ReadView>
         <!--Optional:-->
         <tot:DataServerName>EduAlunoData</tot:DataServerName>
         <!--Optional:-->
         <tot:Filtro>PPESSOA.CPF = '80466346549' AND PPESSOA.NOME = 'ACIDALIA VIEIRA SANTOS'</tot:Filtro>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1;CODSISTEMA=S</tot:Contexto>
      </tot:ReadView>

Bloco de código
languagexml
titleExemplo do retorno de consulta de Aluno
collapsetrue
  <ReadViewResult><![CDATA[<NewDataSet>
  <SAluno>
    <CODIGO>2627</CODIGO>
    <CODCOLIGADA>1</CODCOLIGADA>
    <CODTIPOCURSO>1</CODTIPOCURSO>
    <RA>0000160</RA>
    <CODPESSOA>2627</CODPESSOA>
    <NOME>ACIDALIA VIEIRA SANTOS</NOME>
    <SEXO>F</SEXO>
    <RESPFINANCEIRO>ACIDALIA CARINE VIEIRA SANTOS</RESPFINANCEIRO>
    <NOMEPAI>ANISIO HILARIO DOS SANTOS FILH</NOMEPAI>
    <NOMEMAE>ROSE MARIA VIEIRA SANTOS</NOMEMAE>
    <CPF>80466346549</CPF>
    <CARTIDENTIDADE>06693288 20</CARTIDENTIDADE>
    <DTNASCIMENTO>1981-03-05T00:00:00</DTNASCIMENTO>
    <NATURALIDADE>BELO HORIZONTE</NATURALIDADE>
    <SOBRENOME>SANTOS</SOBRENOME>
    <ESTADOCIVIL>S</ESTADOCIVIL>
    <ESTADONATAL>MG</ESTADONATAL>
    <RUA>RUA CONDE DE PORTO ALEGRE 270</RUA>
    <BAIRRO>IAPI</BAIRRO>
    <CIDADE>BELO HORIZONTE</CIDADE>
    <ESTADO>MG</ESTADO>
    <CEP>40330200</CEP>
    <INDATENDESPECIALIZADO>00</INDATENDESPECIALIZADO>
    <INDATENDESPECIFICO>00</INDATENDESPECIFICO>
    <INDICADORDERECURSOS>00</INDICADORDERECURSOS>
    <NACIONALIDADE>50</NACIONALIDADE>
  </SAluno>
</NewDataSet>]]></ReadViewResult>


Método SaveRecord

Este método realiza a inclusão ou alteraçã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.

...

  1. 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.
  2. Para a tabela <SAluno> deve-se informar as tags <CODIGO></CODIGO> e <CODPESSOA></CODPESSOA> com os mesmos valores.

Inclusão de aluno

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

...

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.

...

Informações

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

...