Contrato (Rest)

Visão geral

Através do serviço RMSRestDataServer, via RESTful, o usuário poderá acessar o dataserver de Contrato (EduContratoData) 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 um contrato ou de uma lista de contratos.

Para a requisição de informações de um contrato será necessário passar os valores da chave primária do contrato: CODCOLIGADA, RA, IDPERLET e CODCONTRATO.

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 contratos:

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

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

É 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/EduContratoData?start=3&limit=2

Mensagem de resposta

{
 "messages": [],
 "length": 1115,
 "data": [
 {
 "id": "1$_$0000000287$_$35$_$1180",
 "CODCOLIGADA": 1,
 "CODCONTRATO": "1180",
 "RA": "0000000287",
 "IDPERLET": 35,
 "IDHABILITACAOFILIAL": 166,
 "NOMEALUNO": "Teste Walquiria",
 "NOMECURSO": "Curso Wal",
 "NOMEHABILITACAO": "Hab WAL",
 "DESCGRADE": "Matriz WAL",
 "NOMETURNO": "MANHÃ",
 "CODTURMA": null,
 "CODPERLET": "2015/1",
 "CODPLANOPGTO": "2015/1cred",
 "DESCRICAOPLANOPGTO": null,
 "IDOPERACAO": null,
 "VALORSERVICO": 0,
 "DESCONTO": 0,
 "VALORBOLSA": 0,
 "STATUSCONT": null,
 "USARSOLICITACAO": "S",
 "STATUS": "N",
 "USARPESQEXT": "N",
 "DTCOMPETENCIAINICIAL": null,
 "DTCOMPETENCIAFINAL": null,
 "IDCLASSEVALORPROTHEUS": null,
 "IDITEMCONTABILPROTHEUS": null,
 "CODFILIAL": 1,
 "CODTIPOCURSO": 1,
 "DTCONTRATO": "2015-01-01T00:00:00-02:00",
 "DTASSINATURA": null,
 "DIAVENCIMENTO": null,
 "TIPOCONTRATO": "P",
 "CODCCUSTO": null,
 "ASSINADO": "N",
 "DIAFIXO": "N",
 "PERIODOCONTABIL": "A",
 "TIPOBOLSA": "S",
 "CONSIDERADESCANTECIPACAO": "S",
 "CONSIDERADESCANTECIPACAOBOLSA": "N",
 "DTCANCELAMENTO": null,
 "CODCURSO": null,
 "CODHABILITACAO": null,
 "CODGRADE": null,
 "VALORDIFERIMENTO": null,
 "CODPLANOPGTOPERSONALIZ": null,
 "VALORBASEPERSONALIZ": null,
 "VALORCONTRATOAPOSPERSONALIZ": null,
 "CODUSUARIOPERSONALIZ": null,
 "DATAPERSONALIZ": null
 },
 {
 "id": "1$_$0000000287$_$35$_$1184",
 "CODCOLIGADA": 1,
 "CODCONTRATO": "1184",
 "RA": "0000000287",
 "IDPERLET": 35,
 "IDHABILITACAOFILIAL": 166,
 "NOMEALUNO": "Teste Walquiria",
 "NOMECURSO": "Curso Wal",
 "NOMEHABILITACAO": "Hab WAL",
 "DESCGRADE": "Matriz WAL",
 "NOMETURNO": "MANHÃ",
 "CODTURMA": null,
 "CODPERLET": "2015/1",
 "CODPLANOPGTO": "2015/1cred",
 "DESCRICAOPLANOPGTO": null,
 "IDOPERACAO": null,
 "VALORSERVICO": 0,
 "DESCONTO": 0,
 "VALORBOLSA": 0,
 "STATUSCONT": null,
 "USARSOLICITACAO": "N",
 "STATUS": "N",
 "USARPESQEXT": "N",
 "DTCOMPETENCIAINICIAL": "2015-01-01T00:00:00-02:00",
 "DTCOMPETENCIAFINAL": "2015-12-01T00:00:00-02:00",
 "IDCLASSEVALORPROTHEUS": null,
 "IDITEMCONTABILPROTHEUS": null,
 "CODFILIAL": 1,
 "CODTIPOCURSO": 1,
 "DTCONTRATO": null,
 "DTASSINATURA": null,
 "DIAVENCIMENTO": null,
 "TIPOCONTRATO": "P",
 "CODCCUSTO": null,
 "ASSINADO": "N",
 "DIAFIXO": "N",
 "PERIODOCONTABIL": "M",
 "TIPOBOLSA": "S",
 "CONSIDERADESCANTECIPACAO": "S",
 "CONSIDERADESCANTECIPACAOBOLSA": "N",
 "DTCANCELAMENTO": null,
 "CODCURSO": null,
 "CODHABILITACAO": null,
 "CODGRADE": null,
 "VALORDIFERIMENTO": null,
 "CODPLANOPGTOPERSONALIZ": null,
 "VALORBASEPERSONALIZ": null,
 "VALORCONTRATOAPOSPERSONALIZ": null,
 "CODUSUARIOPERSONALIZ": null,
 "DATAPERSONALIZ": null
 }
 ]
}

