PortfolioLinkApi

<back to all web services

CalculateOptimalPortfolio

Requires Authentication
The following routes are available for this service:
All Verbs/calculator/optimalportfolio
CalculateOptimalPortfolio Parameters:
NameParameterData TypeRequiredDescription
ClientIdqueryintNo
CurrentSavingsquerydoubleNo
LifeExpectancyAgequeryintNo
ExpectedInflationRatequerydoubleNo
WithdrawalAmountquerydoubleNo
WithdrawalGrowthRatequerydoubleNo
CalculateOptimalPortfolioResponse Parameters:
NameParameterData TypeRequiredDescription
PortfolioIdformintNo
AgeRunOutOfMoneyPessimisticformintNo
ClosingBalancePessimisticformdoubleNo
PortfolioReturnformdoubleNo
PortfolioStandardDeviationformdoubleNo
PortfolioNameformstringNo
PortfolioShortNameformstringNo

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /calculator/optimalportfolio HTTP/1.1 
Host: api.portfoliolink.co.za 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"clientId":0,"currentSavings":0,"lifeExpectancyAge":0,"expectedInflationRate":0,"withdrawalAmount":0,"withdrawalGrowthRate":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"portfolioId":0,"ageRunOutOfMoneyPessimistic":0,"closingBalancePessimistic":0,"portfolioReturn":0,"portfolioStandardDeviation":0,"portfolioName":"String","portfolioShortName":"String"}