post https://api-lib.bambu.life/api/generalCalculator/v2/goalCalculator/calcUniversityGoalAmount
A user enters Gender of the child, Age of the child and age child will attend university, select the Country, Type of University and Specialisation.
The following table describes the parameters of this API:
Name | Data Type | Technical Description | Mandatory | Sample Value | List of Possible Values | No. of Decimals | Remarks |
---|---|---|---|---|---|---|---|
age | number | Age of child | Y | 1 | 0 | age variable represents the Age of Child. Valid age is only >0age must be smaller than ageOfUni | |
ageOfUni | number | Age at which child shall attend university | Y | 18 | 0 | ageOfUni represents the Age child will attend university | |
maxGoalYear | number | Maximum number of years to achieve the goal | Y | 24 | 0 | Value is hardcoded/pre-populated, and not entered by the user, defines the maximum number of year to reach goal | |
universityType | String | Type of University | Y | Public | 'Public', 'Private' | The user selects from Two types of universities Public and Private. If a user is not allowed to select the type of university then default university Type must be 'Public' | |
specialisation | String | Specialization of education | Y | Medicine | 'Medicine','General' | The Type of Major selected for the child's education. | |
country | String | Country of University Education | Y | SG | 'AU', 'CA', 'ID', 'MY', 'NZ', 'PH', 'SG', 'AE', 'GB', 'US', 'VN' | The desired country for a child's university education | |
inflationRate | Number | Rate of inflation in the country of education | Y | 0.03 | 6 | Based on the long term inflation rate retrieved from the Country service of a specific country or by hardcoding in the Front End based on client requirement. endpoint - /v1/rate/:countryCode, field to use - inflation_rate_long_term | |
currentYear | Number | Year to Date | Y | 2019 | 0 | System generated current year |
The following table describes the output of this API:
Name | Data Type | Technical Description | Sample Value | No. of decimals |
---|---|---|---|---|
goalYear | Number | Year of goal attainment | 2036 | 0 |
yearsToGoal | Number | Number of years remaining to reach goal | 17 | 0 |
maxYearsToGoal | Number | Maximum number of years to reach goal by | 23 | 0 |
educationCost | Number | Total cost of university education adjusted to inflation | 1101210 | 0 |
UniversityCost | Number | Cost of university education before adjusting to inflation | 666250 | 0 |
currency | Number | The currency of education cost | SGD |