Retornando apenas um contrato:

Para realizar a consulta de um contrato, será necessário a utilização dos valores de chave primária do contrato:

Exemplo:

http://localhost:8051/rmsrestdataserver/rest/EduContratoData/1$_$LFS-0007$_$55$_$1523

O valor informado no final da URL "1$_$LFS-0007$_$55$_$1523" ("CODCOLIGADA$_$RA$_$IDPERLET$_$CODCONTRATO") se refere aos valores da coligada, do registro acadêmico, do período letivo e do código do contrato.

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$_$LFS-0007$_$55$_$1523",
      "CODCOLIGADA": 1,
      "RA": "LFS-0007",
      "IDPERLET": 55,
      "CODCONTRATO": "1523",
      "IDHABILITACAOFILIAL": 23,
      "CODPLANOPGTO": null,
      "DTCONTRATO": "2018-07-17T00:00:00-03:00",
      "DTASSINATURA": "2018-07-16T00:00:00-03:00",
      "DIAVENCIMENTO": null,
      "CODFILIAL": 1,
      "CODTIPOCURSO": 1,
      "TIPOCONTRATO": "P",
      "CODCCUSTO": null,
      "ASSINADO": "S",
      "DIAFIXO": "N",
      "STATUS": "N",
      "TIPOBOLSA": "C",
      "NOMEALUNO": "LFS Fabiana",
      "NOMEHABILITACAO": null,
      "NOMECURSO": null,
      "NOMETURNO": null,
      "CODTURMA": null,
      "DTCANCELAMENTO": null,
      "CODPERLET": null,
      "DESCRICAOPLANOPGTO": null,
      "IDOPERACAO": null,
      "VALORSERVICO": 0,
      "DESCONTO": 0,
      "VALORBOLSA": 0,
      "DESCGRADE": null,
      "CODCURSO": "4-1",
      "CODHABILITACAO": "4-1-1",
      "STATUSCONT": null,
      "CODGRADE": "1",
      "USARSOLICITACAO": "N",
      "DTCOMPETENCIAINICIAL": null,
      "DTCOMPETENCIAFINAL": null,
      "PERIODOCONTABIL": "M",
      "VALORDIFERIMENTO": 0,
      "USARPESQEXT": "N",
      "IDCLASSEVALORPROTHEUS": null,
      "IDITEMCONTABILPROTHEUS": null,
      "CODPLANOPGTOPERSONALIZ": null,
      "VALORBASEPERSONALIZ": 0,
      "VALORCONTRATOAPOSPERSONALIZ": 0,
      "CODUSUARIOPERSONALIZ": null,
      "DATAPERSONALIZ": null,
      "CONSIDERADESCANTECIPACAO": "S",
      "CONSIDERADESCANTECIPACAOBOLSA": "N",
      "DTCONTRATO1": "2018-07-17T00:00:00-03:00",
      "IDOPERACAO1": null,
      "ALUNO": "LFS-0007 - LFS Fabiana",
      "SResponsavelContrato": [],
      "SBOLSARETROATIVACONTRATO": []
   }
}

CADASTRO

