PortfolioLinkApi

<back to all web services

GetProjectionStats

The following routes are available for this service:
All Verbs/projections/stats
GetProjectionStats Parameters:
NameParameterData TypeRequiredDescription
MoreLikelyZScorequerydecimalNo
LessLikelyZScorequerydecimalNo
InitialInvestmentquerydecimalNo
LocalCashquerydecimalNo
LocalBondsquerydecimalNo
LocalBondsHedgequerydecimalNo
LocalEquityquerydecimalNo
LocalEquityHedgequerydecimalNo
LocalPropertyquerydecimalNo
LocalPropertyHedgequerydecimalNo
ForeignCashquerydecimalNo
ForeignBondsquerydecimalNo
ForeignBondsHedgequerydecimalNo
ForeignEquityquerydecimalNo
ForeignPropertyquerydecimalNo
ForeignEquityHedgequerydecimalNo
ForeignPropertyHedgequerydecimalNo
AfricaquerydecimalNo
CommodityquerydecimalNo
PlatformFeequerydecimalNo
AdvisorFeequerydecimalNo
OtherChargesquerydecimalNo
TicquerydecimalNo
GetProjectionStatsResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<MinMaxView>No
MinMaxView Parameters:
NameParameterData TypeRequiredDescription
LabelformstringNo
YearformintNo
TrrformdecimalNo
MinformdecimalNo
MaxformdecimalNo
MaxReturnformdecimalNo
MinReturnformdecimalNo
AverageformdecimalNo
AverageReturnformdecimalNo

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

{"moreLikelyZScore":0,"lessLikelyZScore":0,"initialInvestment":0,"localCash":0,"localBonds":0,"localBondsHedge":0,"localEquity":0,"localEquityHedge":0,"localProperty":0,"localPropertyHedge":0,"foreignCash":0,"foreignBonds":0,"foreignBondsHedge":0,"foreignEquity":0,"foreignProperty":0,"foreignEquityHedge":0,"foreignPropertyHedge":0,"africa":0,"commodity":0,"platformFee":0,"advisorFee":0,"otherCharges":0,"tic":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"result":[{"label":"String","year":0,"trr":0,"min":0,"max":0,"maxReturn":0,"minReturn":0,"average":0,"averageReturn":0}]}