# Scholarship
Scholarship instance is s published scholarship that can receive new applications. In other words, a potential applicant can apply for it.
# Attributes
id
- GUID - Unique identifier of the scholarship.
title
- String - Scholarship name or basic description.
description
- String - Full scholarship description.
amount
- Number - How many money in dollars, receive 1 winner (award)
awards
- Number - Number of scholarship awards
start
- Date - Date in
timezone
when scholarship starts.
- Date - Date in
deadline
- Date - Date in
timezone
when scholarship deadline is.
- Date - Date in
timezone
- String - Scholarship timezone
recurringType
- String|null - Period type
- day
- week
- month
- year
- String|null - Period type
recurringValue
- String|null - Period value
expiredAt
- Date|null - If set scholarship is expired (after deadline) and new applications can't be sent.
WARNING
If recurringType
and recurringValue
is not null scholarship is repeatable. Recurring period can be build by
concatinating recurringValue
and recurringType
examples: 1 day, 1 week, 1 month, 1 year.
# Relationships
fields
- List of required for application fields. It is also has eligibility configurations that must be checked before application.- Array of scholarship fields.
requirements
- List of requirements that must be sent as application data.- Array of scholarship requirements.
- /api/scholarship/@id/requirements - Get requirements by scholarship id
# Meta
next
- Date|null - If scholarship is repeatable next scholarship start date will be returned.
# Actions
- /api/scholarship/@id/fields - Get fields by scholarship id
- /api/scholarship/@id/requirements - Get requirements by scholarship id