AlbaApi

<back to all web services

PensionsInfoReq

The following routes are available for this service:
POST/pensionsinfo
namespace AlbaApi.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type TransactionHeader() = 
        member val VersionNumber:Int32 = new Int32() with get,set
        member val TransactionId:String = null with get,set
        member val TransactionsTypeNumber:Int32 = new Int32() with get,set
        member val EventTime:DateTimeOffset = new DateTimeOffset() with get,set

    [<AllowNullLiteral>]
    type AnswerSendPensionPlanHeader() = 
        inherit TransactionHeader()
        member val SocialSecurityNumber:String = null with get,set
        member val ReportReceived:Boolean = new Boolean() with get,set
        member val ProviderRemark:Byte[] = [||] with get,set
        member val ErrorText:String = null with get,set

    [<AllowNullLiteral>]
    type SendPensionPlanToProviderResponseVer9DTO() = 
        member val Header:AnswerSendPensionPlanHeader = null with get,set

    [<AllowNullLiteral>]
    type SendPensionPlanHeader() = 
        inherit TransactionHeader()
        member val SocialSecurityNumber:String = null with get,set
        member val CohabitantSocialSecurityNumber:String = null with get,set
        member val CustomerRemark:Byte[] = [||] with get,set
        member val SystemInfo:String = null with get,set
        member val PensionProviderId:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type Pdf() = 
        member val PdfReport:Byte[] = [||] with get,set

    [<AllowNullLiteral>]
    type RemarkVer9DTO() = 
        member val TypeNumber:Int32 = new Int32() with get,set
        member val Number:Int32 = new Int32() with get,set
        member val Text:String = null with get,set

    [<AllowNullLiteral>]
    type PremiumWaiverBenefitVer9DTO() = 
        member val IsEligible:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val IsActive:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val Value:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type BenefitPaymentVer9DTO() = 
        member val BenefitPayment:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val PaymentYearToDate:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val LatestPaymentDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set

    [<AllowNullLiteral>]
    type PayoutForecastVer9DTO() = 
        member val Age:Int32 = new Int32() with get,set
        member val Amount:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type BeneficiaryVer9DTO() = 
        member val Name:String = null with get,set
        member val Percentage:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val TypeNumber:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val TypeText:String = null with get,set

    [<AllowNullLiteral>]
    type DateAgeTypeVer9DTO() = 
        member val Date:DateTimeOffset = new DateTimeOffset() with get,set
        member val Age:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type PayoutVer9DTO() = 
        member val CurrentPayment:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val PayoutForecasts:ICollection<PayoutForecastVer9DTO> = null with get,set
        member val PaymentFormNumber:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val PaymentFormText:String = null with get,set
        member val PaymentTaxationNumber:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val PaymentTaxationText:String = null with get,set
        member val ReceiverNumber:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ReceiverText:String = null with get,set
        member val ConditionNumber:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ConditionText:String = null with get,set
        member val ConditionParameter:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Beneficiaries:ICollection<BeneficiaryVer9DTO> = null with get,set
        member val PayoutStart:DateAgeTypeVer9DTO = null with get,set
        member val PayoutEnd:DateAgeTypeVer9DTO = null with get,set
        member val LatestPossiblePayout:DateAgeTypeVer9DTO = null with get,set
        member val EarliestPossiblePayout:DateAgeTypeVer9DTO = null with get,set
        member val LatestPayoutStart:DateAgeTypeVer9DTO = null with get,set
        member val PaymentYears:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type RiskBenefitVer9DTO() = 
        member val ShadowBenefit:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val Amount:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val AmountDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
        member val RiskTermination:DateAgeTypeVer9DTO = null with get,set
        member val BenefitExtentNumber:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val BenefitDetail:ICollection<Int32> = null with get,set

    [<AllowNullLiteral>]
    type InvestmentDistributionVer9DTO() = 
        member val InvestmentFormNumber:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val InvestmentIdentification:String = null with get,set
        member val InvestmentValue:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val InvestmentValueDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
        member val PendingYieldAmount:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type ForecastVer9DTO() = 
        member val Age:Int32 = new Int32() with get,set
        member val Amount:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type ForecastCalculationVer9DTO() = 
        member val ForecastStartAge:Int32 = new Int32() with get,set
        member val Remarks:ICollection<RemarkVer9DTO> = null with get,set
        member val Forecasts:ICollection<ForecastVer9DTO> = null with get,set

    [<AllowNullLiteral>]
    type PensionForecastsVer9DTO() = 
        member val PensionPayment:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val EarlyRetirementDeduction:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val CalculateForecasts:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val ForecastInterestType:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val PriceIndexRegulated:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val RealIncomeRegulated:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val EnterPaymentEnabled:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val ForecastCalculationDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
        member val ForecastsCalculations:ICollection<ForecastCalculationVer9DTO> = null with get,set

    [<AllowNullLiteral>]
    type PensionBenefitVer9DTO() = 
        member val PensionTypeNumber:Int32 = new Int32() with get,set
        member val PensionType:String = null with get,set
        member val IndexContractCount:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val InvestmentDistributions:ICollection<InvestmentDistributionVer9DTO> = null with get,set
        member val PensionForecasts:PensionForecastsVer9DTO = null with get,set

    [<AllowNullLiteral>]
    type BenefitVer9DTO() = 
        member val TransactionStatus:Int32 = new Int32() with get,set
        member val TypeNumber:Int32 = new Int32() with get,set
        member val TypeText:String = null with get,set
        member val SubscriptionTypeNumber:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val SubscriptionTypeText:String = null with get,set
        member val CanBeShownInGraph:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val MoreInfoUrl:String = null with get,set
        member val SystemInfo:String = null with get,set
        member val PremiumWaiverBenefit:PremiumWaiverBenefitVer9DTO = null with get,set
        member val Payment:BenefitPaymentVer9DTO = null with get,set
        member val Payout:PayoutVer9DTO = null with get,set
        member val Risk:RiskBenefitVer9DTO = null with get,set
        member val Pension:PensionBenefitVer9DTO = null with get,set
        member val Remarks:ICollection<RemarkVer9DTO> = null with get,set

    [<AllowNullLiteral>]
    type PensionSchemeVer9DTO() = 
        member val TransactionStatus:Int32 = new Int32() with get,set
        member val ReferenceNumber:String = null with get,set
        member val TypeNumber:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Phone:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Contact:String = null with get,set
        member val Email:String = null with get,set
        member val Payment:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val PaymentDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
        member val SavedValue:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val SavedValueDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
        member val SavedValuePresentation:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val SystemInfoScheme:String = null with get,set
        member val BusinessPartnerNumber:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Guarantees:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val TransferCosts:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val TransferCostsJobChange:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Repurchase:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RepurchaseText:Byte[] = [||] with get,set
        member val HasWithdrawalPenalty:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val BenefitComposition:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val InvestmentFormNumber:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val BusinessPartner:String = null with get,set
        member val WordSplitCharacter:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Remarks:ICollection<RemarkVer9DTO> = null with get,set
        member val Benefits:ICollection<BenefitVer9DTO> = null with get,set

    [<AllowNullLiteral>]
    type PensionProviderVer9DTO() = 
        member val PensionProviderId:Int32 = new Int32() with get,set
        member val PensionProviderName:String = null with get,set
        member val WordSplitCharacter:Int32 = new Int32() with get,set
        member val WebSiteUrl:String = null with get,set
        member val CurrencyCode:String = null with get,set
        member val AdvisorName:String = null with get,set
        member val ReceiveDataForAdvisory:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val TransactionStatus:Int32 = new Int32() with get,set
        member val Schemes:ICollection<PensionSchemeVer9DTO> = null with get,set
        member val TransactionRemarks:ICollection<RemarkVer9DTO> = null with get,set

    [<AllowNullLiteral>]
    type PensionsInfoReq() = 
        member val Header:SendPensionPlanHeader = null with get,set
        member val Pdf:Pdf = null with get,set
        member val CohabitantPdf:Pdf = null with get,set
        member val PensionProviders:ResizeArray<PensionProviderVer9DTO> = new ResizeArray<PensionProviderVer9DTO>() with get,set
        member val CohabitantPensionProviders:ResizeArray<PensionProviderVer9DTO> = new ResizeArray<PensionProviderVer9DTO>() with get,set

