| All Verbs | /settings/default/update |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MoreLikelyZScore | query | decimal? | No | |
| LessLikelyZScore | query | decimal? | No | |
| ShowLowestProjectedOutcome | query | bool? | No | |
| ShowAdvisoryFees | query | bool? | No | |
| IsFundAlphaEqualToFees | query | bool? | No | |
| XAxisLabel | query | string | No | |
| AaType | query | string | No | |
| AppearanceSettings | query | AppearanceSettings | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AppearanceSchema | form | AppearanceSchema | No | |
| ProjectedComponentName | form | string | No | |
| ShowMedianOutcome | form | bool | No | |
| MedianLineColor | form | string | No | |
| BottomScenarioLineColor | form | string | No | |
| ShowLowestProjectedOutcome | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FontColor | form | string | No | |
| AxisColor | form | string | No | |
| AxisGridColor | form | string | No | |
| GraphColor | form | string | No | |
| GraphColorOpacity | form | double | No | |
| GraphColorRange2 | form | string | No | |
| GraphColorOpacity2 | form | double | No | |
| AverageLineColor | form | string | No | |
| BarColor1 | form | string | No | |
| BarColor2 | form | string | No | |
| LogoHeight | form | string | No | |
| LogoUrl | form | string | No | |
| LogoBackground | form | string | No | |
| TopBarBackground | form | string | No | |
| TopBarFontColor | form | string | No | |
| H2Color | form | string | No | |
| LinkColor | form | string | No | |
| ProposalBackgroundUrl | form | string | No | |
| ProposalBackgroundUrl2 | form | string | No | |
| ProposalBackgroundUrl3 | form | string | No | |
| ProposalBackgroundUrl4 | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Success | form | bool | 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 /settings/default/update HTTP/1.1
Host: api.portfoliolink.co.za
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"moreLikelyZScore":0,"lessLikelyZScore":0,"showLowestProjectedOutcome":false,"showAdvisoryFees":false,"isFundAlphaEqualToFees":false,"xAxisLabel":"String","aaType":"String","appearanceSettings":{"appearanceSchema":{"fontColor":"String","axisColor":"String","axisGridColor":"String","graphColor":"String","graphColorOpacity":0,"graphColorRange2":"String","graphColorOpacity2":0,"averageLineColor":"String","barColor1":"String","barColor2":"String","logoHeight":"String","logoUrl":"String","logoBackground":"String","topBarBackground":"String","topBarFontColor":"String","h2Color":"String","linkColor":"String","proposalBackgroundUrl":"String","proposalBackgroundUrl2":"String","proposalBackgroundUrl3":"String","proposalBackgroundUrl4":"String"},"projectedComponentName":"String","showMedianOutcome":false,"medianLineColor":"String","bottomScenarioLineColor":"String","showLowestProjectedOutcome":false}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"success":false}