Skip to content

Fundacred - OpenApi Specification (1.1)

Documentação para a API renewal-api

Download OpenAPI description
renewal-api.json
renewal-api.yaml
Overview
Infra Fundacred
infra@fundacred.org.br
Languages
Servers
Mock server
https://docs.fundacred.org.br/_mock/renewal-api/
TST
https://tst-api.fundacred.org.br/renewal-api/
HML
https://hml-api.fundacred.org.br/renewal-api/
PRD
https://api.fundacred.org.br/renewal-api/

[V3] Mais Ações

Ações executadas na jornada do estudante

Operations

[V2] VALORES

Operations

[V2] PLANILHAS AUXILIARES

Operations

[V2] MANUTENÇÃO DE VÍNCULO

Operations

[V2] DASHBOARD

Operations

[V2] MATRICULA

Resource para a manipulação da situação da matrícula

Operations

[V2] MAIS AÇÕES

Operations

[V2] JORNADAS

Operations

[V2] TIMELINE

Operations

[V2] NOTIFICAÇÕES

Operations

[V2] NOTIFICAÇÕES IEs

[V1] VALORES

Operations

[V1] TASKS

Operations

[V1] MATRICULA

Resource para a manipulação da situação da matrícula

Operations

[V1] + AÇÕES

Operations

postNewGraduationDate

Request

Informar nova data de formatura

Security
bearerAuth
Query
enviar-valoresboolean

flag indicando se a requisição processará também valores enviados para renovação

Default false
Bodyapplication/jsonrequired
monthstring
yearstring
brbIdinteger(int64)
valoresobject(FillValuesInDto)
curl -i -X POST \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v2/renovacao/processos/previsao-formatura?enviar-valores=false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "month": "string",
    "year": "string",
    "brbId": 0,
    "valores": {
      "brbId": 0,
      "nomeEstudante": "string",
      "qtdParcelasCobertura": 0,
      "qtdCreditos": 0,
      "valorContrato": 0,
      "valorCtrPrestServico": 0,
      "percentualConcedido": 0.1,
      "parcMeses": "string",
      "idCurso": 0,
      "regimeContrato": "string",
      "contratoAnual": "string",
      "motivoReenvio": "string",
      "motivo": "string",
      "serieSemestre": "string"
    }
  }'

Responses

Sucesso ao informar nova data de formatura.

Body*/*
sucessoPrevisaoFormaturaboolean
sucessoEnvioValoresboolean
retornoEnvioValoresobject(FillValuesOutDto)

postNewGraduationDate_1

Request

Informar nova data de formatura

Security
bearerAuth
Query
enviar-valoresboolean

flag indicando se a requisição processará também valores enviados para renovação

Default false
Bodyapplication/jsonrequired
monthstring
yearstring
brbIdinteger(int64)
valoresobject(FillValuesInDto)
curl -i -X POST \
  'https://docs.fundacred.org.br/_mock/renewal-api/processos/previsao-formatura?enviar-valores=false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "month": "string",
    "year": "string",
    "brbId": 0,
    "valores": {
      "brbId": 0,
      "nomeEstudante": "string",
      "qtdParcelasCobertura": 0,
      "qtdCreditos": 0,
      "valorContrato": 0,
      "valorCtrPrestServico": 0,
      "percentualConcedido": 0.1,
      "parcMeses": "string",
      "idCurso": 0,
      "regimeContrato": "string",
      "contratoAnual": "string",
      "motivoReenvio": "string",
      "motivo": "string",
      "serieSemestre": "string"
    }
  }'

Responses

Sucesso ao informar nova data de formatura.

Body*/*
sucessoPrevisaoFormaturaboolean
sucessoEnvioValoresboolean
retornoEnvioValoresobject(FillValuesOutDto)

getComplimentaryData_1

Request

Buscar dados complementares

Security
bearerAuth
Bodyapplication/jsonrequired
cod_bolsainteger(int64)
cod_cursostring
id_contratointeger(int64)
curl -i -X POST \
  https://docs.fundacred.org.br/_mock/renewal-api/s/v1/contrato/mais-acoes/dados-complementares \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "cod_bolsa": 0,
    "cod_curso": "string",
    "id_contrato": 0
  }'

Responses

Sucesso ao buscar daos

Body*/*
campusstring
codBolsainteger(int64)
codCursostring
turnostring
cursostring
data_inicio_reembolsostring(date-time)
numero-processostring
digito-processointeger(int32)
id-bolsainteger(int64)

registerDefaultPreferenceIe

Request

Cadastrar Grupo como preferencie da IE

Security
bearerAuth
Path
grupieinteger(int64)required

Grupo IE

curl -i -X POST \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v1/contrato/mais-acoes/cadastrar-preferencia-grupoie/{grupie}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Sucesso ao buscar daos

Body*/*
string

registrarTodosDefault

Request

Cadastrar Grupo como preferencie da IE

Security
bearerAuth
curl -i -X POST \
  https://docs.fundacred.org.br/_mock/renewal-api/s/v1/contrato/mais-acoes/cadastrar-preferencia-grupoie/ \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Sucesso ao buscar daos

Body*/*
string

existsInProgress_1

Request

Verificar se já existe processo de renovação em andamento

Security
bearerAuth
Path
processIdinteger(int64)required

ID do processo a ser consultado

curl -i -X GET \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v1/processo-solicitacao/{processId}/existe-andamento' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Consulta realizada com sucesso

Body*/*
boolean

findByPreferenceIe

Request

Obter Grupo como preferencie da IE

Security
bearerAuth
curl -i -X GET \
  https://docs.fundacred.org.br/_mock/renewal-api/s/v1/contrato/mais-acoes/obter-preferencia-grupoie \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Sucesso ao buscar daos

Body*/*
integer(int64)

getMotives_1

Request

Motivos de espera para o portal da IE

Security
bearerAuth
Query
paramstringrequired
curl -i -X GET \
  'https://docs.fundacred.org.br/_mock/renewal-api/motivo-espera?param=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Sucesso ao buscar motivos de espera.

Body*/*Array [
string
]

[V1] INCLUIR NA JORNADA

Resource para a manipulação de beneficiarios para inserir nas jornadas

Operations

[V1] DASHBOARD

Resource para a consulta de dados do Dashboard

update-controller

Operations

contract-status-controller

Operations

locking-enrollment-controller

Operations

user-ies-notifications-controller

Operations

[V2] Notificações IEs

Operations

enrollment-status-controller

Operations

[V1] convenios

Operations

dashboard-controller

Operations

[V3] API EXTERNA

Operations

[V3] Renovação

Operations

[V3] Estudantes

Operations

[V1] api-externa

Operations

contract-fill-values-controller

Operations