PortfolioLinkApi

<back to all web services

GetRiskProfiles

Requires Authentication
The following routes are available for this service:
All Verbs/riskprofiles
GetRiskProfiles Parameters:
NameParameterData TypeRequiredDescription
PartnerIdqueryintNo
CurrencyquerystringNo
GetRiskProfilesResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<RiskProfile>No
RiskProfile Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
PartnerIdformintNo
RiskProfileNameformstringNo
LowerBoundformintNo
UpperBoundformintNo
RiskProfileDescriptionformstringNo
CurrencyformstringNo
PortfoliosformList<Portfolio>No
CreatedAsAtformDateTimeNo
UpdatedAsAtformDateTimeNo
Portfolio Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
PartnerIdformintNo
GoalTypeIdsformint[]No
PortfolioNameformstringNo
PortfolioShortNameformstringNo
RiskRatingformintNo
RiskDescriptionformstringNo
AsisaClassificationformstringNo
InvestmentObjectiveformstringNo
CreatedAsAtformDateTimeNo
UpdatedAsAtformDateTimeNo
BenchmarkformstringNo
TargetTicformdecimalNo
WarehouseFundIdformintNo
PctMdlAcrformstringNo
AtoolsMdlAcrformstringNo
SecurityPortfolioCodeformstringNo
StitchPerformanceformboolNo
PlatformModelIdformint?No
CurrencyformstringNo
PartnerNameformstringNo

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

{"partnerId":0,"currency":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"result":[{"id":0,"partnerId":0,"riskProfileName":"String","lowerBound":0,"upperBound":0,"riskProfileDescription":"String","currency":"String","portfolios":[{"id":0,"partnerId":0,"goalTypeIds":[0],"portfolioName":"String","portfolioShortName":"String","riskRating":0,"riskDescription":"String","asisaClassification":"String","investmentObjective":"String","createdAsAt":"0001-01-01T00:00:00.0000000","updatedAsAt":"0001-01-01T00:00:00.0000000","benchmark":"String","targetTic":0,"warehouseFundId":0,"pctMdlAcr":"String","atoolsMdlAcr":"String","securityPortfolioCode":"String","stitchPerformance":false,"platformModelId":0,"currency":"String","partnerName":"String"}],"createdAsAt":"0001-01-01T00:00:00.0000000","updatedAsAt":"0001-01-01T00:00:00.0000000"}]}