| All Verbs | /sustainableIncome |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CurrentSavings | query | decimal | No | |
| CurrentAge | query | int | No | |
| LifeExpectancyAge | query | int | No | |
| PortfolioReturn | query | decimal | No | |
| PortfolioVolatility | query | decimal | No | |
| AdvisorFees | query | decimal | No | |
| ExpectedInflationRate | query | decimal | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SustainableIncomeList | form | Dictionary<int, decimal> | No | |
| SustainableIncome | form | decimal | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /sustainableIncome HTTP/1.1
Host: api.portfoliolink.co.za
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"currentSavings":0,"currentAge":0,"lifeExpectancyAge":0,"portfolioReturn":0,"portfolioVolatility":0,"advisorFees":0,"expectedInflationRate":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"sustainableIncomeList":{"0":0},"sustainableIncome":0}