Linha RM

Atalhos

Páginas filhas
  • Avaliação da Etapa da Turma Disciplina(Rest)

Visão geral

Através do serviço RMSRestDataServer, via RESTful, o usuário poderá acessar o dataserver de Avaliação (EduprovasData) para a realização de requisições de consulta, inclusão, alteração ou exclusão de dados.  

Essas requisições são disponibilizadas através dos métodos: GET, PUT, POST e DELETE 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 Avaliação ou de uma lista de Avaliações de uma Etapa da Turma Disciplina.

Para a requisição de informações de uma Avaliação será necessário passar os valores da chave primária: CODCOLIGADA , IDTURMADISC, CODETAPA, TIPOETAPA e CODPROVA. 

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

Retornando uma lista e uma Avaliação:

Para a consulta de uma lista de Avaliações, é necessário a utilização da URL:

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


É 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 os filtros disponíveis.

Exemplo: 

http://localhost:8051/rmsrestdataserver/rest/EduprovasData?start=3&limit=2


Mensagem de resposta 
{
   "messages": [],
   "length": 49424,
   "data":    [
            {
         "id": "1$_$2081$_$1$_$N$_$1",
         "CODCOLIGADA": 1,
         "IDTURMADISC": 2081,
         "CODETAPA": 1,
         "TIPOETAPA": "N",
         "DESCETAPA": "T1",
         "CODPROVA": 1,
         "DESCRICAO": "P1",
         "VALOR": 10,
         "DTPREVISTA": null,
         "DTPROVA": null,
         "MEDIA": null,
         "NUMQUESTOES": null,
         "CODPROVATESTIS": null,
         "DTDEVOLUCAOAVALIACAO": null,
         "DTLIMITEENTREGAAVAL": null,
         "PERMITEENTREGAWEB": "N",
         "DISPONIVELALUNOS": "N",
         "DISPTODASSUBTURMAS": "S",
         "IDOUTLOOKLIVE": null,
         "IDTURMADISCANTIGA": null,
         "DISCIPLINA": null
      },
            {
         "id": "1$_$1926$_$1$_$N$_$1",
         "CODCOLIGADA": 1,
         "IDTURMADISC": 1926,
         "CODETAPA": 1,
         "TIPOETAPA": "N",
         "DESCETAPA": "T1",
         "CODPROVA": 1,
         "DESCRICAO": "P1",
         "VALOR": 10,
         "DTPREVISTA": null,
         "DTPROVA": null,
         "MEDIA": null,
         "NUMQUESTOES": null,
         "CODPROVATESTIS": null,
         "DTDEVOLUCAOAVALIACAO": null,
         "DTLIMITEENTREGAAVAL": null,
         "PERMITEENTREGAWEB": "N",
         "DISPONIVELALUNOS": "N",
         "DISPTODASSUBTURMAS": "S",
         "IDOUTLOOKLIVE": null,
         "IDTURMADISCANTIGA": null,
         "DISCIPLINA": null
      }
   ]
}


Retornando apenas uma Avaliação:

Para realizar a consulta de um Avaliação, será necessário a utilização dos valores de chave primária de Avaliações (Sprovas)


Exemplo:

http://localhost:8051/rmsrestdataserver/rest/Eduprovasdata/1$_$4385$_$1$_$N$_$1


O valor informado no final da URL "1$_$4385$_$1$_$N$_$1" se refere aos valores da coligada,  o código da coligada, o código da Turma Disciplina, o código da Etapa, tipo da Etapa e o código da Prova da Avaliação

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

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


CADASTRO

Cadastrando uma Avaliação na Etapa de uma Turma Disciplina:


Para realizar o cadastro de uma Avaliação é 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 , IDTURMADISC, CODETAPA, TIPOETAPA e CODPROVA para criação do contexto em que a Avaliação será inclusa.


URL que será utilizada para cadastro da Etapa da turma Disciplina: http://localhost:8051/rmsrestdataserver/rest/EduprovasData

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 cadastro de uma Avaliação.

