Histórico da Página
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.
...
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 | ||
|---|---|---|
| ||
<?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 | ||
|---|---|---|
| ||
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:
netsh http add urlacl url=http://+:8051/ user=NetworkService
netsh http delete urlacl url=http://+:8051/
netsh http show urlacl |
Se necessário clique aqui para obter ajuda na configuração do Host.
| 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 | ||||
|---|---|---|---|---|
| ||||
|
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.
...
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
<ReadRecordResult><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.
...
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.
...
| Informações |
|---|
Caso a inclusão seja realizada com sucesso, será mostrado o código da coligada, o Código do Curso e o Código da Habilitação inserido no item 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.
...
| 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\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 uma 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.
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas