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

get

Request

Consultar contratos

Security
bearerAuth
Path
renewalTabEnumstringrequired
Query
queryStringobject(RenewalBeneficiariesInDto)required

parâmetros passados via query string

queryString.​statusArray of strings
queryString.​pageinteger(int32)
queryString.​sizeinteger(int32)
queryString.​maintenanceMotiveCodesArray of strings
queryString.​maintenanceMotiveObservationstring
queryString.​idMantenedoraArray of integers(int64)
queryString.​idBolsaArray of integers(int64)
queryString.​modalidadeArray of strings
queryString.​idCampusArray of integers(int64)
queryString.​codMotivoManutencaoVinculoArray of stringswrite-only
queryString.​obsMotivoManutencaoVinculostringwrite-only
queryString.​dtFormaturastring
queryString.​pesquisastring
queryString.​ordenarPorstring
queryString.​ordemstring
queryString.​formandosboolean
queryString.​idCursoArray of integers(int64)
queryString.​grauEnsinoArray of strings
queryString.​tagAtuCadArray of strings
queryString.​tagAltCtrArray of strings
queryString.​anointeger(int32)
queryString.​semestreinteger(int32)
queryString.​idRenovacaointeger(int64)
queryString.​grupostringwrite-only
queryString.​idsBolsaArray of integers(int64)
queryString.​dtStatusInistring(date-time)
queryString.​dtStatusFimstring(date-time)
queryString.​idRenovacoesArray of integers(int64)
queryString.​tagAltTraArray of strings
queryString.​inativoboolean
queryString.​courseIdArray of integers(int64)write-only
queryString.​grbIdArray of integers(int64)
queryString.​instIdArray of integers(int64)
curl -i -X GET \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v2/renovacao/{renewalTabEnum}?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 consultar dados

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

tags

Request

Consultar quais tags cada brbId tem

Security
bearerAuth
Query
brbIdsArray of integers(int64)required

Ids para verificar as tags

curl -i -X GET \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v2/renovacao/tags?brbIds=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Sucesso ao consultar dados

Body*/*Array [
brbIdinteger(int64)
tagsArray of objects(TagDto)
]

getContractsByContractId

Request

Busca status do contrato pelo ID e ID da bolsa

Security
bearerAuth
Path
brbIdinteger(int64)required

BRB_ID

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

Responses

Sucesso ao consultar dados

Body*/*
cpfstring
idProcessostring
processostring
digitoProcessostring
bolsastring
cursostring
turnostring
campusstring
nomestring
numeroMatriculastring
numeroContratostring
tipoContratostring
inicioReembolsostring
dataFormaturastring
situacaoContratostring
valorContratostring
valorContratoCrediesstring
anoSemestrestring
contratosFirmadosstring
ultimoContratostring
percentualstring
idSolicitacaointeger(int64)
inicioReembolsoProcessostring
serieSemestrestring
nivelSemestreinteger(int32)
codBolsainteger(int64)
brbIdinteger(int64)
propriedadesJsonstring
cursoInativoboolean
fiadoresArray of objects(PersonOutDto)
contratoUltimoPeriodoboolean
idCursointeger(int64)
bcsIdSerieSemestrePermitidosArray of integers(int64)

getContractsByContractId_1

Request

Busca status do contrato pelo ID e ID da bolsa

Security
bearerAuth
Path
brbIdinteger(int64)required

BRB_ID

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

Responses

Sucesso ao consultar dados

