AlbaApi

PensionsInfoExtReq

The following routes are available for this service:
POST	/ext/pensionsinfo

**PensionsInfoExtReq** Parameters:
Name	Parameter	Data Type	Required
Header	body	SendPensionPlanHeader	No
Pdf	body	Pdf	No
CohabitantPdf	body	Pdf	No
PensionProviders	body	List<PensionProviderVer9DTO>	No
CohabitantPensionProviders	body	List<PensionProviderVer9DTO>	No

**SendPensionPlanHeader** Parameters:
Name	Parameter	Data Type	Required
SocialSecurityNumber	form	string	No
CohabitantSocialSecurityNumber	form	string	No
CustomerRemark	form	byte[]	No
SystemInfo	form	string	No
PensionProviderId	form	int	No

**TransactionHeader** Parameters:
Name	Parameter	Data Type	Required
VersionNumber	form	int	No
TransactionId	form	string	No
TransactionsTypeNumber	form	int	No
EventTime	form	DateTimeOffset	No

**Pdf** Parameters:
Name	Parameter	Data Type	Required	Description
PdfReport	form	byte[]	No

**PensionProviderVer9DTO** Parameters:
Name	Parameter	Data Type	Required
PensionProviderId	form	int	No
PensionProviderName	form	string	No
WordSplitCharacter	form	int	No
WebSiteUrl	form	string	No
CurrencyCode	form	string	No
AdvisorName	form	string	No
ReceiveDataForAdvisory	form	bool?	No
TransactionStatus	form	int	No
Schemes	form	ICollection<PensionSchemeVer9DTO>	No
TransactionRemarks	form	ICollection<RemarkVer9DTO>	No

**PensionSchemeVer9DTO** Parameters:
Name	Parameter	Data Type	Required
TransactionStatus	form	int	No
ReferenceNumber	form	string	No
TypeNumber	form	int?	No
Phone	form	int?	No
Contact	form	string	No
Email	form	string	No
Payment	form	int?	No
PaymentDate	form	DateTimeOffset?	No
SavedValue	form	int?	No
SavedValueDate	form	DateTimeOffset?	No
SavedValuePresentation	form	int?	No
SystemInfoScheme	form	string	No
BusinessPartnerNumber	form	int?	No
Guarantees	form	int?	No
TransferCosts	form	int?	No
TransferCostsJobChange	form	int?	No
Repurchase	form	int?	No
RepurchaseText	form	byte[]	No
HasWithdrawalPenalty	form	bool?	No
BenefitComposition	form	bool?	No
InvestmentFormNumber	form	int?	No
BusinessPartner	form	string	No
WordSplitCharacter	form	int?	No
Remarks	form	ICollection<RemarkVer9DTO>	No
Benefits	form	ICollection<BenefitVer9DTO>	No

**RemarkVer9DTO** Parameters:
Name	Parameter	Data Type	Required
TypeNumber	form	int	No
Number	form	int	No
Text	form	string	No

**BenefitVer9DTO** Parameters:
Name	Parameter	Data Type	Required
TransactionStatus	form	int	No
TypeNumber	form	int	No
TypeText	form	string	No
SubscriptionTypeNumber	form	int?	No
SubscriptionTypeText	form	string	No
CanBeShownInGraph	form	bool?	No
MoreInfoUrl	form	string	No
SystemInfo	form	string	No
PremiumWaiverBenefit	form	PremiumWaiverBenefitVer9DTO	No
Payment	form	BenefitPaymentVer9DTO	No
Payout	form	PayoutVer9DTO	No
Risk	form	RiskBenefitVer9DTO	No
Pension	form	PensionBenefitVer9DTO	No
Remarks	form	ICollection<RemarkVer9DTO>	No

**PremiumWaiverBenefitVer9DTO** Parameters:
Name	Parameter	Data Type	Required
IsEligible	form	bool?	No
IsActive	form	bool?	No
Value	form	int?	No

**BenefitPaymentVer9DTO** Parameters:
Name	Parameter	Data Type	Required
BenefitPayment	form	int?	No
PaymentYearToDate	form	int?	No
LatestPaymentDate	form	DateTimeOffset?	No

