AlbaApi

<back to all web services

InvestmentRiskProfileRiskRequest

The following routes are available for this service:
PUT/members/{EmployeeGuid}/investmentprofile/risk

export class RecommendedRisk
{
    public riskName?: string;
    public riskValue?: number;
    public riskId?: string;

    public constructor(init?: Partial<RecommendedRisk>) { (Object as any).assign(this, init); }
}

export class RiskModel
{
    public recommendedRisk?: RecommendedRisk;
    public chosenRisk?: RecommendedRisk;

    public constructor(init?: Partial<RiskModel>) { (Object as any).assign(this, init); }
}

export class InvestmentProductAllocationsSpec
{
    public fromAge?: number;
    public term?: number;
    public allocs?: { [index: string]: number; };
    public totalAlloc?: number;

    public constructor(init?: Partial<InvestmentProductAllocationsSpec>) { (Object as any).assign(this, init); }
}

export class InvestmentProduct
{
    public code?: string;
    public name?: string;
    public group?: string;
    public isAssetClassFund?: boolean;
    public allocs?: InvestmentProductAllocationsSpec[];
    public order?: number;
    public allocationsDictionary?: { [index: number]: { [index:string]: number; }; };

    public constructor(init?: Partial<InvestmentProduct>) { (Object as any).assign(this, init); }
}

export class RecommendedProductType
{
    public product?: string;
    public investmentProduct?: string;
    public score?: number;
    public productType?: number;
    public investmentProducts?: InvestmentProduct[];

    public constructor(init?: Partial<RecommendedProductType>) { (Object as any).assign(this, init); }
}

export class RecommendedProducts
{
    public recommendedProduct?: RecommendedProductType;
    public chosenProduct?: RecommendedProductType;

    public constructor(init?: Partial<RecommendedProducts>) { (Object as any).assign(this, init); }
}

export class MatrixNoRisk
{
    public minimumAllocationInStocks?: string;
    public maximumAllocationinStocks?: string;

    public constructor(init?: Partial<MatrixNoRisk>) { (Object as any).assign(this, init); }
}

export class RecommendedProductGraph
{
    public barGraphData?: { [index:string]: string; }[];
    public pieGraphInfo?: MatrixNoRisk;

    public constructor(init?: Partial<RecommendedProductGraph>) { (Object as any).assign(this, init); }
}

export class InvestmentRiskProfileResponse
{
    public risk?: RiskModel;
    public product?: RecommendedProducts;
    public recommendedProductGraph?: RecommendedProductGraph;
    public questionnaireAnswers?: QuestionnaireAnswers[];

    public constructor(init?: Partial<InvestmentRiskProfileResponse>) { (Object as any).assign(this, init); }
}

export class InvestmentRiskProfileRiskRequest
{
    public employeeGuid?: string;
    public riskId?: string;

    public constructor(init?: Partial<InvestmentRiskProfileRiskRequest>) { (Object as any).assign(this, init); }
}

export class QuestionnaireAnswers
{
    public questionNumber?: number;
    public optionNumber?: number;

    public constructor(init?: Partial<QuestionnaireAnswers>) { (Object as any).assign(this, init); }
}

TypeScript InvestmentRiskProfileRiskRequest DTOs

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.

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

<InvestmentRiskProfileRiskRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlbaApi.ServiceModel">
  <EmployeeGuid>00000000-0000-0000-0000-000000000000</EmployeeGuid>
  <RiskId>String</RiskId>
</InvestmentRiskProfileRiskRequest>
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>