Corpo da mensagem 
{
         "CODCOLIGADA": 1,
         "IDTURMADISC": 4388,
         "CODETAPA": 1,
         "TIPOETAPA": "N",
         "DESCETAPA": "T1",
         "CODPROVA": 2,
         "DESCRICAO": "P1",
         "VALOR": 10,
         "DTPREVISTA": null,
         "DTPROVA": null,
         "MEDIA": null,
         "NUMQUESTOES": null,
         "CODPROVATESTIS": null,
         "DTDEVOLUCAOAVALIACAO": null,
         "DTLIMITEENTREGAAVAL": null,
         "PERMITEENTREGAWEB": "N",
         "DISPONIVELALUNOS": "N",
         "DISPTODASSUBTURMAS": "S",
         "IDOUTLOOKLIVE": null,
         "IDTURMADISCANTIGA": null,
         "DISCIPLINA": null
      }

Importante

A obrigatoriedade dos campos pode variar de acordo com a parametrização realizada no sistema.

Caso esteja utilizando a aplicação SoapUI, as informações do cabeçalho podem ser informadas conforme abaixo:


Preenchendo o Cabeçalho para o Post

Informe os campos do contexto: CODCOLIGADA, CODFILIAL, CODTIPOCURSO e CODSISTEMA

Mensagem de resposta 
{
   "messages": [],
   "length": 1,
   "data":    {
      "id": "1$_$4388$_$1$_$N$_$2",
      "CODCOLIGADA": 1,
      "IDTURMADISC": 4388,
      "CODETAPA": 1,
      "TIPOETAPA": "N",
      "CODPROVA": 2,
      "DESCRICAO": "P1",
      "VALOR": 10,
      "DTPREVISTA": null,
      "DTPROVA": null,
      "MEDIA": null,
      "NUMQUESTOES": null,
      "CODPROVATESTIS": null,
      "DESCETAPA": "T1",
      "DTDEVOLUCAOAVALIACAO": null,
      "IDOUTLOOKLIVE": null,
      "DTLIMITEENTREGAAVAL": null,
      "PERMITEENTREGAWEB": "N",
      "DISPONIVELALUNOS": "N",
      "IDTURMADISCANTIGA": null,
      "DISPTODASSUBTURMAS": "S",
      "DISCIPLINA": null,
      "SProvasCompl": [],
      "SPROVASSUBTURMA": []
   }
}

Alterações

Atualizando informações a Avaliação de uma Etapa da turma 


Para realizar a atualização de cadastro de uma Avaliação é necessário que sejam passados, entre um conjunto de chaves, todos os campos que serão alterados, assim como, a tag ID que informará qual Avaliação que será alterada.

No cabeçalho da mensagem, também, deverão ser incluídos os campos CODCOLIGADA, CODFILIAL, CODTIPOCURSO e CODSISTEMA para criação do contexto em que a Avaliação será incluso.


URL que será utilizada para cadastro da Avaliação: http://localhost:8051/rmsrestdataserver/rest/EduprovasData/1$_$4388$_$1$_$N$_$3

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


Segue o exemplo de um conjunto de informações de uma Atividade que serão alterados:

Corpo da mensagem 
{
"CODCOLIGADA": 1,
      "IDTURMADISC": 4388,
      "CODETAPA": 1,
      "TIPOETAPA": "N",
      "CODPROVA": 3,
      "DESCRICAO": "P1",
      "VALOR": 5,
      "DTPREVISTA": null,
      "DTPROVA": null,
      "MEDIA": null,
      "NUMQUESTOES": null,
      "CODPROVATESTIS": null,
      "DESCETAPA": "T1",
      "DTDEVOLUCAOAVALIACAO": null,
      "IDOUTLOOKLIVE": null,
      "DTLIMITEENTREGAAVAL": null,
      "PERMITEENTREGAWEB": "N",
      "DISPONIVELALUNOS": "N",
      "IDTURMADISCANTIGA": null,
      "DISPTODASSUBTURMAS": "S",
      "DISCIPLINA": null,
      "SProvasCompl": [],
      "SPROVASSUBTURMA": []
   }

Importante

No corpo da mensagem é de suma importância informar os campos CODCOLIGADA, CODFILIAL, CODTIPOCURSO e  CODSISTEMA.

Exemplo da resposta:

Mensagem de resposta 
{
   "messages": [],
   "length": 1,
   "data":    {
      "id": "1$_$4388$_$1$_$N$_$3",
      "CODCOLIGADA": 1,
      "IDTURMADISC": 4388,
      "CODETAPA": 1,
      "TIPOETAPA": "N",
      "CODPROVA": 3,
      "DESCRICAO": "P1",
      "VALOR": 5,
      "DTPREVISTA": null,
      "DTPROVA": null,
      "MEDIA": null,
      "NUMQUESTOES": null,
      "CODPROVATESTIS": null,
      "DESCETAPA": "T1",
      "DTDEVOLUCAOAVALIACAO": null,
      "IDOUTLOOKLIVE": null,
      "DTLIMITEENTREGAAVAL": null,
      "PERMITEENTREGAWEB": "N",
      "DISPONIVELALUNOS": "N",
      "IDTURMADISCANTIGA": null,
      "DISPTODASSUBTURMAS": "S",
      "DISCIPLINA": null,
      "SProvasCompl": [      {
         "id": "1$_$4388$_$1$_$N$_$3",
         "parent_id": "1$_$4388$_$1$_$N$_$3",
         "CODCOLIGADA": 1,
         "IDTURMADISC": 4388,
         "CODETAPA": 1,
         "TIPOETAPA": "N",
         "CODPROVA": 3,
         "BJCODAVA": null,
         "BJPESAVA": null
      }],
      "SPROVASSUBTURMA": []
   }
}


Exclusões

Excluindo uma Atividades de uma Etapa.

A exclusão de uma Atividade seguirá a mesma ideia da alteração, onde precisaremos passar as chaves da Atividade a ser excluído, assim como o corpo da mensagem com suas informações.

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


URL que será utilizada para cadastro da Atividade de uma Etapa: http://localhost:8051/rmsrestdataserver/rest/EduHabilitacaoData/1$_$4388$_$1$_$N$_$3

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


Segue o exemplo de um conjunto de informações de uma Avaliação que será deletado.

Corpo da mensagem 
 {
"CODCOLIGADA": 1,
      "IDTURMADISC": 4388,
      "CODETAPA": 1,
      "TIPOETAPA": "N",
      "CODPROVA": 3,
      "DESCRICAO": "P1",
      "VALOR": 5,
      "DTPREVISTA": null,
      "DTPROVA": null,
      "MEDIA": null,
      "NUMQUESTOES": null,
      "CODPROVATESTIS": null,
      "DESCETAPA": "T1",
      "DTDEVOLUCAOAVALIACAO": null,
      "IDOUTLOOKLIVE": null,
      "DTLIMITEENTREGAAVAL": null,
      "PERMITEENTREGAWEB": "N",
      "DISPONIVELALUNOS": "N",
      "IDTURMADISCANTIGA": null,
      "DISPTODASSUBTURMAS": "S",
      "DISCIPLINA": null,
      "SProvasCompl": [],
      "SPROVASSUBTURMA": []
   }

Resposta da mensagem:

Mensagem de resposta 
{
   "messages": [],
   "length": 1,
   "data":    {
      "id": "1$_$4388$_$1$_$N$_$3",
      "CODCOLIGADA": 1,
      "IDTURMADISC": 4388,
      "CODETAPA": 1,
      "TIPOETAPA": "N",
      "CODPROVA": 3,
      "DESCRICAO": "P1",
      "VALOR": 5,
      "DTPREVISTA": null,
      "DTPROVA": null,
      "MEDIA": null,
      "NUMQUESTOES": null,
      "CODPROVATESTIS": null,
      "DESCETAPA": "Notas",
      "DTDEVOLUCAOAVALIACAO": null,
      "IDOUTLOOKLIVE": null,
      "DTLIMITEENTREGAAVAL": null,
      "PERMITEENTREGAWEB": "N",
      "DISPONIVELALUNOS": "N",
      "IDTURMADISCANTIGA": null,
      "DISPTODASSUBTURMAS": "S",
      "DISCIPLINA": null,
      "SProvasCompl": [      {
         "id": "1$_$4388$_$1$_$N$_$3",
         "parent_id": "1$_$4388$_$1$_$N$_$3",
         "CODCOLIGADA": 1,
         "IDTURMADISC": 4388,
         "CODETAPA": 1,
         "TIPOETAPA": "N",
         "CODPROVA": 3,
         "BJCODAVA": null,
         "BJPESAVA": null
      }],
      "SPROVASSUBTURMA": []
   }
}