GET | /clientcountryconfig/{Country}/{Client} | ||
---|---|---|---|
GET | /clientcountryconfig | ||
POST | /clientcountryconfig |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CountryCode | body | string | No | |
ClientCode | body | string | 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 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /clientcountryconfig HTTP/1.1
Host: hcbtas-q-albamfs-api.azurewebsites.net
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AlbaClientCountryConfigReq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlbaApi.ServiceModel">
<ClientCode>String</ClientCode>
<CountryCode>String</CountryCode>
</AlbaClientCountryConfigReq>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ClientCountryConfig xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TasSyd.Model.Client"> <Id xmlns="http://schemas.datacontract.org/2004/07/TasSyd.Model.Base">String</Id> <AsAt xmlns="http://schemas.datacontract.org/2004/07/TasSyd.Model.Base">0001-01-01T00:00:00</AsAt> <AgeRMax>0</AgeRMax> <AgeRMin>0</AgeRMin> <AnnuityConfig> <AgeRating>0</AgeRating> <AllowDiscountPreRet>false</AllowDiscountPreRet> <AmountSpent>0</AmountSpent> <DRStochastic>String</DRStochastic> <DeferralPeriod>0</DeferralPeriod> <Expense>0</Expense> <Guarantee>0</Guarantee> <ImpliedInflationStochasticSeries>String</ImpliedInflationStochasticSeries> <ImprFactorTableNames> <LifeTableName> <Gender>Female</Gender> <Name>String</Name> </LifeTableName> </ImprFactorTableNames> <IncomePurchased>0</IncomePurchased> <IndexationName>String</IndexationName> <PercBalanceSpent>0</PercBalanceSpent> <Price>0</Price> <PriceType>Calc</PriceType> <Reversion>0</Reversion> <ScaleImpr>0</ScaleImpr> <ScaleQx>0</ScaleQx> <SpouseAgeRating>0</SpouseAgeRating> <TableNames> <LifeTableName> <Gender>Female</Gender> <Name>String</Name> </LifeTableName> </TableNames> <TargetTpx>0</TargetTpx> <Timing>0</Timing> </AnnuityConfig> <AssetContNameMap xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringArrayOfKeyValueOfstringstringty7Ep6D1> <d2p1:Key>String</d2p1:Key> <d2p1:Value> <d2p1:KeyValueOfstringstring> <d2p1:Key>String</d2p1:Key> <d2p1:Value>String</d2p1:Value> </d2p1:KeyValueOfstringstring> </d2p1:Value> </d2p1:KeyValueOfstringArrayOfKeyValueOfstringstringty7Ep6D1> </AssetContNameMap> <AssetNameMap xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringstring> <d2p1:Key>String</d2p1:Key> <d2p1:Value>String</d2p1:Value> </d2p1:KeyValueOfstringstring> </AssetNameMap> <AssetReturnRates xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringReturnRatesnS1zg5F4> <d2p1:Key>String</d2p1:Key> <d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/TasSyd.Model.Core"> <d4p1:EarningRates> <d2p1:double>0</d2p1:double> </d4p1:EarningRates> <d4p1:TaxRates> <d2p1:double>0</d2p1:double> </d4p1:TaxRates> </d2p1:Value> </d2p1:KeyValueOfstringReturnRatesnS1zg5F4> </AssetReturnRates> <Assets> <AssetConfig> <CanEditInvestmentChoice>false</CanEditInvestmentChoice> <Code>String</Code> <Contributions xmlns:d4p1="http://schemas.datacontract.org/2004/07/TasSyd.Model.Core.Contributions"> <d4p1:ContributionSpec> <d4p1:AmountType>Any</d4p1:AmountType> <d4p1:Ccy>String</d4p1:Ccy> <d4p1:Code>String</d4p1:Code> <d4p1:Constraints> <d4p1:ContributionConstraint> <d4p1:FromAge>0</d4p1:FromAge> <d4p1:Max>0</d4p1:Max> <d4p1:Min>0</d4p1:Min> <d4p1:Step>0</d4p1:Step> <d4p1:ToAge>0</d4p1:ToAge> </d4p1:ContributionConstraint> </d4p1:Constraints> <d4p1:Editable>false</d4p1:Editable> <d4p1:FromAge>0</d4p1:FromAge> <d4p1:IndexationType>String</d4p1:IndexationType> <d4p1:IsEmployeeCont>false</d4p1:IsEmployeeCont> <d4p1:IsOneOff>false</d4p1:IsOneOff> <d4p1:IsTaxable>false</d4p1:IsTaxable> <d4p1:Name>String</d4p1:Name> <d4p1:Order>0</d4p1:Order> <d4p1:RelatedRate>String</d4p1:RelatedRate> <d4p1:SalaryType>String</d4p1:SalaryType> <d4p1:Table>String</d4p1:Table> <d4p1:ToAge>0</d4p1:ToAge> <d4p1:Type>Fixed</d4p1:Type> </d4p1:ContributionSpec> </Contributions> <Investments xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>String</d4p1:string> </Investments> <Name>String</Name> <Rebalance>false</Rebalance> <WillSpend>false</WillSpend> </AssetConfig> </Assets> <ClientCode>String</ClientCode> <ClientName>String</ClientName> <ContTables xmlns:d2p1="http://schemas.datacontract.org/2004/07/TasSyd.Model.Core.Contributions"> <d2p1:ContributionTableSpec> <d2p1:Code>String</d2p1:Code> <d2p1:KeyTemplate>age-service-rate</d2p1:KeyTemplate> <d2p1:RateSpecs> <d2p1:ContributionRateSpec> <d2p1:CoreRate>0</d2p1:CoreRate> <d2p1:DateFrom>0001-01-01T00:00:00</d2p1:DateFrom> <d2p1:DateTo>0001-01-01T00:00:00</d2p1:DateTo> <d2p1:FromAge>0</d2p1:FromAge> <d2p1:FromService>0</d2p1:FromService> <d2p1:LookupKey>String</d2p1:LookupKey> <d2p1:Rate>0</d2p1:Rate> <d2p1:SourceRate>0</d2p1:SourceRate> <d2p1:ToAge>0</d2p1:ToAge> <d2p1:ToService>0</d2p1:ToService> <d2p1:UpperLimit>0</d2p1:UpperLimit> </d2p1:ContributionRateSpec> </d2p1:RateSpecs> <d2p1:Rates xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:KeyValueOfstringdouble> <d4p1:Key>String</d4p1:Key> <d4p1:Value>0</d4p1:Value> </d4p1:KeyValueOfstringdouble> </d2p1:Rates> <d2p1:Type>Fixed</d2p1:Type> </d2p1:ContributionTableSpec> </ContTables> <Content xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringArrayOfContentlNVkt6SI> <d2p1:Key>String</d2p1:Key> <d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/TasSyd.Model"> <d4p1:Content> <Id xmlns="http://schemas.datacontract.org/2004/07/TasSyd.Model.Base">String</Id> <d4p1:App>String</d4p1:App> <d4p1:Company>String</d4p1:Company> <d4p1:CompanyId>String</d4p1:CompanyId> <d4p1:Country>String</d4p1:Country> <d4p1:Elements> <d2p1:KeyValueOfstringstring> <d2p1:Key>String</d2p1:Key> <d2p1:Value>String</d2p1:Value> </d2p1:KeyValueOfstringstring> </d4p1:Elements> <d4p1:ItemCode>String</d4p1:ItemCode> <d4p1:ItemId>String</d4p1:ItemId> <d4p1:Lang>String</d4p1:Lang> <d4p1:Section>String</d4p1:Section> </d4p1:Content> </d2p1:Value> </d2p1:KeyValueOfstringArrayOfContentlNVkt6SI> </Content> <CountryCode>String</CountryCode> <CustomNumericConstraints xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringConstraintOfdecimalnS1zg5F4> <d2p1:Key>String</d2p1:Key> <d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/TasSyd.Model.Core"> <d4p1:Max>0</d4p1:Max> <d4p1:Min>0</d4p1:Min> <d4p1:Step>0</d4p1:Step> </d2p1:Value> </d2p1:KeyValueOfstringConstraintOfdecimalnS1zg5F4> </CustomNumericConstraints> <Environments xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringstring> <d2p1:Key>String</d2p1:Key> <d2p1:Value>String</d2p1:Value> </d2p1:KeyValueOfstringstring> </Environments> <GetAllocationsDictionary xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringArrayOfKeyValueOfintArrayOfKeyValueOfstringdoublety7Ep6D1ty7Ep6D1> <d2p1:Key>String</d2p1:Key> <d2p1:Value> <d2p1:KeyValueOfintArrayOfKeyValueOfstringdoublety7Ep6D1> <d2p1:Key>0</d2p1:Key> <d2p1:Value /> </d2p1:KeyValueOfintArrayOfKeyValueOfstringdoublety7Ep6D1> </d2p1:Value> </d2p1:KeyValueOfstringArrayOfKeyValueOfintArrayOfKeyValueOfstringdoublety7Ep6D1ty7Ep6D1> </GetAllocationsDictionary> <GetAssetClassFundDictionary xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringboolean> <d2p1:Key>String</d2p1:Key> <d2p1:Value>false</d2p1:Value> </d2p1:KeyValueOfstringboolean> </GetAssetClassFundDictionary> <GetTermBasedFundDictionary xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringboolean> <d2p1:Key>String</d2p1:Key> <d2p1:Value>true</d2p1:Value> </d2p1:KeyValueOfstringboolean> </GetTermBasedFundDictionary> <InvestmentPropertyRates>0</InvestmentPropertyRates> <Investments xmlns:d2p1="http://schemas.datacontract.org/2004/07/TasSyd.Model.Core"> <d2p1:InvestmentProduct> <d2p1:AllocationsDictionary xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:KeyValueOfintArrayOfKeyValueOfstringdoublety7Ep6D1> <d4p1:Key>0</d4p1:Key> <d4p1:Value /> </d4p1:KeyValueOfintArrayOfKeyValueOfstringdoublety7Ep6D1> </d2p1:AllocationsDictionary> <d2p1:Allocs> <d2p1:InvestmentProductAllocationsSpec> <d2p1:Allocs xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:KeyValueOfstringdouble> <d6p1:Key>String</d6p1:Key> <d6p1:Value>0</d6p1:Value> </d6p1:KeyValueOfstringdouble> </d2p1:Allocs> <d2p1:FromAge>0</d2p1:FromAge> <d2p1:Term>0</d2p1:Term> </d2p1:InvestmentProductAllocationsSpec> </d2p1:Allocs> <d2p1:Code>String</d2p1:Code> <d2p1:Group>String</d2p1:Group> <d2p1:IsAssetClassFund>false</d2p1:IsAssetClassFund> <d2p1:Name>String</d2p1:Name> <d2p1:Order>0</d2p1:Order> </d2p1:InvestmentProduct> </Investments> <PrimarySalary>String</PrimarySalary> <Source xmlns:d2p1="http://schemas.datacontract.org/2004/07/TasSyd.Model.Stochastic"> <d2p1:D>Db</d2p1:D> <d2p1:T>0</d2p1:T> </Source> </ClientCountryConfig>