| All Verbs | /goals/retirement/create |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | query | int | No | |
| ClientId | query | int | No | |
| GoalName | query | string | No | |
| LifeExpectancyAge | query | int | No | |
| ExpectedInflationRate | query | double | No | |
| CurrentSavings | query | double | No | |
| WithdrawalAmount | query | double | No | |
| WithdrawalGrowthRate | query | double | No | |
| CashReserve | query | double | No | |
| AddtionalSaProperty | query | double | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Success | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /goals/retirement/create HTTP/1.1
Host: api.portfoliolink.co.za
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: 0,
clientId: 0,
goalName: String,
lifeExpectancyAge: 0,
expectedInflationRate: 0,
currentSavings: 0,
withdrawalAmount: 0,
withdrawalGrowthRate: 0,
cashReserve: 0,
addtionalSaProperty: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
success: 0
}