AlbaApi

<back to all web services

PensionsInfoReq

export class TransactionHeader
{
    public versionNumber?: number;
    public transactionId?: string;
    public transactionsTypeNumber?: number;
    public eventTime?: string;

    public constructor(init?: Partial<TransactionHeader>) { (Object as any).assign(this, init); }
}

export class AnswerSendPensionPlanHeader extends TransactionHeader
{
    public socialSecurityNumber?: string;
    public reportReceived?: boolean;
    public providerRemark?: string;
    public errorText?: string;

    public constructor(init?: Partial<AnswerSendPensionPlanHeader>) { super(init); (Object as any).assign(this, init); }
}

export class SendPensionPlanToProviderResponseVer9DTO
{
    public header?: AnswerSendPensionPlanHeader;

    public constructor(init?: Partial<SendPensionPlanToProviderResponseVer9DTO>) { (Object as any).assign(this, init); }
}

export class SendPensionPlanHeader extends TransactionHeader
{
    public socialSecurityNumber?: string;
    public cohabitantSocialSecurityNumber?: string;
    public customerRemark?: string;
    public systemInfo?: string;
    public pensionProviderId?: number;

    public constructor(init?: Partial<SendPensionPlanHeader>) { super(init); (Object as any).assign(this, init); }
}

export class Pdf
{
    public pdfReport?: string;

    public constructor(init?: Partial<Pdf>) { (Object as any).assign(this, init); }
}

export class RemarkVer9DTO
{
    public typeNumber?: number;
    public number?: number;
    public text?: string;

    public constructor(init?: Partial<RemarkVer9DTO>) { (Object as any).assign(this, init); }
}

export class PremiumWaiverBenefitVer9DTO
{
    public isEligible?: boolean;
    public isActive?: boolean;
    public value?: number;

    public constructor(init?: Partial<PremiumWaiverBenefitVer9DTO>) { (Object as any).assign(this, init); }
}

export class BenefitPaymentVer9DTO
{
    public benefitPayment?: number;
    public paymentYearToDate?: number;
    public latestPaymentDate?: string;

    public constructor(init?: Partial<BenefitPaymentVer9DTO>) { (Object as any).assign(this, init); }
}

export class PayoutForecastVer9DTO
{
    public age?: number;
    public amount?: number;

    public constructor(init?: Partial<PayoutForecastVer9DTO>) { (Object as any).assign(this, init); }
}

export class BeneficiaryVer9DTO
{
    public name?: string;
    public percentage?: number;
    public typeNumber?: number;
    public typeText?: string;

    public constructor(init?: Partial<BeneficiaryVer9DTO>) { (Object as any).assign(this, init); }
}

export class DateAgeTypeVer9DTO
{
    public date?: string;
    public age?: number;

    public constructor(init?: Partial<DateAgeTypeVer9DTO>) { (Object as any).assign(this, init); }
}

export class PayoutVer9DTO
{
    public currentPayment?: boolean;
    public payoutForecasts?: PayoutForecastVer9DTO[];
    public paymentFormNumber?: number;
    public paymentFormText?: string;
    public paymentTaxationNumber?: number;
    public paymentTaxationText?: string;
    public receiverNumber?: number;
    public receiverText?: string;
    public conditionNumber?: number;
    public conditionText?: string;
    public conditionParameter?: number;
    public beneficiaries?: BeneficiaryVer9DTO[];
    public payoutStart?: DateAgeTypeVer9DTO;
    public payoutEnd?: DateAgeTypeVer9DTO;
    public latestPossiblePayout?: DateAgeTypeVer9DTO;
    public earliestPossiblePayout?: DateAgeTypeVer9DTO;
    public latestPayoutStart?: DateAgeTypeVer9DTO;
    public paymentYears?: number;

    public constructor(init?: Partial<PayoutVer9DTO>) { (Object as any).assign(this, init); }
}

export class RiskBenefitVer9DTO
{
    public shadowBenefit?: boolean;
    public amount?: number;
    public amountDate?: string;
    public riskTermination?: DateAgeTypeVer9DTO;
    public benefitExtentNumber?: number;
    public benefitDetail?: number[];

    public constructor(init?: Partial<RiskBenefitVer9DTO>) { (Object as any).assign(this, init); }
}

export class InvestmentDistributionVer9DTO
{
    public investmentFormNumber?: number;
    public investmentIdentification?: string;
    public investmentValue?: number;
    public investmentValueDate?: string;
    public pendingYieldAmount?: number;

