AlbaApi

<back to all web services

InvestmentRiskProfileSaveRequest

The following routes are available for this service:
POST/members/{EmployeeGuid}/investmentprofile
InvestmentRiskProfileSaveRequest Parameters:
NameParameterData TypeRequiredDescription
EmployeeGuidpathGuidNo
AnswersbodyQuestionnaireAnswers[]No
QuestionnaireAnswers Parameters:
NameParameterData TypeRequiredDescription
QuestionNumberformintNo
OptionNumberformintNo
InvestmentRiskProfileSaveResponse Parameters:
NameParameterData TypeRequiredDescription
RiskformRiskModelNo
ProductformRecommendedProductsNo
RecommendedProductGraphformRecommendedProductGraphNo
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

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.

POST /members/{EmployeeGuid}/investmentprofile HTTP/1.1 
Host: hcbtas-q-albamfs-api.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	employeeGuid: 00000000000000000000000000000000,
	answers: 
	[
		{
			questionNumber: 0,
			optionNumber: 0
		}
	]
}
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
		}
	}
}