F# PensionsInfoReq 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 /pensionsinfo HTTP/1.1 
Host: hcbtas-q-albamfs-api.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"header":{"socialSecurityNumber":"String","cohabitantSocialSecurityNumber":"String","customerRemark":"AA==","systemInfo":"String","pensionProviderId":0,"versionNumber":0,"transactionId":"String","transactionsTypeNumber":0,"eventTime":"0001-01-01T00:00:00.0000000+00:00"},"pdf":{"pdfReport":"AA=="},"cohabitantPdf":{"pdfReport":"AA=="},"pensionProviders":[{"pensionProviderId":0,"pensionProviderName":"String","wordSplitCharacter":0,"webSiteUrl":"String","currencyCode":"String","advisorName":"String","receiveDataForAdvisory":false,"transactionStatus":0}],"cohabitantPensionProviders":[{"pensionProviderId":0,"pensionProviderName":"String","wordSplitCharacter":0,"webSiteUrl":"String","currencyCode":"String","advisorName":"String","receiveDataForAdvisory":false,"transactionStatus":0}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"header":{"socialSecurityNumber":"String","reportReceived":false,"providerRemark":"AA==","errorText":"String","versionNumber":0,"transactionId":"String","transactionsTypeNumber":0,"eventTime":"0001-01-01T00:00:00.0000000+00:00"}}