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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<GetRiskProfiles xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
  <Currency>String</Currency>
  <PartnerId>0</PartnerId>
</GetRiskProfiles>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetRiskProfilesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/SharedTypes">
    <d2p1:RiskProfile>
      <d2p1:CreatedAsAt>0001-01-01T00:00:00</d2p1:CreatedAsAt>
      <d2p1:Currency>String</d2p1:Currency>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:LowerBound>0</d2p1:LowerBound>
      <d2p1:PartnerId>0</d2p1:PartnerId>
      <d2p1:Portfolios>
        <d2p1:Portfolio>
          <d2p1:AsisaClassification>String</d2p1:AsisaClassification>
          <d2p1:AtoolsMdlAcr>String</d2p1:AtoolsMdlAcr>
          <d2p1:Benchmark>String</d2p1:Benchmark>
          <d2p1:CreatedAsAt>0001-01-01T00:00:00</d2p1:CreatedAsAt>
          <d2p1:Currency>String</d2p1:Currency>
          <d2p1:GoalTypeIds xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>0</d6p1:int>
          </d2p1:GoalTypeIds>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:InvestmentObjective>String</d2p1:InvestmentObjective>
          <d2p1:PartnerId>0</d2p1:PartnerId>
          <d2p1:PartnerName>String</d2p1:PartnerName>
          <d2p1:PctMdlAcr>String</d2p1:PctMdlAcr>
          <d2p1:PlatformModelId>0</d2p1:PlatformModelId>
          <d2p1:PortfolioName>String</d2p1:PortfolioName>
          <d2p1:PortfolioShortName>String</d2p1:PortfolioShortName>
          <d2p1:RiskDescription>String</d2p1:RiskDescription>
          <d2p1:RiskRating>0</d2p1:RiskRating>
          <d2p1:SecurityPortfolioCode>String</d2p1:SecurityPortfolioCode>
          <d2p1:StitchPerformance>false</d2p1:StitchPerformance>
          <d2p1:TargetTic>0</d2p1:TargetTic>
          <d2p1:UpdatedAsAt>0001-01-01T00:00:00</d2p1:UpdatedAsAt>
          <d2p1:WarehouseFundId>0</d2p1:WarehouseFundId>
        </d2p1:Portfolio>
      </d2p1:Portfolios>
      <d2p1:RiskProfileDescription>String</d2p1:RiskProfileDescription>
      <d2p1:RiskProfileName>String</d2p1:RiskProfileName>
      <d2p1:UpdatedAsAt>0001-01-01T00:00:00</d2p1:UpdatedAsAt>
      <d2p1:UpperBound>0</d2p1:UpperBound>
    </d2p1:RiskProfile>
  </Result>
</GetRiskProfilesResponse>