Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Visão Geral dos processos WebSevices da Turma

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

Através do dataserver "EduTurmaData" e por meio dos métodos ReadRecord, SaveRecord e DeleteRecord, é possível realizar busca, inclusão, manutenção e exclusão das informações das Turmas no TOTVS Gestão Educacional.

...

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
languagexml
<?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
titleLiberaçã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

...

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.

...

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


Expandir
titleÍndice

Índice
minLevel2

Método ReadRecord

Este método realiza a consulta de uma turma. Algumas informações são obrigatórias e devem ser informadas: o código da coligada, o código da filial, o id do período letivo, o código da turma.

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

Consulta da turma

Para realizar a consulta de uma turma, deve ser utilizado a operação de ReadRecord.

...

Bloco de código
languagexml
titleExemplo do retorno sem registros
collapsetrue
<ReadRecordResult>&lt;EduTurma /></ReadRecordResult>

Método SaveRecord

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

...

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 à turma que se deseja alterar.

Inclusão da turma

Para realizar inclusão de uma turma, deve ser utilizado a operação de SaveRecord.

...

Informações

Caso a inclusão seja realizada com sucesso, será mostrado o código da coligada, o código da filial, o id do período letivo e o código da turma inserido no item SaveRecordResult.

Alteração de Turmas

Para realizar alteração de uma turma, deve ser utilizado a operação de SaveRecord.

...

Informações

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

Método DeleteRecord

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

O sistema irá realizar a exclusão de uma turma caso encontre o registro.

Exclusão da turma

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

...