Body*/*
cpfstring
idProcessostring
processostring
digitoProcessostring
bolsastring
cursostring
turnostring
campusstring
nomestring
numeroMatriculastring
numeroContratostring
tipoContratostring
inicioReembolsostring
dataFormaturastring
situacaoContratostring
valorContratostring
valorContratoCrediesstring
anoSemestrestring
contratosFirmadosstring
ultimoContratostring
percentualstring
idSolicitacaointeger(int64)
inicioReembolsoProcessostring
serieSemestrestring
nivelSemestreinteger(int32)
codBolsainteger(int64)
brbIdinteger(int64)
propriedadesJsonstring
cursoInativoboolean
fiadoresArray of objects(PersonOutDto)
contratoUltimoPeriodoboolean
idCursointeger(int64)
bcsIdSerieSemestrePermitidosArray of integers(int64)

getWithoutRenewal

Request

Consultar contratos sem renovação

Security
bearerAuth
Query
queryStringobject(RenewalBeneficiariesInDto)required

parâmetros passados via query string

queryString.​statusArray of strings
queryString.​pageinteger(int32)
queryString.​sizeinteger(int32)
queryString.​maintenanceMotiveCodesArray of strings
queryString.​maintenanceMotiveObservationstring
queryString.​idMantenedoraArray of integers(int64)
queryString.​idBolsaArray of integers(int64)
queryString.​modalidadeArray of strings
queryString.​idCampusArray of integers(int64)
queryString.​codMotivoManutencaoVinculoArray of stringswrite-only
queryString.​obsMotivoManutencaoVinculostringwrite-only
queryString.​dtFormaturastring
queryString.​pesquisastring
queryString.​ordenarPorstring
queryString.​ordemstring
queryString.​formandosboolean
queryString.​idCursoArray of integers(int64)
queryString.​grauEnsinoArray of strings
queryString.​tagAtuCadArray of strings
queryString.​tagAltCtrArray of strings
queryString.​anointeger(int32)
queryString.​semestreinteger(int32)
queryString.​idRenovacaointeger(int64)
queryString.​grupostringwrite-only
queryString.​idsBolsaArray of integers(int64)
queryString.​dtStatusInistring(date-time)
queryString.​dtStatusFimstring(date-time)
queryString.​idRenovacoesArray of integers(int64)
queryString.​tagAltTraArray of strings
queryString.​inativoboolean
queryString.​courseIdArray of integers(int64)write-only
queryString.​grbIdArray of integers(int64)
queryString.​instIdArray of integers(int64)
curl -i -X GET \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v2/renovacao/sem-renovacao?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 consultar dados

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

getAutocomplete

Request

Consultar dados para o autocomplete

Security
bearerAuth
Query
queryStringobject(JourneyAutocompleteInDto)required

parâmetros passados via query string

queryString.​pesquisastring
queryString.​anointeger(int32)
queryString.​semestreinteger(int32)
queryString.​idRenovacaointeger(int64)
curl -i -X GET \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v2/renovacao/manutencao-vinculo/estudantes/autocomplete?pesquisa=string&ano=0&semestre=0&idRenovacao=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Sucesso ao consultar dados

Body*/*
autocompleteArray of objects(RenewalAutocompleteOutDto)

getAutocomplete_1

Request

Consultar dados para o autocomplete

Security
bearerAuth
Query
queryStringobject(JourneyAutocompleteInDto)required

parâmetros passados via query string

queryString.​pesquisastring
queryString.​anointeger(int32)
queryString.​semestreinteger(int32)
queryString.​idRenovacaointeger(int64)
curl -i -X GET \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v2/manutencao-vinculo/estudantes/autocomplete?pesquisa=string&ano=0&semestre=0&idRenovacao=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Sucesso ao consultar dados

Body*/*
autocompleteArray of objects(RenewalAutocompleteOutDto)

getTypes

Request

Listar tipos de jornadas para renovação

Security
bearerAuth
Query
grbIdArray of integers(int64)
instIdArray of integers(int64)
curl -i -X GET \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v2/renovacao/jornadas/tipos?grbId=0&instId=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Sucesso ao consultar dados

Body*/*Array [
tipostring
descricaostring
anointeger(int32)
periodointeger(int32)
]

list

Request

Consultar contratos de uma jornada para renovação

Security
bearerAuth
Query
dtoobject(RenewalBeneficiariesInDto)required

dados para consulta

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/jornadas/listar?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 consultar dados

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

getFinished

Request

Consultar contratos com processo de renovação finalizados

Security
bearerAuth
Query
queryStringobject(RenewalBeneficiariesInDto)required

parâmetros passados via query string