Cadastrando um contrato:

Para realizar o cadastro de um contrato é 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 contrato será incluído.

URL que será utilizada para cadastro do contrato: http://localhost:8051/rmsrestdataserver/rest/EduContratoData

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 um contrato:

Corpo da mensagem

{
      "CODCOLIGADA": 1,
      "RA": "LFS-0007",
      "IDPERLET": 55,
      "CODCONTRATO": "0",
      "IDHABILITACAOFILIAL": 23,
      "CODPLANOPGTO": null,
      "DTCONTRATO": "2018-07-17T00:00:00-03:00",
      "DTASSINATURA": "2018-07-16T00:00:00-03:00",
      "DIAVENCIMENTO": null,
      "CODFILIAL": 1,
      "CODTIPOCURSO": 1,
      "TIPOCONTRATO": "P",
      "CODCCUSTO": null,
      "ASSINADO": "S",
      "DIAFIXO": "N",
      "STATUS": "N",
      "TIPOBOLSA": "C",
      "NOMEALUNO": "LFS Fabiana",
      "NOMEHABILITACAO": null,
      "NOMECURSO": null,
      "NOMETURNO": null,
      "CODTURMA": null,
      "DTCANCELAMENTO": null,
      "CODPERLET": null,
      "DESCRICAOPLANOPGTO": null,
      "IDOPERACAO": null,
      "VALORSERVICO": 0,
      "DESCONTO": 0,
      "VALORBOLSA": 0,
      "DESCGRADE": null,
      "CODCURSO": "4-1",
      "CODHABILITACAO": "4-1-1",
      "STATUSCONT": null,
      "CODGRADE": "1",
      "USARSOLICITACAO": "N",
      "DTCOMPETENCIAINICIAL": null,
      "DTCOMPETENCIAFINAL": null,
      "PERIODOCONTABIL": "M",
      "VALORDIFERIMENTO": 0,
      "USARPESQEXT": "N",
      "IDCLASSEVALORPROTHEUS": null,
      "IDITEMCONTABILPROTHEUS": null,
      "CODPLANOPGTOPERSONALIZ": null,
      "VALORBASEPERSONALIZ": 0,
      "VALORCONTRATOAPOSPERSONALIZ": 0,
      "CODUSUARIOPERSONALIZ": null,
      "DATAPERSONALIZ": null,
      "CONSIDERADESCANTECIPACAO": "S",
      "CONSIDERADESCANTECIPACAOBOLSA": "N",
      "DTCONTRATO1": "2018-07-17T00:00:00-03:00",
      "IDOPERACAO1": null,
      "ALUNO": "LFS-0007 - LFS Fabiana",
      "SResponsavelContrato": [],
      "SBOLSARETROATIVACONTRATO": []
   }

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:

Mensagem de resposta

{
   "messages": [],
   "length": 1,
   "data":    {
      "id": "1$_$LFS-0007$_$55$_$1523",
      "CODCOLIGADA": 1,
      "RA": "LFS-0007",
      "IDPERLET": 55,
      "CODCONTRATO": "1523",
      "IDHABILITACAOFILIAL": 23,
      "CODPLANOPGTO": null,
      "DTCONTRATO": "2018-07-17T00:00:00-03:00",
      "DTASSINATURA": "2018-07-16T00:00:00-03:00",
      "DIAVENCIMENTO": null,
      "CODFILIAL": 1,
      "CODTIPOCURSO": 1,
      "TIPOCONTRATO": "P",
      "CODCCUSTO": null,
      "ASSINADO": "S",
      "DIAFIXO": "N",
      "STATUS": "N",
      "TIPOBOLSA": "C",
      "NOMEALUNO": "LFS Fabiana",
      "NOMEHABILITACAO": null,
      "NOMECURSO": null,
      "NOMETURNO": null,
      "CODTURMA": null,
      "DTCANCELAMENTO": null,
      "CODPERLET": null,
      "DESCRICAOPLANOPGTO": null,
      "IDOPERACAO": null,
      "VALORSERVICO": 0,
      "DESCONTO": 0,
      "VALORBOLSA": 0,
      "DESCGRADE": null,
      "CODCURSO": "4-1",
      "CODHABILITACAO": "4-1-1",
      "STATUSCONT": null,
      "CODGRADE": "1",
      "USARSOLICITACAO": "N",
      "DTCOMPETENCIAINICIAL": null,
      "DTCOMPETENCIAFINAL": null,
      "PERIODOCONTABIL": "M",
      "VALORDIFERIMENTO": 0,
      "USARPESQEXT": "N",
      "IDCLASSEVALORPROTHEUS": null,
      "IDITEMCONTABILPROTHEUS": null,
      "CODPLANOPGTOPERSONALIZ": null,
      "VALORBASEPERSONALIZ": 0,
      "VALORCONTRATOAPOSPERSONALIZ": 0,
      "CODUSUARIOPERSONALIZ": null,
      "DATAPERSONALIZ": null,
      "CONSIDERADESCANTECIPACAO": "S",
      "CONSIDERADESCANTECIPACAOBOLSA": "N",
      "DTCONTRATO1": null,
      "IDOPERACAO1": null,
      "ALUNO": null,
      "SResponsavelContrato": [],
      "SBOLSARETROATIVACONTRATO": []
   }
}

