AlbaApi

<back to all web services

ClientCountryConfigValidateReq

The following routes are available for this service:
POST/clientcountryconfig/validate
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 Entity(IEntity):
    id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DatedEntity(Entity, IDatedEntity):
    as_at: Optional[datetime.datetime] = None


class DataSource(str, Enum):
    DB = 'Db'
    CACHE = 'Cache'
    PARAMETER = 'Parameter'
    NA = 'NA'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DataSourceResult:
    d: Optional[DataSource] = None
    t: Optional[int] = None


class Gender(str, Enum):
    FEMALE = 'Female'
    MALE = 'Male'
    OTHER = 'Other'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LifeTableName:
    name: Optional[str] = None
    gender: Optional[Gender] = None


class AnnuityPriceType(str, Enum):
    CALC = 'Calc'
    TABLE = 'Table'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AnnuityConfig:
    table_names: Optional[List[LifeTableName]] = None
    impr_factor_table_names: Optional[List[LifeTableName]] = None
    reversion: Optional[float] = None
    guarantee: Optional[float] = None
    timing: Optional[float] = None
    allow_discount_pre_ret: Optional[bool] = None
    scale_qx: Optional[float] = None
    scale_impr: Optional[float] = None
    age_rating: Optional[int] = None
    spouse_age_rating: Optional[int] = None
    expense: Optional[float] = None
    perc_balance_spent: Optional[float] = None
    amount_spent: Optional[float] = None
    income_purchased: Optional[float] = None
    deferral_period: Optional[int] = None
    indexation_name: Optional[str] = None
    dr_stochastic: Optional[str] = None
    implied_inflation_stochastic_series: Optional[str] = None
    target_tpx: Optional[float] = None
    price_type: Optional[AnnuityPriceType] = None
    price: Optional[float] = None


class ContributionType(str, Enum):
    FIXED = 'Fixed'
    TIME = 'Time'
    LOOKUP = 'Lookup'
    MATCH = 'Match'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContributionConstraint:
    from_age: Optional[int] = None
    to_age: Optional[int] = None
    min: Optional[float] = None
    max: Optional[float] = None
    step: Optional[float] = None


class AmountType(str, Enum):
    ANY = 'Any'
    AMOUNT = 'Amount'
    RATE = 'Rate'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContributionSpec:
    code: Optional[str] = None
    name: Optional[str] = None
    type: Optional[ContributionType] = None
    is_employee_cont: Optional[bool] = None
    table: Optional[str] = None
    ccy: Optional[str] = None
    from_age: Optional[int] = None
    to_age: Optional[int] = None
    indexation_type: Optional[str] = None
    salary_type: Optional[str] = None
    is_taxable: Optional[bool] = None
    related_rate: Optional[str] = None
    order: Optional[int] = None
    editable: Optional[bool] = None
    constraints: Optional[List[ContributionConstraint]] = None
    amount_type: Optional[AmountType] = None
    is_one_off: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AssetConfig:
    code: Optional[str] = None
    name: Optional[str] = None
    rebalance: Optional[bool] = None
    can_edit_investment_choice: Optional[bool] = None
    will_spend: Optional[bool] = None
    investments: Optional[List[str]] = None
    contributions: Optional[List[ContributionSpec]] = None
    is_one_off: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContributionRateSpec:
    from_age: Optional[int] = None
    to_age: Optional[int] = None
    from_service: Optional[int] = None
    to_service: Optional[int] = None
    source_rate: Optional[float] = None
    date_from: Optional[datetime.datetime] = None
    date_to: Optional[datetime.datetime] = None
    upper_limit: Optional[float] = None
    rate: Optional[float] = None
    core_rate: Optional[float] = None
    lookup_key: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContributionTableSpec:
    code: Optional[str] = None
    type: Optional[ContributionType] = None
    rates: Optional[Dict[str, float]] = None
    rate_specs: Optional[List[ContributionRateSpec]] = None
    key_template: Optional[str] = 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 ReturnRates:
    earning_rates: Optional[List[float]] = None
    tax_rates: Optional[List[float]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ClientCountryConfig(DatedEntity):
    client_code: Optional[str] = None
    client_name: Optional[str] = None
    country_code: Optional[str] = None
    source: Optional[DataSourceResult] = None
    age_r_min: Optional[int] = None
    age_r_max: Optional[int] = None
    primary_salary: Optional[str] = None
    annuity_config: Optional[AnnuityConfig] = None
    assets: Optional[List[AssetConfig]] = None
    cont_tables: Optional[List[ContributionTableSpec]] = None
    investments: Optional[List[InvestmentProduct]] = None
    content: Optional[Dict[str, List[Content]]] = None
    environments: Optional[Dict[str, str]] = None
    custom_numeric_constraints: Optional[Dict[str, Constraint[Decimal]]] = None
    asset_return_rates: Optional[Dict[str, ReturnRates]] = None
    investment_property_rates: Optional[float] = None
    get_asset_class_fund_dictionary: Optional[Dict[str, bool]] = None
    get_term_based_fund_dictionary: Optional[Dict[str, bool]] = None
    get_allocations_dictionary: Optional[Dict[str, Dict[int, Dict[str, float]]]] = None
    asset_name_map: Optional[Dict[str, str]] = None
    asset_cont_name_map: Optional[Dict[str, Dict[str, str]]] = None
    cache_key: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ClientCountryConfigValidateReq:
    config: Optional[ClientCountryConfig] = None

Python ClientCountryConfigValidateReq DTOs

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

HTTP + JSON

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"}