queryString.​statusArray of strings
queryString.​pageinteger(int32)
queryString.​sizeinteger(int32)
queryString.​maintenanceMotiveCodesArray of strings
queryString.​maintenanceMotiveObservationstring
queryString.​idMantenedoraArray of integers(int64)
queryString.​idBolsaArray of integers(int64)
queryString.​modalidadeArray of strings
queryString.​idCampusArray of integers(int64)
queryString.​codMotivoManutencaoVinculoArray of stringswrite-only
queryString.​obsMotivoManutencaoVinculostringwrite-only
queryString.​dtFormaturastring
queryString.​pesquisastring
queryString.​ordenarPorstring
queryString.​ordemstring
queryString.​formandosboolean
queryString.​idCursoArray of integers(int64)
queryString.​grauEnsinoArray of strings
queryString.​tagAtuCadArray of strings
queryString.​tagAltCtrArray of strings
queryString.​anointeger(int32)
queryString.​semestreinteger(int32)
queryString.​idRenovacaointeger(int64)
queryString.​grupostringwrite-only
queryString.​idsBolsaArray of integers(int64)
queryString.​dtStatusInistring(date-time)
queryString.​dtStatusFimstring(date-time)
queryString.​idRenovacoesArray of integers(int64)
queryString.​tagAltTraArray of strings
queryString.​inativoboolean
queryString.​courseIdArray of integers(int64)write-only
queryString.​grbIdArray of integers(int64)
queryString.​instIdArray of integers(int64)
curl -i -X GET \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v2/renovacao/finalizados?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 consultar dados

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

getFilters

Request

Buscar filtros utilizados nas telas de renovação

Security
bearerAuth
Query
dtoobject(RenewalFiltersInDto)required

Parâmetros para montar os filtros

dto.​idMantenedoraArray of integers(int64)
dto.​idBolsaArray of integers(int64)
dto.​modalidadeArray of strings
dto.​idCampusArray of integers(int64)
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/filtros?idMantenedora=0&idBolsa=0&modalidade=string&idCampus=0&grbId=0&instId=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Sucesso ao consultar dados

Body*/*
statusArray of objects(FilterOptionDto)
campusArray of objects(FilterOptionDto)
tagsobject
cursosArray of objects(FilterOptionDto)
mantenedorasArray of objects(FilterOptionDto)
iesArray of objects(FilterOptionDto)
modalidadesArray of objects(FilterOptionDto)
grausArray of objects(FilterOptionDto)
conveniosArray of objects(AgreementBetaDTO)
gruposArray of objects(GroupsDTO)
modulosTimelineArray of objects(FilterOptionDto)
semestresArray of objects(FilterOptionDto)
jornadasArray of objects(FilterOptionDto)

getProcessing

Request

Consultar contratos com renovação em processamento

Security
bearerAuth
Query
queryStringobject(RenewalBeneficiariesInDto)required

parâmetros passados via query string

queryString.​statusArray of strings
queryString.​pageinteger(int32)
queryString.​sizeinteger(int32)
queryString.​maintenanceMotiveCodesArray of strings
queryString.​maintenanceMotiveObservationstring
queryString.​idMantenedoraArray of integers(int64)
queryString.​idBolsaArray of integers(int64)
queryString.​modalidadeArray of strings
queryString.​idCampusArray of integers(int64)
queryString.​codMotivoManutencaoVinculoArray of stringswrite-only
queryString.​obsMotivoManutencaoVinculostringwrite-only
queryString.​dtFormaturastring
queryString.​pesquisastring
queryString.​ordenarPorstring
queryString.​ordemstring
queryString.​formandosboolean
queryString.​idCursoArray of integers(int64)
queryString.​grauEnsinoArray of strings
queryString.​tagAtuCadArray of strings
queryString.​tagAltCtrArray of strings
queryString.​anointeger(int32)
queryString.​semestreinteger(int32)
queryString.​idRenovacaointeger(int64)
queryString.​grupostringwrite-only
queryString.​idsBolsaArray of integers(int64)
queryString.​dtStatusInistring(date-time)
queryString.​dtStatusFimstring(date-time)
queryString.​idRenovacoesArray of integers(int64)
queryString.​tagAltTraArray of strings
queryString.​inativoboolean
queryString.​courseIdArray of integers(int64)write-only
queryString.​grbIdArray of integers(int64)
queryString.​instIdArray of integers(int64)
curl -i -X GET \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v2/renovacao/em-processamento?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 consultar dados

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

getCount

Request

Buscar contadores de registros para cada aba do dashboard

Security
bearerAuth
Query
queryStringobject(RenewalBeneficiariesInDto)required

parâmetros passados via query string

queryString.​statusArray of strings
queryString.​pageinteger(int32)
queryString.​sizeinteger(int32)
queryString.​maintenanceMotiveCodesArray of strings
queryString.​maintenanceMotiveObservationstring
queryString.​idMantenedoraArray of integers(int64)
queryString.​idBolsaArray of integers(int64)
queryString.​modalidadeArray of strings
queryString.​idCampusArray of integers(int64)
queryString.​codMotivoManutencaoVinculoArray of stringswrite-only
queryString.​obsMotivoManutencaoVinculostringwrite-only
queryString.​dtFormaturastring
queryString.​pesquisastring
queryString.​ordenarPorstring
queryString.​ordemstring
queryString.​formandosboolean
queryString.​idCursoArray of integers(int64)
queryString.​grauEnsinoArray of strings
queryString.​tagAtuCadArray of strings
queryString.​tagAltCtrArray of strings
queryString.​anointeger(int32)
queryString.​semestreinteger(int32)
queryString.​idRenovacaointeger(int64)
queryString.​grupostringwrite-only
queryString.​idsBolsaArray of integers(int64)
queryString.​dtStatusInistring(date-time)
queryString.​dtStatusFimstring(date-time)
queryString.​idRenovacoesArray of integers(int64)
queryString.​tagAltTraArray of strings
queryString.​inativoboolean
queryString.​courseIdArray of integers(int64)write-only
queryString.​grbIdArray of integers(int64)
queryString.​instIdArray of integers(int64)
curl -i -X GET \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v2/renovacao/dashboard/contadores?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 consultar dados

Body*/*
tabsArray of objects(TabOutDto)