**PayoutVer9DTO** Parameters:
Name	Parameter	Data Type	Required
CurrentPayment	form	bool?	No
PayoutForecasts	form	ICollection<PayoutForecastVer9DTO>	No
PaymentFormNumber	form	int?	No
PaymentFormText	form	string	No
PaymentTaxationNumber	form	int?	No
PaymentTaxationText	form	string	No
ReceiverNumber	form	int?	No
ReceiverText	form	string	No
ConditionNumber	form	int?	No
ConditionText	form	string	No
ConditionParameter	form	int?	No
Beneficiaries	form	ICollection<BeneficiaryVer9DTO>	No
PayoutStart	form	DateAgeTypeVer9DTO	No
PayoutEnd	form	DateAgeTypeVer9DTO	No
LatestPossiblePayout	form	DateAgeTypeVer9DTO	No
EarliestPossiblePayout	form	DateAgeTypeVer9DTO	No
LatestPayoutStart	form	DateAgeTypeVer9DTO	No
PaymentYears	form	int?	No

**PayoutForecastVer9DTO** Parameters:
Name	Parameter	Data Type	Required	Description
Age	form	int	No
Amount	form	int?	No

**BeneficiaryVer9DTO** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Percentage	form	int?	No
TypeNumber	form	int?	No
TypeText	form	string	No

**DateAgeTypeVer9DTO** Parameters:
Name	Parameter	Data Type	Required	Description
Date	form	DateTimeOffset	No
Age	form	int	No

**RiskBenefitVer9DTO** Parameters:
Name	Parameter	Data Type	Required
ShadowBenefit	form	bool?	No
Amount	form	int?	No
AmountDate	form	DateTimeOffset?	No
RiskTermination	form	DateAgeTypeVer9DTO	No
BenefitExtentNumber	form	int?	No
BenefitDetail	form	ICollection<int>	No

**PensionBenefitVer9DTO** Parameters:
Name	Parameter	Data Type	Required
PensionTypeNumber	form	int	No
PensionType	form	string	No
IndexContractCount	form	int?	No
InvestmentDistributions	form	ICollection<InvestmentDistributionVer9DTO>	No
PensionForecasts	form	PensionForecastsVer9DTO	No

**InvestmentDistributionVer9DTO** Parameters:
Name	Parameter	Data Type	Required
InvestmentFormNumber	form	int?	No
InvestmentIdentification	form	string	No
InvestmentValue	form	int?	No
InvestmentValueDate	form	DateTimeOffset?	No
PendingYieldAmount	form	int?	No

**PensionForecastsVer9DTO** Parameters:
Name	Parameter	Data Type	Required
PensionPayment	form	bool?	No
EarlyRetirementDeduction	form	bool?	No
CalculateForecasts	form	bool?	No
ForecastInterestType	form	int?	No
PriceIndexRegulated	form	bool?	No
RealIncomeRegulated	form	bool?	No
EnterPaymentEnabled	form	bool?	No
ForecastCalculationDate	form	DateTimeOffset?	No
ForecastsCalculations	form	ICollection<ForecastCalculationVer9DTO>	No

**ForecastCalculationVer9DTO** Parameters:
Name	Parameter	Data Type	Required
ForecastStartAge	form	int	No
Remarks	form	ICollection<RemarkVer9DTO>	No
Forecasts	form	ICollection<ForecastVer9DTO>	No

**ForecastVer9DTO** Parameters:
Name	Parameter	Data Type	Required	Description
Age	form	int	No
Amount	form	int?	No

**SendPensionPlanToProviderResponseVer9DTO** Parameters:
Name	Parameter	Data Type	Required	Description
Header	form	AnswerSendPensionPlanHeader	No

