PortfolioLinkApi

<back to all web services

RunMsSimulation

The following routes are available for this service:
All Verbs/ms/run
RunMsSimulation Parameters:
NameParameterData TypeRequiredDescription
ExpectedReturnquerydoubleNo
VolatilityquerydoubleNo
YearsqueryintNo
RunMsSimulationResponse Parameters:
NameParameterData TypeRequiredDescription
GraphReturnsformList<GraphReturn>No
GraphBalancesformList<GraphReturn>No
GraphReturn Parameters:
NameParameterData TypeRequiredDescription
YearIndexformintNo
Pess2formdoubleNo
Pess1formdoubleNo
MedformdoubleNo
Opt1formdoubleNo
Opt2formdoubleNo

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

{
	expectedReturn: 0,
	volatility: 0,
	years: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	graphReturns: 
	[
		{
			yearIndex: 0,
			pess2: 0,
			pess1: 0,
			med: 0,
			opt1: 0,
			opt2: 0
		}
	],
	graphBalances: 
	[
		{
			yearIndex: 0,
			pess2: 0,
			pess1: 0,
			med: 0,
			opt1: 0,
			opt2: 0
		}
	]
}