Visão geral
Através do serviço RMSRestDataServer, via RESTful, o usuário poderá acessar o dataserver de Turma (EduTurmaData) 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.
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 Turma ou de uma lista de Turmas.
Para a requisição de informações de uma Turma será necessário passar os valores da chave primária da Turma: CODCOLIGADA, CODFILIAL, IDPERLET e CODTURMA.
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 Turmas:
Para a consulta de uma lista de Turmas, é necessário a utilização da URL:
HTTP://<SERVIDOR>:<HTTPORT>/rmsrestdataserver/rest/EduTurmaData
É 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/EduTurmaData?start=3&limit=2
{
"messages": [],
"length": 712,
"data": [
{
"id": "1$_$2$_$18$_$EF4C",
"CODPERLET": "2017",
"DTINICIOPLETIVO": "2016-12-01T00:00:00-02:00",
"CODTURMA": "EF4C",
"NOMERED": "EF4C",
"NOME": "4ª série C",
"CODCURSO": "B04",
"NOMECURSO": "Ensino Fundamental",
"CODHABILITACAO": "4",
"NOMEHABILITACAO": "4ª Série",
"CODGRADE": "EF4",
"DESCGRADE": "Ensino Fundamental 4ª Série",
"TURNO": "07h20/11h45 4",
"NOMEDEPTO": null,
"CCUSTO": "ENS.FUND.9 ANOS 4ª SÉRIE 9/C",
"FORMULA": null,
"CODCOLIGADA": 1,
"CODFILIAL": 2,
"IDPERLET": 18,
"IDHABILITACAOFILIAL": 64,
"CODDEPARTAMENTO": null,
"CODPREDIO": null,
"CODBLOCO": null,
"CODSALA": null,
"CODCCUSTO": "1.1.01.004.024",
"APLICACAO": null,
"CODFORMULA": null,
"MAXALUNOS": 31,
"DTINICIAL": "2017-02-08T00:00:00-02:00",
"DTFINAL": "2017-12-15T00:00:00-02:00",
"ALUNOSLABORE": null,
"DTALUNOSLABORE": null,
"CODTIPOCURSO": 1,
"CODTURMAPROX": null,
"CODCAMPUS": null,
"CONTROLEVAGAS": "0",
"TIPOMEDIACAO": 1,
"MODALIDADE": 1,
"IDUNIDADEPONTO": null,
"IDCLASSEVALORPROTHEUS": null,
"IDITEMCONTABILPROTHEUS": null,
"CODHORARIOAGRUPURANIA": null,
"TURMAENCERRADA": null
},
{
"id": "1$_$2$_$18$_$EF4D",
"CODPERLET": "2017",
"DTINICIOPLETIVO": "2016-12-01T00:00:00-02:00",
"CODTURMA": "EF4D",
"NOMERED": "EF4D",
"NOME": "4ª série D",
"CODCURSO": "B04",
"NOMECURSO": "Ensino Fundamental",
"CODHABILITACAO": "4",
"NOMEHABILITACAO": "4ª Série",
"CODGRADE": "EF4",
"DESCGRADE": "Ensino Fundamental 4ª Série",
"TURNO": "07h20/11h45 4",
"NOMEDEPTO": null,
"CCUSTO": "ENS.FUND.9 ANOS 4ª SÉRIE 9/D",
"FORMULA": null,
"CODCOLIGADA": 1,
"CODFILIAL": 2,
"IDPERLET": 18,
"IDHABILITACAOFILIAL": 64,
"CODDEPARTAMENTO": null,
"CODPREDIO": null,
"CODBLOCO": null,
"CODSALA": null,
"CODCCUSTO": "1.1.01.004.025",
"APLICACAO": null,
"CODFORMULA": null,
"MAXALUNOS": 31,
"DTINICIAL": "2017-02-08T00:00:00-02:00",
"DTFINAL": "2017-12-15T00:00:00-02:00",
"ALUNOSLABORE": null,
"DTALUNOSLABORE": null,
"CODTIPOCURSO": 1,
"CODTURMAPROX": null,
"CODCAMPUS": null,
"CONTROLEVAGAS": "0",
"TIPOMEDIACAO": 1,
"MODALIDADE": 1,
"IDUNIDADEPONTO": null,
"IDCLASSEVALORPROTHEUS": null,
"IDITEMCONTABILPROTHEUS": null,
"CODHORARIOAGRUPURANIA": null,
"TURMAENCERRADA": null
}
]
}
Retornando apenas uma Turma:
Para realizar a consulta de uma Turma, será necessário a utilização dos valores de chave primária da Turma:
Exemplo:
http://localhost:8051/rmsrestdataserver/rest/EduTurmaData/1$_$2$_$18$_$EF4C
O valor informado no final da URL "1$_$2$_$18$_$EF4C" se refere aos valores da Coligada, Filial, Id do Periodo Letivo e Código da Turma.
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 Turma:
Para realizar o cadastro de uma turma é 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 o Turma será incluso.
URL que será utilizada para cadastro do turma: http://localhost:8051/rmsrestdataserver/rest/EduTurmaData
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 Turma:
{
"CODCOLIGADA": 1,
"CODFILIAL": 2,
"IDPERLET": 18,
"CODTURMA": "EF12C",
"IDHABILITACAOFILIAL": 64,
"CODDEPARTAMENTO": null,
"CODPREDIO": null,
"CODSALA": null,
"CODCCUSTO": "1.1.01.004.024",
"APLICACAO": null,
"CODFORMULA": null,
"NOMERED": "EF12C",
"NOME": "12 série C",
"MAXALUNOS": 31,
"DTINICIAL": "2017-02-08T00:00:00-02:00",
"DTFINAL": "2017-12-15T00:00:00-02:00",
"ALUNOSLABORE": null,
"DTALUNOSLABORE": null,
"CODTIPOCURSO": 1,
"CODTURMAPROX": null,
"TURMAENCERRADA": null,
"CODCURSO": "B04",
"CODHABILITACAO": "4",
"CODGRADE": "EF4",
"CODBLOCO": null,
"CODCAMPUS": null,
"TIPOMEDIACAO": 1,
"MODALIDADE": 1,
"CODPERLET": "2017",
"IDUNIDADEPONTO": null,
"IDCLASSEVALORPROTHEUS": null,
"IDITEMCONTABILPROTHEUS": null,
"CODHORARIOAGRUPURANIA": null,
"DTINICIOPLETIVO": "2016-12-01T00:00:00-02:00",
"TURNO": "07h20/11h45 4",
"NOMEDEPTO": null,
"FORMULA": null,
"CONTROLEVAGAS": "0"
}
Caso esteja utilizando a aplicação SoapUI, as informações do cabeçalho podem ser informadas conforme abaixo:
{
"messages": [],
"length": 1,
"data": {
"id": "1$_$2$_$18$_$EF12C",
"CODCOLIGADA": 1,
"CODFILIAL": 2,
"IDPERLET": 18,
"CODTURMA": "EF12C",
"IDHABILITACAOFILIAL": 64,
"CODDEPARTAMENTO": null,
"CODPREDIO": null,
"CODSALA": null,
"CODCCUSTO": "1.1.01.004.024",
"APLICACAO": null,
"CODFORMULA": null,
"NOMERED": "EF12C",
"NOME": "12 série C",
"MAXALUNOS": 31,
"DTINICIAL": "2017-02-08T00:00:00-02:00",
"DTFINAL": "2017-12-15T00:00:00-02:00",
"ALUNOSLABORE": null,
"DTALUNOSLABORE": null,
"CODTIPOCURSO": 1,
"CODTURMAPROX": null,
"TURMAENCERRADA": "N",
"CODCURSO": "B04",
"CODHABILITACAO": "4",
"CODGRADE": "EF4",
"CODBLOCO": null,
"CODCAMPUS": null,
"TIPOMEDIACAO": 1,
"MODALIDADE": 1,
"CODPERLET": "2017",
"IDUNIDADEPONTO": null,
"IDCLASSEVALORPROTHEUS": null,
"IDITEMCONTABILPROTHEUS": null,
"CODHORARIOAGRUPURANIA": null,
"DTINICIOPLETIVO": "2016-12-01T00:00:00-02:00",
"NOMECURSO": null,
"NOMEHABILITACAO": null,
"DESCGRADE": null,
"TURNO": null,
"NOMEDEPTO": null,
"CCUSTO": null,
"FORMULA": null,
"CONTROLEVAGAS": null,
"STURMACOMPL": []
}
}
Alterações
Para realizar a atualização de cadastro de uma Turma é 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 CODCOLIGADA, CODFILIAL, CODTIPOCURSO e CODSISTEMA para criação do contexto em que a Turma será inclusa.
URL que será utilizada para cadastro da turma: http://localhost:8051/rmsrestdataserver/rest/EduTurmaData//1$_$2$_$18$_$EF12C
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 Turma que serão alteradas:
{
"CODCOLIGADA": 1,
"CODFILIAL": 2,
"IDPERLET": 18,
"CODTURMA": "EF12C",
"IDHABILITACAOFILIAL": 64,
"CODDEPARTAMENTO": null,
"CODPREDIO": null,
"CODSALA": null,
"CODCCUSTO": "1.1.01.004.024",
"APLICACAO": null,
"CODFORMULA": null,
"NOMERED": "EF12J",
"NOME": "12 serie J",
"MAXALUNOS": 31,
"DTINICIAL": "2017-02-08T00:00:00-02:00",
"DTFINAL": "2017-12-15T00:00:00-02:00",
"ALUNOSLABORE": null,
"DTALUNOSLABORE": null,
"CODTIPOCURSO": 1,
"CODTURMAPROX": null,
"TURMAENCERRADA": null,
"CODCURSO": "B04",
"CODHABILITACAO": "4",
"CODGRADE": "EF4",
"CODBLOCO": null,
"CODCAMPUS": null,
"TIPOMEDIACAO": 1,
"MODALIDADE": 1,
"CODPERLET": "2017",
"IDUNIDADEPONTO": null,
"IDCLASSEVALORPROTHEUS": null,
"IDITEMCONTABILPROTHEUS": null,
"CODHORARIOAGRUPURANIA": null,
"DTINICIOPLETIVO": "2016-12-01T00:00:00-02:00",
"TURNO": "07h20/11h45 4",
"NOMEDEPTO": null,
"FORMULA": null,
"CONTROLEVAGAS": "0"
}
Exemplo da resposta:
{
"messages": [],
"length": 1,
"data": {
"id": "1$_$2$_$18$_$EF12C",
"CODCOLIGADA": 1,
"CODFILIAL": 2,
"IDPERLET": 18,
"CODTURMA": "EF12C",
"IDHABILITACAOFILIAL": 64,
"CODDEPARTAMENTO": null,
"CODPREDIO": null,
"CODSALA": null,
"CODCCUSTO": "1.1.01.004.024",
"APLICACAO": null,
"CODFORMULA": null,
"NOMERED": "EF12J",
"NOME": "12 serie J",
"MAXALUNOS": 31,
"DTINICIAL": "2017-02-08T00:00:00-02:00",
"DTFINAL": "2017-12-15T00:00:00-02:00",
"ALUNOSLABORE": null,
"DTALUNOSLABORE": null,
"CODTIPOCURSO": 1,
"CODTURMAPROX": null,
"TURMAENCERRADA": "N",
"CODCURSO": "B04",
"CODHABILITACAO": "4",
"CODGRADE": "EF4",
"CODBLOCO": null,
"CODCAMPUS": null,
"TIPOMEDIACAO": 1,
"MODALIDADE": 1,
"CODPERLET": "2017",
"IDUNIDADEPONTO": null,
"IDCLASSEVALORPROTHEUS": null,
"IDITEMCONTABILPROTHEUS": null,
"CODHORARIOAGRUPURANIA": null,
"DTINICIOPLETIVO": "2016-12-01T00:00:00-02:00",
"NOMECURSO": "Ensino Fundamental",
"NOMEHABILITACAO": "4ª Série",
"DESCGRADE": "Ensino Fundamental 4ª Série",
"TURNO": "07h20/11h45 4",
"NOMEDEPTO": null,
"CCUSTO": "ENS.FUND.9 ANOS 4ª SÉRIE 9/C",
"FORMULA": null,
"CONTROLEVAGAS": "0",
"STURMACOMPL": [ {
"id": "1$_$2$_$18$_$EF12C",
"parent_id": "1$_$2$_$18$_$EF12C",
"CODCOLIGADA": 1,
"CODFILIAL": 2,
"IDPERLET": 18,
"CODTURMA": "EF12C"
}]
}
}
Exclusões
Excluindo uma Turma:
A exclusão de uma Turma seguirá a mesma ideia da alteração, onde precisaremos passar as chaves da Turma a ser excluída, 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 do Curso: http://localhost:8051/rmsrestdataserver/rest/EduTurmaData/1$_$2$_$18$_$EF12C
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 Turma que serão alteradas:
{
"CODCOLIGADA": 1,
"CODFILIAL": 2,
"IDPERLET": 18,
"CODTURMA": "EF12C",
"IDHABILITACAOFILIAL": 64,
"CODDEPARTAMENTO": null,
"CODPREDIO": null,
"CODSALA": null,
"CODCCUSTO": "1.1.01.004.024",
"APLICACAO": null,
"CODFORMULA": null,
"NOMERED": "EF12J",
"NOME": "12 serie J",
"MAXALUNOS": 31,
"DTINICIAL": "2017-02-08T00:00:00-02:00",
"DTFINAL": "2017-12-15T00:00:00-02:00",
"ALUNOSLABORE": null,
"DTALUNOSLABORE": null,
"CODTIPOCURSO": 1,
"CODTURMAPROX": null,
"TURMAENCERRADA": null,
"CODCURSO": "B04",
"CODHABILITACAO": "4",
"CODGRADE": "EF4",
"CODBLOCO": null,
"CODCAMPUS": null,
"TIPOMEDIACAO": 1,
"MODALIDADE": 1,
"CODPERLET": "2017",
"IDUNIDADEPONTO": null,
"IDCLASSEVALORPROTHEUS": null,
"IDITEMCONTABILPROTHEUS": null,
"CODHORARIOAGRUPURANIA": null,
"DTINICIOPLETIVO": "2016-12-01T00:00:00-02:00",
"TURNO": "07h20/11h45 4",
"NOMEDEPTO": null,
"FORMULA": null,
"CONTROLEVAGAS": "0"
}
Resposta da mensagem:
{
"messages": [],
"length": 1,
"data": {
"id": "1$_$2$_$18$_$EF12C",
"CODCOLIGADA": 1,
"CODFILIAL": 2,
"IDPERLET": 18,
"CODTURMA": "EF12C",
"IDHABILITACAOFILIAL": 64,
"CODDEPARTAMENTO": null,
"CODPREDIO": null,
"CODSALA": null,
"CODCCUSTO": "1.1.01.004.024",
"APLICACAO": null,
"CODFORMULA": null,
"NOMERED": "EF12J",
"NOME": "12 serie J",
"MAXALUNOS": 31,
"DTINICIAL": "2017-02-08T00:00:00-02:00",
"DTFINAL": "2017-12-15T00:00:00-02:00",
"ALUNOSLABORE": null,
"DTALUNOSLABORE": null,
"CODTIPOCURSO": 1,
"CODTURMAPROX": null,
"TURMAENCERRADA": null,
"CODCURSO": "B04",
"CODHABILITACAO": "4",
"CODGRADE": "EF4",
"CODBLOCO": null,
"CODCAMPUS": null,
"TIPOMEDIACAO": 1,
"MODALIDADE": 1,
"CODPERLET": "2017",
"IDUNIDADEPONTO": null,
"IDCLASSEVALORPROTHEUS": null,
"IDITEMCONTABILPROTHEUS": null,
"CODHORARIOAGRUPURANIA": null,
"DTINICIOPLETIVO": "2016-12-01T00:00:00-02:00",
"NOMECURSO": "Ensino Fundamental",
"NOMEHABILITACAO": "4ª Série",
"DESCGRADE": "Ensino Fundamental 4ª Série",
"TURNO": "07h20/11h45 4",
"NOMEDEPTO": null,
"CCUSTO": "ENS.FUND.9 ANOS 4ª SÉRIE 9/C",
"FORMULA": null,
"CONTROLEVAGAS": "0",
"STURMACOMPL": [ {
"id": "1$_$2$_$18$_$EF12C",
"parent_id": "1$_$2$_$18$_$EF12C",
"CODCOLIGADA": 1,
"CODFILIAL": 2,
"IDPERLET": 18,
"CODTURMA": "EF12C"
}]
}
}