    public constructor(init?: Partial<InvestmentDistributionVer9DTO>) { (Object as any).assign(this, init); }
}

export class ForecastVer9DTO
{
    public age?: number;
    public amount?: number;

    public constructor(init?: Partial<ForecastVer9DTO>) { (Object as any).assign(this, init); }
}

export class ForecastCalculationVer9DTO
{
    public forecastStartAge?: number;
    public remarks?: RemarkVer9DTO[];
    public forecasts?: ForecastVer9DTO[];

    public constructor(init?: Partial<ForecastCalculationVer9DTO>) { (Object as any).assign(this, init); }
}

export class PensionForecastsVer9DTO
{
    public pensionPayment?: boolean;
    public earlyRetirementDeduction?: boolean;
    public calculateForecasts?: boolean;
    public forecastInterestType?: number;
    public priceIndexRegulated?: boolean;
    public realIncomeRegulated?: boolean;
    public enterPaymentEnabled?: boolean;
    public forecastCalculationDate?: string;
    public forecastsCalculations?: ForecastCalculationVer9DTO[];

    public constructor(init?: Partial<PensionForecastsVer9DTO>) { (Object as any).assign(this, init); }
}

export class PensionBenefitVer9DTO
{
    public pensionTypeNumber?: number;
    public pensionType?: string;
    public indexContractCount?: number;
    public investmentDistributions?: InvestmentDistributionVer9DTO[];
    public pensionForecasts?: PensionForecastsVer9DTO;

    public constructor(init?: Partial<PensionBenefitVer9DTO>) { (Object as any).assign(this, init); }
}

export class BenefitVer9DTO
{
    public transactionStatus?: number;
    public typeNumber?: number;
    public typeText?: string;
    public subscriptionTypeNumber?: number;
    public subscriptionTypeText?: string;
    public canBeShownInGraph?: boolean;
    public moreInfoUrl?: string;
    public systemInfo?: string;
    public premiumWaiverBenefit?: PremiumWaiverBenefitVer9DTO;
    public payment?: BenefitPaymentVer9DTO;
    public payout?: PayoutVer9DTO;
    public risk?: RiskBenefitVer9DTO;
    public pension?: PensionBenefitVer9DTO;
    public remarks?: RemarkVer9DTO[];

    public constructor(init?: Partial<BenefitVer9DTO>) { (Object as any).assign(this, init); }
}

export class PensionSchemeVer9DTO
{
    public transactionStatus?: number;
    public referenceNumber?: string;
    public typeNumber?: number;
    public phone?: number;
    public contact?: string;
    public email?: string;
    public payment?: number;
    public paymentDate?: string;
    public savedValue?: number;
    public savedValueDate?: string;
    public savedValuePresentation?: number;
    public systemInfoScheme?: string;
    public businessPartnerNumber?: number;
    public guarantees?: number;
    public transferCosts?: number;
    public transferCostsJobChange?: number;
    public repurchase?: number;
    public repurchaseText?: string;
    public hasWithdrawalPenalty?: boolean;
    public benefitComposition?: boolean;
    public investmentFormNumber?: number;
    public businessPartner?: string;
    public wordSplitCharacter?: number;
    public remarks?: RemarkVer9DTO[];
    public benefits?: BenefitVer9DTO[];

    public constructor(init?: Partial<PensionSchemeVer9DTO>) { (Object as any).assign(this, init); }
}

export class PensionProviderVer9DTO
{
    public pensionProviderId?: number;
    public pensionProviderName?: string;
    public wordSplitCharacter?: number;
    public webSiteUrl?: string;
    public currencyCode?: string;
    public advisorName?: string;
    public receiveDataForAdvisory?: boolean;
    public transactionStatus?: number;
    public schemes?: PensionSchemeVer9DTO[];
    public transactionRemarks?: RemarkVer9DTO[];

    public constructor(init?: Partial<PensionProviderVer9DTO>) { (Object as any).assign(this, init); }
}

export class PensionsInfoReq
{
    public header?: SendPensionPlanHeader;
    public pdf?: Pdf;
    public cohabitantPdf?: Pdf;
    public pensionProviders?: PensionProviderVer9DTO[];
    public cohabitantPensionProviders?: PensionProviderVer9DTO[];

    public constructor(init?: Partial<PensionsInfoReq>) { (Object as any).assign(this, init); }
}

TypeScript PensionsInfoReq DTOs

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

<PensionsInfoReq 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>
</PensionsInfoReq>

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>