Visão Geral dos processos WebSevices de Curso

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

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

Dica

Os serviços WebService identificarão a base de dados a ser utilizada através da tag DefaultDB, que informa o Alias que será utilizado no acesso. Essa tag deve existir no arquivo de configuração do Host (RM.Host.Service.exe.config ou RM.Host.exe.config):

<add key=”DefaultDB” value=”<ALIAS_DO_BANCO_RM>

A variável <ALIAS_DO_BANCO_RM> deverá ser substituída pelo nome do alias cadastrado para acesso ao banco de dados.

Exemplo:

Bloco de código

language	xml

<?xml version="1.0"?>
<configuration>
 <appSettings>
 <add key="JobServer3Camadas" value="false" />
 <add key="Port" value="12120" />
 <add key="ActionsPath" value="C:\totvs\CorporeRM\RM.Net;" />
 <add key="LibPath" value="C:\totvs\CorporeRM\RM.Net" />
 <add key="EnableDynamicLocalization" value="false" />
 <add key="EnableCompression" value="false" />
 <add key="LocalizationLanguage" value="pt-BR" />
 <add key="HttpPort" value="8051" />
 <add key="DefaultDB" value="CorporeRM" />
 </appSettings>
 <runtime>
 <NetFx40_LegacySecurityPolicy enabled="true" />
 <generatePublisherEvidence enabled="false" />
 </runtime>
 <startup useLegacyV2RuntimeActivationPolicy="true">
 <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0" />
 </startup>
</configuration>

A porta 8051 é padrão no sistema e caso seja alterada na tag HttpPort no arquivo de configuração do Host, precisa ser alterada no link acima.

Aviso

title	Liberação de acesso a porta do Host Service

Caso o Host utilizado seja o RM.Host.Service.exe é necessário a execução do comando, abaixo, para liberação da porta configurada na tag HttpPort, via prompt de comando:

Adicionar

netsh http add urlacl url=http://+:8051/ user=NetworkService

Apagar

netsh http delete urlacl url=http://+:8051/

Exibir

netsh http show urlacl

Nota

Para que o sistema carregue corretamente os parâmetros do sistema no momento de utilização do WebService, é necessário que sejam inclusas as informações do contexto: Coligada, Filial, Tipo de curso e Código do Sistema.

Essas informações devem ser separadas pelo caractere ";".

Expandir

title	Índice

Índice

minLevel	2

Método ReadRecord

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

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

Consulta do Curso

Para realizar a consulta de um Curso, 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, CODFILIAL E CODTIPOCURSO como informações da chave para busca de Curso.

Bloco de código

language	xml
title	Exemplo de XML para consulta de um Curso
collapse	true

	<tot:ReadRecord>
         <!--Optional:-->
         <tot:DataServerName>EduCursoData</tot:DataServerName>
         <!--Optional:-->
         <tot:PrimaryKey>1;12-1</tot:PrimaryKey>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1;CODSISTEMA=S</tot:Contexto>
      </tot:ReadRecord>

Bloco de código

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

<ReadRecordResponse xmlns="http://www.totvs.com/">
         <ReadRecordResult><![CDATA[<EduCurso>
  <SCurso>
    <CODCOLIGADA>1</CODCOLIGADA>
    <CODCURSO>12-1</CODCURSO>
    <NOME>ENGENHARIA DE AUTOMAÇÃO</NOME>
    <CODTIPOCURSO>1</CODTIPOCURSO>
    <CURPRESDIST>P</CURPRESDIST>
  </SCurso>
  <SCURSOCOMPL>
    <CODCOLIGADA>1</CODCOLIGADA>
    <CODCURSO>12-1</CODCURSO>
  </SCURSOCOMPL>
</EduCurso>]]></ReadRecordResult>

Bloco de código

language	xml
title	Exemplo do retorno sem registros
collapse	true

<ReadRecordResult>&lt;EduCursoData /></ReadRecordResult>

Método SaveRecord

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

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

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

Inclusão de Curso

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

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

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

Bloco de código

