Visão Geral dos processos WebSevices de Parcelas

O objetivo deste DataServer é possibilitar a busca, inclusão, alteração e exclusão de parcelas através de WebService. 

Através do dataserver "EduParcelaData" 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 parcelas no TOTVS Gestão Educacional.

Se necessário clique aqui para obter ajuda na configuração do Host.

Método ReadRecord

Este método realiza a consulta de uma parcela. Algumas informações são obrigatórias e devem ser informadas: o código da coligada e o identificador da parcela.

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

Consulta de parcela

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 IDPARCELA como informações da chave para busca do aluno.

		<tot:ReadRecord>
         <!--Optional:-->
         <tot:DataServerName>EduParcelaData</tot:DataServerName>
         <!--Optional:-->
         <tot:PrimaryKey>1;49711</tot:PrimaryKey>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=2</tot:Contexto>
      </tot:ReadRecord>

<ReadRecordResult><![CDATA[<EduParcela >
  <SParcela>
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDPARCELA>49711</IDPARCELA>
    <RA>JR01</RA>
    <CODCONTRATO>3651</CODCONTRATO>
    <IDPERLET>86</IDPERLET>
    <CODSERVICO>1</CODSERVICO>
    <PARCELA>8</PARCELA>
    <COTA>1</COTA>
    <VALOR>225.0000</VALOR>
    <DTVENCIMENTO>2018-05-10T00:00:00</DTVENCIMENTO>
    <TIPODESC>P</TIPODESC>
    <TIPOPARCELA>P</TIPOPARCELA>
    <VALORAUTOMATICO>N</VALORAUTOMATICO>
    <ORIGEM>MN</ORIGEM>
    <RECCREATEDBY>mestre</RECCREATEDBY>
    <RECCREATEDON>2018-07-12T14:30:43</RECCREATEDON>
    <RECMODIFIEDBY>mestre</RECMODIFIEDBY>
    <RECMODIFIEDON>2018-07-12T14:30:43</RECMODIFIEDON>
  </SParcela>
  <SResponsavel>
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDPARCELA>49711</IDPARCELA>
    <CODCOLCFO>1</CODCOLCFO>
    <CODCFO>L02552</CODCFO>
    <RA>JR01</RA>
    <CODSERVICO>1</CODSERVICO>
    <IDPERLET>86</IDPERLET>
    <NOMECLIFOR>JULIANA DATENA PEREIRA NETA</NOMECLIFOR>
    <PERCENTUAL>100.0000</PERCENTUAL>
  </SResponsavel>
</EduParcela>
]]></ReadRecordResult>

<ReadRecordResult>&lt;EduParcela /></ReadRecordResult>

Método SaveRecord

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

O sistema irá realizar a inclusão da parcela, caso o 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 informado existir na base de dados ele terá as informações alteradas de acordo com o que será passado no arquivo XML.

Observação:

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

   Exempo do XML para inclusão de várias parcelas Expandir origem

   <EduParcela>  
     <SParcela>  
       <CODCOLIGADA>1</CODCOLIGADA>
       <IDPARCELA>0</IDPARCELA>
       <RA>JR01</RA>  
       <CODCONTRATO>3651</CODCONTRATO>  
       <IDPERLET>86</IDPERLET>  
       <CODSERVICO>1</CODSERVICO>  
       <PARCELA>7</PARCELA>  
       <COTA>1</COTA>  
       <VALOR>226</VALOR>  
       <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>
   

Método DeleteRecord

Este método realiza a exclusão de uma ou várias parcelas. Algumas informações são obrigatórias: o código da coligada e o identificador da parcela.

Deve ser passado um XML contendo a chave primária que fazem parte do registro de parcela (CODCOLIGADA e IDPARCELA).

      <tot:DeleteRecord>
         <!--Optional:-->
         <tot:DataServerName>EduparcelaData</tot:DataServerName>
         <!--Optional:-->
         <tot:XML><![CDATA[<EduParcela>  
  <SParcela>  
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDPARCELA>49710</IDPARCELA>
  </SParcela>
  <SParcela>  
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDPARCELA>49711</IDPARCELA>
  </SParcela>
  <SParcela>  
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDPARCELA>49712</IDPARCELA>
  </SParcela>
</EduParcela>]]></tot:XML>
         <!--Optional:-->
         <tot:Contexto>codcoligada=1;codfilial=1;codtipocurso=1</tot:Contexto>
      </tot:DeleteRecord>

 <DeleteRecordResult>Exclusão de registro(s) realizado com sucesso</DeleteRecordResult>