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

listBondMaintenanceBeneficiaries

Request

Listar todos os beneficarios com manutenção de vínculo para a jornada

Security
bearerAuth
Query
dtoobject(RenewalBeneficiariesInDto)required

Dados de entrada para filtrar beneficiarios

dto.​statusArray of strings
dto.​pageinteger(int32)
dto.​sizeinteger(int32)
dto.​maintenanceMotiveCodesArray of strings
dto.​maintenanceMotiveObservationstring
dto.​idMantenedoraArray of integers(int64)
dto.​idBolsaArray of integers(int64)
dto.​modalidadeArray of strings
dto.​idCampusArray of integers(int64)
dto.​codMotivoManutencaoVinculoArray of stringswrite-only
dto.​obsMotivoManutencaoVinculostringwrite-only
dto.​dtFormaturastring
dto.​pesquisastring
dto.​ordenarPorstring
dto.​ordemstring
dto.​formandosboolean
dto.​idCursoArray of integers(int64)
dto.​grauEnsinoArray of strings
dto.​tagAtuCadArray of strings
dto.​tagAltCtrArray of strings
dto.​anointeger(int32)
dto.​semestreinteger(int32)
dto.​idRenovacaointeger(int64)
dto.​grupostringwrite-only
dto.​idsBolsaArray of integers(int64)
dto.​dtStatusInistring(date-time)
dto.​dtStatusFimstring(date-time)
dto.​idRenovacoesArray of integers(int64)
dto.​tagAltTraArray of strings
dto.​inativoboolean
dto.​courseIdArray of integers(int64)write-only
dto.​grbIdArray of integers(int64)
dto.​instIdArray of integers(int64)
curl -i -X GET \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v2/renovacao/manutencao-vinculo/estudantes?status=string&page=0&size=0&maintenanceMotiveCodes=string&maintenanceMotiveObservation=string&idMantenedora=0&idBolsa=0&modalidade=string&idCampus=0&codMotivoManutencaoVinculo=string&obsMotivoManutencaoVinculo=string&dtFormatura=string&pesquisa=string&ordenarPor=string&ordem=string&formandos=true&idCurso=0&grauEnsino=string&tagAtuCad=string&tagAltCtr=string&ano=0&semestre=0&idRenovacao=0&grupo=string&idsBolsa=0&dtStatusIni=2019-08-24T14%3A15%3A22Z&dtStatusFim=2019-08-24T14%3A15%3A22Z&idRenovacoes=0&tagAltTra=string&inativo=true&courseId=0&grbId=0&instId=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Sucesso ao listar dados

Body*/*
resultadosArray of objects(RenewalConcessionOutDto)
anointeger(int32)
semestreinteger(int32)
totalEstudantesinteger(int64)
total_paginasinteger(int32)
total_resultadosinteger(int64)
tamanhointeger(int32)
paginainteger(int32)

listBondMaintenanceBeneficiaries_1

Request

Listar todos os beneficarios com manutenção de vínculo para a jornada

Security
bearerAuth
Query
dtoobject(RenewalBeneficiariesInDto)required

Dados de entrada para filtrar beneficiarios

dto.​statusArray of strings
dto.​pageinteger(int32)
dto.​sizeinteger(int32)
dto.​maintenanceMotiveCodesArray of strings
dto.​maintenanceMotiveObservationstring
dto.​idMantenedoraArray of integers(int64)
dto.​idBolsaArray of integers(int64)
dto.​modalidadeArray of strings
dto.​idCampusArray of integers(int64)
dto.​codMotivoManutencaoVinculoArray of stringswrite-only
dto.​obsMotivoManutencaoVinculostringwrite-only
dto.​dtFormaturastring
dto.​pesquisastring
dto.​ordenarPorstring
dto.​ordemstring
dto.​formandosboolean
dto.​idCursoArray of integers(int64)
dto.​grauEnsinoArray of strings
dto.​tagAtuCadArray of strings
dto.​tagAltCtrArray of strings
dto.​anointeger(int32)
dto.​semestreinteger(int32)
dto.​idRenovacaointeger(int64)
dto.​grupostringwrite-only
dto.​idsBolsaArray of integers(int64)
dto.​dtStatusInistring(date-time)
dto.​dtStatusFimstring(date-time)
dto.​idRenovacoesArray of integers(int64)
dto.​tagAltTraArray of strings
dto.​inativoboolean
dto.​courseIdArray of integers(int64)write-only
dto.​grbIdArray of integers(int64)
dto.​instIdArray of integers(int64)
curl -i -X GET \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v2/manutencao-vinculo/estudantes?status=string&page=0&size=0&maintenanceMotiveCodes=string&maintenanceMotiveObservation=string&idMantenedora=0&idBolsa=0&modalidade=string&idCampus=0&codMotivoManutencaoVinculo=string&obsMotivoManutencaoVinculo=string&dtFormatura=string&pesquisa=string&ordenarPor=string&ordem=string&formandos=true&idCurso=0&grauEnsino=string&tagAtuCad=string&tagAltCtr=string&ano=0&semestre=0&idRenovacao=0&grupo=string&idsBolsa=0&dtStatusIni=2019-08-24T14%3A15%3A22Z&dtStatusFim=2019-08-24T14%3A15%3A22Z&idRenovacoes=0&tagAltTra=string&inativo=true&courseId=0&grbId=0&instId=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Sucesso ao listar dados

Body*/*
resultadosArray of objects(RenewalConcessionOutDto)
anointeger(int32)
semestreinteger(int32)
totalEstudantesinteger(int64)
total_paginasinteger(int32)
total_resultadosinteger(int64)
tamanhointeger(int32)
paginainteger(int32)

hasBondMaintenanceBeneficiaries

Request

Validar se existem beneficarios com manutenção de vínculo para a jornada

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

Responses

Sucesso ao consultar dados

Body*/*
boolean

hasBondMaintenanceBeneficiaries_1

Request

Validar se existem beneficarios com manutenção de vínculo para a jornada

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

Responses

Sucesso ao consultar dados

Body*/*
boolean

[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