AlbaApi

<back to all web services

ClientCountryConfigValidateReq

The following routes are available for this service:
POST/clientcountryconfig/validate
ClientCountryConfigValidateReq Parameters:
NameParameterData TypeRequiredDescription
ConfigbodyClientCountryConfigNo
ClientCountryConfig Parameters:
NameParameterData TypeRequiredDescription
ClientCodeformstringNo
ClientNameformstringNo
CountryCodeformstringNo
SourceformDataSourceResultNo
AgeRMinformintNo
AgeRMaxformintNo
PrimarySalaryformstringNo
AnnuityConfigformAnnuityConfigNo
AssetsformList<AssetConfig>No
ContTablesformList<ContributionTableSpec>No
InvestmentsformList<InvestmentProduct>No
ContentformDictionary<string, List<Content>>No
EnvironmentsformDictionary<string, string>No
CustomNumericConstraintsformDictionary<string, Constraint<Decimal>>No
AssetReturnRatesformDictionary<string, ReturnRates>No
InvestmentPropertyRatesformdoubleNo
GetAssetClassFundDictionaryformDictionary<string, bool>No
GetTermBasedFundDictionaryformDictionary<string, bool>No
GetAllocationsDictionaryformDictionary<string, Dictionary<Int32,Dictionary<String,Double>>>No
AssetNameMapformDictionary<string, string>No
AssetContNameMapformDictionary<string, Dictionary<String,String>>No
CacheKeyformstringNo
DatedEntity Parameters:
NameParameterData TypeRequiredDescription
AsAtformDateTimeNo
Entity Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
DataSourceResult Parameters:
NameParameterData TypeRequiredDescription
DformDataSourceNo
TformlongNo
DataSource Enum:
Db
Cache
Parameter
NA
AnnuityConfig Parameters:
NameParameterData TypeRequiredDescription
TableNamesformList<LifeTableName>No
ImprFactorTableNamesformList<LifeTableName>No
Reversionformdouble?No
Guaranteeformdouble?No
Timingformdouble?No
AllowDiscountPreRetformbool?No
ScaleQxformdouble?No
ScaleImprformdouble?No
AgeRatingformint?No
SpouseAgeRatingformint?No
Expenseformdouble?No
PercBalanceSpentformdouble?No
AmountSpentformdouble?No
IncomePurchasedformdouble?No
DeferralPeriodformint?No
IndexationNameformstringNo
DRStochasticformstringNo
ImpliedInflationStochasticSeriesformstringNo
TargetTpxformdouble?No
PriceTypeformAnnuityPriceTypeNo
PriceformdoubleNo
LifeTableName Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
GenderformGenderNo
Gender Enum:
Female
Male
Other
AnnuityPriceType Enum:
Calc
Table
AssetConfig Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
NameformstringNo
RebalanceformboolNo
CanEditInvestmentChoiceformboolNo
WillSpendformboolNo
InvestmentsformList<string>No
ContributionsformList<ContributionSpec>No
IsOneOffformboolNo
ContributionSpec Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
NameformstringNo
TypeformContributionTypeNo
IsEmployeeContformboolNo
TableformstringNo
CcyformstringNo
FromAgeformintNo
ToAgeformint?No
IndexationTypeformstringNo
SalaryTypeformstringNo
IsTaxableformboolNo
RelatedRateformstringNo
OrderformintNo
EditableformboolNo
ConstraintsformList<ContributionConstraint>No
AmountTypeformAmountTypeNo
IsOneOffformboolNo
ContributionType Enum:
Fixed
Time
Lookup
Match
ContributionConstraint Parameters:
NameParameterData TypeRequiredDescription
FromAgeformint?No
ToAgeformint?No
Minformdouble?No
Maxformdouble?No
Stepformdouble?No
AmountType Enum:
Any
Amount
Rate
ContributionTableSpec Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
TypeformContributionTypeNo
RatesformDictionary<string, double>No
RateSpecsformList<ContributionRateSpec>No
KeyTemplateformstringNo
ContributionRateSpec Parameters:
NameParameterData TypeRequiredDescription
FromAgeformint?No
ToAgeformint?No
FromServiceformint?No
ToServiceformint?No
SourceRateformdouble?No
DateFromformDateTime?No
DateToformDateTime?No
UpperLimitformdouble?No
RateformdoubleNo
CoreRateformdoubleNo
LookupKeyformstringNo
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
ReturnRates Parameters:
NameParameterData TypeRequiredDescription
EarningRatesformList<double>No
TaxRatesformList<double>No
ClientCountryConfig Parameters:
NameParameterData TypeRequiredDescription
ClientCodeformstringNo
ClientNameformstringNo
CountryCodeformstringNo
SourceformDataSourceResultNo
AgeRMinformintNo
AgeRMaxformintNo
PrimarySalaryformstringNo
AnnuityConfigformAnnuityConfigNo
AssetsformList<AssetConfig>No
ContTablesformList<ContributionTableSpec>No
InvestmentsformList<InvestmentProduct>No
ContentformDictionary<string, List<Content>>No
EnvironmentsformDictionary<string, string>No
CustomNumericConstraintsformDictionary<string, Constraint<Decimal>>No
AssetReturnRatesformDictionary<string, ReturnRates>No
InvestmentPropertyRatesformdoubleNo
GetAssetClassFundDictionaryformDictionary<string, bool>No
GetTermBasedFundDictionaryformDictionary<string, bool>No
GetAllocationsDictionaryformDictionary<string, Dictionary<Int32,Dictionary<String,Double>>>No
AssetNameMapformDictionary<string, string>No
AssetContNameMapformDictionary<string, Dictionary<String,String>>No
CacheKeyformstringNo

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 /clientcountryconfig/validate HTTP/1.1 
Host: hcbtas-q-albamfs-api.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	config: 
	{
		clientCode: String,
		clientName: String,
		countryCode: String,
		source: 
		{
			d: Db,
			t: 0
		},
		ageRMin: 0,
		ageRMax: 0,
		primarySalary: String,
		annuityConfig: 
		{
			tableNames: 
			[
				{
					name: String,
					gender: Female
				}
			],
			imprFactorTableNames: 
			[
				{
					name: String,
					gender: Female
				}
			],
			reversion: 0,
			guarantee: 0,
			timing: 0,
			allowDiscountPreRet: False,
			scaleQx: 0,
			scaleImpr: 0,
			ageRating: 0,
			spouseAgeRating: 0,
			expense: 0,
			percBalanceSpent: 0,
			amountSpent: 0,
			incomePurchased: 0,
			deferralPeriod: 0,
			indexationName: String,
			drStochastic: String,
			impliedInflationStochasticSeries: String,
			targetTpx: 0,
			priceType: Calc,
			price: 0
		},
		assets: 
		[
			{
				code: String,
				name: String,
				rebalance: False,
				canEditInvestmentChoice: False,
				willSpend: False,
				investments: 
				[
					String
				],
				contributions: 
				[
					{
						code: String,
						name: String,
						type: Fixed,
						isEmployeeCont: False,
						table: String,
						ccy: String,
						fromAge: 0,
						toAge: 0,
						indexationType: String,
						salaryType: String,
						isTaxable: False,
						relatedRate: String,
						order: 0,
						editable: False,
						constraints: 
						[
							{
								fromAge: 0,
								toAge: 0,
								min: 0,
								max: 0,
								step: 0
							}
						],
						amountType: Any,
						isOneOff: False
					}
				],
				isOneOff: False
			}
		],
		contTables: 
		[
			{
				code: String,
				type: Fixed,
				rates: 
				{
					String: 0
				},
				rateSpecs: 
				[
					{
						fromAge: 0,
						toAge: 0,
						fromService: 0,
						toService: 0,
						sourceRate: 0,
						dateFrom: 0001-01-01,
						dateTo: 0001-01-01,
						upperLimit: 0,
						rate: 0,
						coreRate: 0,
						lookupKey: String
					}
				],
				keyTemplate: age-service-rate
			}
		],
		investments: 
		[
			{
				code: String,
				name: String,
				group: String,
				isAssetClassFund: False,
				allocs: 
				[
					{
						fromAge: 0,
						term: 0,
						allocs: 
						{
							String: 0
						},
						totalAlloc: 0
					}
				],
				order: 0,
				allocationsDictionary: 
				{
					0: {}
				}
			}
		],
		content: 
		{
			String: 
			[
				{
					section: String,
					itemId: String,
					itemCode: String,
					country: String,
					lang: String,
					app: String,
					companyId: String,
					company: String,
					elements: 
					{
						String: String
					},
					id: String
				}
			]
		},
		environments: 
		{
			String: String
		},
		customNumericConstraints: 
		{
			String: 
			{
				min: 0,
				max: 0,
				step: 0
			}
		},
		assetReturnRates: 
		{
			String: 
			{
				earningRates: 
				[
					0
				],
				taxRates: 
				[
					0
				]
			}
		},
		investmentPropertyRates: 0,
		getAssetClassFundDictionary: 
		{
			String: False
		},
		getTermBasedFundDictionary: 
		{
			String: True
		},
		getAllocationsDictionary: 
		{
			String: 
			{
				0: {}
			}
		},
		assetNameMap: 
		{
			String: String
		},
		assetContNameMap: 
		{
			String: 
			{
				String: String
			}
		},
		cacheKey: ClientCountryConfig-String-String,
		asAt: 0001-01-01,
		id: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	clientCode: String,
	clientName: String,
	countryCode: String,
	source: 
	{
		d: Db,
		t: 0
	},
	ageRMin: 0,
	ageRMax: 0,
	primarySalary: String,
	annuityConfig: 
	{
		tableNames: 
		[
			{
				name: String,
				gender: Female
			}
		],
		imprFactorTableNames: 
		[
			{
				name: String,
				gender: Female
			}
		],
		reversion: 0,
		guarantee: 0,
		timing: 0,
		allowDiscountPreRet: False,
		scaleQx: 0,
		scaleImpr: 0,
		ageRating: 0,
		spouseAgeRating: 0,
		expense: 0,
		percBalanceSpent: 0,
		amountSpent: 0,
		incomePurchased: 0,
		deferralPeriod: 0,
		indexationName: String,
		drStochastic: String,
		impliedInflationStochasticSeries: String,
		targetTpx: 0,
		priceType: Calc,
		price: 0
	},
	assets: 
	[
		{
			code: String,
			name: String,
			rebalance: False,
			canEditInvestmentChoice: False,
			willSpend: False,
			investments: 
			[
				String
			],
			contributions: 
			[
				{
					code: String,
					name: String,
					type: Fixed,
					isEmployeeCont: False,
					table: String,
					ccy: String,
					fromAge: 0,
					toAge: 0,
					indexationType: String,
					salaryType: String,
					isTaxable: False,
					relatedRate: String,
					order: 0,
					editable: False,
					constraints: 
					[
						{
							fromAge: 0,
							toAge: 0,
							min: 0,
							max: 0,
							step: 0
						}
					],
					amountType: Any,
					isOneOff: False
				}
			],
			isOneOff: False
		}
	],
	contTables: 
	[
		{
			code: String,
			type: Fixed,
			rates: 
			{
				String: 0
			},
			rateSpecs: 
			[
				{
					fromAge: 0,
					toAge: 0,
					fromService: 0,
					toService: 0,
					sourceRate: 0,
					dateFrom: 0001-01-01,
					dateTo: 0001-01-01,
					upperLimit: 0,
					rate: 0,
					coreRate: 0,
					lookupKey: String
				}
			],
			keyTemplate: age-service-rate
		}
	],
	investments: 
	[
		{
			code: String,
			name: String,
			group: String,
			isAssetClassFund: False,
			allocs: 
			[
				{
					fromAge: 0,
					term: 0,
					allocs: 
					{
						String: 0
					},
					totalAlloc: 0
				}
			],
			order: 0,
			allocationsDictionary: 
			{
				0: {}
			}
		}
	],
	content: 
	{
		String: 
		[
			{
				section: String,
				itemId: String,
				itemCode: String,
				country: String,
				lang: String,
				app: String,
				companyId: String,
				company: String,
				elements: 
				{
					String: String
				},
				id: String
			}
		]
	},
	environments: 
	{
		String: String
	},
	customNumericConstraints: 
	{
		String: 
		{
			min: 0,
			max: 0,
			step: 0
		}
	},
	assetReturnRates: 
	{
		String: 
		{
			earningRates: 
			[
				0
			],
			taxRates: 
			[
				0
			]
		}
	},
	investmentPropertyRates: 0,
	getAssetClassFundDictionary: 
	{
		String: False
	},
	getTermBasedFundDictionary: 
	{
		String: True
	},
	getAllocationsDictionary: 
	{
		String: 
		{
			0: {}
		}
	},
	assetNameMap: 
	{
		String: String
	},
	assetContNameMap: 
	{
		String: 
		{
			String: String
		}
	},
	cacheKey: ClientCountryConfig-String-String,
	asAt: 0001-01-01,
	id: String
}