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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	employeeGuid: 00000000000000000000000000000000,
	riskId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	risk: 
	{
		recommendedRisk: 
		{
			riskName: String,
			riskValue: 0,
			riskId: String
		},
		chosenRisk: 
		{
			riskName: String,
			riskValue: 0,
			riskId: String
		}
	},
	product: 
	{
		recommendedProduct: 
		{
			product: String,
			investmentProduct: String,
			score: 0,
			productType: 0,
			investmentProducts: 
			[
				{
					riskId: String,
					riskName: String
				}
			]
		},
		chosenProduct: 
		{
			product: String,
			investmentProduct: String,
			score: 0,
			productType: 0,
			investmentProducts: 
			[
				{
					riskId: String,
					riskName: String
				}
			]
		}
	},
	recommendedProductGraph: 
	{
		barGraphData: 
		[
			{
				String: String
			}
		],
		pieGraphInfo: 
		{
			minimumAllocationInStocks: String,
			maximumAllocationinStocks: String
		}
	},
	questionnaireAnswers: 
	[
		{
			questionNumber: 0,
			optionNumber: 0
		}
	]
}