PortfolioLinkApi

GetRiskNeed

The following routes are available for this service:
All Verbs	/riskprofiles/calculate/riskneed

**GetRiskNeed** Parameters:
Name	Parameter	Data Type	Required
LumpSum	query	decimal	No
GetIncomeCashFlowRequest	query	GetIncomeCashFlowRequest	No
GetContributionCashFlowRequest	query	GetContributionCashFlowRequest	No
AdditionalGetIncomeCashFlowRequests	query	List<GetIncomeCashFlowRequest>	No
AdditionalGetContributionCashFlowRequests	query	List<GetContributionCashFlowRequest>	No
Currency	query	string	No
GoalInfo	query	GoalInfo	No
Override	query	bool	No
OverrideMessage	query	string	No
OverrideRiskProfileId	query	int	No

**GetIncomeCashFlowRequest** Parameters:
Name	Parameter	Data Type	Required
KeyIndex	form	int	No
IncomeLabel	form	string	No
IncomeIncludeZeroIncomeYears	form	bool	No
Income	form	decimal	No
TaxRate	form	decimal	No
IncomeToLast	form	int	No
CurrentAge	form	int	No
IncomeGrowth	form	decimal	No
IncomeGrowthFrequency	form	decimal	No
PayoutFrequency	form	int	No
StartYear	form	int	No
HasAdhocCashFlow	form	bool	No
AdhocCashFlowAge1	form	int	No
AdhocCashFlow1	form	decimal	No
AdhocCashFlowAge2	form	int	No
AdhocCashFlow2	form	decimal	No
AdhocCashFlowAge3	form	int	No
AdhocCashFlow3	form	decimal	No
ApplySmile	form	bool	No

**GetContributionCashFlowRequest** Parameters:
Name	Parameter	Data Type	Required
KeyIndex	form	int	No
ContributionLabel	form	string	No
ApplyContribution	form	bool	No
Contribution	form	decimal	No
ContributionGrowth	form	decimal	No
ContributionGrowthFrequency	form	decimal	No
ContributionFrequency	form	int	No
ContributionStartYear	form	int	No
ContributionToLast	form	int	No

**GoalInfo** Parameters:
Name	Parameter	Data Type	Required
GoalName	form	string	No
GoalDescription	form	string	No
Type	form	GoalTypeEnum	No
GoalHasTarget	form	bool	No
GoalTarget	form	decimal	No
GoalTargetAge	form	int	No
Currency	form	string	No
WrapperType	form	string	No

**GoalTypeEnum** Enum:
PostRetirement
PreRetirement
Emergency
Education
GeneralInvesting
Target
Wedding
House

**GetRiskNeedResponse** Parameters:
Name	Parameter	Data Type	Required
RequiredRateOfReturn	form	decimal	No
RiskProfile	form	string	No
RiskProfileId	form	int	No
Message	form	string	No
Override	form	bool	No
OverrideMessage	form	string	No
OverrideRiskProfileId	form	int	No

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 /riskprofiles/calculate/riskneed HTTP/1.1 
Host: api.portfoliolink.co.za 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	lumpSum: 0,
	getIncomeCashFlowRequest: 
	{
		keyIndex: 0,
		incomeLabel: String,
		incomeIncludeZeroIncomeYears: False,
		income: 0,
		taxRate: 0,
		incomeToLast: 0,
		currentAge: 0,
		incomeGrowth: 0,
		incomeGrowthFrequency: 0,
		payoutFrequency: 0,
		startYear: 0,
		hasAdhocCashFlow: False,
		adhocCashFlowAge1: 0,
		adhocCashFlow1: 0,
		adhocCashFlowAge2: 0,
		adhocCashFlow2: 0,
		adhocCashFlowAge3: 0,
		adhocCashFlow3: 0,
		applySmile: False
	},
	getContributionCashFlowRequest: 
	{
		keyIndex: 0,
		contributionLabel: String,
		applyContribution: False,
		contribution: 0,
		contributionGrowth: 0,
		contributionGrowthFrequency: 0,
		contributionFrequency: 0,
		contributionStartYear: 0,
		contributionToLast: 0
	},
	additionalGetIncomeCashFlowRequests: 
	[
		{
			keyIndex: 0,
			incomeLabel: String,
			incomeIncludeZeroIncomeYears: False,
			income: 0,
			taxRate: 0,
			incomeToLast: 0,
			currentAge: 0,
			incomeGrowth: 0,
			incomeGrowthFrequency: 0,
			payoutFrequency: 0,
			startYear: 0,
			hasAdhocCashFlow: False,
			adhocCashFlowAge1: 0,
			adhocCashFlow1: 0,
			adhocCashFlowAge2: 0,
			adhocCashFlow2: 0,
			adhocCashFlowAge3: 0,
			adhocCashFlow3: 0,
			applySmile: False
		}
	],
	additionalGetContributionCashFlowRequests: 
	[
		{
			keyIndex: 0,
			contributionLabel: String,
			applyContribution: False,
			contribution: 0,
			contributionGrowth: 0,
			contributionGrowthFrequency: 0,
			contributionFrequency: 0,
			contributionStartYear: 0,
			contributionToLast: 0
		}
	],
	currency: String,
	goalInfo: 
	{
		goalName: String,
		goalDescription: String,
		type: PostRetirement,
		goalHasTarget: False,
		goalTarget: 0,
		goalTargetAge: 0,
		currency: String,
		wrapperType: String
	},
	override: False,
	overrideMessage: String,
	overrideRiskProfileId: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	requiredRateOfReturn: 0,
	riskProfile: String,
	riskProfileId: 0,
	message: String,
	override: False,
	overrideMessage: String,
	overrideRiskProfileId: 0
}