AlbaApi

<back to all web services

InvestmentRiskProfileRiskRequest

The following routes are available for this service:
PUT/members/{EmployeeGuid}/investmentprofile/risk
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RecommendedRisk:
    risk_name: Optional[str] = None
    risk_value: Optional[int] = None
    risk_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RiskModel:
    recommended_risk: Optional[RecommendedRisk] = None
    chosen_risk: Optional[RecommendedRisk] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InvestmentProductAllocationsSpec:
    from_age: Optional[int] = None
    term: Optional[int] = None
    allocs: Optional[Dict[str, float]] = None
    total_alloc: Optional[float] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InvestmentProduct:
    code: Optional[str] = None
    name: Optional[str] = None
    group: Optional[str] = None
    is_asset_class_fund: Optional[bool] = None
    allocs: Optional[List[InvestmentProductAllocationsSpec]] = None
    order: Optional[int] = None
    allocations_dictionary: Optional[Dict[int, Dict[str, float]]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RecommendedProductType:
    product: Optional[str] = None
    investment_product: Optional[str] = None
    score: Optional[float] = None
    product_type: Optional[int] = None
    investment_products: Optional[List[InvestmentProduct]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RecommendedProducts:
    recommended_product: Optional[RecommendedProductType] = None
    chosen_product: Optional[RecommendedProductType] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MatrixNoRisk:
    minimum_allocation_in_stocks: Optional[str] = None
    maximum_allocationin_stocks: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RecommendedProductGraph:
    bar_graph_data: Optional[List[Dict[str, str]]] = None
    pie_graph_info: Optional[MatrixNoRisk] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InvestmentRiskProfileResponse:
    risk: Optional[RiskModel] = None
    product: Optional[RecommendedProducts] = None
    recommended_product_graph: Optional[RecommendedProductGraph] = None
    questionnaire_answers: Optional[List[QuestionnaireAnswers]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InvestmentRiskProfileRiskRequest:
    employee_guid: Optional[str] = None
    risk_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QuestionnaireAnswers:
    question_number: Optional[int] = None
    option_number: Optional[int] = None

Python 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
		}
	]
}