Visão geral
Através do serviço RMSRestDataServer, via RESTful, o usuário poderá acessar o dataserver de Turma/Disciplina (EduTurmaDiscData) 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/Disc ou de uma lista de Turma/Disciplinas.
Para a requisição de informações de uma Turma/Disciplina será necessário passar os valores da chave primária da Turma/Disciplina: CODCOLIGADA e IDTURMADISC.
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 Turma/Disciplina:
Para a consulta de uma lista de Turmas/Disciplinas, é necessário a utilização da URL:
HTTP://<SERVIDOR>:<HTTPORT>/rmsrestdataserver/rest/EduTurmaDiscData
É 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/EduTurmaDiscData?start=3&limit=2
{
"messages": [],
"length": 2512,
"data": [
{
"id": "1$_$2360",
"CODCOLIGADA": 1,
"CODFILIAL": 1,
"IDTURMADISC": 2360,
"IDPERLET": 16,
"CODPERLET": "2017",
"DTINICIOPLETIVO": "2017-01-01T00:00:00-02:00",
"NOME": null,
"CODTURMA": "ACALFAMED",
"CODDISC": "B0011",
"CODCAMPUS": null,
"NOMEDISC": "Língua Portuguesa E Literatura",
"CODCURSO": "B90",
"NOMECURSO": "Atividades Complementares",
"CODHABILITACAO": "3",
"NOMEHABILITACAO": "3ª série",
"CODGRADE": "ACALFAMED",
"DESCGRADE": "Atividade Complementar - ALFAMED",
"NOMETURNO": "ALFAMED",
"IDHABILITACAOFILIAL": 372,
"DTINICIAL": null,
"DTFINAL": null,
"CODSALA": null,
"CODPREDIO": null,
"CODBLOCO": null,
"TIPO": "P",
"TURNODISCIPLINA": "ALFAMED",
"ADICIONALNOTURNO": null,
"ADICIONALEXTRA": null,
"VAGASCALOUROS": null,
"NUMMAXALUNOOUTROSCURSOS": null,
"VAGASLISTAESPERA": null,
"NUMCREDITOSCOB": null,
"VALORCREDITO": null,
"DISPONIVELMATRICULA": "S",
"CODTURNO": 291,
"DTINICIOMATPRES": null,
"DTFIMMATPRES": null,
"DTINICIOMATPORTAL": null,
"DTFIMMATPORTAL": null,
"DURACAOAULA": null,
"GERENCIAL": "N",
"ATIVA": "S",
"CODTIPOCURSO": 1,
"MAXALUNOS": null,
"ALIASCOMUNIDADE": null,
"POSHIST": null,
"CODPERIODO": 3,
"RECCREATEDBY": "mestre",
"RECCREATEDON": "2017-04-11T11:09:23-03:00",
"RECMODIFIEDBY": "mestre",
"RECMODIFIEDON": "2017-04-11T11:09:23-03:00",
"CODCCUSTO": null,
"APLICACAO": null,
"CODFORMULA": null,
"CODEVENTO": null,
"CODPLANILHA": null,
"NUMAULASEM": null,
"MINALUNOS": null,
"CUSTOMEDIO": null,
"DISCOPCIONAL": null,
"PREALOCACAO": null,
"CODEVENTOFALTA": null,
"CODEVENTOATRASO": null,
"COMPLEMENTODISC": null,
"IDTURMADISCANTIGO": null,
"NUMMAXALUNOSOUTRASMTZAPLICADAS": null,
"DECIMAIS": null,
"CODTIPOCURSOPLETIVO": null
},
{
"id": "1$_$2361",
"CODCOLIGADA": 1,
"CODFILIAL": 1,
"IDTURMADISC": 2361,
"IDPERLET": 16,
"CODPERLET": "2017",
"DTINICIOPLETIVO": "2017-01-01T00:00:00-02:00",
"NOME": null,
"CODTURMA": "ACALFAMED",
"CODDISC": "B0040",
"CODCAMPUS": null,
"NOMEDISC": "Matemática",
"CODCURSO": "B90",
"NOMECURSO": "Atividades Complementares",
"CODHABILITACAO": "3",
"NOMEHABILITACAO": "3ª série",
"CODGRADE": "ACALFAMED",
"DESCGRADE": "Atividade Complementar - ALFAMED",
"NOMETURNO": "ALFAMED",
"IDHABILITACAOFILIAL": 372,
"DTINICIAL": null,
"DTFINAL": null,
"CODSALA": null,
"CODPREDIO": null,
"CODBLOCO": null,
"TIPO": "P",
"TURNODISCIPLINA": "ALFAMED",
"ADICIONALNOTURNO": null,
"ADICIONALEXTRA": null,
"VAGASCALOUROS": null,
"NUMMAXALUNOOUTROSCURSOS": null,
"VAGASLISTAESPERA": null,
"NUMCREDITOSCOB": null,
"VALORCREDITO": null,
"DISPONIVELMATRICULA": "S",
"CODTURNO": 291,
"DTINICIOMATPRES": null,
"DTFIMMATPRES": null,
"DTINICIOMATPORTAL": null,
"DTFIMMATPORTAL": null,
"DURACAOAULA": null,
"GERENCIAL": "N",
"ATIVA": "S",
"CODTIPOCURSO": 1,
"MAXALUNOS": null,
"ALIASCOMUNIDADE": null,
"POSHIST": null,
"CODPERIODO": 3,
"RECCREATEDBY": "mestre",
"RECCREATEDON": "2017-04-11T11:09:23-03:00",
"RECMODIFIEDBY": "mestre",
"RECMODIFIEDON": "2017-04-11T11:09:23-03:00",
"CODCCUSTO": null,
"APLICACAO": null,
"CODFORMULA": null,
"CODEVENTO": null,
"CODPLANILHA": null,
"NUMAULASEM": null,
"MINALUNOS": null,
"CUSTOMEDIO": null,
"DISCOPCIONAL": null,
"PREALOCACAO": null,
"CODEVENTOFALTA": null,
"CODEVENTOATRASO": null,
"COMPLEMENTODISC": null,
"IDTURMADISCANTIGO": null,
"NUMMAXALUNOSOUTRASMTZAPLICADAS": null,
"DECIMAIS": null,
"CODTIPOCURSOPLETIVO": null
}
]
}
Retornando apenas uma Turma/Disciplina:
Para realizar a consulta de uma Turma/Disciplina, será necessário a utilização dos valores de chave primária da Turma/Disciplina:
Exemplo:
http://localhost:8051/rmsrestdataserver/rest/EduTurmaDiscData/1$_$2944
O valor informado no final da URL "1$_$2944" se refere aos valores da Coligada e Id da Turma/Disciplina.
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/Disciplina:
Para realizar o cadastro de uma turma/Disciplina é 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/Disciplina será inclusa.
URL que será utilizada para cadastro da turma/Disciplina: http://localhost:8051/rmsrestdataserver/rest/EduTurmaDiscData
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/Disciplina:
{
"CODCOLIGADA": 1,
"IDTURMADISC": 0,
"CODFILIAL": 2,
"CODTURMA": "EF12C",
"IDPERLET": 18,
"CODDISC": "B0057",
"CODCCUSTO": null,
"APLICACAO": null,
"CODFORMULA": null,
"CODTURNO": 27,
"CODPREDIO": null,
"CODSALA": null,
"CODEVENTO": null,
"CODPLANILHA": null,
"IDHABILITACAOFILIAL": 64,
"NUMAULASEM": 300,
"DURACAOAULA": 50,
"MAXALUNOS": 100,
"CODTIPOCURSO": 1,
"DTINICIAL": "2017-02-08T00:00:00-02:00",
"DTFINAL": "2017-12-15T00:00:00-02:00",
"MINALUNOS": null,
"CUSTOMEDIO": null,
"DISCOPCIONAL": null,
"PREALOCACAO": null,
"CODEVENTOFALTA": null,
"CODEVENTOATRASO": null,
"NOMEDISC": 'Ciências',
"NOME": "EF12CBC",
"TIPO": "P",
"CODBLOCO": null,
"CODCURSO": "B04",
"CODHABILITACAO": "4",
"CODGRADE": "EF4",
"CODCAMPUS": null,
"ADICIONALNOTURNO": "N",
"ADICIONALEXTRA": "N",
"VAGASCALOUROS": null,
"NUMMAXALUNOOUTROSCURSOS": null,
"VAGASLISTAESPERA": null,
"NUMCREDITOSCOB": null,
"VALORCREDITO": null,
"DISPONIVELMATRICULA": "S",
"COMPLEMENTODISC": null,
"DTINICIOMATPRES": null,
"DTFIMMATPRES": null,
"DTINICIOMATPORTAL": null,
"DTFIMMATPORTAL": null,
"GERENCIAL": "N",
"ATIVA": "S",
"IDTURMADISCANTIGO": 0,
"NUMMAXALUNOSOUTRASMTZAPLICADAS": null,
"DECIMAIS": null,
"ALIASCOMUNIDADE": null,
"CODTIPOCURSOPLETIVO": 1,
"CODPERLET": "2017"
}
No momento de informar o IDTURMADISC deve-se informar o digito 0 "Zero". Desta forma o sistema gerará o código.
Caso esteja utilizando a aplicação SoapUI, as informações do cabeçalho podem ser informadas conforme abaixo:
{
"messages": [],
"length": 1,
"data": {
"id": "1$_$2945",
"CODCOLIGADA": 1,
"IDTURMADISC": 2945,
"CODFILIAL": 2,
"CODTURMA": "EF12C",
"IDPERLET": 18,
"CODDISC": "B0057",
"CODCCUSTO": null,
"APLICACAO": null,
"CODFORMULA": null,
"CODTURNO": 27,
"CODPREDIO": null,
"CODSALA": null,
"CODEVENTO": null,
"CODPLANILHA": null,
"IDHABILITACAOFILIAL": 64,
"NUMAULASEM": 300,
"DURACAOAULA": 50,
"MAXALUNOS": 100,
"CODTIPOCURSO": 1,
"DTINICIAL": "2017-02-08T00:00:00-02:00",
"DTFINAL": "2017-12-15T00:00:00-02:00",
"MINALUNOS": null,
"CUSTOMEDIO": null,
"DISCOPCIONAL": null,
"PREALOCACAO": null,
"CODEVENTOFALTA": null,
"CODEVENTOATRASO": null,
"NOMEDISC": "Ciências",
"NOME": "EF12CBC",
"TIPO": "P",
"CODBLOCO": null,
"CODCURSO": "B04",
"CODHABILITACAO": "4",
"CODGRADE": "EF4",
"CODCAMPUS": null,
"ADICIONALNOTURNO": "N",
"ADICIONALEXTRA": "N",
"VAGASCALOUROS": null,
"NUMMAXALUNOOUTROSCURSOS": null,
"VAGASLISTAESPERA": null,
"NUMCREDITOSCOB": null,
"VALORCREDITO": null,
"DISPONIVELMATRICULA": "S",
"COMPLEMENTODISC": null,
"DTINICIOMATPRES": null,
"DTFIMMATPRES": null,
"DTINICIOMATPORTAL": null,
"DTFIMMATPORTAL": null,
"GERENCIAL": "N",
"ATIVA": "S",
"IDTURMADISCANTIGO": 0,
"NUMMAXALUNOSOUTRASMTZAPLICADAS": null,
"DECIMAIS": null,
"ALIASCOMUNIDADE": null,
"CODTIPOCURSOPLETIVO": 1,
"CODPERLET": null,
"STURMADISCCOMPL": []
}
}
Alterações
Para realizar a atualização de cadastro de uma Turma/Disciplina é 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/Disciplina será inclusa.
URL que será utilizada para cadastro da turma/disciplina: http://localhost:8051/rmsrestdataserver/rest/EduTurmaDiscData/1$_$2945
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/Disciplina que serão alteradas:
{
"CODCOLIGADA": 1,
"IDTURMADISC": 0,
"CODFILIAL": 2,
"CODTURMA": "EF12C",
"IDPERLET": 18,
"CODDISC": "B0057",
"CODCCUSTO": null,
"APLICACAO": null,
"CODFORMULA": null,
"CODTURNO": 27,
"CODPREDIO": null,
"CODSALA": null,
"CODEVENTO": null,
"CODPLANILHA": null,
"IDHABILITACAOFILIAL": 64,
"NUMAULASEM": 300,
"DURACAOAULA": 50,
"MAXALUNOS": 100,
"CODTIPOCURSO": 1,
"DTINICIAL": "2017-02-08T00:00:00-02:00",
"DTFINAL": "2017-12-15T00:00:00-02:00",
"MINALUNOS": null,
"CUSTOMEDIO": null,
"DISCOPCIONAL": null,
"PREALOCACAO": null,
"CODEVENTOFALTA": null,
"CODEVENTOATRASO": null,
"NOMEDISC": 'Ciências',
"NOME": "EF12CB5",
"TIPO": "P",
"CODBLOCO": null,
"CODCURSO": "B04",
"CODHABILITACAO": "4",
"CODGRADE": "EF4",
"CODCAMPUS": null,
"ADICIONALNOTURNO": "N",
"ADICIONALEXTRA": "N",
"VAGASCALOUROS": null,
"NUMMAXALUNOOUTROSCURSOS": null,
"VAGASLISTAESPERA": null,
"NUMCREDITOSCOB": null,
"VALORCREDITO": null,
"DISPONIVELMATRICULA": "S",
"COMPLEMENTODISC": null,
"DTINICIOMATPRES": null,
"DTFIMMATPRES": null,
"DTINICIOMATPORTAL": null,
"DTFIMMATPORTAL": null,
"GERENCIAL": "N",
"ATIVA": "S",
"IDTURMADISCANTIGO": 0,
"NUMMAXALUNOSOUTRASMTZAPLICADAS": null,
"DECIMAIS": null,
"ALIASCOMUNIDADE": null,
"CODTIPOCURSOPLETIVO": 1,
"CODPERLET": "2017"
}
Exemplo da resposta:
{
"messages": [],
"length": 1,
"data": {
"id": "1$_$2945",
"CODCOLIGADA": 1,
"IDTURMADISC": 2945,
"CODFILIAL": 2,
"CODTURMA": "EF12C",
"IDPERLET": 18,
"CODDISC": "B0057",
"CODCCUSTO": null,
"APLICACAO": null,
"CODFORMULA": null,
"CODTURNO": 27,
"CODPREDIO": null,
"CODSALA": null,
"CODEVENTO": null,
"CODPLANILHA": null,
"IDHABILITACAOFILIAL": 64,
"NUMAULASEM": 300,
"DURACAOAULA": 50,
"MAXALUNOS": 100,
"CODTIPOCURSO": 1,
"DTINICIAL": "2017-02-08T00:00:00-02:00",
"DTFINAL": "2017-12-15T00:00:00-02:00",
"MINALUNOS": null,
"CUSTOMEDIO": null,
"DISCOPCIONAL": null,
"PREALOCACAO": null,
"CODEVENTOFALTA": null,
"CODEVENTOATRASO": null,
"NOMEDISC": "Ciências",
"NOME": "EF12CB5",
"TIPO": "P",
"CODBLOCO": null,
"CODCURSO": "B04",
"CODHABILITACAO": "4",
"CODGRADE": "EF4",
"CODCAMPUS": null,
"ADICIONALNOTURNO": "N",
"ADICIONALEXTRA": "N",
"VAGASCALOUROS": null,
"NUMMAXALUNOOUTROSCURSOS": null,
"VAGASLISTAESPERA": null,
"NUMCREDITOSCOB": null,
"VALORCREDITO": null,
"DISPONIVELMATRICULA": "S",
"COMPLEMENTODISC": null,
"DTINICIOMATPRES": null,
"DTFIMMATPRES": null,
"DTINICIOMATPORTAL": null,
"DTFIMMATPORTAL": null,
"GERENCIAL": "N",
"ATIVA": "S",
"IDTURMADISCANTIGO": 0,
"NUMMAXALUNOSOUTRASMTZAPLICADAS": null,
"DECIMAIS": null,
"ALIASCOMUNIDADE": null,
"CODTIPOCURSOPLETIVO": 1,
"CODPERLET": "2017",
"STURMADISCCOMPL": [ {
"id": "1$_$2945",
"parent_id": "1$_$2945",
"CODCOLIGADA": 1,
"IDTURMADISC": 2945,
"MATRICULADOS": null,
"BJEXIBOL": null
}]
}
}
Exclusões
Excluindo uma Turma/Disciplina:
A exclusão de uma Turma/Disciplina seguirá a mesma ideia da alteração, onde precisaremos passar as chaves da Turma/Disciplina 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/EduTurmaDiscData/1$_$2945
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/Disciplina que serão alteradas:
{
"CODCOLIGADA": 1,
"IDTURMADISC": 2945,
"CODFILIAL": 2,
"CODTURMA": "EF12C",
"IDPERLET": 18,
"CODDISC": "B0057",
"CODCCUSTO": null,
"APLICACAO": null,
"CODFORMULA": null,
"CODTURNO": 27,
"CODPREDIO": null,
"CODSALA": null,
"CODEVENTO": null,
"CODPLANILHA": null,
"IDHABILITACAOFILIAL": 64,
"NUMAULASEM": 300,
"DURACAOAULA": 50,
"MAXALUNOS": 100,
"CODTIPOCURSO": 1,
"DTINICIAL": "2017-02-08T00:00:00-02:00",
"DTFINAL": "2017-12-15T00:00:00-02:00",
"MINALUNOS": null,
"CUSTOMEDIO": null,
"DISCOPCIONAL": null,
"PREALOCACAO": null,
"CODEVENTOFALTA": null,
"CODEVENTOATRASO": null,
"NOMEDISC": 'Ciências',
"NOME": "EF12CB5",
"TIPO": "P",
"CODBLOCO": null,
"CODCURSO": "B04",
"CODHABILITACAO": "4",
"CODGRADE": "EF4",
"CODCAMPUS": null,
"ADICIONALNOTURNO": "N",
"ADICIONALEXTRA": "N",
"VAGASCALOUROS": null,
"NUMMAXALUNOOUTROSCURSOS": null,
"VAGASLISTAESPERA": null,
"NUMCREDITOSCOB": null,
"VALORCREDITO": null,
"DISPONIVELMATRICULA": "S",
"COMPLEMENTODISC": null,
"DTINICIOMATPRES": null,
"DTFIMMATPRES": null,
"DTINICIOMATPORTAL": null,
"DTFIMMATPORTAL": null,
"GERENCIAL": "N",
"ATIVA": "S",
"IDTURMADISCANTIGO": 0,
"NUMMAXALUNOSOUTRASMTZAPLICADAS": null,
"DECIMAIS": null,
"ALIASCOMUNIDADE": null,
"CODTIPOCURSOPLETIVO": 1,
"CODPERLET": "2017"
}
Resposta da mensagem:
{
"messages": [],
"length": 1,
"data": {
"id": "1$_$2945",
"CODCOLIGADA": 1,
"IDTURMADISC": 2945,
"CODFILIAL": 2,
"CODTURMA": "EF12C",
"IDPERLET": 18,
"CODDISC": "B0057",
"CODCCUSTO": null,
"APLICACAO": null,
"CODFORMULA": null,
"CODTURNO": 27,
"CODPREDIO": null,
"CODSALA": null,
"CODEVENTO": null,
"CODPLANILHA": null,
"IDHABILITACAOFILIAL": 64,
"NUMAULASEM": 300,
"DURACAOAULA": 50,
"MAXALUNOS": 100,
"CODTIPOCURSO": 1,
"DTINICIAL": "2017-02-08T00:00:00-02:00",
"DTFINAL": "2017-12-15T00:00:00-02:00",
"MINALUNOS": null,
"CUSTOMEDIO": null,
"DISCOPCIONAL": null,
"PREALOCACAO": null,
"CODEVENTOFALTA": null,
"CODEVENTOATRASO": null,
"NOMEDISC": null,
"NOME": "EF12CB5",
"TIPO": "P",
"CODBLOCO": null,
"CODCURSO": "B04",
"CODHABILITACAO": "4",
"CODGRADE": "EF4",
"CODCAMPUS": null,
"ADICIONALNOTURNO": "N",
"ADICIONALEXTRA": "N",
"VAGASCALOUROS": null,
"NUMMAXALUNOOUTROSCURSOS": null,
"VAGASLISTAESPERA": null,
"NUMCREDITOSCOB": null,
"VALORCREDITO": null,
"DISPONIVELMATRICULA": "S",
"COMPLEMENTODISC": null,
"DTINICIOMATPRES": null,
"DTFIMMATPRES": null,
"DTINICIOMATPORTAL": null,
"DTFIMMATPORTAL": null,
"GERENCIAL": "N",
"ATIVA": "S",
"IDTURMADISCANTIGO": 0,
"NUMMAXALUNOSOUTRASMTZAPLICADAS": null,
"DECIMAIS": null,
"ALIASCOMUNIDADE": null,
"CODTIPOCURSOPLETIVO": 1,
"CODPERLET": "2017",
"STURMADISCCOMPL": [ {
"id": "1$_$2945",
"parent_id": "1$_$2945",
"CODCOLIGADA": 1,
"IDTURMADISC": 2945,
"MATRICULADOS": null,
"BJEXIBOL": null
}]
}
}