language	xml
title	Exemplo de XML para inclusão de um Curso
collapse	true

		<tot:SaveRecord>
         <!--Optional:-->
         <tot:DataServerName>EduCursoData</tot:DataServerName>
         <!--Optional:-->
         <tot:XML><![CDATA[<EduCurso>
  <SCurso>
    <CODCOLIGADA>1</CODCOLIGADA>
    <CODCURSO>3-12</CODCURSO>
    <NOME>ENGENHARIA_EXCLUIR- Automação</NOME>
    <DECRETO xml:space="preserve"> </DECRETO>
    <DESCRICAO xml:space="preserve"> </DESCRICAO>
    <CODTIPOCURSO>1</CODTIPOCURSO>
  </SCurso>
  <SCURSOCOMPL>
    <CODCOLIGADA>1</CODCOLIGADA>
    <CODCURSO>3-12</CODCURSO>
  </SCURSOCOMPL>
</EduCurso>]]></tot:XML>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1;CODSISTEMA=S</tot:Contexto>
      </tot:SaveRecord>

Bloco de código

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

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

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

Alteração de Curso

Para realizar alteração de um Curso, 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;

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

Bloco de código

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

<tot:SaveRecord>
         <!--Optional:-->
         <tot:DataServerName>EduCursoData</tot:DataServerName>
         <!--Optional:-->
         <tot:XML><![CDATA[<EduCurso>
  <SCurso>
    <CODCOLIGADA>1</CODCOLIGADA>
    <CODCURSO>3-13</CODCURSO>
    <NOME>ENGENHARIA PRODUÇÃO</NOME>
    <DECRETO xml:space="preserve"> </DECRETO>
    <DESCRICAO xml:space="preserve"> </DESCRICAO>
    <CODTIPOCURSO>1</CODTIPOCURSO>
  </SCurso>
  <SCURSOCOMPL>
    <CODCOLIGADA>1</CODCOLIGADA>
    <CODCURSO>3-13</CODCURSO>
  </SCURSOCOMPL>
</EduCurso>]]></tot:XML>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1;CODSISTEMA=S</tot:Contexto>
      </tot:SaveRecord>

Bloco de código

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

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

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

Método DeleteRecord

Este método realiza a exclusão de um Curso. 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 uma Curso caso encontre o registro.

Exclusão de Curso

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

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

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

Bloco de código

language	xml
title	Exemplo de XML para exclusão de um Curso
collapse	true

		<tot:DeleteRecord>
         <!--Optional:-->
         <tot:DataServerName>EduCursoData</tot:DataServerName>
         <!--Optional:-->
         <tot:XML><![CDATA[<EduCurso>
  <SCurso>
    <CODCOLIGADA>1</CODCOLIGADA>
    <CODCURSO>3-4</CODCURSO>
    <CODESCOLA>1</CODESCOLA>
    <CODAREA>1</CODAREA>
    <NOME>VET_01(Excluir)_AUTOMAÇÃO</NOME>
    <COMPLEMENTO>VETERINARIA_NOTURNO</COMPLEMENTO>
    <CODCURINEP>555</CODCURINEP>
    <CODTIPOCURSO>1</CODTIPOCURSO>
    <CFGMATRICULA>666</CFGMATRICULA>
    <CAPES>1</CAPES>
    <CURPRESDIST>P</CURPRESDIST>
    <CODMODALIDADECURSO>1</CODMODALIDADECURSO>
    <MASCARATURMA>#####</MASCARATURMA>
  </SCurso>
  <SCURSOCOMPL>
    <CODCOLIGADA>1</CODCOLIGADA>
    <CODCURSO>3-4</CODCURSO>
  </SCURSOCOMPL>
</EduCurso>]]></tot:XML>

Bloco de código

language	xml
title	Exemplo do retorno de exclusão da Turma/Disciplina
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

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

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 1

Nova versão 2

Chave

Visão Geral dos processos WebSevices de Curso

Método ReadRecord

Consulta do Curso

Método SaveRecord

Inclusão de Curso

Alteração de Curso

Método DeleteRecord

Exclusão de Curso

Atalhos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 1

Nova versão 2

Chave

Visão Geral dos processos WebSevices de Curso

Método ReadRecord

Consulta do Curso

Método SaveRecord

Inclusão de Curso

Alteração de Curso

Método DeleteRecord

Exclusão de Curso