Visão geral
Através do serviço RMSRestDataServer, via RESTful, o usuário poderá acessar o dataserver de Parcela (EduParcelaData) 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 parcela ou de uma lista de parcelas.
Para a requisição de informações de uma parcela será necessário passar os valores da chave primária da parcela: CODCOLIGADA e IDPARCELA.
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 de parcelas:
Para a consulta de uma lista de parcelas, é necessário a utilização da URL:
HTTP://<SERVIDOR>:<HTTPORT>/rmsrestdataserver/rest/EduParcelaData
É 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/EduParcelaData?start=3&limit=2
{
"messages": [],
"length": 12319,
"data": [
{
"id": "1$_$10",
"CODCOLIGADA": 1,
"IDPARCELA": 10,
"RA": "0000107",
"CODCONTRATO": "174-2",
"IDPERLET": 11,
"CODSERVICO": "1",
"PARCELA": 4,
"COTA": 1,
"VALOR": 0,
"DTVENCIMENTO": "2004-05-10T00:00:00-03:00",
"DESCONTO": null,
"TIPODESC": "P",
"TIPOPARCELA": "P",
"VALORAUTOMATICO": "S",
"DTCOMPETENCIA": null,
"NOMESERVICO": "Mensalidade",
"ORIGEM": null,
"IDLAN": null,
"ORIGEMCONTACORRENTE": null,
"VALORORIGINAL": null,
"VLRBOLSAATEVENC": null,
"VLRBOLSAPOSVENC": null,
"VLRDESCONTO": null,
"VLRLIQUIDO": null,
"VLRCREDRETROATIVO": null
},
{
"id": "1$_$11",
"CODCOLIGADA": 1,
"IDPARCELA": 11,
"RA": "0000107",
"CODCONTRATO": "174-2",
"IDPERLET": 11,
"CODSERVICO": "1",
"PARCELA": 5,
"COTA": 1,
"VALOR": 0,
"DTVENCIMENTO": "2004-06-10T00:00:00-03:00",
"DESCONTO": null,
"TIPODESC": "P",
"TIPOPARCELA": "P",
"VALORAUTOMATICO": "S",
"DTCOMPETENCIA": null,
"NOMESERVICO": "Mensalidade",
"ORIGEM": null,
"IDLAN": null,
"ORIGEMCONTACORRENTE": null,
"VALORORIGINAL": null,
"VLRBOLSAATEVENC": null,
"VLRBOLSAPOSVENC": null,
"VLRDESCONTO": null,
"VLRLIQUIDO": null,
"VLRCREDRETROATIVO": null
}
]
}
Retornando apenas uma parcela:
Para realizar a consulta de uma parcela, será necessário a utilização dos valores de chave primária da parcela:
Exemplo:
http://localhost:8051/rmsrestdataserver/rest/EduParcelaData/1$_$17816
O valor informado no final da URL "1$_$17816" ("CODCOLIGADA$_$IDPARCELA") se refere aos valores da coligada e do id da parcela.
Esse valores são separados pelos caracteres "$" e "_".
Para a realização dessa requisição, deverá ser utilizado o método: GET.
{
"messages": [],
"length": 1,
"data": {
"id": "1$_$17816",
"CODCOLIGADA": 1,
"IDPARCELA": 17816,
"RA": "ES-00272",
"CODCONTRATO": "1291",
"IDPERLET": 49,
"CODSERVICO": "2",
"PARCELA": 3,
"COTA": 1,
"VALOR": 700,
"DTVENCIMENTO": "2016-03-01T00:00:00-03:00",
"DESCONTO": 10,
"TIPODESC": "P",
"TIPOPARCELA": "P",
"VALORAUTOMATICO": "N",
"NOMESERVICO": null,
"DTCOMPETENCIA": "2016-04-01T00:00:00-03:00",
"IDLAN": null,
"ORIGEMCONTACORRENTE": null,
"VALORORIGINAL": null,
"VLRBOLSAATEVENC": null,
"VLRBOLSAPOSVENC": null,
"VLRDESCONTO": null,
"VLRLIQUIDO": null,
"VLRCREDRETROATIVO": null,
"ORIGEM": null,
"RECCREATEDBY": "mestre",
"RECCREATEDON": "2016-10-19T13:05:36-02:00",
"RECMODIFIEDBY": "mestre",
"RECMODIFIEDON": "2016-10-19T13:05:36-02:00",
"STATUSLAN": null,
"SResponsavel": [ {
"id": "1$_$17816$_$1$_$C01560",
"parent_id": "1$_$17816",
"CODCOLIGADA": 1,
"IDPARCELA": 17816,
"CODCOLCFO": 1,
"CODCFO": "C01560",
"RA": "ES-00272",
"CODSERVICO": "2",
"IDPERLET": 49,
"NOMECLIFOR": "ALUNO 10",
"PERCENTUAL": 100
}]
}
}
CADASTRO
Cadastrando uma parcela:
Para realizar o cadastro de uma parcela é 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 parcela será incluída.
URL que será utilizada para cadastro da parcela: http://localhost:8051/rmsrestdataserver/rest/EduParcelaData
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 parcela:
{
"CODCOLIGADA": 1,
"RA": "ES-00272",
"CODCONTRATO": "1291",
"IDPERLET": 49,
"CODSERVICO": "1",
"PARCELA": 3,
"COTA": 1,
"VALOR": 500,
"DTVENCIMENTO": "2016-03-01"
}
Caso esteja utilizando a aplicação SoapUI, as informações do cabeçalho podem ser informadas conforme abaixo:
{
"messages": [],
"length": 1,
"data": {
"id": "1$_$18136",
"CODCOLIGADA": 1,
"IDPARCELA": 18136,
"RA": "ES-00272",
"CODCONTRATO": "1291",
"IDPERLET": 49,
"CODSERVICO": "1",
"PARCELA": 3,
"COTA": 1,
"VALOR": 500,
"DTVENCIMENTO": "2016-03-01T00:00:00-03:00",
"DESCONTO": null,
"TIPODESC": "P",
"TIPOPARCELA": "P",
"VALORAUTOMATICO": "N",
"NOMESERVICO": null,
"DTCOMPETENCIA": null,
"IDLAN": null,
"ORIGEMCONTACORRENTE": null,
"VALORORIGINAL": null,
"VLRBOLSAATEVENC": null,
"VLRBOLSAPOSVENC": null,
"VLRDESCONTO": null,
"VLRLIQUIDO": null,
"VLRCREDRETROATIVO": null,
"ORIGEM": null,
"RECCREATEDBY": null,
"RECCREATEDON": null,
"RECMODIFIEDBY": null,
"RECMODIFIEDON": null,
"STATUSLAN": null,
"SResponsavel": [ {
"id": "1$_$18136$_$1$_$C01560",
"parent_id": "1$_$18136",
"CODCOLIGADA": 1,
"IDPARCELA": 18136,
"CODCOLCFO": 1,
"CODCFO": "C01560",
"RA": "ES-00272",
"CODSERVICO": "1",
"IDPERLET": 49,
"NOMECLIFOR": "ALUNO 10",
"PERCENTUAL": 100
}]
}
}
Alterações
Para realizar a atualização de cadastro de uma parcela é 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 parcela 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 parcela será inclusa.
URL que será utilizada para cadastro do aluno: http://localhost:8051/rmsrestdataserver/rest/EduParcelaData/1$_$18133
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 parcela que será alterada:
{
"VALOR": 800,
"id": "1$_$18133"
}
Exemplo da resposta:
{
"messages": [],
"length": 1,
"data": {
"id": "1$_$18133",
"CODCOLIGADA": 1,
"IDPARCELA": 18136,
"RA": "ES-00272",
"CODCONTRATO": "1291",
"IDPERLET": 49,
"CODSERVICO": "1",
"PARCELA": 3,
"COTA": 1,
"VALOR": 800,
"DTVENCIMENTO": "2016-03-01T00:00:00-03:00",
"DESCONTO": null,
"TIPODESC": "P",
"TIPOPARCELA": "P",
"VALORAUTOMATICO": "N",
"NOMESERVICO": null,
"DTCOMPETENCIA": null,
"IDLAN": null,
"ORIGEMCONTACORRENTE": null,
"VALORORIGINAL": null,
"VLRBOLSAATEVENC": null,
"VLRBOLSAPOSVENC": null,
"VLRDESCONTO": null,
"VLRLIQUIDO": null,
"VLRCREDRETROATIVO": null,
"ORIGEM": null,
"RECCREATEDBY": null,
"RECCREATEDON": null,
"RECMODIFIEDBY": null,
"RECMODIFIEDON": null,
"STATUSLAN": null,
"SResponsavel": [ {
"id": "1$_$18136$_$1$_$C01560",
"parent_id": "1$_$18136",
"CODCOLIGADA": 1,
"IDPARCELA": 18136,
"CODCOLCFO": 1,
"CODCFO": "C01560",
"RA": "ES-00272",
"CODSERVICO": "1",
"IDPERLET": 49,
"NOMECLIFOR": "ALUNO 10",
"PERCENTUAL": 100
}]
}
}
Exclusões
Excluindo a parcela:
A exclusão de uma parcela seguirá a mesma ideia da alteração, onde precisaremos passar as chaves da parcela 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 da parcela: http://localhost:8051/rmsrestdataserver/rest/EduParcelaData/1$_$18133
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 parcela que serão removidas:
{
"CODCOLIGADA": 1,
"RA": "ES-00272",
"CODCONTRATO": "1291",
"IDPERLET": 49,
"CODSERVICO": "1",
"PARCELA": 3,
"COTA": 1,
"VALOR": 800,
"DTVENCIMENTO": "2016-03-01",
"id": "1$_$18133"
}
Resposta da mensagem:
{
"messages": [],
"length": 1,
"data": {
"id": "1$_$18133",
"CODCOLIGADA": 1,
"IDPARCELA": 18133,
"RA": "ES-00272",
"CODCONTRATO": "1291",
"IDPERLET": 49,
"CODSERVICO": "1",
"PARCELA": 3,
"COTA": 1,
"VALOR": 800,
"DTVENCIMENTO": "2016-03-01T00:00:00-03:00",
"DESCONTO": null,
"TIPODESC": "P",
"TIPOPARCELA": "P",
"VALORAUTOMATICO": "N",
"NOMESERVICO": null,
"DTCOMPETENCIA": null,
"IDLAN": null,
"ORIGEMCONTACORRENTE": null,
"VALORORIGINAL": null,
"VLRBOLSAATEVENC": null,
"VLRBOLSAPOSVENC": null,
"VLRDESCONTO": null,
"VLRLIQUIDO": null,
"VLRCREDRETROATIVO": null,
"ORIGEM": "MN",
"RECCREATEDBY": "mestre",
"RECCREATEDON": "2017-12-27T14:41:42-02:00",
"RECMODIFIEDBY": "mestre",
"RECMODIFIEDON": "2017-12-27T14:52:09-02:00",
"STATUSLAN": null,
"SResponsavel": [ {
"id": "1$_$18133$_$1$_$C01560",
"parent_id": "1$_$18133",
"CODCOLIGADA": 1,
"IDPARCELA": 18133,
"CODCOLCFO": 1,
"CODCFO": "C01560",
"RA": "ES-00272",
"CODSERVICO": "1",
"IDPERLET": 49,
"NOMECLIFOR": "ALUNO 10",
"PERCENTUAL": 100
}]
}
}
