Histórico da Página
Visão geral dos processos webservices de frequência diária e justificativa de falta
O objetivo deste DataServer é possibilitar a busca, inclusão, alteração da frequência diária do aluno, através de um Webservice. Tudo o que for realizado, poderá ser visualizado na tela de frequência diária no TOTVS Gestão Educacional.
Através do DataServer "EduFrequenciaDiariaWSData" e por meio dos métodos ReadRecord e SaveRecord, é possível realizar a busca, inclusão e manutenção das frequências da frequência no TOTVS Gestão Educacional.
Dica |
---|
Se necessário clique aqui para obter ajuda na configuração do Host. |
Método ReadRecord
Este método realiza a consulta de uma frequência lançada.
Algumas informações são obrigatórias e devem ser informadas para a realização da consulta: código da coligada, código do horário da turma, código da turma disciplina, registro acadêmico do aluno e a data da aula.
O sistema irá realizar a consulta de uma marcação de frequência do aluno, caso as informações passadas estejam de acordo com alguma frequência já existente no sistema.
Consulta de uma frequência
Para realizar a consulta de uma frequência, deve ser utilizado a operação de ReadRecord.
Deve ser passado um XML contendo todos os campos da chave primária.
Caso a chave informada não retorne registro, o resultado será o nome do DataSet. Caso contrário, o mesmo terá suas informações exibidas através de um XML.
O XML deve conter os campos CODCOLIGADA , IDHORARIOTURMA, IDTURMADISC, RA e DATA como informações da chave para busca a frequência lançada.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
<tot:ReadRecord> <!--Optional:--> <tot:DataServerName>EduFrequenciaDiariaWSData</tot:DataServerName> <!--Optional:--> <tot:PrimaryKey>1;295;1217;ES-00180;2018-07-17</tot:PrimaryKey> <!--Optional:--> <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1;CODSISTEMA=S</tot:Contexto> </tot:ReadRecord> |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
<ReadRecordResult> <![CDATA[<EduFrequenciaDiaria > <SFREQUENCIA> <CODCOLIGADA>1</CODCOLIGADA> <IDHORARIOTURMA>295</IDHORARIOTURMA> <IDTURMADISC>1217</IDTURMADISC> <RA>ES-00180</RA> <DATA>2018-07-17T00:00:00</DATA> <PRESENCA>A</PRESENCA> <JUSTIFICADA>0</JUSTIFICADA> <IDJUSTIFICATIVAFALTA>2</IDJUSTIFICATIVAFALTA> </SFREQUENCIA> </EduFrequenciaDiaria>]]> </ReadRecordResult> |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
<ReadRecordResult><EduFrequenciaDiaria /></ReadRecordResult> |
Método SaveRecord
Este método realiza a inclusão ou alteração de uma frequência de aluno. Algumas informações são obrigatórias e devem ser informadas: código da coligada, código do horário da turma, código da turma disciplina, registro acadêmico do aluno e a marcação de presença.
O sistema somente irá realizar a inclusão de marcações de ausências.
Nota |
---|
Caso seja definida uma marcação de presença, o sistema não irá incluir nenhum registro e o retorno será vazio. Caso exista uma marcação de ausência, ela será excluída e o retorno, também, será vazio. |
Inclusão de uma marcação de frequência
Para realizar inclusão de uma marcação de frequência, deve ser utilizada a operação SaveRecord.
O SaveRecord irá efetivamente manipular os registros da tabela SFREQUENCIA.
Para que os dados sejam salvos corretamente, devem ser seguidos algumas premissas.
O XML, obrigatoriamente, deverá conter uma tag chamada PARAMS que será responsável por passar algumas informações que são pré-requisitos para a inclusão/alteração da marcação de frequência. Esta tag deve conter os campos: CODCOLIGADA, IDTURMADISC, CODETAPA, AULASDADAS e CODSUBTURMA.
Outra tag com o nome AlunosFreq, também, deverá ser incluída no XML, contendo os campos CODCOLIGADA, RA, IDTURMADISC, IDTURMADISCORIGEM.
Por fim, a tag SFREQUENCIA conterá as informações da frequência que será lançada.
Turma Gerencial:
Caso seja necessária a manipulação de registros de frequência para turmas gerenciais, deve ser informado o código IDTURMADISC da turma gerencial na tag PARAMS dos parâmetros passados para o SaveRecord.
No lançamento da frequência, o IDTURMADISC deverá conter o código da turma/disciplina em que o aluno está matriculado.
Nota | ||
---|---|---|
| ||
O campo Data deverá ser informado no formato americano (YYYY-MM-DD). |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
<tot:SaveRecord> <!--Optional:--> <tot:DataServerName>EduFrequenciaDiariaWSData</tot:DataServerName> <!--Optional:--> <tot:XML><![CDATA[ <EduFrequenciaDiaria xmlns="http://tempuri.org/EduFrequenciaDiaria.xsd"> <SFREQUENCIA> <CODCOLIGADA>1</CODCOLIGADA> <IDTURMADISC>1217</IDTURMADISC> <IDHORARIOTURMA>295</IDHORARIOTURMA> <RA>ES-00180</RA> <PRESENCA>A</PRESENCA> <JUSTIFICADA>1</JUSTIFICADA> <IDJUSTIFICATIVAFALTA>6</IDJUSTIFICATIVAFALTA> <DATA>2018-07-17T00:00:00</DATA> </SFREQUENCIA> <AlunosFreq> <CODCOLIGADA>1</CODCOLIGADA> <RA>ES-00180</RA> <IDTURMADISC>1217</IDTURMADISC> <IDTURMADISCORIGEM></IDTURMADISCORIGEM> </AlunosFreq> <PARAMS> <CODCOLIGADA>1</CODCOLIGADA> <IDTURMADISC>1217</IDTURMADISC> <CODETAPA>1</CODETAPA> <AULASDADAS>1</AULASDADAS> <CODSUBTURMA></CODSUBTURMA> </PARAMS> </EduFrequenciaDiaria>]]></tot:XML> <!--Optional:--> <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1;CODSISTEMA=S</tot:Contexto> </tot:SaveRecord> |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
<SaveRecordResponse xmlns="http://www.totvs.com/"> <SaveRecordResult>1;295;1217;ES-00180;17/07/2018 00:00:00</SaveRecordResult> </SaveRecordResponse> |
Painel | ||
---|---|---|
| ||
O campo Presenca espera dois valores. (P ou A) P: Presença A: Ausência. O campo Justificada espera dois valores. (1 ou 0) 1: Falta abonada 0: Falta não abonada. |
Informações |
---|
Para a inclusão de uma justificativa, será necessário informar o código da mesma, cadastrada anteriormente, através do menu de cadastros auxiliares. Educacional | Currículo e Oferta | Auxiliares | Justificativas de falta Exemplo: 2 - Visita ao médico <JUSTIFICADA>f</JUSTIFICADA> <IDJUSTIFICATIVAFALTA>2</IDJUSTIFICATIVAFALTA> |
Dica |
---|
Para mais informações segue o link da documentação padrão de uso de DataServers utilizando WebService: |