PortfolioLinkApi

<back to all web services

UpdatePartnerDefaultSettings

Requires Authentication
The following routes are available for this service:
All Verbs/settings/default/update
UpdatePartnerDefaultSettings Parameters:
NameParameterData TypeRequiredDescription
MoreLikelyZScorequerydecimal?No
LessLikelyZScorequerydecimal?No
ShowLowestProjectedOutcomequerybool?No
ShowAdvisoryFeesquerybool?No
IsFundAlphaEqualToFeesquerybool?No
XAxisLabelquerystringNo
AaTypequerystringNo
AppearanceSettingsqueryAppearanceSettingsNo
AppearanceSettings Parameters:
NameParameterData TypeRequiredDescription
AppearanceSchemaformAppearanceSchemaNo
ProjectedComponentNameformstringNo
ShowMedianOutcomeformboolNo
MedianLineColorformstringNo
BottomScenarioLineColorformstringNo
ShowLowestProjectedOutcomeformboolNo
AppearanceSchema Parameters:
NameParameterData TypeRequiredDescription
FontColorformstringNo
AxisColorformstringNo
AxisGridColorformstringNo
GraphColorformstringNo
GraphColorOpacityformdoubleNo
GraphColorRange2formstringNo
GraphColorOpacity2formdoubleNo
AverageLineColorformstringNo
BarColor1formstringNo
BarColor2formstringNo
LogoHeightformstringNo
LogoUrlformstringNo
LogoBackgroundformstringNo
TopBarBackgroundformstringNo
TopBarFontColorformstringNo
H2ColorformstringNo
LinkColorformstringNo
ProposalBackgroundUrlformstringNo
ProposalBackgroundUrl2formstringNo
ProposalBackgroundUrl3formstringNo
ProposalBackgroundUrl4formstringNo
UpdatePartnerDefaultSettingsResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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/jsv
Content-Type: text/jsv
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/jsv
Content-Length: length

{
	success: False
}