Visão Geral dos processos WebSevices de Bolsas

O objetivo deste DataServer é possibilitar a busca, inclusão, alteração e exclusão de bolsas através de WebService. Tudo o que for realizado, poderá ser visualizado no cadastro de 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 bolsas no TOTVS Gestão Educacional.

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

Expandir

title	Índice

Índice

minLevel	2

Método ReadRecord

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

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

Consulta de bolsa

Para realizar a consulta de uma bolsa, 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 CODBOLSA como informações da chave para busca da bolsa.

Bloco de código

language	xml
title	Exemplo de XML para consulta de uma Bolsa
collapse	true

      <tot:ReadRecord>
         <!--Optional:-->
         <tot:DataServerName>EduBolsaData</tot:DataServerName>
         <!--Optional:-->
         <tot:PrimaryKey>1;69</tot:PrimaryKey>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1</tot:Contexto>
      </tot:ReadRecord>

Bloco de código

language	xml
title	Exemplo do retorno de consulta de Bolsa
collapse	true

         <ReadRecordResult><![CDATA[<EduBolsa>
  <SBolsa>
    <CODCOLIGADA>1</CODCOLIGADA>
    <CODBOLSA>69</CODBOLSA>
    <NOME>Teste Automatizado T</NOME>
    <VALOR>15.0000</VALOR>
    <CODTIPOCURSO>1</CODTIPOCURSO>
    <VALIDADELIMITADA>1</VALIDADELIMITADA>
    <BOLSAFUNC>0</BOLSAFUNC>
    <TIPOSAC>N</TIPOSAC>
    <ATIVA>S</ATIVA>
    <TIPODESC>P</TIPODESC>
    <PERMITEALTERARVALOR>S</PERMITEALTERARVALOR>
    <VERIFICAINADIMPLENCIA>S</VERIFICAINADIMPLENCIA>
    <CONTABCOMPETENCIA>S</CONTABCOMPETENCIA>
    <ORDEMAPLICDESCANTECIPACAO>A</ORDEMAPLICDESCANTECIPACAO>
    <AFETABASECALCULO>N</AFETABASECALCULO>
  </SBolsa>
  <SBOLSACOMPL>
    <CODCOLIGADA>1</CODCOLIGADA>
    <CODBOLSA>69</CODBOLSA>
    <TESTE>Teste</TESTE>
  </SBOLSACOMPL>
</EduBolsa>]]></ReadRecordResult>

Bloco de código

language	xml
title	Exemplo do retorno sem registros
collapse	true

<ReadRecordResult>&lt;EduBolsa /></ReadRecordResult>

Método SaveRecord

Este método realiza a inclusão ou alteração de uma bolsa. Algumas informações são obrigatórias e devem ser informadas: o código da coligada e o có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 uma bolsa, caso o código da bolsa informado no 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 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 à bolsa que se deseja alterar.

Inclusão de bolsa

Para realizar inclusão de uma 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 a bolsa.

Caso o Código da Bolsa informado exista as informações serão atualizadas.

O XML deve conter a tabela SBOLSA com os campos CODCOLIGADA e CODBOLSA como informações da chave para o cadastro de bolsa e, também, os campos obrigatórios para seu cadastro.

Bloco de código

language	xml
title	Exemplo de XML para inclusão de uma Bolsa
collapse	true

      <tot:SaveRecord>
         <!--Optional:-->
         <tot:DataServerName>EduBolsaData</tot:DataServerName>
         <!--Optional:-->
         <tot:XML><![CDATA[
<EduBolsa>
 <SBOLSA>
      <CODCOLIGADA>1</CODCOLIGADA>
      <CODBOLSA>68</CODBOLSA>
      <CODCFO></CODCFO> 
      <NOME>Teste Automatizado T</NOME>
      <VALOR>15</VALOR>
      <CODTIPOCURSO>1</CODTIPOCURSO>
      <CODCOLCFO></CODCOLCFO>
      <ORDEMPERDA></ORDEMPERDA>
      <RENOVACAOAUTOMATICA></RENOVACAOAUTOMATICA>
      <VALIDADELIMITADA>1</VALIDADELIMITADA>
      <FIES></FIES>
      <BOLSAFUNC>0</BOLSAFUNC>
      <TIPOSAC>N</TIPOSAC>
      <ATIVA>S</ATIVA>
      <TIPODESC>P</TIPODESC>
      <PERMITEALTERARVALOR>S</PERMITEALTERARVALOR>
      <NOMERESPONSAVELBOLSACRED></NOMERESPONSAVELBOLSACRED>
      <CODCLASSIFICACAO></CODCLASSIFICACAO>
      <VERIFICAINADIMPLENCIA>S</VERIFICAINADIMPLENCIA>
      <CONTABCOMPETENCIA>S</CONTABCOMPETENCIA>
      <APLICFORMULA></APLICFORMULA>
      <CODFORMULAPERCENTUAL></CODFORMULAPERCENTUAL>
      <CODFORMULAVALOR></CODFORMULAVALOR>
      <ORDEMAPLICDESCANTECIPACAO>A</ORDEMAPLICDESCANTECIPACAO>
      <AFETABASECALCULO>N</AFETABASECALCULO>
 </SBOLSA>
 <SBOLSACOMPL>
      <CODCOLIGADA>1</CODCOLIGADA>
      <CODBOLSA>68</CODBOLSA>
      <TESTE>Teste</TESTE>
 </SBOLSACOMPL>
</EduBolsa>         
         ]]></tot:XML>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1</tot:Contexto>
      </tot:SaveRecord>

Bloco de código

language	xml
title	Exemplo do retorno da inclusão de Bolsa
collapse	true

<SaveRecordResult>1;78</SaveRecordResult>

Informações
Caso a inclusão seja realizada com sucesso, será mostrado o código da coligada e o código da bolsa inserido no item SaveRecordResult.

Alteração de bolsa

Para realizar alteração de uma 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 bolsa.

O XML deve conter a tabela SBOLSA com os campos CODCOLIGADA e CODBOLSA como informações da chave para a atualização do cadastro de bolsa.

Bloco de código

language	xml
title	Exemplo de XML para alteração de informações de Bolsa
collapse	true

      <tot:SaveRecord>
         <!--Optional:-->
         <tot:DataServerName>EduBolsaData</tot:DataServerName>
         <!--Optional:-->
         <tot:XML><![CDATA[
<EduBolsa>
 <SBOLSA>
      <CODCOLIGADA>1</CODCOLIGADA>
      <CODBOLSA>78</CODBOLSA>
      <CODCFO></CODCFO> 
      <NOME>Teste Automatizado</NOME>
      <VALOR>20</VALOR>
      <CODTIPOCURSO>1</CODTIPOCURSO>
      <CODCOLCFO></CODCOLCFO>
      <ORDEMPERDA></ORDEMPERDA>
      <RENOVACAOAUTOMATICA></RENOVACAOAUTOMATICA>
      <VALIDADELIMITADA>1</VALIDADELIMITADA>
      <FIES></FIES>
      <BOLSAFUNC>0</BOLSAFUNC>
      <TIPOSAC>N</TIPOSAC>
      <ATIVA>S</ATIVA>
      <TIPODESC>P</TIPODESC>
      <PERMITEALTERARVALOR>S</PERMITEALTERARVALOR>
      <NOMERESPONSAVELBOLSACRED></NOMERESPONSAVELBOLSACRED>
      <CODCLASSIFICACAO></CODCLASSIFICACAO>
      <VERIFICAINADIMPLENCIA>S</VERIFICAINADIMPLENCIA>
      <CONTABCOMPETENCIA>S</CONTABCOMPETENCIA>
      <APLICFORMULA></APLICFORMULA>
      <CODFORMULAPERCENTUAL></CODFORMULAPERCENTUAL>
      <CODFORMULAVALOR></CODFORMULAVALOR>
      <ORDEMAPLICDESCANTECIPACAO>A</ORDEMAPLICDESCANTECIPACAO>
      <AFETABASECALCULO>N</AFETABASECALCULO>
 </SBOLSA>
 <SBOLSACOMPL>
      <CODCOLIGADA>1</CODCOLIGADA>
      <CODBOLSA>78</CODBOLSA>
      <TESTE>Teste</TESTE>
 </SBOLSACOMPL>
</EduBolsa>         
         ]]></tot:XML>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1</tot:Contexto>
      </tot:SaveRecord>

