Visão geral

Através do serviço RMSRestDataServer, via RESTful, o usuário poderá acessar o dataserver de Frequência diária / Justificativa de falta (EduFrequenciaDiariaWSData) para a realização de requisições de consultas de frequências e inclusões de justificativas de faltas.  

Essas requisições são disponibilizadas através dos métodos: GET, PUT, POST e são, sempre, utilizados os valores das chaves primárias como índice para que elas sejam realizadas.

No link Serviços RESTful no RM é possível obter todas as informações sobre os serviços disponibilizados.

Importante

Para utilização dos serviços, é necessário que seja utilizada a forma de autenticação básica, onde deverão ser passados os valores de usuário e senha do usuário de acesso ao sistema.

Conforme documentação disponibilizada pela equipe de FrameWork, os serviços via RESTfull estão disponibilizados, à partir da versão 12.1.6 da linha RM.

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

Consulta

Para a realização de uma consulta, é necessária a utilização do método GET. 

Através desse método, é possível realizar a consulta de apenas uma frequência diária ou de uma lista de frequências.

Para a requisição de informações de uma frequência diária será necessário passar os valores da chave primária da frequência diária: CODCOLIGADAIDTURMADISC, IDHORARIOTURMARA e DATA


Atenção ao Formato da Data

É essencial informar a data com o formato utilizado no banco, pois o mesmo será validado na chave primaria.

Para todas as operações é necessário que sejam passadas as informações do contexto no cabeçalho da mensagem: CODCOLIGADACODFILIAL, CODTIPOCURSO CODSISTEMA.


Retornando uma lista de frequência diária:

Para a consulta de uma lista de frequência diárias, é necessário a utilização da URL:

HTTP://<SERVIDOR>:<HTTPORT>/rmsrestdataserver/rest/EduFrequenciaDiariaWSData


É possível, nessa consulta, utilizar filtros para a limitação da quantidade de informações retornadas e, também, para restringir o resultado.

Através do link Serviço GetAll é possível obter mais informações de como utilizar o serviço.


Para a utilização do GetAll na frequência diária, é necessário que um filtro seja informado, porém, apesar de termos uma flexibilidade nesse serviço, ele dataserver permite a utilização de apenas um filtro.

Para isso, é necessário que seja informado um parâmetro "filter" para a inclusão do filtro: 


Filtro para pesquisa de período de frequências da etapa de uma turma/disciplina em um determinado período:

["CODCOLIGADA = :CODCOLIGADA AND IDTURMADISC = :IDTURMADISC AND CODETAPA = :CODETAPA AND DATA = :DATAINI AND DATA = :DATAFIM", "1", "1055", "1", "30/09/2018","20/10/2018"] 


Filtro para pesquisa de período de frequências da etapa de uma subturma de uma turma/disciplina em um determinado período:

["CODCOLIGADA = :CODCOLIGADA AND IDTURMADISC = :IDTURMADISC AND CODETAPA = :CODETAPA AND DATA = :DATAINI AND DATA = :DATAFIM AND CODSUBTURMA = :CODSUBTURMA", "1", "1055", "1", "10/12/2018","10/12/2018","123"]



Mensagem de resposta
{
   "messages": [],
   "length": 6,
   "data":    [
            {
         "id": "",
         "CODCOLIGADA": 1,
         "IDTURMADISC": 1055,
         "IDHORARIOTURMA": 295,
         "RA": "0000107",
         "DATA": "2018-10-01T00:00:00-03:00",
         "PRESENCA": "A",
         "IDJUSTIFICATIVAFALTA": null,
         "JUSTIFICADA": null,
         "IDHORARIOTURMAGER": 295
      },
            {
         "id": "",
         "CODCOLIGADA": 1,
         "IDTURMADISC": 1055,
         "IDHORARIOTURMA": 295,
         "RA": "0000107",
         "DATA": "2018-10-08T00:00:00-03:00",
         "PRESENCA": "A",
         "IDJUSTIFICATIVAFALTA": null,
         "JUSTIFICADA": null,
         "IDHORARIOTURMAGER": 295
      },
            {
         "id": "",
         "CODCOLIGADA": 1,
         "IDTURMADISC": 1055,
         "IDHORARIOTURMA": 295,
         "RA": "0000107",
         "DATA": "2018-10-15T00:00:00-03:00",
         "PRESENCA": "A",
         "IDJUSTIFICATIVAFALTA": null,
         "JUSTIFICADA": null,
         "IDHORARIOTURMAGER": 295
      },
            {
         "id": "",
         "CODCOLIGADA": 1,
         "IDTURMADISC": 1055,
         "IDHORARIOTURMA": 295,
         "RA": "0000112",
         "DATA": "2018-10-01T00:00:00-03:00",
         "PRESENCA": "A",
         "IDJUSTIFICATIVAFALTA": null,
         "JUSTIFICADA": null,
         "IDHORARIOTURMAGER": 295
      },
            {
         "id": "",
         "CODCOLIGADA": 1,
         "IDTURMADISC": 1055,
         "IDHORARIOTURMA": 295,
         "RA": "0000112",
         "DATA": "2018-10-08T00:00:00-03:00",
         "PRESENCA": "A",
         "IDJUSTIFICATIVAFALTA": null,
         "JUSTIFICADA": null,
         "IDHORARIOTURMAGER": 295
      },
            {
         "id": "",
         "CODCOLIGADA": 1,
         "IDTURMADISC": 1055,
         "IDHORARIOTURMA": 295,
         "RA": "0000112",
         "DATA": "2018-10-22T00:00:00-03:00",
         "PRESENCA": "A",
         "IDJUSTIFICATIVAFALTA": null,
         "JUSTIFICADA": null,
         "IDHORARIOTURMAGER": 295
      }
   ]
}


