Histórico da Página
Visão Geral dos processos
...
WebServices de
...
Bolsas
O objetivo deste DataServer é possibilitar a busca, inclusão, alteração e exclusão de alunos bolsas através de WebService. Tudo o que for realizado, poderá ser visualizado no cadastro de alunos bolsas no TOTVS Gestão Educacional.
Através do dataserver "EduBolsaData" 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 bolsas no TOTVS Gestão Educacional.
...
Expandir | ||||
---|---|---|---|---|
| ||||
|
Método ReadRecord
Este método realiza a consulta de um alunouma bolsa. Algumas informações são obrigatórias e devem ser informadas: o código da coligada e o registro acadêmicocódigo da bolsa.
O sistema irá realizar a consulta de alunobolsa, caso as informações passadas estejam de acordo com algum aluno alguma bolsa já existente no sistema.
Consulta de
...
bolsa
Para realizar a consulta de um alunouma bolsa, deve ser utilizado a operação de ReadRecord.
...
O XML deve conter os campos CODCOLIGADA e RA como CODBOLSA como informações da chave para busca do alunoda bolsa.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
<tot:ReadRecord> <!--Optional:--> <tot:DataServerName>EduAlunoData<DataServerName>EduBolsaData</tot:DataServerName> <!--Optional:--> <tot:PrimaryKey>1;EB-00384<69</tot:PrimaryKey> <!--Optional:--> <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=2<1</tot:Contexto> </tot:ReadRecord> |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
<ReadRecordResult><![CDATA[<EduAluno> <SAluno> <CODCOLIGADA>1</CODCOLIGADA> <RA>EB-00384</RA><ReadRecordResult><![CDATA[<EduBolsa> <CODPESSOA>4105</CODPESSOA><SBolsa> <CODTIPOCURSO>2<<CODCOLIGADA>1</CODTIPOCURSO>CODCOLIGADA> <CODIGO>4105<<CODBOLSA>69</CODIGO>CODBOLSA> <NOME>Yasmin<NOME>Teste MarcelaAutomatizado Cavalcanti<T</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><VALOR>15.0000</VALOR> <ESTADOROW>0<<CODTIPOCURSO>1</ESTADOROW>CODTIPOCURSO> <ROWVALIDA>0<<VALIDADELIMITADA>1</ROWVALIDA>VALIDADELIMITADA> <ALUNO>1<<BOLSAFUNC>0</ALUNO>BOLSAFUNC> <PROFESSOR>0<<TIPOSAC>N</PROFESSOR>TIPOSAC> <CANDIDATO>0<<ATIVA>S</CANDIDATO>ATIVA> <USUARIOBIBLIOS>0<<TIPODESC>P</USUARIOBIBLIOS>TIPODESC> <FUNCIONARIO>0<<PERMITEALTERARVALOR>S</FUNCIONARIO>PERMITEALTERARVALOR> <EXFUNCIONARIO>0<<VERIFICAINADIMPLENCIA>S</EXFUNCIONARIO>VERIFICAINADIMPLENCIA> <FALECIDO>0<<CONTABCOMPETENCIA>S</FALECIDO>CONTABCOMPETENCIA> <CODSTATUS>-1<<ORDEMAPLICDESCANTECIPACAO>A</CODSTATUS>ORDEMAPLICDESCANTECIPACAO> <FIADOR_SGI>0</FIADOR_SGI><AFETABASECALCULO>N</AFETABASECALCULO> <CONJUGE_SGI>0</CONJUGE_SGI></SBolsa> <RECCREATEDBY>mestre</RECCREATEDBY><SBOLSACOMPL> <RECCREATEDON>2018-04-03T08:42:41</RECCREATEDON><CODCOLIGADA>1</CODCOLIGADA> <RECMODIFIEDBY>mestre<<CODBOLSA>69</RECMODIFIEDBY>CODBOLSA> <RECMODIFIEDON>2018-04-03T08:42:41</RECMODIFIEDON><TESTE>Teste</TESTE> <CODIGO1>4105<</CODIGO1>SBOLSACOMPL> </EduAluno>EduBolsa>]]></ReadRecordResult> |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
<ReadRecordResult><EduAlunoEduBolsa /></ReadRecordResult> |
Método SaveRecord
Este método realiza a inclusão ou alteração de um alunouma bolsa. Algumas informações são obrigatórias e devem ser informadas: o código da coligada e o registro acadêmicocódigo da bolsa, além dos outros campos que estão configurados como obrigatórios no sistema.
O sistema irá realizar a inclusão de um alunode uma bolsa, caso o código da bolsa informado não exista na baseno XML não exista no sistema. O valor do código da bolsa presente no XML serve apenas para identificar a bolsa dentro do próprio XML. O sistema irá criar um código para a bolsa inserida.
Se o Registro Acadêmico código da bolsa 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 à bolsa que se deseja alterar.
Inclusão de
...
bolsa
Para realizar inclusão de um alunouma bolsa, 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 alunoa bolsa.
Caso o Registro acadêmico Código da Bolsa informado não exista, será incluído um novo aluno. Caso contrário, o mesmo terá suas informações exista as informações serão atualizadas.
O XML deve conter a tabela SALUNO SBOLSA com os campos CODCOLIGADA e RA como CODBOLSA como informações da chave para o cadastro de aluno bolsa 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.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
<tot:SaveRecord> <!--Optional:--> <tot:DataServerName>EduAlunoData<DataServerName>EduBolsaData</tot:DataServerName> <!--Optional:--> <tot:XML><![CDATA[<EduAluno> <EduBolsa> <SBOLSA> <SAluno> <CODCOLIGADA>1</CODCOLIGADA> <RA>0< <CODBOLSA>68</RA>CODBOLSA> <CODPESSOA>0< <CODCFO></CODPESSOA>CODCFO> <CODTIPOCURSO>2</CODTIPOCURSO> <NOME>Teste Automatizado <CODIGO>0<T</CODIGO>NOME> <NOME>Stella Fernanda Aparício<<VALOR>15</NOME>VALOR> <CPF>62587463653<<CODTIPOCURSO>1</CPF>CODTIPOCURSO> <SOBRENOME>Aparício<<CODCOLCFO></SOBRENOME>CODCOLCFO> <APELIDO>Fernanda<<ORDEMPERDA></APELIDO>ORDEMPERDA> <DTNASCIMENTO>1994-06-10T00:00:00</DTNASCIMENTO> <RENOVACAOAUTOMATICA></RENOVACAOAUTOMATICA> <NACIONALIDADE>10<<VALIDADELIMITADA>1</NACIONALIDADE>VALIDADELIMITADA> <ESTADONATAL>MG< <FIES></ESTADONATAL>FIES> <NATURALIDADE>Belo Horizonte<<BOLSAFUNC>0</NATURALIDADE>BOLSAFUNC> <NIT>0< <TIPOSAC>N</NIT>TIPOSAC> <NROFILHOSBRASIL>0< <ATIVA>S</NROFILHOSBRASIL>ATIVA> <CONJUGEBRASIL>0< <TIPODESC>P</CONJUGEBRASIL>TIPODESC> <NATURALIZADO>0</NATURALIZADO> <FILHOSBRASIL>0<<PERMITEALTERARVALOR>S</FILHOSBRASIL>PERMITEALTERARVALOR> <INDATENDESPECIALIZADO>00</INDATENDESPECIALIZADO> <INDATENDESPECIFICO>00<<NOMERESPONSAVELBOLSACRED></INDATENDESPECIFICO>NOMERESPONSAVELBOLSACRED> <INDICADORDERECURSOS>00</INDICADORDERECURSOS> <CANHOTO>F<<CODCLASSIFICACAO></CANHOTO>CODCLASSIFICACAO> <INVESTTREINANT>0.00</INVESTTREINANT> <ESTADOROW>0<<VERIFICAINADIMPLENCIA>S</ESTADOROW>VERIFICAINADIMPLENCIA> <ROWVALIDA>0</ROWVALIDA> <ALUNO>1<<CONTABCOMPETENCIA>S</ALUNO>CONTABCOMPETENCIA> <PROFESSOR>0</PROFESSOR> <CANDIDATO>0<<APLICFORMULA></CANDIDATO>APLICFORMULA> <USUARIOBIBLIOS>0</USUARIOBIBLIOS> <FUNCIONARIO>0<<CODFORMULAPERCENTUAL></FUNCIONARIO>CODFORMULAPERCENTUAL> <EXFUNCIONARIO>0</EXFUNCIONARIO> <FALECIDO>0<<CODFORMULAVALOR></FALECIDO>CODFORMULAVALOR> <CODSTATUS>-1</CODSTATUS> <FIADOR_SGI>0</FIADOR_SGI> <CONJUGE_SGI>0</CONJUGE_SGI> <ORDEMAPLICDESCANTECIPACAO>A</ORDEMAPLICDESCANTECIPACAO> <RECCREATEDBY>mestre<<AFETABASECALCULO>N</RECCREATEDBY>AFETABASECALCULO> <RECCREATEDON>2018-04-03T08:42:41</RECCREATEDON> <RECMODIFIEDBY>mestre</RECMODIFIEDBY> </SBOLSA> <SBOLSACOMPL> <RECMODIFIEDON>2018-04-03T08:42:41</RECMODIFIEDON><CODCOLIGADA>1</CODCOLIGADA> <CODIGO1>4105</CODIGO1> <<CODBOLSA>68</SAluno>CODBOLSA> <SAlunoCompl> <CODCOLIGADA>1<<TESTE>Teste</CODCOLIGADA>TESTE> <RA>0</RA> </SBOLSACOMPL> </EduBolsa> <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<78</SaveRecordResult> |
Informações |
---|
Caso a inclusão seja realizada com sucesso, será mostrado o código da coligada e o registro acadêmico código da bolsa inserido no item SaveRecordResult. |
Alteração de
...
bolsa
Para realizar alteração de um alunouma bolsa, deve ser utilizado a operação de SaveRecord.
Deve ser passado um XML contendo todos os campos que serão atualizados no cadastro de alunobolsa.
O XML deve conter a tabela SALUNO SBOLSA com os campos CODCOLIGADA e RA CODBOLSA como informações da chave para a atualização do cadastro de alunobolsa.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
<tot:SaveRecord> <!--Optional:--> <tot:DataServerName>EduAlunoData<DataServerName>EduBolsaData</tot:DataServerName> <!--Optional:--> <tot:XML><![CDATA[<EduAluno> <EduBolsa> <SBOLSA> <SAluno> <CODCOLIGADA>1</CODCOLIGADA> <RA>0< <CODBOLSA>78</RA>CODBOLSA> <CODPESSOA>0< <CODCFO></CODPESSOA>CODCFO> <CODTIPOCURSO>2</CODTIPOCURSO> <NOME>Teste <CODIGO>0<Automatizado</CODIGO>NOME> <NOME>Stella Fernanda Aparício<<VALOR>20</NOME>VALOR> <CPF>62587463653<<CODTIPOCURSO>1</CPF>CODTIPOCURSO> <SOBRENOME>Aparício<<CODCOLCFO></SOBRENOME>CODCOLCFO> <APELIDO>Fernanda<<ORDEMPERDA></APELIDO>ORDEMPERDA> <DTNASCIMENTO>1994-06-12T00:00:00</DTNASCIMENTO> <RENOVACAOAUTOMATICA></RENOVACAOAUTOMATICA> <NACIONALIDADE>10< <VALIDADELIMITADA>1</NACIONALIDADE>VALIDADELIMITADA> <ESTADONATAL>MG< <FIES></ESTADONATAL>FIES> <NATURALIDADE>Belo Horizonte<<BOLSAFUNC>0</NATURALIDADE>BOLSAFUNC> <NIT>0< <TIPOSAC>N</NIT>TIPOSAC> <NROFILHOSBRASIL>0< <ATIVA>S</NROFILHOSBRASIL>ATIVA> <CONJUGEBRASIL>0< <TIPODESC>P</CONJUGEBRASIL>TIPODESC> <NATURALIZADO>0</NATURALIZADO> <FILHOSBRASIL>0<<PERMITEALTERARVALOR>S</FILHOSBRASIL>PERMITEALTERARVALOR> <INDATENDESPECIALIZADO>00</INDATENDESPECIALIZADO> <INDATENDESPECIFICO>00<<NOMERESPONSAVELBOLSACRED></INDATENDESPECIFICO>NOMERESPONSAVELBOLSACRED> <INDICADORDERECURSOS>00</INDICADORDERECURSOS> <CANHOTO>F<<CODCLASSIFICACAO></CANHOTO>CODCLASSIFICACAO> <INVESTTREINANT>0.00</INVESTTREINANT> <ESTADOROW>0<<VERIFICAINADIMPLENCIA>S</ESTADOROW>VERIFICAINADIMPLENCIA> <ROWVALIDA>0</ROWVALIDA> <ALUNO>1<<CONTABCOMPETENCIA>S</ALUNO>CONTABCOMPETENCIA> <PROFESSOR>0</PROFESSOR> <CANDIDATO>0<<APLICFORMULA></CANDIDATO>APLICFORMULA> <USUARIOBIBLIOS>0</USUARIOBIBLIOS> <FUNCIONARIO>0<<CODFORMULAPERCENTUAL></FUNCIONARIO>CODFORMULAPERCENTUAL> <EXFUNCIONARIO>0</EXFUNCIONARIO> <FALECIDO>0<<CODFORMULAVALOR></FALECIDO>CODFORMULAVALOR> <CODSTATUS>-1</CODSTATUS> <FIADOR_SGI>0</FIADOR_SGI><ORDEMAPLICDESCANTECIPACAO>A</ORDEMAPLICDESCANTECIPACAO> <CONJUGE_SGI>0</CONJUGE_SGI> <RECCREATEDBY>mestre<<AFETABASECALCULO>N</RECCREATEDBY>AFETABASECALCULO> <RECCREATEDON>2018-04-03T08:42:41</RECCREATEDON> <RECMODIFIEDBY>mestre</RECMODIFIEDBY> </SBOLSA> <SBOLSACOMPL> <RECMODIFIEDON>2018-04-03T08:42:41</RECMODIFIEDON><CODCOLIGADA>1</CODCOLIGADA> <CODIGO1>4105</CODIGO1> <<CODBOLSA>78</SAluno>CODBOLSA> <SAlunoCompl> <CODCOLIGADA>1<<TESTE>Teste</CODCOLIGADA>TESTE> <RA>0</RA> </SBOLSACOMPL> </EduBolsa> <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<78</SaveRecordResult> |
Informações |
---|
Caso a alteração seja realizada com sucesso, será mostrado o código da coligada e o registro acadêmico código da bolsa no item SaveRecordResult. |
Método DeleteRecord
Este método realiza a exclusão de um alunouma bolsa. Algumas informações são obrigatórias e devem ser informadas: o código da coligada e o registro acadêmicocódigo da bolsa, além dos outros campos que estão configurados como obrigatórios no sistema.
O sistema irá realizar a exclusão de um aluno de uma bolsa caso encontre o registro.
Exclusão de
...
bolsa
Para realizar exclusão de um alunouma bolsa, deve ser utilizado a operação de DeleteRecord.
Deve ser passado um XML contendo todos os campos que fazem parte do registro de alunobolsa.
O XML deve conter a tabela SALUNO SBOLSA com os campos CODCOLIGADA e RA como CODBOLSA como informações da chave para o cadastro de aluno bolsa e, também, os campos obrigatórios para seu cadastro.
...
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
<tot:DeleteRecord> <!--Optional:--> <tot:DataServerName>EduAlunoData<DataServerName>EduBolsaData</tot:DataServerName> <!--Optional:--> <tot:XML><XML> <![CDATA[<EduAluno><EduBolsa> <SBOLSA> <SAluno> <CODCOLIGADA>1</CODCOLIGADA> <RA>8001408<<CODBOLSA>78</RA>CODBOLSA> <CODPESSOA>45087<<CODCFO></CODPESSOA>CODCFO> <CODTIPOCURSO>2</CODTIPOCURSO> <NOME>Teste Automatizado <CODIGO>45087<T</CODIGO>NOME> <NOME>Stella Fernanda Aparício<<VALOR>15</NOME>VALOR> <CPF>62587463653<<CODTIPOCURSO>1</CPF>CODTIPOCURSO> <SOBRENOME>Aparício<<CODCOLCFO></SOBRENOME>CODCOLCFO> <APELIDO>Fernanda</APELIDO> <DTNASCIMENTO>1994-06-12T00:00:00</DTNASCIMENTO> <NACIONALIDADE>10</NACIONALIDADE> <ORDEMPERDA></ORDEMPERDA> <ESTADONATAL>MG<<RENOVACAOAUTOMATICA></ESTADONATAL>RENOVACAOAUTOMATICA> <NATURALIDADE>Belo Horizonte<<VALIDADELIMITADA>1</NATURALIDADE>VALIDADELIMITADA> <NIT>0</NIT> <NROFILHOSBRASIL>0<<FIES></NROFILHOSBRASIL>FIES> <CONJUGEBRASIL>0</CONJUGEBRASIL> <NATURALIZADO>0<<BOLSAFUNC>0</NATURALIZADO>BOLSAFUNC> <FILHOSBRASIL>0</FILHOSBRASIL> <INDATENDESPECIALIZADO>00<<TIPOSAC>N</INDATENDESPECIALIZADO>TIPOSAC> <INDATENDESPECIFICO>00</INDATENDESPECIFICO> <INDICADORDERECURSOS>00<<ATIVA>S</INDICADORDERECURSOS>ATIVA> <CANHOTO>F</CANHOTO> <INVESTTREINANT>0.00</INVESTTREINANT><TIPODESC>P</TIPODESC> <ESTADOROW>0</ESTADOROW> <ROWVALIDA>0<<PERMITEALTERARVALOR>S</ROWVALIDA>PERMITEALTERARVALOR> <ALUNO>1</ALUNO> <PROFESSOR>0<<NOMERESPONSAVELBOLSACRED></PROFESSOR>NOMERESPONSAVELBOLSACRED> <CANDIDATO>0</CANDIDATO> <USUARIOBIBLIOS>0<<CODCLASSIFICACAO></USUARIOBIBLIOS>CODCLASSIFICACAO> <FUNCIONARIO>0</FUNCIONARIO> <EXFUNCIONARIO>0<<VERIFICAINADIMPLENCIA>S</EXFUNCIONARIO>VERIFICAINADIMPLENCIA> <FALECIDO>0</FALECIDO> <CODSTATUS>-1</CODSTATUS> <FIADOR_SGI>0</FIADOR_SGI> <CONTABCOMPETENCIA>S</CONTABCOMPETENCIA> <CONJUGE_SGI>0</CONJUGE_SGI> <RECCREATEDBY>mestre</RECCREATEDBY> <APLICFORMULA></APLICFORMULA> <RECCREATEDON>2018-04-03T08:42:41</RECCREATEDON><CODFORMULAPERCENTUAL></CODFORMULAPERCENTUAL> <RECMODIFIEDBY>mestre</RECMODIFIEDBY> <RECMODIFIEDON>2018-04-03T08:42:41</RECMODIFIEDON><CODFORMULAVALOR></CODFORMULAVALOR> <CODIGO1>4105</CODIGO1> <<ORDEMAPLICDESCANTECIPACAO>A</SAluno>ORDEMAPLICDESCANTECIPACAO> <SAlunoCompl> <CODCOLIGADA>1<<AFETABASECALCULO>N</CODCOLIGADA>AFETABASECALCULO> <RA>8001408</RA> </SBOLSA> </EduBolsa>]]> <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;<1</tot:Contexto> </tot:DeleteRecord> |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
<DeleteRecordResult>Exclusão de registro(s) realizado com sucesso</DeleteRecordResult> |
...