Histórico da Página
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, SaveRecord e DeleteRecord, é possível realizar busca, inclusão, manutenção e exclusão das informações de alunos no TOTVS Gestão Educacional.
Se necessário clique aqui para obter ajuda na configuração do Host.
| Expandir | ||||
|---|---|---|---|---|
| ||||
|
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.
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 e RA como informações da chave para busca do aluno.
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
<tot:ReadRecord>
<!--Optional:-->
<tot:DataServerName>EduAlunoData</tot:DataServerName>
<!--Optional:-->
<tot:PrimaryKey>1;EB-00384</tot:PrimaryKey>
<!--Optional:-->
<tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=2</tot:Contexto>
</tot:ReadRecord>
|
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
<ReadRecordResult><![CDATA[<EduAluno>
<SAluno>
<CODCOLIGADA>1</CODCOLIGADA>
<RA>EB-00384</RA>
<CODPESSOA>4105</CODPESSOA>
<CODTIPOCURSO>2</CODTIPOCURSO>
<CODIGO>4105</CODIGO>
<NOME>Yasmin Marcela Cavalcanti</NOME>
<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>]]></ReadRecordResult>
|
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
<ReadRecordResult><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 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 ReadView.
Deve ser passado um XML contendo os campos no filtro.
Para visualizar os nomes dos campos do aluno acesse: Cadastro do Aluno | Filtro.
Ao selecionar um novo filtro é possível visualizar os nomes dos campos do cadastro do aluno
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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 | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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.
O sistema irá realizar a inclusão de um aluno, caso o código informado 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.
- 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.
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.
O XML deve conter a tabela SALUNO com os campos CODCOLIGADA e RA como informações da chave para o cadastro de aluno 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 automaticamente, deve-se informar "0" para o registro, nesse caso o xml deve conter apenas um aluno.
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
<tot:SaveRecord>
<!--Optional:-->
<tot:DataServerName>EduAlunoData</tot:DataServerName>
<!--Optional:-->
<tot:XML><![CDATA[<EduAluno>
<SAluno>
<CODCOLIGADA>1</CODCOLIGADA>
<RA>0</RA>
<CODPESSOA>0</CODPESSOA>
<CODTIPOCURSO>2</CODTIPOCURSO>
<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>
<RECCREATEDBY>mestre</RECCREATEDBY>
<RECCREATEDON>2018-04-03T08:42:42</RECCREATEDON>
<RECMODIFIEDBY>mestre</RECMODIFIEDBY>
<RECMODIFIEDON>2018-04-03T08:42:42</RECMODIFIEDON>
</SAlunoCompl>
</EduAluno>]]></tot:XML>
<!--Optional:-->
<tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1</tot:Contexto>
</tot:SaveRecord>
|
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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.
Deve ser passado um XML contendo todos os campos que serão atualizados no cadastro de aluno.
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 | ||||||
|---|---|---|---|---|---|---|
| ||||||
<tot:SaveRecord>
<!--Optional:-->
<tot:DataServerName>EduAlunoData</tot:DataServerName>
<!--Optional:-->
<tot:XML><![CDATA[<EduAluno>
<SAluno>
<CODCOLIGADA>1</CODCOLIGADA>
<RA>0</RA>
<CODPESSOA>0</CODPESSOA>
<CODTIPOCURSO>2</CODTIPOCURSO>
<CODIGO>0</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>0</RA>
<RECCREATEDBY>mestre</RECCREATEDBY>
<RECCREATEDON>2018-04-03T08:42:42</RECCREATEDON>
<RECMODIFIEDBY>mestre</RECMODIFIEDBY>
<RECMODIFIEDON>2018-04-03T08:42:42</RECMODIFIEDON>
</SAlunoCompl>
</EduAluno>]]></tot:XML>
<!--Optional:-->
<tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1</tot:Contexto>
</tot:SaveRecord>
|
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
<SaveRecordResult>1;8001408</SaveRecordResult> |
| 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.
Deve ser passado um XML contendo todos os campos que fazem parte do registro de aluno.
O XML deve conter a tabela SALUNO com os campos CODCOLIGADA e RA como informações da chave para o cadastro de aluno e, também, os campos obrigatórios para seu cadastro.
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
<tot:DeleteRecord>
<!--Optional:-->
<tot:DataServerName>EduAlunoData</tot:DataServerName>
<!--Optional:-->
<tot:XML><![CDATA[<EduAluno>
<SAluno>
<CODCOLIGADA>1</CODCOLIGADA>
<RA>8001408</RA>
<CODPESSOA>45087</CODPESSOA>
<CODTIPOCURSO>2</CODTIPOCURSO>
<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>
<RECCREATEDBY>mestre</RECCREATEDBY>
<RECCREATEDON>2018-04-03T08:42:42</RECCREATEDON>
<RECMODIFIEDBY>mestre</RECMODIFIEDBY>
<RECMODIFIEDON>2018-04-03T08:42:42</RECMODIFIEDON>
</SAlunoCompl>
</EduAluno>]]></tot:XML>
<!--Optional:-->
<tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=3;CODSISTEMA=S;</tot:Contexto>
</tot:DeleteRecord>
|
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
<DeleteRecordResult>Exclusão de registro(s) realizado com sucesso</DeleteRecordResult> |
| Informações |
|---|
Para mais informações segue o link da documentação padrão de uso de DataServers utilizando WebService: |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas