Linha RM

Atalhos

Páginas filhas
  • Fiadores - WebServices

Visão Geral dos processos WebServices de Fiadores

O objetivo deste DataServer é possibilitar a busca, inclusão, alteração e exclusão de fiadores através de WebService. Tudo o que for realizado, poderá ser visualizado no cadastro de fiadores no TOTVS Gestão Educacional.

Através do dataserver "EduFiadorData" 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 fiadores 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 um fiador. Algumas informações são obrigatórias e devem ser informadas: o código da coligada e o código do fiador.

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

Consulta de fiador

Para realizar a consulta de um fiador, 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 IDFIADOR como informações da chave para busca do fiador.


Exemplo de XML para consulta de um Fiador 
      <tot:ReadRecord>
         <!--Optional:-->
         <tot:DataServerName>EduFiadorData</tot:DataServerName>
         <!--Optional:-->
         <tot:PrimaryKey>1;33</tot:PrimaryKey>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1</tot:Contexto>
      </tot:ReadRecord>
Exemplo do retorno de consulta de Fiador 
         <ReadRecordResult><![CDATA[<EduFiador >
  <SFIADOR>
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDFIADOR>33</IDFIADOR>
    <RA>LFS-0020</RA>
    <CODCOLCFO>1</CODCOLCFO>
    <CODCFO>C01893</CODCFO>
    <IDHABILITACAOFILIAL>23</IDHABILITACAOFILIAL>
    <CODCURSO>4-1</CODCURSO>
    <CODGRADE>1</CODGRADE>
    <CODTURNO>3</CODTURNO>
    <STATUS>V</STATUS>
    <ATIVO>S</ATIVO>
    <CODHABILITACAO>4-1-1</CODHABILITACAO>
  </SFIADOR>
</EduFiador>]]></ReadRecordResult>
Exemplo do retorno sem registros 
<ReadRecordResult><EduFiador  /></ReadRecordResult>

Método SaveRecord

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

O sistema irá realizar a inclusão de um fiador, caso o código do fiador informado no XML seja igual a zero. O valor do código do fiador presente no XML serve apenas para identificar o fiador dentro do próprio XML. O sistema irá criar um código para o fiador inserido.

Se o código do fiador existir na coligada informada, essa terá as informações alteradas de acordo com o que será passado no arquivo XML.

Observação: 

  • No campo Status só pode receber um dos valores V - Avaliação, A - Aprovado, e R - Reprovado
  • No campo Ativo só pode receber um dos valores S - Ativo, e N - Inativo.

Inclusão de fiador

Para realizar inclusão de um fiador, 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 fiador.

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

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


Exemplo de XML para inclusão de um Fiador 
      <tot:SaveRecord>
         <!--Optional:-->
         <tot:DataServerName>EduFiadorData</tot:DataServerName>
         <!--Optional:-->
         <tot:XML><![CDATA[  <SFIADOR>
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDFIADOR>0</IDFIADOR>
    <RA>LFS-0020</RA>
    <NOMEALUNO>Carolina Maria Souza</NOMEALUNO>
    <CODCOLCFO>1</CODCOLCFO>
    <CODCFO>C01893</CODCFO>
    <NOMEFIADOR>LFS Aluno 1 Agrupamento</NOMEFIADOR>
    <IDHABILITACAOFILIAL>23</IDHABILITACAOFILIAL>
    <CODCURSO>4-1</CODCURSO>
    <NOMECURSO>ENGENHARIA DE SOFTWARE</NOMECURSO>
    <CODHABILITACAO>4-1-1</CODHABILITACAO>
    <NOMEHABILITACAO>TECNÓLOGO EM ANÁLISE DE SISTEMAS</NOMEHABILITACAO>
    <CODGRADE>1</CODGRADE>
    <NOMEGRADE>Habilitação 2009/1</NOMEGRADE>
    <CODTURNO>3</CODTURNO>
    <NOMETURNO>NOITE</NOMETURNO>
    <STATUS>V</STATUS>
    <ATIVO>S</ATIVO>
  </SFIADOR>
]]></tot:XML>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1</tot:Contexto>
      </tot:SaveRecord>
Exemplo do retorno da inclusão de Fiador 
<SaveRecordResult>1;33</SaveRecordResult>


