AlbaApi

<back to all web services

PensionsInfoExtReq

The following routes are available for this service:
POST/ext/pensionsinfo
import java.math.*
import java.util.*
import net.servicestack.client.*


open class PensionsInfoExtReq
{
    var header:SendPensionPlanHeader? = null
    var pdf:Pdf? = null
    var cohabitantPdf:Pdf? = null
    var pensionProviders:ArrayList<PensionProviderVer9DTO> = ArrayList<PensionProviderVer9DTO>()
    var cohabitantPensionProviders:ArrayList<PensionProviderVer9DTO> = ArrayList<PensionProviderVer9DTO>()
}

open class SendPensionPlanHeader : TransactionHeader()
{
    var socialSecurityNumber:String? = null
    var cohabitantSocialSecurityNumber:String? = null
    var customerRemark:ByteArray? = null
    var systemInfo:String? = null
    var pensionProviderId:Int? = null
}

open class TransactionHeader
{
    var versionNumber:Int? = null
    var transactionId:String? = null
    var transactionsTypeNumber:Int? = null
    var eventTime:Date? = null
}

open class Pdf
{
    var pdfReport:ByteArray? = null
}

open class PensionProviderVer9DTO
{
    var pensionProviderId:Int? = null
    var pensionProviderName:String? = null
    var wordSplitCharacter:Int? = null
    var webSiteUrl:String? = null
    var currencyCode:String? = null
    var advisorName:String? = null
    var receiveDataForAdvisory:Boolean? = null
    var transactionStatus:Int? = null
    var schemes:ArrayList<PensionSchemeVer9DTO> = ArrayList<PensionSchemeVer9DTO>()
    var transactionRemarks:ArrayList<RemarkVer9DTO> = ArrayList<RemarkVer9DTO>()
}

open class PensionSchemeVer9DTO
{
    var transactionStatus:Int? = null
    var referenceNumber:String? = null
    var typeNumber:Int? = null
    var phone:Int? = null
    var contact:String? = null
    var email:String? = null
    var payment:Int? = null
    var paymentDate:Date? = null
    var savedValue:Int? = null
    var savedValueDate:Date? = null
    var savedValuePresentation:Int? = null
    var systemInfoScheme:String? = null
    var businessPartnerNumber:Int? = null
    var guarantees:Int? = null
    var transferCosts:Int? = null
    var transferCostsJobChange:Int? = null
    var repurchase:Int? = null
    var repurchaseText:ByteArray? = null
    var hasWithdrawalPenalty:Boolean? = null
    var benefitComposition:Boolean? = null
    var investmentFormNumber:Int? = null
    var businessPartner:String? = null
    var wordSplitCharacter:Int? = null
    var remarks:ArrayList<RemarkVer9DTO> = ArrayList<RemarkVer9DTO>()
    var benefits:ArrayList<BenefitVer9DTO> = ArrayList<BenefitVer9DTO>()
}

open class RemarkVer9DTO
{
    var typeNumber:Int? = null
    var number:Int? = null
    var text:String? = null
}

open class BenefitVer9DTO
{
    var transactionStatus:Int? = null
    var typeNumber:Int? = null
    var typeText:String? = null
    var subscriptionTypeNumber:Int? = null
    var subscriptionTypeText:String? = null
    var canBeShownInGraph:Boolean? = null
    var moreInfoUrl:String? = null
    var systemInfo:String? = null
    var premiumWaiverBenefit:PremiumWaiverBenefitVer9DTO? = null
    var payment:BenefitPaymentVer9DTO? = null
    var payout:PayoutVer9DTO? = null
    var risk:RiskBenefitVer9DTO? = null
    var pension:PensionBenefitVer9DTO? = null
    var remarks:ArrayList<RemarkVer9DTO> = ArrayList<RemarkVer9DTO>()
}

open class PremiumWaiverBenefitVer9DTO
{
    var isEligible:Boolean? = null
    var isActive:Boolean? = null
    var value:Int? = null
}

open class BenefitPaymentVer9DTO
{
    var benefitPayment:Int? = null
    var paymentYearToDate:Int? = null
    var latestPaymentDate:Date? = null
}

open class PayoutVer9DTO
{
    var currentPayment:Boolean? = null
    var payoutForecasts:ArrayList<PayoutForecastVer9DTO> = ArrayList<PayoutForecastVer9DTO>()
    var paymentFormNumber:Int? = null
    var paymentFormText:String? = null
    var paymentTaxationNumber:Int? = null
    var paymentTaxationText:String? = null
    var receiverNumber:Int? = null
    var receiverText:String? = null
    var conditionNumber:Int? = null
    var conditionText:String? = null
    var conditionParameter:Int? = null
    var beneficiaries:ArrayList<BeneficiaryVer9DTO> = ArrayList<BeneficiaryVer9DTO>()
    var payoutStart:DateAgeTypeVer9DTO? = null
    var payoutEnd:DateAgeTypeVer9DTO? = null
    var latestPossiblePayout:DateAgeTypeVer9DTO? = null
    var earliestPossiblePayout:DateAgeTypeVer9DTO? = null
    var latestPayoutStart:DateAgeTypeVer9DTO? = null
    var paymentYears:Int? = null
}

open class PayoutForecastVer9DTO
{
    var age:Int? = null
    var amount:Int? = null
}

open class BeneficiaryVer9DTO
{
    var name:String? = null
    var percentage:Int? = null
    var typeNumber:Int? = null
    var typeText:String? = null
}

open class DateAgeTypeVer9DTO
{
    var date:Date? = null
    var age:Int? = null
}

open class RiskBenefitVer9DTO
{
    var shadowBenefit:Boolean? = null
    var amount:Int? = null
    var amountDate:Date? = null
    var riskTermination:DateAgeTypeVer9DTO? = null
    var benefitExtentNumber:Int? = null
    var benefitDetail:ArrayList<Int> = ArrayList<Int>()
}

open class PensionBenefitVer9DTO
{
    var pensionTypeNumber:Int? = null
    var pensionType:String? = null
    var indexContractCount:Int? = null
    var investmentDistributions:ArrayList<InvestmentDistributionVer9DTO> = ArrayList<InvestmentDistributionVer9DTO>()
    var pensionForecasts:PensionForecastsVer9DTO? = null
}

open class InvestmentDistributionVer9DTO
{
    var investmentFormNumber:Int? = null
    var investmentIdentification:String? = null
    var investmentValue:Int? = null
    var investmentValueDate:Date? = null
    var pendingYieldAmount:Int? = null
}

open class PensionForecastsVer9DTO
{
    var pensionPayment:Boolean? = null
    var earlyRetirementDeduction:Boolean? = null
    var calculateForecasts:Boolean? = null
    var forecastInterestType:Int? = null
    var priceIndexRegulated:Boolean? = null
    var realIncomeRegulated:Boolean? = null
    var enterPaymentEnabled:Boolean? = null
    var forecastCalculationDate:Date? = null
    var forecastsCalculations:ArrayList<ForecastCalculationVer9DTO> = ArrayList<ForecastCalculationVer9DTO>()
}

open class ForecastCalculationVer9DTO
{
    var forecastStartAge:Int? = null
    var remarks:ArrayList<RemarkVer9DTO> = ArrayList<RemarkVer9DTO>()
    var forecasts:ArrayList<ForecastVer9DTO> = ArrayList<ForecastVer9DTO>()
}

open class ForecastVer9DTO
{
    var age:Int? = null
    var amount:Int? = null
}

open class SendPensionPlanToProviderResponseVer9DTO
{
    var header:AnswerSendPensionPlanHeader? = null
}

open class AnswerSendPensionPlanHeader : TransactionHeader()
{
    var socialSecurityNumber:String? = null
    var reportReceived:Boolean? = null
    var providerRemark:ByteArray? = null
    var errorText:String? = null
}

Kotlin PensionsInfoExtReq DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
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: text/jsv
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
	}
}