Alterações

Atualizando informações do contrato:

Para realizar a atualização de cadastro de um contrato é 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 contrato será alterado.

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 o contrato será incluso.

URL que será utilizada para cadastro do aluno: http://localhost:8051/rmsrestdataserver/rest/EduContratoData/1$_$LFS-0007$_$55$_$1522

Para a realização dessa requisição, poderá ser utilizado o método PUT ou PATCH:

Segue o exemplo de um conjunto de informações de um contrato que será alterado via método PUT:

Corpo da mensagem

{
      "CODCOLIGADA": 1,
      "RA": "LFS-0007",
      "IDPERLET": 55,
      "CODCONTRATO": "1523",
      "IDHABILITACAOFILIAL": 23,
      "CODPLANOPGTO": null,
      "DTCONTRATO": "2018-07-17T00:00:00-03:00",
      "DTASSINATURA": "2018-07-16T00:00:00-03:00",
      "DIAVENCIMENTO": null,
      "CODFILIAL": 1,
      "CODTIPOCURSO": 1,
      "TIPOCONTRATO": "P",
      "CODCCUSTO": null,
      "ASSINADO": "N",
      "DIAFIXO": "N",
      "STATUS": "N",
      "TIPOBOLSA": "C",
      "NOMEALUNO": "LFS Fabiana",
      "NOMEHABILITACAO": null,
      "NOMECURSO": null,
      "NOMETURNO": null,
      "CODTURMA": null,
      "DTCANCELAMENTO": null,
      "CODPERLET": null,
      "DESCRICAOPLANOPGTO": null,
      "IDOPERACAO": null,
      "VALORSERVICO": 0,
      "DESCONTO": 0,
      "VALORBOLSA": 0,
      "DESCGRADE": null,
      "CODCURSO": "4-1",
      "CODHABILITACAO": "4-1-1",
      "STATUSCONT": null,
      "CODGRADE": "1",
      "USARSOLICITACAO": "N",
      "DTCOMPETENCIAINICIAL": null,
      "DTCOMPETENCIAFINAL": null,
      "PERIODOCONTABIL": "M",
      "VALORDIFERIMENTO": 0,
      "USARPESQEXT": "N",
      "IDCLASSEVALORPROTHEUS": null,
      "IDITEMCONTABILPROTHEUS": null,
      "CODPLANOPGTOPERSONALIZ": null,
      "VALORBASEPERSONALIZ": 0,
      "VALORCONTRATOAPOSPERSONALIZ": 0,
      "CODUSUARIOPERSONALIZ": null,
      "DATAPERSONALIZ": null,
      "CONSIDERADESCANTECIPACAO": "S",
      "CONSIDERADESCANTECIPACAOBOLSA": "N",
      "DTCONTRATO1": null,
      "IDOPERACAO1": null,
      "ALUNO": null,
      "SResponsavelContrato": [],
      "SBOLSARETROATIVACONTRATO": [],
      "id": "1$_$LFS-0007$_$55$_$1523"
}