Bloco de código

language	xml
title	Exemplo do retorno da alteração do cadastro de Bolsa
collapse	true

<SaveRecordResult>1;78</SaveRecordResult>

Informações
Caso a alteração seja realizada com sucesso, será mostrado o código da coligada e o código da bolsa no item SaveRecordResult.

Método DeleteRecord

Este método realiza a exclusão de uma bolsa. Algumas informações são obrigatórias e devem ser informadas: o código da coligada e o có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 uma bolsa caso encontre o registro.

Exclusão de bolsa

Para realizar exclusão de uma bolsa, deve ser utilizado a operação de DeleteRecord.

Deve ser passado um XML contendo todos os campos que fazem parte do registro de bolsa.

O XML deve conter a tabela SBOLSA com os campos CODCOLIGADA e CODBOLSA como informações da chave para o cadastro de bolsa e, também, os campos obrigatórios para seu cadastro.

Bloco de código

language	xml
title	Exemplo de XML para exclusão de uma Bolsa
collapse	true

      <tot:DeleteRecord>
         <!--Optional:-->
         <tot:DataServerName>EduBolsaData</tot:DataServerName>
         <!--Optional:-->
         <tot:XML>
<![CDATA[<EduBolsa>
 <SBOLSA>
      <CODCOLIGADA>1</CODCOLIGADA>
      <CODBOLSA>78</CODBOLSA>
      <CODCFO></CODCFO> 
      <NOME>Teste Automatizado T</NOME>
      <VALOR>15</VALOR>
      <CODTIPOCURSO>1</CODTIPOCURSO>
      <CODCOLCFO></CODCOLCFO>
      <ORDEMPERDA></ORDEMPERDA>
      <RENOVACAOAUTOMATICA></RENOVACAOAUTOMATICA>
      <VALIDADELIMITADA>1</VALIDADELIMITADA>
      <FIES></FIES>
      <BOLSAFUNC>0</BOLSAFUNC>
      <TIPOSAC>N</TIPOSAC>
      <ATIVA>S</ATIVA>
      <TIPODESC>P</TIPODESC>
      <PERMITEALTERARVALOR>S</PERMITEALTERARVALOR>
      <NOMERESPONSAVELBOLSACRED></NOMERESPONSAVELBOLSACRED>
      <CODCLASSIFICACAO></CODCLASSIFICACAO>
      <VERIFICAINADIMPLENCIA>S</VERIFICAINADIMPLENCIA>
      <CONTABCOMPETENCIA>S</CONTABCOMPETENCIA>
      <APLICFORMULA></APLICFORMULA>
      <CODFORMULAPERCENTUAL></CODFORMULAPERCENTUAL>
      <CODFORMULAVALOR></CODFORMULAVALOR>
      <ORDEMAPLICDESCANTECIPACAO>A</ORDEMAPLICDESCANTECIPACAO>
      <AFETABASECALCULO>N</AFETABASECALCULO>
 </SBOLSA>
</EduBolsa>]]>         
         </tot:XML>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1</tot:Contexto>
      </tot:DeleteRecord>

Bloco de código

language	xml
title	Exemplo do retorno de exclusão de Bolsa
collapse	true

<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:

http://tdn.totvs.com/x/XYlpCw

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 5

Nova versão 6

Chave

Visão Geral dos processos WebSevices de Bolsas

Método ReadRecord

Consulta de bolsa

Método SaveRecord

Inclusão de bolsa

Alteração de bolsa

Método DeleteRecord

Exclusão de bolsa

Atalhos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 5

Nova versão 6

Chave

Visão Geral dos processos WebSevices de Bolsas

Método ReadRecord

Consulta de bolsa

Método SaveRecord

Inclusão de bolsa

Alteração de bolsa

Método DeleteRecord

Exclusão de bolsa