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.

...

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 ";".

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 periodo letivo, o código da turma.

...

Caso os parâmetros informados no ReadRecord não encontre nenhuma turma cadastrada, o XML de retorno não trará nada.

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 de consulta da Turma
collapsetrue
<ReadRecordResult><![CDATA[<EduTurma>
  <STurma>
    <CODCOLIGADA>1</CODCOLIGADA>
    <CODFILIAL>1</CODFILIAL>
    <IDPERLET>98</IDPERLET>
    <CODTURMA>Turma B</CODTURMA>
    <IDHABILITACAOFILIAL>403</IDHABILITACAOFILIAL>
    <NOMERED>ADS-A</NOMERED>
    <NOME>Análise e Desenvolvimento de Sofware - Turma A</NOME>
    <MAXALUNOS>100</MAXALUNOS>
    <DTINICIAL>2018-01-01T00:00:00</DTINICIAL>
    <DTFINAL>2018-12-31T00:00:00</DTFINAL>
    <CODTIPOCURSO>3</CODTIPOCURSO>
    <CODCURSO>ADS</CODCURSO>
    <CODHABILITACAO>1</CODHABILITACAO>
    <CODGRADE>1</CODGRADE>
    <CODPERLET>2018/01</CODPERLET>
    <DTINICIOPLETIVO>2017-01-01T00:00:00</DTINICIOPLETIVO>
    <NOMECURSO>Análise e Desenvolvimento de Software</NOMECURSO>
    <NOMEHABILITACAO>Bacharelado</NOMEHABILITACAO>
    <DESCGRADE>Tecnologia da Informação</DESCGRADE>
    <TURNO>Matutino</TURNO>
    <CONTROLEVAGAS>0</CONTROLEVAGAS>
  </STurma>
  <STURMACOMPL>
    <CODCOLIGADA>1</CODCOLIGADA>
    <CODFILIAL>1</CODFILIAL>
    <IDPERLET>98</IDPERLET>
    <CODTURMA>Turma B</CODTURMA>
  </STURMACOMPL>
</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 periodo 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.

Utilização do WebService

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 periodo 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.

...