Exemplo da resposta:

Mensagem de resposta

{
   "messages": [],
   "length": 1,
   "data":    {
      "id": "1$_$LFS-0007$_$55$_$1523",
      "CODCOLIGADA": 1,
      "RA": "LFS-0007",
      "IDPERLET": 55,
      "CODCONTRATO": "1523",
      "IDHABILITACAOFILIAL": 23,
      "CODPLANOPGTO": null,
      "DTCONTRATO": "2018-07-17T00:00:00-03:00",
      "DTASSINATURA": "2018-07-16T00:00:00-03:00",
      "DIAVENCIMENTO": null,
      "CODFILIAL": 1,
      "CODTIPOCURSO": 1,
      "TIPOCONTRATO": "P",
      "CODCCUSTO": null,
      "ASSINADO": "N",
      "DIAFIXO": "N",
      "STATUS": "N",
      "TIPOBOLSA": "C",
      "NOMEALUNO": "LFS Fabiana",
      "NOMEHABILITACAO": null,
      "NOMECURSO": null,
      "NOMETURNO": null,
      "CODTURMA": null,
      "DTCANCELAMENTO": null,
      "CODPERLET": null,
      "DESCRICAOPLANOPGTO": null,
      "IDOPERACAO": null,
      "VALORSERVICO": 0,
      "DESCONTO": 0,
      "VALORBOLSA": 0,
      "DESCGRADE": null,
      "CODCURSO": "4-1",
      "CODHABILITACAO": "4-1-1",
      "STATUSCONT": null,
      "CODGRADE": "1",
      "USARSOLICITACAO": "N",
      "DTCOMPETENCIAINICIAL": null,
      "DTCOMPETENCIAFINAL": null,
      "PERIODOCONTABIL": "M",
      "VALORDIFERIMENTO": 0,
      "USARPESQEXT": "N",
      "IDCLASSEVALORPROTHEUS": null,
      "IDITEMCONTABILPROTHEUS": null,
      "CODPLANOPGTOPERSONALIZ": null,
      "VALORBASEPERSONALIZ": 0,
      "VALORCONTRATOAPOSPERSONALIZ": 0,
      "CODUSUARIOPERSONALIZ": null,
      "DATAPERSONALIZ": null,
      "CONSIDERADESCANTECIPACAO": "S",
      "CONSIDERADESCANTECIPACAOBOLSA": "N",
      "DTCONTRATO1": "2018-07-17T00:00:00-03:00",
      "IDOPERACAO1": null,
      "ALUNO": "LFS-0007 - LFS Fabiana",
      "SResponsavelContrato": [],
      "SBOLSARETROATIVACONTRATO": []
   }
}

Segue o exemplo de um conjunto de informações de um contrato que será alterado via método PATCH:

Corpo da mensagem

{
      "DTCOMPETENCIAINICIALMOV": "2023-01-01T00:00:00-03:00",
      "DTCOMPETENCIAFINALMOV": "2023-12-31T00:00:00-03:00"
}

Exemplo da resposta:

Mensagem de resposta

