Versões comparadas

Chave

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

...

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

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

Consulta de

...

parcela

Deve ser passado um XML contendo todos os campos de chave primária.

...

XML deve conter os campos CODCOLIGADA e RAIDPARCELA como informações da chave para busca do aluno.

...

Bloco de código
languagexml
titleExemplo de XML para consulta de um Alunouma parcela
linenumberstrue
collapsetrue
		<tot:ReadRecord>
         <!--Optional:-->
         <tot:DataServerName>EduAlunoData<DataServerName>EduParcelaData</tot:DataServerName>
         <!--Optional:-->
         <tot:PrimaryKey>1;EB-00384<49711</tot:PrimaryKey>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=2</tot:Contexto>
      </tot:ReadRecord>
Bloco de código
languagexml
titleExemplo do retorno de consulta de AlunoParcela
collapsetrue
<ReadRecordResult><![CDATA[<EduAluno><EduParcela >
  <SAluno><SParcela>
    <CODCOLIGADA>1</CODCOLIGADA>
    <RA>EB-00384<<IDPARCELA>49711</RA>IDPARCELA>
    <CODPESSOA>4105<<RA>JR01</CODPESSOA>RA>
    <CODTIPOCURSO>2<<CODCONTRATO>3651</CODTIPOCURSO>CODCONTRATO>
    <CODIGO>4105<<IDPERLET>86</CODIGO>IDPERLET>
    <NOME>Yasmin Marcela Cavalcanti</NOME><CODSERVICO>1</CODSERVICO>
    <CPF>38252307671<<PARCELA>8</CPF>PARCELA>
    <SOBRENOME>Cavalcanti<<COTA>1</SOBRENOME>COTA>
    <APELIDO>Yasmin<<VALOR>225.0000</APELIDO>VALOR>
    <DTNASCIMENTO>1994<DTVENCIMENTO>2018-0605-10T00:00:00</DTNASCIMENTO>DTVENCIMENTO>
    <NACIONALIDADE>10<<TIPODESC>P</NACIONALIDADE>TIPODESC>
    <ESTADONATAL>MG<<TIPOPARCELA>P</ESTADONATAL>TIPOPARCELA>
    <NATURALIDADE>Belo Horizonte<<VALORAUTOMATICO>N</NATURALIDADE>VALORAUTOMATICO>
    <NIT>0<<ORIGEM>MN</NIT>ORIGEM>
    <NROFILHOSBRASIL>0<<RECCREATEDBY>mestre</NROFILHOSBRASIL>RECCREATEDBY>
    <CONJUGEBRASIL>0</CONJUGEBRASIL><RECCREATEDON>2018-07-12T14:30:43</RECCREATEDON>
    <NATURALIZADO>0<<RECMODIFIEDBY>mestre</NATURALIZADO>RECMODIFIEDBY>
    <FILHOSBRASIL>0</FILHOSBRASIL><RECMODIFIEDON>2018-07-12T14:30:43</RECMODIFIEDON>
    <INDATENDESPECIALIZADO>00<</INDATENDESPECIALIZADO>SParcela>
    <INDATENDESPECIFICO>00</INDATENDESPECIFICO><SResponsavel>
    <INDICADORDERECURSOS>00<<CODCOLIGADA>1</INDICADORDERECURSOS>CODCOLIGADA>
    <CANHOTO>F<<IDPARCELA>49711</CANHOTO>IDPARCELA>
    <INVESTTREINANT>0.00<<CODCOLCFO>1</INVESTTREINANT>CODCOLCFO>
    <ESTADOROW>0<<CODCFO>L02552</ESTADOROW>CODCFO>
    <ROWVALIDA>0<<RA>JR01</ROWVALIDA>RA>
    <ALUNO>1<<CODSERVICO>1</ALUNO>CODSERVICO>
    <PROFESSOR>0<<IDPERLET>86</PROFESSOR>IDPERLET>
    <CANDIDATO>0</CANDIDATO>
<NOMECLIFOR>JULIANA DATENA PEREIRA  <USUARIOBIBLIOS>0<NETA</USUARIOBIBLIOS>NOMECLIFOR>
    <FUNCIONARIO>0<<PERCENTUAL>100.0000</FUNCIONARIO>PERCENTUAL>
    <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>SResponsavel>
</EduParcela>
]]></ReadRecordResult>
Bloco de código
languagexml
titleExemplo do retorno sem registros
collapsetrue
<ReadRecordResult>&lt;EduAlunoEduParcela /></ReadRecordResult>

Método SaveRecord

Este método realiza a inclusão ou alteração de um alunouma ou várias parcelas. Algumas informações são obrigatórias e devem ser informadas: o código da coligada e o registro acadêmicoidentificador da parcela, além dos outros campos que estão configurados como obrigatórios no sistema.

O sistema irá realizar a inclusão de um alunoda parcela, caso o código registro  informado não exista na base. Essa identificação ocorre com base na chave primária da tabela SPARCELA: CODCOLIGADA e IDPARCELA

Se o Registro Acadêmico registro informado existir na coligada informada, essa base de dados ele terá as informações alteradas de acordo com o que será passado no arquivo XML.

Observação:

  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.

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.

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.

...

  1. No caso da inclusão de parcelas, caso seja informado mais de um registro no XML a chave primária informada deve ser diferente entre os registros. Isso se faz necessário para que o processo entenda que as informações passadas através do XML correspondem a registros diferentes

    Bloco de código
    languagexml
    title

...

  1. Exempo do XML para inclusão de

...

  1. várias parcelas
    collapsetrue

...

  1. <EduParcela>  
      <SParcela>  
        <CODCOLIGADA>1</CODCOLIGADA>
        

...

  1. <IDPARCELA>0</

...

  1. IDPARCELA>
        

...

  1. <RA>JR01</RA>  

...

  1. 
        

...

  1. <CODCONTRATO>3651</

...

  1. CODCONTRATO>  

...

  1. 
        

...

  1. <IDPERLET>86</IDPERLET>  

...

  1. 
        

...

  1. <CODSERVICO>1</CODSERVICO>  
        

...

  1. <PARCELA>7</PARCELA>  

...

  1. 
        

...

  1. <COTA>1</COTA>  

...

  1. 
        

...

  1. <VALOR>226</

...

  1. VALOR>  

...

  1. 
        

...

  1. <DTVENCIMENTO>2018-05-10T00:00:00</DTVENCIMENTO>  
        <TIPODESC>P</TIPODESC>  
        <TIPOPARCELA>P</TIPOPARCELA>
      </SParcela>
      <SParcela>  
        <CODCOLIGADA>1</CODCOLIGADA>
        <IDPARCELA>1</IDPARCELA>
        <RA>JR01</RA>  
        <CODCONTRATO>3651</CODCONTRATO>  
        <IDPERLET>86</IDPERLET>  
        <CODSERVICO>1</CODSERVICO>  
        <PARCELA>8</PARCELA>  
        <COTA>1</COTA>  
        <VALOR>227</VALOR>  
        <DTVENCIMENTO>2018-05-10T00:00:00</DTVENCIMENTO>  
        <TIPODESC>P</TIPODESC>  
        <TIPOPARCELA>P</TIPOPARCELA>
      </SParcela>
      <SParcela>  
        <CODCOLIGADA>1</CODCOLIGADA>
        <IDPARCELA>2</IDPARCELA>
        <RA>JR01</RA>  
        <CODCONTRATO>3651</CODCONTRATO>  
        <IDPERLET>86</IDPERLET>  
        <CODSERVICO>1</CODSERVICO>  
        <PARCELA>9</PARCELA>  
        <COTA>1</COTA>  
        <VALOR>228</VALOR>  
        <DTVENCIMENTO>2018-06-10T00:00:00</DTVENCIMENTO>  
        <TIPODESC>P</TIPODESC>  
        <TIPOPARCELA>P</TIPOPARCELA>
      </SParcela>
    </EduParcela>
    
Informações

Caso a inclusão ou

Bloco de código
languagexml
titleExemplo do retorno da inclusão de Aluno
collapsetrue
<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.

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
languagexml
titleExemplo de XML para alteração de informações de Aluno
collapsetrue
<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
languagexml
titleExemplo do retorno da alteração do cadastro de Aluno
collapsetrue
<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 identificador da parcela SaveRecordResult.

Método DeleteRecord

Este método realiza a exclusão de um alunouma ou várias parcelas. 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 DeleteRecordidentificador da parcela.

Deve ser passado um XML contendo todos os campos a chave primária 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 cadastroparcela (CODCOLIGADA e IDPARCELA).

Bloco de código
languagexml
titleExemplo de XML para exclusão de um Alunouma parcela
collapsetrue
		      <tot:DeleteRecord>
         <!--Optional:-->
         <tot:DataServerName>EduAlunoData<DataServerName>EduparcelaData</tot:DataServerName>
         <!--Optional:-->
         <tot:XML><![CDATA[<EduAluno>
<EduParcela>  <SAluno>
  <SParcela>  <CODCOLIGADA>1</CODCOLIGADA>
    <RA>8001408<<CODCOLIGADA>1</RA>CODCOLIGADA>
    <CODPESSOA>45087<<IDPARCELA>49710</CODPESSOA>IDPARCELA>
    <CODTIPOCURSO>2<</CODTIPOCURSO>SParcela>
  <SParcela>  <CODIGO>45087</CODIGO>
    <NOME>Stella Fernanda Aparício</NOME><CODCOLIGADA>1</CODCOLIGADA>
    <CPF>62587463653<<IDPARCELA>49711</CPF>IDPARCELA>
    <SOBRENOME>Aparício<</SOBRENOME>SParcela>
  <SParcela>  <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><IDPARCELA>49712</IDPARCELA>
  </SAlunoCompl>SParcela>
</EduAluno>EduParcela>]]></tot:XML>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADAContexto>codcoligada=1;CODFILIALcodfilial=1;CODTIPOCURSO=3;CODSISTEMA=S;<codtipocurso=1</tot:Contexto>
      </tot:DeleteRecord>

...