AlbaApi

<back to all web services

PensionsInfoReq

The following routes are available for this service:
POST/pensionsinfo
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AlbaApi.ServiceModel
Imports AlbaMfs.Common.PensionsInfo

Namespace Global

    Namespace AlbaApi.ServiceModel

        Public Partial Class PensionsInfoReq
            Public Sub New()
                PensionProviders = New List(Of PensionProviderVer9DTO)
                CohabitantPensionProviders = New List(Of PensionProviderVer9DTO)
            End Sub

            Public Overridable Property Header As SendPensionPlanHeader
            Public Overridable Property Pdf As Pdf
            Public Overridable Property CohabitantPdf As Pdf
            Public Overridable Property PensionProviders As List(Of PensionProviderVer9DTO)
            Public Overridable Property CohabitantPensionProviders As List(Of PensionProviderVer9DTO)
        End Class
    End Namespace

    Namespace AlbaMfs.Common.PensionsInfo

        Public Partial Class AnswerSendPensionPlanHeader
            Inherits TransactionHeader
            Public Sub New()
                ProviderRemark = New Byte(){}
            End Sub

            Public Overridable Property SocialSecurityNumber As String
            Public Overridable Property ReportReceived As Boolean
            Public Overridable Property ProviderRemark As Byte()
            Public Overridable Property ErrorText As String
        End Class

        Public Partial Class BeneficiaryVer9DTO
            Public Overridable Property Name As String
            Public Overridable Property Percentage As Nullable(Of Integer)
            Public Overridable Property TypeNumber As Nullable(Of Integer)
            Public Overridable Property TypeText As String
        End Class

        Public Partial Class BenefitPaymentVer9DTO
            Public Overridable Property BenefitPayment As Nullable(Of Integer)
            Public Overridable Property PaymentYearToDate As Nullable(Of Integer)
            Public Overridable Property LatestPaymentDate As Nullable(Of DateTimeOffset)
        End Class

        Public Partial Class BenefitVer9DTO
            Public Overridable Property TransactionStatus As Integer
            Public Overridable Property TypeNumber As Integer
            Public Overridable Property TypeText As String
            Public Overridable Property SubscriptionTypeNumber As Nullable(Of Integer)
            Public Overridable Property SubscriptionTypeText As String
            Public Overridable Property CanBeShownInGraph As Nullable(Of Boolean)
            Public Overridable Property MoreInfoUrl As String
            Public Overridable Property SystemInfo As String
            Public Overridable Property PremiumWaiverBenefit As PremiumWaiverBenefitVer9DTO
            Public Overridable Property Payment As BenefitPaymentVer9DTO
            Public Overridable Property Payout As PayoutVer9DTO
            Public Overridable Property Risk As RiskBenefitVer9DTO
            Public Overridable Property Pension As PensionBenefitVer9DTO
            Public Overridable Property Remarks As ICollection(Of RemarkVer9DTO)
        End Class

        Public Partial Class DateAgeTypeVer9DTO
            Public Overridable Property [Date] As DateTimeOffset
            Public Overridable Property Age As Integer
        End Class

        Public Partial Class ForecastCalculationVer9DTO
            Public Overridable Property ForecastStartAge As Integer
            Public Overridable Property Remarks As ICollection(Of RemarkVer9DTO)
            Public Overridable Property Forecasts As ICollection(Of ForecastVer9DTO)
        End Class

        Public Partial Class ForecastVer9DTO
            Public Overridable Property Age As Integer
            Public Overridable Property Amount As Nullable(Of Integer)
        End Class

        Public Partial Class InvestmentDistributionVer9DTO
            Public Overridable Property InvestmentFormNumber As Nullable(Of Integer)
            Public Overridable Property InvestmentIdentification As String
            Public Overridable Property InvestmentValue As Nullable(Of Integer)
            Public Overridable Property InvestmentValueDate As Nullable(Of DateTimeOffset)
            Public Overridable Property PendingYieldAmount As Nullable(Of Integer)
        End Class

        Public Partial Class PayoutForecastVer9DTO
            Public Overridable Property Age As Integer
            Public Overridable Property Amount As Nullable(Of Integer)
        End Class

        Public Partial Class PayoutVer9DTO
            Public Overridable Property CurrentPayment As Nullable(Of Boolean)
            Public Overridable Property PayoutForecasts As ICollection(Of PayoutForecastVer9DTO)
            Public Overridable Property PaymentFormNumber As Nullable(Of Integer)
            Public Overridable Property PaymentFormText As String
            Public Overridable Property PaymentTaxationNumber As Nullable(Of Integer)
            Public Overridable Property PaymentTaxationText As String
            Public Overridable Property ReceiverNumber As Nullable(Of Integer)
            Public Overridable Property ReceiverText As String
            Public Overridable Property ConditionNumber As Nullable(Of Integer)
            Public Overridable Property ConditionText As String
            Public Overridable Property ConditionParameter As Nullable(Of Integer)
            Public Overridable Property Beneficiaries As ICollection(Of BeneficiaryVer9DTO)
            Public Overridable Property PayoutStart As DateAgeTypeVer9DTO
            Public Overridable Property PayoutEnd As DateAgeTypeVer9DTO
            Public Overridable Property LatestPossiblePayout As DateAgeTypeVer9DTO
            Public Overridable Property EarliestPossiblePayout As DateAgeTypeVer9DTO
            Public Overridable Property LatestPayoutStart As DateAgeTypeVer9DTO
            Public Overridable Property PaymentYears As Nullable(Of Integer)
        End Class

        Public Partial Class Pdf
            Public Sub New()
                PdfReport = New Byte(){}
            End Sub

            Public Overridable Property PdfReport As Byte()
        End Class

        Public Partial Class PensionBenefitVer9DTO
            Public Overridable Property PensionTypeNumber As Integer
            Public Overridable Property PensionType As String
            Public Overridable Property IndexContractCount As Nullable(Of Integer)
            Public Overridable Property InvestmentDistributions As ICollection(Of InvestmentDistributionVer9DTO)
            Public Overridable Property PensionForecasts As PensionForecastsVer9DTO
        End Class

        Public Partial Class PensionForecastsVer9DTO
            Public Overridable Property PensionPayment As Nullable(Of Boolean)
            Public Overridable Property EarlyRetirementDeduction As Nullable(Of Boolean)
            Public Overridable Property CalculateForecasts As Nullable(Of Boolean)
            Public Overridable Property ForecastInterestType As Nullable(Of Integer)
            Public Overridable Property PriceIndexRegulated As Nullable(Of Boolean)
            Public Overridable Property RealIncomeRegulated As Nullable(Of Boolean)
            Public Overridable Property EnterPaymentEnabled As Nullable(Of Boolean)
            Public Overridable Property ForecastCalculationDate As Nullable(Of DateTimeOffset)
            Public Overridable Property ForecastsCalculations As ICollection(Of ForecastCalculationVer9DTO)
        End Class

        Public Partial Class PensionProviderVer9DTO
            Public Overridable Property PensionProviderId As Integer
            Public Overridable Property PensionProviderName As String
            Public Overridable Property WordSplitCharacter As Integer
            Public Overridable Property WebSiteUrl As String
            Public Overridable Property CurrencyCode As String
            Public Overridable Property AdvisorName As String
            Public Overridable Property ReceiveDataForAdvisory As Nullable(Of Boolean)
            Public Overridable Property TransactionStatus As Integer
            Public Overridable Property Schemes As ICollection(Of PensionSchemeVer9DTO)
            Public Overridable Property TransactionRemarks As ICollection(Of RemarkVer9DTO)
        End Class

        Public Partial Class PensionSchemeVer9DTO
            Public Sub New()
                RepurchaseText = New Byte(){}
            End Sub

            Public Overridable Property TransactionStatus As Integer
            Public Overridable Property ReferenceNumber As String
            Public Overridable Property TypeNumber As Nullable(Of Integer)
            Public Overridable Property Phone As Nullable(Of Integer)
            Public Overridable Property Contact As String
            Public Overridable Property Email As String
            Public Overridable Property Payment As Nullable(Of Integer)
            Public Overridable Property PaymentDate As Nullable(Of DateTimeOffset)
            Public Overridable Property SavedValue As Nullable(Of Integer)
            Public Overridable Property SavedValueDate As Nullable(Of DateTimeOffset)
            Public Overridable Property SavedValuePresentation As Nullable(Of Integer)
            Public Overridable Property SystemInfoScheme As String
            Public Overridable Property BusinessPartnerNumber As Nullable(Of Integer)
            Public Overridable Property Guarantees As Nullable(Of Integer)
            Public Overridable Property TransferCosts As Nullable(Of Integer)
            Public Overridable Property TransferCostsJobChange As Nullable(Of Integer)
            Public Overridable Property Repurchase As Nullable(Of Integer)
            Public Overridable Property RepurchaseText As Byte()
            Public Overridable Property HasWithdrawalPenalty As Nullable(Of Boolean)
            Public Overridable Property BenefitComposition As Nullable(Of Boolean)
            Public Overridable Property InvestmentFormNumber As Nullable(Of Integer)
            Public Overridable Property BusinessPartner As String
            Public Overridable Property WordSplitCharacter As Nullable(Of Integer)
            Public Overridable Property Remarks As ICollection(Of RemarkVer9DTO)
            Public Overridable Property Benefits As ICollection(Of BenefitVer9DTO)
        End Class

        Public Partial Class PremiumWaiverBenefitVer9DTO
            Public Overridable Property IsEligible As Nullable(Of Boolean)
            Public Overridable Property IsActive As Nullable(Of Boolean)
            Public Overridable Property Value As Nullable(Of Integer)
        End Class

        Public Partial Class RemarkVer9DTO
            Public Overridable Property TypeNumber As Integer
            Public Overridable Property Number As Integer
            Public Overridable Property Text As String
        End Class

        Public Partial Class RiskBenefitVer9DTO
            Public Overridable Property ShadowBenefit As Nullable(Of Boolean)
            Public Overridable Property Amount As Nullable(Of Integer)
            Public Overridable Property AmountDate As Nullable(Of DateTimeOffset)
            Public Overridable Property RiskTermination As DateAgeTypeVer9DTO
            Public Overridable Property BenefitExtentNumber As Nullable(Of Integer)
            Public Overridable Property BenefitDetail As ICollection(Of Integer)
        End Class

        Public Partial Class SendPensionPlanHeader
            Inherits TransactionHeader
            Public Sub New()
                CustomerRemark = New Byte(){}
            End Sub

            Public Overridable Property SocialSecurityNumber As String
            Public Overridable Property CohabitantSocialSecurityNumber As String
            Public Overridable Property CustomerRemark As Byte()
            Public Overridable Property SystemInfo As String
            Public Overridable Property PensionProviderId As Integer
        End Class

        Public Partial Class SendPensionPlanToProviderResponseVer9DTO
            Public Overridable Property Header As AnswerSendPensionPlanHeader
        End Class

        Public Partial Class TransactionHeader
            Public Overridable Property VersionNumber As Integer
            Public Overridable Property TransactionId As String
            Public Overridable Property TransactionsTypeNumber As Integer
            Public Overridable Property EventTime As DateTimeOffset
        End Class
    End Namespace
End Namespace

VB.NET PensionsInfoReq DTOs

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