Skip to content

Fundacred - OpenApi Specification (1.1)

Documentação para a API renewal-api

Download OpenAPI description
Overview
Infra Fundacred
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

open

Request

Abrir novas jornadas de renovação

Security
bearerAuth
Path
tipostringrequired

Código do tipo contrato, ex: T (Anual e Semestral), Q (Quadrimestral)

Query
anointeger(int32)
Example: ano=2024
periodointeger(int32)
Example: periodo=1
dtoobject(OpenJourneyInDto)required
dto.​grbIdArray of integers(int64)
dto.​instIdArray of integers(int64)
dto.​typestring
dto.​yearinteger(int32)
dto.​periodinteger(int32)
curl -i -X POST \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v2/renovacao/jornadas/{tipo}/abrir?ano=2024&periodo=1&grbId=0&instId=0&type=string&year=0&period=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Sucesso ao abrir jornadas

Body*/*
logArray of strings
sucessoboolean
mensagemErrostring
mensagemstring

refresh

Request

Atualizar (refresh) estudantes na jornada atual

Security
bearerAuth
Query
grbIdArray of integers(int64)
instIdArray of integers(int64)
curl -i -X POST \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v2/renovacao/jornadas/atualizar?grbId=0&instId=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Sucesso ao atualizar jornada atual

Body*/*
boolean

open_1

Request

Abrir novas jornadas de renovação

Security
bearerAuth
Query
dtoobject(OpenJourneyInDto)required
dto.​grbIdArray of integers(int64)
dto.​instIdArray of integers(int64)
dto.​typestring
dto.​yearinteger(int32)
dto.​periodinteger(int32)
curl -i -X POST \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v2/renovacao/jornadas/abrir?grbId=0&instId=0&type=string&year=0&period=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Sucesso ao abrir jornadas

Body*/*
logArray of strings
sucessoboolean
mensagemErrostring
mensagemstring

getJourneys

Request

Listar jornadas de renovação

Security
bearerAuth
Query
grbIdArray of integers(int64)
instIdArray of integers(int64)
curl -i -X GET \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v2/renovacao/jornadas?grbId=0&instId=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Sucesso ao listar jornadas

Body*/*
atualArray of objects(JourneyBriefOutDto)
anterioresArray of objects(JourneyBriefOutDto)

getJourneyDetail

Request

Detalhar jornada

Security
bearerAuth
Path
journeyIdinteger(int64)required

journeyId

Query
grbIdArray of integers(int64)

grbId

instIdArray of integers(int64)

instId

curl -i -X GET \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v2/renovacao/jornadas/{journeyId}?grbId=0&instId=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Sucesso ao listar jornadas

Body*/*
totalinteger(int64)
idRenovacaointeger(int64)
descricaostring
anointeger(int32)
semestreinteger(int32)
dtIniciostring(date-time)
dtFimstring(date-time)
tpContratointeger(int32)
totalAptosinteger(int64)
totalEmProcessamentointeger(int64)
totalFinalizadosinteger(int64)
totalSemRenovacaointeger(int64)

getGroups

Request

Listar Grupos grb IDs

Security
bearerAuth
curl -i -X GET \
  https://docs.fundacred.org.br/_mock/renewal-api/s/v2/renovacao/jornadas/groups \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Sucesso ao listar jornadas

Body*/*Array [
grupoIesIdinteger(int64)
nomestring
grupoPadraostring
descricaostring
valorinteger(int64)
]

[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

[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