**AnswerSendPensionPlanHeader** Parameters:
Name	Parameter	Data Type	Required
SocialSecurityNumber	form	string	No
ReportReceived	form	bool	No
ProviderRemark	form	byte[]	No
ErrorText	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /ext/pensionsinfo HTTP/1.1 
Host: hcbtas-q-albamfs-api.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PensionsInfoExtReq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlbaApi.ServiceModel">
  <CohabitantPdf xmlns:d2p1="http://schemas.datacontract.org/2004/07/AlbaMfs.Common.PensionsInfo">
    <d2p1:PdfReport>AA==</d2p1:PdfReport>
  </CohabitantPdf>
  <CohabitantPensionProviders xmlns:d2p1="http://schemas.datacontract.org/2004/07/AlbaMfs.Common.PensionsInfo">
    <d2p1:PensionProviderVer9DTO>
      <d2p1:AdvisorName>String</d2p1:AdvisorName>
      <d2p1:CurrencyCode>String</d2p1:CurrencyCode>
      <d2p1:PensionProviderId>0</d2p1:PensionProviderId>
      <d2p1:PensionProviderName>String</d2p1:PensionProviderName>
      <d2p1:ReceiveDataForAdvisory>false</d2p1:ReceiveDataForAdvisory>
      <d2p1:Schemes i:nil="true" />
      <d2p1:TransactionRemarks i:nil="true" />
      <d2p1:TransactionStatus>0</d2p1:TransactionStatus>
      <d2p1:WebSiteUrl>String</d2p1:WebSiteUrl>
      <d2p1:WordSplitCharacter>0</d2p1:WordSplitCharacter>
    </d2p1:PensionProviderVer9DTO>
  </CohabitantPensionProviders>
  <Header xmlns:d2p1="http://schemas.datacontract.org/2004/07/AlbaMfs.Common.PensionsInfo">
    <d2p1:EventTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:EventTime>
    <d2p1:TransactionId>String</d2p1:TransactionId>
    <d2p1:TransactionsTypeNumber>0</d2p1:TransactionsTypeNumber>
    <d2p1:VersionNumber>0</d2p1:VersionNumber>
    <d2p1:CohabitantSocialSecurityNumber>String</d2p1:CohabitantSocialSecurityNumber>
    <d2p1:CustomerRemark>AA==</d2p1:CustomerRemark>
    <d2p1:PensionProviderId>0</d2p1:PensionProviderId>
    <d2p1:SocialSecurityNumber>String</d2p1:SocialSecurityNumber>
    <d2p1:SystemInfo>String</d2p1:SystemInfo>
  </Header>
  <Pdf xmlns:d2p1="http://schemas.datacontract.org/2004/07/AlbaMfs.Common.PensionsInfo">
    <d2p1:PdfReport>AA==</d2p1:PdfReport>
  </Pdf>
  <PensionProviders xmlns:d2p1="http://schemas.datacontract.org/2004/07/AlbaMfs.Common.PensionsInfo">
    <d2p1:PensionProviderVer9DTO>
      <d2p1:AdvisorName>String</d2p1:AdvisorName>
      <d2p1:CurrencyCode>String</d2p1:CurrencyCode>
      <d2p1:PensionProviderId>0</d2p1:PensionProviderId>
      <d2p1:PensionProviderName>String</d2p1:PensionProviderName>
      <d2p1:ReceiveDataForAdvisory>false</d2p1:ReceiveDataForAdvisory>
      <d2p1:Schemes i:nil="true" />
      <d2p1:TransactionRemarks i:nil="true" />
      <d2p1:TransactionStatus>0</d2p1:TransactionStatus>
      <d2p1:WebSiteUrl>String</d2p1:WebSiteUrl>
      <d2p1:WordSplitCharacter>0</d2p1:WordSplitCharacter>
    </d2p1:PensionProviderVer9DTO>
  </PensionProviders>
</PensionsInfoExtReq>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SendPensionPlanToProviderResponseVer9DTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlbaMfs.Common.PensionsInfo">
  <Header>
    <EventTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </EventTime>
    <TransactionId>String</TransactionId>
    <TransactionsTypeNumber>0</TransactionsTypeNumber>
    <VersionNumber>0</VersionNumber>
    <ErrorText>String</ErrorText>
    <ProviderRemark>AA==</ProviderRemark>
    <ReportReceived>false</ReportReceived>
    <SocialSecurityNumber>String</SocialSecurityNumber>
  </Header>
</SendPensionPlanToProviderResponseVer9DTO>