POST | /clientcountryconfig/validate |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Config | body | ClientCountryConfig | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ClientCode | form | string | No | |
ClientName | form | string | No | |
CountryCode | form | string | No | |
Source | form | DataSourceResult | No | |
AgeRMin | form | int | No | |
AgeRMax | form | int | No | |
PrimarySalary | form | string | No | |
AnnuityConfig | form | AnnuityConfig | No | |
Assets | form | List<AssetConfig> | No | |
ContTables | form | List<ContributionTableSpec> | No | |
Investments | form | List<InvestmentProduct> | No | |
Content | form | Dictionary<string, List<Content>> | No | |
Environments | form | Dictionary<string, string> | No | |
CustomNumericConstraints | form | Dictionary<string, Constraint<Decimal>> | No | |
AssetReturnRates | form | Dictionary<string, ReturnRates> | No | |
InvestmentPropertyRates | form | double | No | |
GetAssetClassFundDictionary | form | Dictionary<string, bool> | No | |
GetTermBasedFundDictionary | form | Dictionary<string, bool> | No | |
GetAllocationsDictionary | form | Dictionary<string, Dictionary<Int32,Dictionary<String,Double>>> | No | |
AssetNameMap | form | Dictionary<string, string> | No | |
AssetContNameMap | form | Dictionary<string, Dictionary<String,String>> | No | |
CacheKey | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AsAt | form | DateTime | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
D | form | DataSource | No | |
T | form | long | No |
Db | |
Cache | |
Parameter | |
NA |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TableNames | form | List<LifeTableName> | No | |
ImprFactorTableNames | form | List<LifeTableName> | No | |
Reversion | form | double? | No | |
Guarantee | form | double? | No | |
Timing | form | double? | No | |
AllowDiscountPreRet | form | bool? | No | |
ScaleQx | form | double? | No | |
ScaleImpr | form | double? | No | |
AgeRating | form | int? | No | |
SpouseAgeRating | form | int? | No | |
Expense | form | double? | No | |
PercBalanceSpent | form | double? | No | |
AmountSpent | form | double? | No | |
IncomePurchased | form | double? | No | |
DeferralPeriod | form | int? | No | |
IndexationName | form | string | No | |
DRStochastic | form | string | No | |
ImpliedInflationStochasticSeries | form | string | No | |
TargetTpx | form | double? | No | |
PriceType | form | AnnuityPriceType | No | |
Price | form | double | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
Gender | form | Gender | No |
Female | |
Male | |
Other |
Calc | |
Table |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Code | form | string | No | |
Name | form | string | No | |
Rebalance | form | bool | No | |
CanEditInvestmentChoice | form | bool | No | |
WillSpend | form | bool | No | |
Investments | form | List<string> | No | |
Contributions | form | List<ContributionSpec> | No | |
IsOneOff | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Code | form | string | No | |
Name | form | string | No | |
Type | form | ContributionType | No | |
IsEmployeeCont | form | bool | No | |
Table | form | string | No | |
Ccy | form | string | No | |
FromAge | form | int | No | |
ToAge | form | int? | No | |
IndexationType | form | string | No | |
SalaryType | form | string | No | |
IsTaxable | form | bool | No | |
RelatedRate | form | string | No | |
Order | form | int | No | |
Editable | form | bool | No | |
Constraints | form | List<ContributionConstraint> | No | |
AmountType | form | AmountType | No | |
IsOneOff | form | bool | No |
Fixed | |
Time | |
Lookup | |
Match |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FromAge | form | int? | No | |
ToAge | form | int? | No | |
Min | form | double? | No | |
Max | form | double? | No | |
Step | form | double? | No |
Any | |
Amount | |
Rate |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Code | form | string | No | |
Type | form | ContributionType | No | |
Rates | form | Dictionary<string, double> | No | |
RateSpecs | form | List<ContributionRateSpec> | No | |
KeyTemplate | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FromAge | form | int? | No | |
ToAge | form | int? | No | |
FromService | form | int? | No | |
ToService | form | int? | No | |
SourceRate | form | double? | No | |
DateFrom | form | DateTime? | No | |
DateTo | form | DateTime? | No | |
UpperLimit | form | double? | No | |
Rate | form | double | No | |
CoreRate | form | double | No | |
LookupKey | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Code | form | string | No | |
Name | form | string | No | |
Group | form | string | No | |
IsAssetClassFund | form | bool | No | |
Allocs | form | List<InvestmentProductAllocationsSpec> | No | |
Order | form | int | No | |
AllocationsDictionary | form | Dictionary<int, Dictionary<String,Double>> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FromAge | form | int | No | |
Term | form | int? | No | |
Allocs | form | Dictionary<string, double> | No | |
TotalAlloc | form | double | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
EarningRates | form | List<double> | No | |
TaxRates | form | List<double> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ClientCode | form | string | No | |
ClientName | form | string | No | |
CountryCode | form | string | No | |
Source | form | DataSourceResult | No | |
AgeRMin | form | int | No | |
AgeRMax | form | int | No | |
PrimarySalary | form | string | No | |
AnnuityConfig | form | AnnuityConfig | No | |
Assets | form | List<AssetConfig> | No | |
ContTables | form | List<ContributionTableSpec> | No | |
Investments | form | List<InvestmentProduct> | No | |
Content | form | Dictionary<string, List<Content>> | No | |
Environments | form | Dictionary<string, string> | No | |
CustomNumericConstraints | form | Dictionary<string, Constraint<Decimal>> | No | |
AssetReturnRates | form | Dictionary<string, ReturnRates> | No | |
InvestmentPropertyRates | form | double | No | |
GetAssetClassFundDictionary | form | Dictionary<string, bool> | No | |
GetTermBasedFundDictionary | form | Dictionary<string, bool> | No | |
GetAllocationsDictionary | form | Dictionary<string, Dictionary<Int32,Dictionary<String,Double>>> | No | |
AssetNameMap | form | Dictionary<string, string> | No | |
AssetContNameMap | form | Dictionary<string, Dictionary<String,String>> | No | |
CacheKey | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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: application/json
Content-Type: application/json
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-01T00:00:00.0000000","dateTo":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","id":"String"}}
HTTP/1.1 200 OK Content-Type: application/json 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-01T00:00:00.0000000","dateTo":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","id":"String"}