Caso a inclusão seja realizada com sucesso, será mostrado o código da coligada e o código do fiador inserido no item SaveRecordResult.

Alteração de fiador

Para realizar alteração de um fiador, deve ser utilizado a operação de SaveRecord.

Deve ser passado um XML contendo todos os campos que serão atualizados no cadastro de fiador.

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


Exemplo de XML para alteração de informações de Fiador 
      <tot:SaveRecord>
         <!--Optional:-->
         <tot:DataServerName>EduFiadorData</tot:DataServerName>
         <!--Optional:-->
         <tot:XML><![CDATA[  <SFIADOR>
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDFIADOR>33</IDFIADOR>
    <RA>LFS-0020</RA>
    <NOMEALUNO>Carolina Maria Souza</NOMEALUNO>
    <CODCOLCFO>1</CODCOLCFO>
    <CODCFO>C01893</CODCFO>
    <NOMEFIADOR>LFS Aluno 1 Agrupamento</NOMEFIADOR>
    <IDHABILITACAOFILIAL>23</IDHABILITACAOFILIAL>
    <CODCURSO>4-1</CODCURSO>
    <NOMECURSO>ENGENHARIA DE SOFTWARE</NOMECURSO>
    <CODHABILITACAO>4-1-1</CODHABILITACAO>
    <NOMEHABILITACAO>TECNÓLOGO EM ANÁLISE DE SISTEMAS</NOMEHABILITACAO>
    <CODGRADE>1</CODGRADE>
    <NOMEGRADE>Habilitação 2009/1</NOMEGRADE>
    <CODTURNO>3</CODTURNO>
    <NOMETURNO>NOITE</NOMETURNO>
    <STATUS>V</STATUS>
    <ATIVO>N</ATIVO>
  </SFIADOR>
]]></tot:XML>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1</tot:Contexto>
      </tot:SaveRecord>
Exemplo do retorno da alteração do cadastro de Fiador 
<SaveRecordResult>1;33</SaveRecordResult>

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

Método DeleteRecord

Este método realiza a exclusão de um fiador. Algumas informações são obrigatórias e devem ser informadas: o código da coligada e o código do fiador, além dos outros campos que estão configurados como obrigatórios no sistema.

O sistema irá realizar a exclusão de um fiador caso encontre o registro.

Exclusão de fiador

Para realizar exclusão de um fiador, deve ser utilizado a operação de DeleteRecord.

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

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


Exemplo de XML para exclusão de um Fiador 
      <tot:DeleteRecord>
         <!--Optional:-->
         <tot:DataServerName>EduFiadorData</tot:DataServerName>
         <!--Optional:-->
         <tot:XML><![CDATA[  <SFIADOR>
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDFIADOR>33</IDFIADOR>
    <RA>LFS-0020</RA>
    <NOMEALUNO>Carolina Maria Souza</NOMEALUNO>
    <CODCOLCFO>1</CODCOLCFO>
    <CODCFO>C01893</CODCFO>
    <NOMEFIADOR>LFS Aluno 1 Agrupamento</NOMEFIADOR>
    <IDHABILITACAOFILIAL>23</IDHABILITACAOFILIAL>
    <CODCURSO>4-1</CODCURSO>
    <NOMECURSO>ENGENHARIA DE SOFTWARE</NOMECURSO>
    <CODHABILITACAO>4-1-1</CODHABILITACAO>
    <NOMEHABILITACAO>TECNÓLOGO EM ANÁLISE DE SISTEMAS</NOMEHABILITACAO>
    <CODGRADE>1</CODGRADE>
    <NOMEGRADE>Habilitação 2009/1</NOMEGRADE>
    <CODTURNO>3</CODTURNO>
    <NOMETURNO>NOITE</NOMETURNO>
    <STATUS>V</STATUS>
    <ATIVO>N</ATIVO>
  </SFIADOR>
]]></tot:XML>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1</tot:Contexto>
      </tot:DeleteRecord>
Exemplo do retorno de exclusão de Fiador 
<DeleteRecordResult>Exclusão de registro(s) realizado com sucesso</DeleteRecordResult>

Para mais informações segue o link da documentação padrão de uso de DataServers utilizando WebService:

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