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

Alterar status da Jornada

Request

Alterar status da Jornada

Parâmetros para Definição de Tipo Ação

Revisão de Análise

{ "motivo": "string", "situacao": "REVISAO_ANALISE" }

Trancamento de Matrícula

{ "situacao": "TRANCAMENTO", "situacaoMatricula": { "tipo": "D", "situacaoMatricula": "T", "data-ocorrido": "dd-mm-yyyy" } }

Afastamento ou Evasão

{ "situacao": "AFASTAMENTO_EVASAO", "situacaoMatricula": { "tipo": "F", "situacao-matricula": "S", "motivo": "5", "situacao-restituicao": "A", "data-ocorrido": "dd-mm-yyyy" } }

ou

{ "situacao": "AFASTAMENTO_EVASAO", "situacaoMatricula": { "tipo": "E", "situacao-matricula": "S", "motivo": "string", "situacao-restituicao": "A", "data-ocorrido": "dd-mm-yyyy" } }

Manutenção de Vínculo

{ "situacao": "MANUTENCAO_VINCULO", "situacaoMatricula": { "tipo" : "S", "motivo" : "string", "motivo-complementar" : "string", "situacao-matricula" : "A", "situacao-restituicao" : "A", "data-ocorrido" : "dd-mm-yyyy", "contratos-firmados" : number, "inicio-reembolso" : "yyyy-mm-dd"} }

Enviar Valores

{ "situacao": "ENVIO_VALORES", "valoresRenovacao": [{...campos }]

Security
bearerAuth
Path
brbIdinteger(int64)required
Bodyapplication/jsonrequired
brbIdinteger(int64)
motivostring
curl -i -X POST \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v2/renovacao/status-contrato/{brbId}/brb-id/alterar' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "brbId": 0,
    "motivo": "string"
  }'

Responses

OK

Body*/*
envio-valoresobject(FillValuesOutDto)

Alterar status da Jornada

Request

Alterar status da Jornada

Parâmetros para Definição de Tipo Ação

Revisão de Análise

{ "motivo": "string", "situacao": "REVISAO_ANALISE" }

Trancamento de Matrícula

{ "situacao": "TRANCAMENTO", "situacaoMatricula": { "tipo": "D", "situacaoMatricula": "T", "data-ocorrido": "dd-mm-yyyy" } }

Afastamento ou Evasão

{ "situacao": "AFASTAMENTO_EVASAO", "situacaoMatricula": { "tipo": "F", "situacao-matricula": "S", "motivo": "5", "situacao-restituicao": "A", "data-ocorrido": "dd-mm-yyyy" } }

ou

{ "situacao": "AFASTAMENTO_EVASAO", "situacaoMatricula": { "tipo": "E", "situacao-matricula": "S", "motivo": "string", "situacao-restituicao": "A", "data-ocorrido": "dd-mm-yyyy" } }

Manutenção de Vínculo

{ "situacao": "MANUTENCAO_VINCULO", "situacaoMatricula": { "tipo" : "S", "motivo" : "string", "motivo-complementar" : "string", "situacao-matricula" : "A", "situacao-restituicao" : "A", "data-ocorrido" : "dd-mm-yyyy", "contratos-firmados" : number, "inicio-reembolso" : "yyyy-mm-dd"} }

Enviar Valores

{ "situacao": "ENVIO_VALORES", "valoresRenovacao": [{...campos }]

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

Responses

OK

Body*/*
envio-valoresobject(FillValuesOutDto)

deleteContract_3

Request

Realizar exclusão do contrato do estudante

Security
bearerAuth
Path
brbIdinteger(int64)required

ID da jornada do estudante

Bodyapplication/jsonrequired
situacaostring
motivostring
motivo-complementarstring
datastring(date-time)
arquivostring
curl -i -X POST \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v2/mais-acoes/{brbId}/excluir-contrato' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "situacao": "string",
    "motivo": "string",
    "motivo-complementar": "string",
    "data": "2019-08-24T14:15:22Z",
    "arquivo": "string"
  }'

Responses

Sucesso realizar exclusão

Body*/*
sucessoboolean
mensagemstring

cancelContract_3

Request

Realizar cancelamento do contrato do estudante

Security
bearerAuth
Path
brbIdinteger(int64)required

ID da jornada do estudante

Bodyapplication/jsonrequired
situacaostring
motivostring
motivo-complementarstring
datastring(date-time)
arquivostring
curl -i -X POST \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v2/mais-acoes/{brbId}/cancelar-contrato' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "situacao": "string",
    "motivo": "string",
    "motivo-complementar": "string",
    "data": "2019-08-24T14:15:22Z",
    "arquivo": "string"
  }'

Responses

Sucesso realizar cancelamento

Body*/*
sucessoboolean
mensagemstring

maintainLocking_2

Request

Realizar trancamento de matrícula do estudante

Security
bearerAuth
Bodyapplication/jsonrequired
brbIdinteger(int64)
id-processointeger(int64)
id-solicitacaointeger(int64)
nome-estudantestring
cpfstring
cod-bolsastring
bolsastring
situacao-matriculastring
tipostring
motivostring
motivo-complementarstring
situacao-restituicaostring
data-ocorridostring(date-time)
anointeger(int32)
semestreinteger(int32)
matriculastring
inicio-reembolsostring(date-time)
ultimo-contratostring
texto-livrestring
caminho-arquivostring
curl -i -X POST \
  https://docs.fundacred.org.br/_mock/renewal-api/s/v2/mais-acoes/trancamento \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "brbId": 0,
    "id-processo": 0,
    "id-solicitacao": 0,
    "nome-estudante": "string",
    "cpf": "string",
    "cod-bolsa": "string",
    "bolsa": "string",
    "situacao-matricula": "string",
    "tipo": "string",
    "motivo": "string",
    "motivo-complementar": "string",
    "situacao-restituicao": "string",
    "data-ocorrido": "2019-08-24T14:15:22Z",
    "ano": 0,
    "semestre": 0,
    "matricula": "string",
    "inicio-reembolso": "2019-08-24T14:15:22Z",
    "ultimo-contrato": "string",
    "texto-livre": "string",
    "caminho-arquivo": "string"
  }'

Responses

Sucesso realizar trancamento

existsInProgress

Request

Verificar se já existe ações em andamento para a renovação

Security
bearerAuth
Path
brbIdinteger(int64)required

ID da renovação a ser consultada

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

Responses

Consulta realizada com sucesso

Body*/*
envioValoresboolean
trancamentoboolean
afastamentoEvasaoboolean
previsaoFormaturaboolean
manutencaoVinculoboolean
assinaturaContratoAnteriorboolean

listSituations

Request

Listar situações permitidas para Exclusão ou Cancelamento de contrato

Security
bearerAuth
Query
exclusaoCancelamentoboolean

Indica se deve listar apenas tipos para as ações Exclusão ou Cancelamento de contrato.

curl -i -X GET \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v2/mais-acoes/situacoes?exclusaoCancelamento=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Sucesso realizar trancamento

Body*/*Array [
statusTypeIdsArray of strings
descriptionstring
idstring
]

[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