AlbaApi

<back to all web services

InvestmentRiskProfileRequest

The following routes are available for this service:
GET/members/{EmployeeGuid}/investmentprofile
InvestmentRiskProfileRequest Parameters:
NameParameterData TypeRequiredDescription
EmployeeGuidpathGuidNo
InvestmentRiskProfileResponse Parameters:
NameParameterData TypeRequiredDescription
RiskformRiskModelNo
ProductformRecommendedProductsNo
RecommendedProductGraphformRecommendedProductGraphNo
QuestionnaireAnswersformQuestionnaireAnswers[]No
RiskModel Parameters:
NameParameterData TypeRequiredDescription
RecommendedRiskformRecommendedRiskNo
ChosenRiskformRecommendedRiskNo
RecommendedRisk Parameters:
NameParameterData TypeRequiredDescription
RiskNameformstringNo
RiskValueformint?No
RiskIdformstringNo
RecommendedProducts Parameters:
NameParameterData TypeRequiredDescription
RecommendedProductformRecommendedProductTypeNo
ChosenProductformRecommendedProductTypeNo
RecommendedProductType Parameters:
NameParameterData TypeRequiredDescription
ProductformstringNo
InvestmentProductformstringNo
Scoreformdouble?No
ProductTypeformintNo
InvestmentProductsformList<InvestmentProduct>No
InvestmentProduct Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
NameformstringNo
GroupformstringNo
IsAssetClassFundformboolNo
AllocsformList<InvestmentProductAllocationsSpec>No
OrderformintNo
AllocationsDictionaryformDictionary<int, Dictionary<String,Double>>No
InvestmentProductAllocationsSpec Parameters:
NameParameterData TypeRequiredDescription
FromAgeformintNo
Termformint?No
AllocsformDictionary<string, double>No
TotalAllocformdoubleNo
RecommendedProductGraph Parameters:
NameParameterData TypeRequiredDescription
BarGraphDataformList<Dictionary<String,String>>No
PieGraphInfoformMatrixNoRiskNo
MatrixNoRisk Parameters:
NameParameterData TypeRequiredDescription
MinimumAllocationInStocksformstringNo
MaximumAllocationinStocksformstringNo
QuestionnaireAnswers Parameters:
NameParameterData TypeRequiredDescription
QuestionNumberformintNo
OptionNumberformintNo

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.

GET /members/{EmployeeGuid}/investmentprofile HTTP/1.1 
Host: hcbtas-q-albamfs-api.azurewebsites.net 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InvestmentRiskProfileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlbaApi.Model">
  <Product>
    <ChosenProduct>
      <InvestmentProduct>String</InvestmentProduct>
      <InvestmentProducts>
        <InvestmentProduct>
          <RiskId>String</RiskId>
          <RiskName>String</RiskName>
        </InvestmentProduct>
      </InvestmentProducts>
      <Product>String</Product>
      <ProductType>0</ProductType>
      <Score>0</Score>
    </ChosenProduct>
    <RecommendedProduct>
      <InvestmentProduct>String</InvestmentProduct>
      <InvestmentProducts>
        <InvestmentProduct>
          <RiskId>String</RiskId>
          <RiskName>String</RiskName>
        </InvestmentProduct>
      </InvestmentProducts>
      <Product>String</Product>
      <ProductType>0</ProductType>
      <Score>0</Score>
    </RecommendedProduct>
  </Product>
  <QuestionnaireAnswers>
    <QuestionnaireAnswers>
      <OptionNumber>0</OptionNumber>
      <QuestionNumber>0</QuestionNumber>
    </QuestionnaireAnswers>
  </QuestionnaireAnswers>
  <RecommendedProductGraph>
    <BarGraphData xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:ArrayOfKeyValueOfstringstring>
        <d3p1:KeyValueOfstringstring>
          <d3p1:Key>String</d3p1:Key>
          <d3p1:Value>String</d3p1:Value>
        </d3p1:KeyValueOfstringstring>
      </d3p1:ArrayOfKeyValueOfstringstring>
    </BarGraphData>
    <PieGraphInfo>
      <MaximumAllocationinStocks>String</MaximumAllocationinStocks>
      <MinimumAllocationInStocks>String</MinimumAllocationInStocks>
    </PieGraphInfo>
  </RecommendedProductGraph>
  <Risk>
    <ChosenRisk>
      <RiskId>String</RiskId>
      <RiskName>String</RiskName>
      <RiskValue>0</RiskValue>
    </ChosenRisk>
    <RecommendedRisk>
      <RiskId>String</RiskId>
      <RiskName>String</RiskName>
      <RiskValue>0</RiskValue>
    </RecommendedRisk>
  </Risk>
</InvestmentRiskProfileResponse>