Retornando apenas a frequência diária de um aluno:

Para realizar a consulta da frequência diária de um aluno, será necessária a utilização dos valores de chave primária da frequência diária.


Exemplo:

http://localhost:8051/rmsrestdataserver/rest/EduFrequenciaDiariaWSData/1$_$295$_$1055$_$0000112$_$2018-10-22T00:00:00


O valor informado no final da URL "1$_$295$_$1055$_$0000112$_$2018-10-22T00:00:00" se referem aos valores da coligada, id. do horário da turma, id. da turma/disciplina, do RA do aluno e a data da frequência.

Esse valores são separados pelos caracteres "$" e "_".

Para a realização dessa requisição, deverá ser utilizado o método: GET.


Mensagem de resposta
{
   "messages": [],
   "length": 1,
   "data":    {
      "id": "1$_$295$_$1055$_$0000112$_$2018-10-22T00:00:00",
      "CODCOLIGADA": 1,
      "IDHORARIOTURMA": 295,
      "IDTURMADISC": 1055,
      "RA": "0000112",
      "DATA": "2018-10-22T00:00:00-03:00",
      "PRESENCA": "A",
      "JUSTIFICADA": null,
      "IDJUSTIFICATIVAFALTA": null
   }
}

CADASTRO

Inclusão de uma falta na frequência diária:

Para realizar a inclusão de uma falta na frequência é necessário que sejam passados, entre um conjunto de chaves, todos os campos que serão inseridos e no cabeçalho da mensagem deverão ser incluídos os campos CODCOLIGADA, CODFILIAL, CODTIPOCURSO e CODSISTEMA para criação do contexto em que a frequência diária será incluso.


URL que será utilizada para cadastro da frequência: http://localhost:8051/rmsrestdataserver/rest/EduFrequenciaDiariaWSData

Para a realização dessa requisição, deverá ser utilizado o método: POST.


Segue o exemplo de um conjunto mínimo de informações necessárias para o lançamento de uma frequência de um aluno:

É necessário que sejam informadas as tabelas "AlunosFreq" e "PARAMS" na inclusão de frequências.

Corpo da mensagem
{
      "CODCOLIGADA": 1,
      "IDTURMADISC": 1055,
      "IDHORARIOTURMA": 295,
      "RA": "0000112",
      "PRESENCA": "A",
      "DATA": "2018-10-29T00:00:00",
      "AlunosFreq": [      {
         "CODCOLIGADA": 1,
         "RA": "0000112",
         "IDTURMADISC": 1055
      }],
	  "PARAMS": [      {
         "CODCOLIGADA": 1,
         "IDTURMADISC": 1055,
         "CODETAPA": 1,
         "AULASDADAS": "1"
      }]
}		 


Exemplo da resposta:

Mensagem de resposta
{
   "messages": [],
   "length": 1,
   "data":    {
      "id": "1$_$295$_$1055$_$0000112$_$15/10/2018 00:00:00",
      "CODCOLIGADA": 1,
      "IDHORARIOTURMA": 295,
      "IDTURMADISC": 1055,
      "RA": "0000112",
      "DATA": "2018-10-15T00:00:00-03:00",
      "PRESENCA": "A",
      "JUSTIFICADA": null,
      "IDJUSTIFICATIVAFALTA": null
   }
}
Importante

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.

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": 1

"IDJUSTIFICATIVAFALTA": 2

Alterações

Atualizando a frequência diária de um aluno:


Para realizar a atualização de uma frequência é necessário que sejam passados, entre um conjunto de chaves, todos os campos que serão alterados.

No cabeçalho da mensagem, também, deverão ser incluídos os campos CODCOLIGADACODFILIAL, CODTIPOCURSO CODSISTEMA para criação do contexto.


URL que será utilizada para a atualização da frequência: http://localhost:8051/rmsrestdataserver/rest/EduFrequenciaDiariaWSData/1$_$295$_$1055$_$0000112$_$2018-10-15T00:00:00

Esse código "1$_$295$_$1055$_$0000112$_$2018-10-15T00:00:00" é soma dos valores que compõem a chave da frequência diária: CODCOLIGADAIDHORARIOTURMAIDTURMADISCRA e DATA


Para a realização dessa requisição, deverá ser utilizado o método: PUT.

Segue o exemplo de um conjunto de informações que serão alteradas:

Corpo da mensagem
{	
      "CODCOLIGADA": 1,
      "IDTURMADISC": 1055,
      "IDHORARIOTURMA": 295,
      "RA": "0000112",
      "PRESENCA": "P",
      "DATA": "2018-10-15T00:00:00",      
      "AlunosFreq": [      {
         "CODCOLIGADA": 1,
         "RA": "0000112",
         "IDTURMADISC": 1055
      }],
	  "PARAMS": [      {
         "CODCOLIGADA": 1,
         "IDTURMADISC": 1055,
         "CODETAPA": 1,
         "AULASDADAS": "1"
      }]
}

Importante

No corpo da mensagem é de suma importância informar os campos CODCOLIGADA, IDTURMADISC, IDHORARIOTURMA, RA, DATA e as tabelas AlunosFreq e PARAMS com os mesmos valores.


Exemplo da resposta:

Mensagem de resposta
{
   "messages": [],
   "length": 1,
   "data": null
}

Exclusões

Não é possível utilizar o DeleteRecord do dataserver EduFrequenciaDiariaWSData.

Se for remover frequência do(s) aluno(s) utilize o SaveRecord, via SOAP, ou a operação de PUT informando na tag "PRESENCA" igual o valor "P".