PortfolioLinkApi

<back to all web services

CreateOrUpdateRetirementGoal

Requires Authentication
The following routes are available for this service:
All Verbs/goals/retirement/create
CreateOrUpdateRetirementGoal Parameters:
NameParameterData TypeRequiredDescription
IdqueryintNo
ClientIdqueryintNo
GoalNamequerystringNo
LifeExpectancyAgequeryintNo
ExpectedInflationRatequerydoubleNo
CurrentSavingsquerydoubleNo
WithdrawalAmountquerydoubleNo
WithdrawalGrowthRatequerydoubleNo
CashReservequerydoubleNo
AddtionalSaPropertyquerydoubleNo
CreateGoalResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformintNo

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 /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
}