getAutocomplete_2

Request

Consultar dados para o autocomplete

Security
bearerAuth
Query
queryStringobject(JourneyAutocompleteInDto)required

parâmetros passados via query string

queryString.​pesquisastring
queryString.​anointeger(int32)
queryString.​semestreinteger(int32)
queryString.​idRenovacaointeger(int64)
curl -i -X GET \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v2/renovacao/autocomplete?pesquisa=string&ano=0&semestre=0&idRenovacao=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Sucesso ao consultar dados

Body*/*
autocompleteArray of objects(RenewalAutocompleteOutDto)

getApt

Request

Consultar contratos aptos para renovação

Security
bearerAuth
Query
queryStringobject(RenewalBeneficiariesInDto)required

parâmetros passados via query string

queryString.​statusArray of strings
queryString.​pageinteger(int32)
queryString.​sizeinteger(int32)
queryString.​maintenanceMotiveCodesArray of strings
queryString.​maintenanceMotiveObservationstring
queryString.​idMantenedoraArray of integers(int64)
queryString.​idBolsaArray of integers(int64)
queryString.​modalidadeArray of strings
queryString.​idCampusArray of integers(int64)
queryString.​codMotivoManutencaoVinculoArray of stringswrite-only
queryString.​obsMotivoManutencaoVinculostringwrite-only
queryString.​dtFormaturastring
queryString.​pesquisastring
queryString.​ordenarPorstring
queryString.​ordemstring
queryString.​formandosboolean
queryString.​idCursoArray of integers(int64)
queryString.​grauEnsinoArray of strings
queryString.​tagAtuCadArray of strings
queryString.​tagAltCtrArray of strings
queryString.​anointeger(int32)
queryString.​semestreinteger(int32)
queryString.​idRenovacaointeger(int64)
queryString.​grupostringwrite-only
queryString.​idsBolsaArray of integers(int64)
queryString.​dtStatusInistring(date-time)
queryString.​dtStatusFimstring(date-time)
queryString.​idRenovacoesArray of integers(int64)
queryString.​tagAltTraArray of strings
queryString.​inativoboolean
queryString.​courseIdArray of integers(int64)write-only
queryString.​grbIdArray of integers(int64)
queryString.​instIdArray of integers(int64)
curl -i -X GET \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v2/renovacao/aptos?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 consultar dados

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

[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