{
    "messages": [],
    "length": 1,
    "data": {
        "id": "1$_$ES-00215$_$22$_$475",
        "CODCOLIGADA": 1,
        "RA": "ES-00215",
        "IDPERLET": 22,
        "CODCONTRATO": "475",
        "IDHABILITACAOFILIAL": 21,
        "CODPLANOPGTO": "P6Fixas",
        "DTCONTRATO": null,
        "DTASSINATURA": null,
        "DIAVENCIMENTO": null,
        "CODFILIAL": 1,
        "CODTIPOCURSO": 1,
        "TIPOCONTRATO": "P",
        "CODCCUSTO": null,
        "ASSINADO": "N",
        "DIAFIXO": "N",
        "STATUS": "N",
        "TIPOBOLSA": "S",
        "NOMEALUNO": "ALUNO DEDUPACMEN-4548",
        "NOMEHABILITACAO": null,
        "NOMECURSO": null,
        "NOMETURNO": null,
        "CODTURMA": null,
        "DTCANCELAMENTO": null,
        "CODPERLET": null,
        "NOMEPLANOPGTO": null,
        "DESCRICAOPLANOPGTO": null,
        "IDOPERACAO": null,
        "VALORSERVICO": 0.0000,
        "DESCONTO": 0.0000,
        "VALORBOLSA": 0.0000,
        "DESCGRADE": null,
        "CODCURSO": "2-1",
        "CODHABILITACAO": "1",
        "STATUSCONT": null,
        "CODGRADE": "2009/1",
        "USARSOLICITACAO": "S",
        "DTCOMPETENCIAINICIAL": "2023-01-01T00:00:00-03:00",
        "DTCOMPETENCIAFINAL": "2023-12-31T00:00:00-03:00",
        "PERIODOCONTABIL": "A",
        "USARPESQEXT": "N",
        "IDCLASSEVALORPROTHEUS": null,
        "IDITEMCONTABILPROTHEUS": null,
        "CODPLANOPGTOPERSONALIZ": null,
        "VALORBASEPERSONALIZ": null,
        "VALORCONTRATOAPOSPERSONALIZ": null,
        "CODUSUARIOPERSONALIZ": null,
        "DATAPERSONALIZ": null,
        "CONSIDERADESCANTECIPACAO": "S",
        "CONSIDERADESCANTECIPACAOBOLSA": "S",
        "DTCOMPETENCIAINICIALMOV": "2023-01-01T00:00:00-03:00",
        "DTCOMPETENCIAFINALMOV": "2023-12-31T00:00:00-03:00",
        "DTCONTRATO1": null,
        "IDOPERACAO1": null,
        "ALUNO": "ES-00215 - ALUNO DEDUPACMEN-4548",
        "SResponsavelContrato": [],
        "SBOLSARETROATIVACONTRATO": []
    }
}

Importante

Algumas validações são feitas na edição do contrato como:

Validação de alteração no período de competência contábil do contrato: Quando o sistema está parametrizado para utilizar contabilização por competência e a data a ser utilizada é a data contábil do contrato, o sistema não permitirá a alteração se os campos de data inicial ou data final de competência forem alterados e existir alguma contabilização por competência realizada para o contrato.
Validação de data de competência do movimento: Quando o sistema está parametrizado para gerar movimento por competência e a data a ser utilizada é a data de competência do contrato e plano de pagamento, o sistema não permitirá a alteração se os campos de data inicial ou data final de competência para emissão de NFS-e forem alterados e existir movimento por competência gerado para o contrato.

Exclusões

Excluindo o contrato:

A exclusão de um contrato seguirá a mesma ideia da alteração, onde precisaremos passar as chaves do contrato 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 do contrato: http://localhost:8051/rmsrestdataserver/rest/EduContratoData/1$_$LFS-0007$_$55$_$1523

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

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

Corpo da mensagem

{
      "CODCOLIGADA": 1,
      "RA": "LFS-0007",
      "IDPERLET": 55,
      "CODCONTRATO": "1523",
      "IDHABILITACAOFILIAL": 23,
      "CODPLANOPGTO": null,
      "DTCONTRATO": "2018-07-17T00:00:00-03:00",
      "DTASSINATURA": "2018-07-16T00:00:00-03:00",
      "DIAVENCIMENTO": null,
      "CODFILIAL": 1,
      "CODTIPOCURSO": 1,
      "TIPOCONTRATO": "P",
      "CODCCUSTO": null,
      "ASSINADO": "N",
      "DIAFIXO": "N",
      "STATUS": "N",
      "TIPOBOLSA": "C",
      "NOMEALUNO": "LFS Fabiana",
      "NOMEHABILITACAO": null,
      "NOMECURSO": null,
      "NOMETURNO": null,
      "CODTURMA": null,
      "DTCANCELAMENTO": null,
      "CODPERLET": null,
      "DESCRICAOPLANOPGTO": null,
      "IDOPERACAO": null,
      "VALORSERVICO": 0,
      "DESCONTO": 0,
      "VALORBOLSA": 0,
      "DESCGRADE": null,
      "CODCURSO": "4-1",
      "CODHABILITACAO": "4-1-1",
      "STATUSCONT": null,
      "CODGRADE": "1",
      "USARSOLICITACAO": "N",
      "DTCOMPETENCIAINICIAL": null,
      "DTCOMPETENCIAFINAL": null,
      "PERIODOCONTABIL": "M",
      "VALORDIFERIMENTO": 0,
      "USARPESQEXT": "N",
      "IDCLASSEVALORPROTHEUS": null,
      "IDITEMCONTABILPROTHEUS": null,
      "CODPLANOPGTOPERSONALIZ": null,
      "VALORBASEPERSONALIZ": 0,
      "VALORCONTRATOAPOSPERSONALIZ": 0,
      "CODUSUARIOPERSONALIZ": null,
      "DATAPERSONALIZ": null,
      "CONSIDERADESCANTECIPACAO": "S",
      "CONSIDERADESCANTECIPACAOBOLSA": "N",
      "DTCONTRATO1": null,
      "IDOPERACAO1": null,
      "ALUNO": null,
      "SResponsavelContrato": [],
      "SBOLSARETROATIVACONTRATO": [],
      "id": "1$_$LFS-0007$_$55$_$1523"
}

