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

[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

getDashboard

Request

Consulta de dados para compor as células do Dashboard

Security
bearerAuth
Bodyapplication/jsonrequired
likeArray of objects(LikeFilterDto)
orderobject(OrderFilterDto)
Tabelastring
Filtrostring
curl -i -X POST \
  https://docs.fundacred.org.br/_mock/renewal-api/s/dashboard \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "like": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "order": {
      "orderBy": "string",
      "reversed": true
    },
    "Tabela": "string",
    "Filtro": "string"
  }'

Responses

Sucesso ao buscar dados do dashboard

Body*/*
cardGroupListArray of objects(CardGroup)

getMainFilter

Request

Filtros bolsas. Usado como base para montar os filtros do Dashboard.

Security
bearerAuth
Bodyapplication/jsonrequired
likeArray of objects(LikeFilterDto)
orderobject(OrderFilterDto)
Tabelastring
Filtrostring
curl -i -X POST \
  https://docs.fundacred.org.br/_mock/renewal-api/s/dashboard/filtros-bolsas \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "like": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "order": {
      "orderBy": "string",
      "reversed": true
    },
    "Tabela": "string",
    "Filtro": "string"
  }'

Responses

Sucesso ao consultar filtros bolsas

Body*/*
bolsasIdArray of integers(int64)
mantenedorasArray of objects(MaintainerDto)

getDashboardDetail

Request

Consulta de dados detalhados do dashboard

Security
bearerAuth
Query
pageinteger(int32)

Número da página de resultados

sizeinteger(int32)

Número de registros por página

Bodyapplication/jsonrequired
likeArray of objects(LikeFilterDto)
orderobject(OrderFilterDto)
Tabelastring
Filtrostring
curl -i -X POST \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/dashboard/detalhes?page=0&size=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "like": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "order": {
      "orderBy": "string",
      "reversed": true
    },
    "Tabela": "string",
    "Filtro": "string"
  }'

Responses

Sucesso ao buscar dados do dashboard

Body*/*
string

[V3] API EXTERNA

Operations

[V3] Renovação

Operations

[V3] Estudantes

Operations

[V1] api-externa

Operations

contract-fill-values-controller

Operations