Visão Geral dos processos WebSevices de Curso\Habilitações

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

Através do DataServer "EduHabilitacaoData" 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 Curso\Habilitação 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 Curso\Habilitação. Algumas informações são obrigatórias e devem ser informadas: o código da coligada, código do Curso e o Código da Habilitação. 

O sistema irá realizar a consulta de um Curso\Habilitação, caso as informações passadas estejam de acordo com algum Curso\Habilitação já existente no sistema.

Consulta do Curso\Habilitação

Para realizar a consulta de um Curso\Habilitação, 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, CODCURSO e CODHABILITACAO como informações da chave para busca de Curso\Habilitação.

	 <tot:ReadRecord>
         <!--Optional:-->
         <tot:DataServerName>EduHabilitacaoData</tot:DataServerName>
         <!--Optional:-->
         <tot:PrimaryKey>1;3-7;1</tot:PrimaryKey>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1</tot:Contexto>
      </tot:ReadRecord>

<ReadRecordResponse xmlns="http://www.totvs.com/">
         <ReadRecordResult><![CDATA[<EduHabilitacao>
  <SHabilitacao>
    <CODCOLIGADA>1</CODCOLIGADA>
    <CODCURSO>3-7</CODCURSO>
    <CODHABILITACAO>1</CODHABILITACAO>
    <NOME>ENGENHARIA01_AUTOMAÇÃO</NOME>
    <DECRETO xml:space="preserve"> </DECRETO>
    <DESCRICAO xml:space="preserve"> </DESCRICAO>
    <CODTIPOHABILITACAO>2</CODTIPOHABILITACAO>
    <NRHABILITACOESVINCULADAS>0</NRHABILITACOESVINCULADAS>
  </SHabilitacao>
  <SHABILITACAOCOMPL>
    <CODCOLIGADA>1</CODCOLIGADA>
    <CODCURSO>3-7</CODCURSO>
    <CODHABILITACAO>1</CODHABILITACAO>
  </SHABILITACAOCOMPL>
</EduHabilitacao>]]></ReadRecordResult>

<ReadRecordResult>&lt;EduHabilitacaoData /></ReadRecordResult>

Método SaveRecord

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

O sistema irá realizar a inclusão de um Curso\Habilitação, caso o código informado não exista na base.

Se o código do Curso\Habilitação 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 Curso\Habilitação que se deseja alterar.

Inclusão de Curso\Habilitação

Para realizar inclusão de um Curso\Habilitação, 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 Curso\Habilitação.

Caso o código do Curso\Habilitaçãco informado não exista, será incluída um novo Curso\Habilitaçãoo. Caso contrário, o mesmo terá suas informações atualizadas.

O XML deve conter a tabela SHABILITACAO com os campos CODCOLIGADA, CODCURSO e o CODHABILITACAO  como informações da chave para o cadastro de Curso\Habilitação, também os campos obrigatórios para seu cadastro.

		<tot:SaveRecord>
         <!--Optional:-->
         <tot:DataServerName>EduHabilitacaoData</tot:DataServerName>
         <!--Optional:-->
         <tot:XML><![CDATA[<EduHabilitacao>
  <SHabilitacao>
    <CODCOLIGADA>1</CODCOLIGADA>
    <CODCURSO>3-7</CODCURSO>
    <CODHABILITACAO>1</CODHABILITACAO>
    <NOME>ENGENHARIA01_AUTOMAÇÃO</NOME>
    <DECRETO xml:space="preserve"> </DECRETO>
    <DESCRICAO xml:space="preserve"> </DESCRICAO>
    <CODTIPOHABILITACAO>2</CODTIPOHABILITACAO>
    <NRHABILITACOESVINCULADAS>0</NRHABILITACOESVINCULADAS>
  </SHabilitacao>
  <SHABILITACAOCOMPL>
    <CODCOLIGADA>1</CODCOLIGADA>
    <CODCURSO>3-7</CODCURSO>
    <CODHABILITACAO>1</CODHABILITACAO>
  </SHABILITACAOCOMPL>
</EduHabilitacao>]]></tot:XML>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1;CODSISTEMA=S</tot:Contexto>
      </tot:SaveRecord>

<SaveRecordResult>1;3-7;1</SaveRecordResult>

Alteração de Curso\Habilitação

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

Deve ser passado um XML contendo todos os campos que serão atualizados no cadastro de Curso\Habilitação;

O XML deve conter a tabela SHABILITACAO  com os campos CODCOLIGADA, CODCURSO e o CODHABILITACAO como informações da chave para a atualização do cadastro de Curso\Habilitação.

<tot:SaveRecord>
         <!--Optional:-->      
         <tot:DataServerName>EduHabilitacaoData</tot:DataServerName>
         <!--Optional:-->     
         <tot:XML><![CDATA[<EduHabilitacao>
         <SHabilitacao>
        <CODCOLIGADA>1</CODCOLIGADA>   
        <CODCURSO>3-2</CODCURSO>  
        <CODHABILITACAO>1</CODHABILITACAO>  
        <NOME>ADM_EMPR_ADM01</NOME>
        <DECRETO
       xml:space="preserve"> </DECRETO>
       <DESCRICAO
       xml:space="preserve"> </DESCRICAO>
      <CODTIPOHABILITACAO>2</CODTIPOHABILITACAO>   
      <NRHABILITACOESVINCULADAS>0</NRHABILITACOESVINCULADAS>
      </SHabilitacao>
      <SHABILITACAOCOMPL>
      <CODCOLIGADA>1</CODCOLIGADA>  
      <CODCURSO>3-2</CODCURSO>
      <CODHABILITACAO>1</CODHABILITACAO>
      </SHABILITACAOCOMPL>
      </EduHabilitacao>]]></tot:XML>
      <!--Optional:-->       
      <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1;CODSISTEMA=S</tot:Contexto>   
</tot:SaveRecord>

<SaveRecordResult>1;3-2;1</SaveRecordResult>

Método DeleteRecord

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

O sistema irá realizar a exclusão de um Curso\Habilitação caso encontre o registro.

Exclusão de Curso\Habilitação

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

Deve ser passado um XML contendo todos os campos que fazem parte do registro de Curso\Habilitação.

O XML deve conter a tabela SHABILITACAO com os campos CODCOLIGADA, CODCURSO e o CODHABILITACAO como informações da chave para o cadastro de Curso\Habilitação e também os campos obrigatórios para seu cadastro.

		<tot:DeleteRecord>
         <!--Optional:-->
         <tot:DataServerName>EduHabilitacaoData</tot:DataServerName>
         <!--Optional:-->
         <tot:XML><![CDATA[<EduHabilitacao>
  <SHabilitacao>
    <CODCOLIGADA>1</CODCOLIGADA>
    <CODCURSO>3-7</CODCURSO>
    <CODHABILITACAO>1</CODHABILITACAO>
    <NOME>ENGENHARIA01_AUTOMAÇÃO</NOME>
    <DECRETO xml:space="preserve"> </DECRETO>
    <DESCRICAO xml:space="preserve"> </DESCRICAO>
    <CODTIPOHABILITACAO>2</CODTIPOHABILITACAO>
    <NRHABILITACOESVINCULADAS>0</NRHABILITACOESVINCULADAS>
  </SHabilitacao>
  <SHABILITACAOCOMPL>
    <CODCOLIGADA>1</CODCOLIGADA>
    <CODCURSO>3-7</CODCURSO>
    <CODHABILITACAO>1</CODHABILITACAO>
  </SHABILITACAOCOMPL>
</EduHabilitacao>]]>

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