Resposta da mensagem:

Mensagem de resposta

{
 "messages": [],
 "length": 1,
 "data": {
 "id": "1$_$LFS-0007$_$55$_$1523",
 "CODCOLIGADA": 1,
 "RA": "LFS-0007",
 "IDPERLET": 55,
 "CODCONTRATO": "1523",
 "IDHABILITACAOFILIAL": 23,
 "CODPLANOPGTO": null,
 "DTCONTRATO": "2018-07-17T00:00:00-03:00",
 "DTASSINATURA": "2018-07-16T00:00:00-03:00",
 "DIAVENCIMENTO": null,
 "CODFILIAL": 1,
 "CODTIPOCURSO": 1,
 "TIPOCONTRATO": "P",
 "CODCCUSTO": null,
 "ASSINADO": "N",
 "DIAFIXO": "N",
 "STATUS": "N",
 "TIPOBOLSA": "C",
 "NOMEALUNO": "LFS Fabiana",
 "NOMEHABILITACAO": null,
 "NOMECURSO": null,
 "NOMETURNO": null,
 "CODTURMA": null,
 "DTCANCELAMENTO": null,
 "CODPERLET": null,
 "DESCRICAOPLANOPGTO": null,
 "IDOPERACAO": null,
 "VALORSERVICO": 0,
 "DESCONTO": 0,
 "VALORBOLSA": 0,
 "DESCGRADE": null,
 "CODCURSO": "4-1",
 "CODHABILITACAO": "4-1-1",
 "STATUSCONT": null,
 "CODGRADE": "1",
 "USARSOLICITACAO": "N",
 "DTCOMPETENCIAINICIAL": null,
 "DTCOMPETENCIAFINAL": null,
 "PERIODOCONTABIL": "M",
 "VALORDIFERIMENTO": 0,
 "USARPESQEXT": "N",
 "IDCLASSEVALORPROTHEUS": null,
 "IDITEMCONTABILPROTHEUS": null,
 "CODPLANOPGTOPERSONALIZ": null,
 "VALORBASEPERSONALIZ": 0,
 "VALORCONTRATOAPOSPERSONALIZ": 0,
 "CODUSUARIOPERSONALIZ": null,
 "DATAPERSONALIZ": null,
 "CONSIDERADESCANTECIPACAO": "S",
 "CONSIDERADESCANTECIPACAOBOLSA": "N",
 "DTCONTRATO1": "2018-07-17T00:00:00-03:00",
 "IDOPERACAO1": null,
 "ALUNO": "LFS-0007 - LFS Fabiana",
 "SResponsavelContrato": [],
 "SBOLSARETROATIVACONTRATO": []
 }
}

Atalhos

Páginas filhas

Visão geral

Consulta

Retornando uma lista de contratos:

Retornando apenas um contrato:

CADASTRO

Cadastrando um contrato:

Alterações

Atualizando informações do contrato:

Exclusões

Excluindo o contrato: