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

getTurns

Request

Listar turnos disponíveis ao usuário IE

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

Responses

Sucesso ao consultar dados

Body*/*
turnosArray of strings

getCourses

Request

Listar cursos disponíveis ao usuário IE

Security
bearerAuth
Query
codBolsastring

Código da bolsa

nomestring

Nome do curso (busca parcial)

turnostring

Turno do curso

nomeBolsastring

Nome da bolsa (busca parcial)

curl -i -X GET \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v2/renovacao/planilhas-auxiliares/cursos?codBolsa=string&nome=string&turno=string&nomeBolsa=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Sucesso ao consultar dados

Body*/*
cursosArray of objects(CourseOutDto)

getCampuses

Request

Listar campus disponíveis ao usuário IE

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

Responses

Sucesso ao consultar dados

Body*/*
campusArray of strings

[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

[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