Histórico da Página
Visão Geral do Programa
O objetivo deste dataserver método ListarBoletos presente no webservice do Educacional (wsEdu) é possibilitar a inclusão e alteração de Professores através de webservice. As informações incluídas ou alteradas poderão ser visualizadas no cadastro de professor no TOTVS Gestão Educacional.
Através do dataserver "EduProfessorData" é possível, por meio do método SaveRecord, realizar a manutenção das informações dos professores no TOTVS Gestão Educacional.
Ir para o início dos metadados
Visão Geral do Programa
O objetivo deste dataserver é possibilitar a inclusão e alteração de Professores através de webservice. As informações incluídas ou alteradas poderão ser visualizadas no cadastro de professor no TOTVS Gestão Educacional.
listagem de todos os boletos do aluno presente em seus contratos não cancelados no TOTVS Gestão Educacional vinculados ao lançamentos financeiros do aluno no TOTVS Gestão Financeira.
É importante destacar que serão listados somente os boletos em abertos.
Através do server "ConEducacionalWebEnsinoAMSDataAtravés do dataserver "EduProfessorData" é possível, por meio do método SaveRecord, realizar a manutenção das informações dos professores no TOTVS Gestão Educacional.
Os serviços REST 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:
ListarBoletos, solicitar as informações de data de vencimento e referência do boleto bancário.
Se necessário clique aqui para obter ajuda na configuração do Host.
Método ListarBoletos
Este método realiza a listagem de todos os boletos do aluno presente em seus contratos não cancelados no TOTVS Gestão Educacional. Como informações obrigatórias no XML, devem ser informados o registro acadêmico do aluno, código da coligada, código da filial, código do tipo de curso e a referência da turma/disciplina do aluno.
É importante destacar que serão listados somente os boletos em abertos.
Referente às informações código da coligada, código da filial, código do tipo de curso e a referência da turma/disciplina do aluno. Essas informações devem ser informadas de forma única no campo "CodTurmaConcat" separadas por vírgula, como pode ser observado na imagem abaixo.
Na imagem acima observa que:
- Na tag "RA" tem a informação:
- Registro Acadêmico do Aluno igual a ES-212814
- Registro Acadêmico do Aluno igual a ES-212814
- Na tag "CodTurmaConcat" tem as informações:
- Código da Coligada igual a 1
- Código da Filial igual a 1
- Código do Tipo de Curso igual a 1
- Referência da Turma/Disciplina do Aluno igual a 1171
O sistema irá realizar a consulta dos boletos do aluno a partir das informações presente nas tag's "RA" e "CodTurmaConcat", caso as informações existirem na base de dados o sistema irá retorna um XML com a data de vencimento e referência do boleto conforme imagem abaixo.
Caso nos contratos não cancelados do aluno não tenha boletos bancários vinculados o XML retornado pelo método será:
Método SaveRecord
Este método realiza a inclusão ou alteração de um professor. Como informações obrigatórias, devem ser informados os código da coligada e do professor, além dos outros campos configurados como obrigatórios.
O sistema irá realizar a inclusão de um professor, caso o código informado não exista na base.
Se o código de professor existir na coligada informada, esse 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 mesmo códigos da coligada e do professores para que o sistema consiga entender que se referem ao professor que se deseja alterar.
Utilização do WebService
Inclusão do professor
Para realizar inclusão de um professor, 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 professor.
Caso o código e professor informado não exista, será incluído um novo professor. Caso contrário, o mesmo terá suas informações atualizadas.
O XML deve conter a tabela SPROFESSOR com os campos CODCOLIGADA e CODPROF como informações da chave para o cadastro do professor e, também, os campos obrigatórios para seu cadastro.
O cadastro de um professor gera uma nova pessoa nova base.Dessa forma, é necessário que as informações obrigatórias para a validação de unicidade de uma pessoa sejam informadas no XML.
Essa validação pode variar com a necessidade de se informar o nome, a data de nascimento, o estado natal e sua naturalidade ou o CPF, conforme parametrização do módulo de Gestão de Pessoa.
Exemplo de XML para inclusão de um professor
...
Para que o sistema carregue corretamente os parâmetros do sistema, é necessário que sejam inclusas as informações do contexto: Coligada, Filial e Tipo de curso.
Essas informações devem ser separadas pelo caractere ";".
Exemplo do retorno da inclusão do Professor
...
Caso a inclusão seja realizada com sucesso, será mostrado o código da coligada e o código do professor inserido no item SaveRecordResult
Alteração de Professores
Para realizar inclusão de um professor, deve ser utilizado a operação de SaveRecord.
Deve ser passado um XML contendo todos os campos que serão atualizado no cadastro do professor.
O XML deve conter a tabela SPROFESSOR com os campos CODCOLIGADA e CODPROF como informações da chave para a atualização de cadastro do professor.
Exemplo de XML para alteração de informações do Professor
...
Exemplo do retorno da alteração do cadastro do Professor
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas