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

Inativar estudante na aba Sem Renovação

Request

Security
bearerAuth
Bodyapplication/jsonrequired
brb-idinteger(int64)
motivostring
curl -i -X POST \
  https://docs.fundacred.org.br/_mock/renewal-api/s/v3/mais-acoes/alterar-status/inativar-estudante \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "brb-id": 0,
    "motivo": "string"
  }'

Responses

Sucesso ao executar a ação

Body*/*
resultadostring
errostring

Alterar Status - Enviar Valores

Request

Realizar a ação Alterar Status / enviar Valores para estudantes na situação Sem Renovação.

Security
bearerAuth
Bodyapplication/jsonrequired
reenvioboolean
valoresArray of objects(FillValuesInDto)required
valores[].​brbIdinteger(int64)
valores[].​nomeEstudantestring
valores[].​qtdParcelasCoberturainteger(int32)
valores[].​qtdCreditosinteger(int32)
valores[].​valorContratonumber
valores[].​valorCtrPrestServiconumber
valores[].​percentualConcedidonumber(float)
valores[].​parcMesesstring
valores[].​idCursointeger(int64)
valores[].​regimeContratostring
valores[].​contratoAnualstring
valores[].​motivoReenviostring
valores[].​motivostring
valores[].​serieSemestrestring
dadosTrancamentoobject(EnrollmentLockInDto)

parâmetros

curl -i -X POST \
  https://docs.fundacred.org.br/_mock/renewal-api/s/v3/mais-acoes/alterar-status/enviar-valores \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "reenvio": true,
    "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"
      }
    ],
    "dadosTrancamento": {
      "brbId": 0,
      "dataOcorrido": "01-01-2025",
      "caminhoArquivo": "string"
    }
  }'

Responses

Sucesso ao executar a ação

Body*/*
registrosComSucessointeger(int64)
registrosComErrointeger(int64)
registrosPendentesinteger(int64)
errostring
linhasComErroArray of strings
linhasPendenteFundacredArray of strings
loteinteger(int64)
trancamentoobject(ResultOutDto)

Alterar Status - Afastamento ou Evasão

Request

Realizar a ação Alterar Status / Afastamento ou Evasão para estudantes na situação Sem Renovação.

Security
bearerAuth
Bodyapplication/jsonrequired
brbIdinteger(int64)required
dataOcorridostringrequired

data da solicitação do Afastamento ou Evasão

Example: "01-01-2025"
motivostringrequired
caminhoArquivostring
curl -i -X POST \
  https://docs.fundacred.org.br/_mock/renewal-api/s/v3/mais-acoes/alterar-status/afastamento-evasao \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "brbId": 0,
    "dataOcorrido": "01-01-2025",
    "motivo": "string",
    "caminhoArquivo": "string"
  }'

Responses

Sucesso ao executar a ação

Body*/*
resultadostring
errostring

[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

[V3] API EXTERNA

Operations

[V3] Renovação

Operations

[V3] Estudantes

Operations

[V1] api-externa

Operations

contract-fill-values-controller

Operations