| All Verbs | /projections/contribution |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| KeyIndex | query | int | No | |
| ContributionLabel | query | string | No | |
| ApplyContribution | query | bool | No | |
| Contribution | query | decimal | No | |
| ContributionGrowth | query | decimal | No | |
| ContributionGrowthFrequency | query | decimal | No | |
| ContributionFrequency | query | int | No | |
| ContributionStartYear | query | int | No | |
| ContributionToLast | query | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Incomes | form | List<IncomeView> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Year | form | int | No | |
| Income | form | decimal | 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 /projections/contribution HTTP/1.1
Host: api.portfoliolink.co.za
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
keyIndex: 0,
contributionLabel: String,
applyContribution: False,
contribution: 0,
contributionGrowth: 0,
contributionGrowthFrequency: 0,
contributionFrequency: 0,
contributionStartYear: 0,
contributionToLast: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
incomes:
[
{
year: 0,
income: 0
}
]
}