AlbaApi

<back to all web services

PensionsInfoExtReq

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

namespace AlbaApi.ServiceModel
{
    public partial class PensionsInfoExtReq
    {
        public PensionsInfoExtReq()
        {
            PensionProviders = new List<PensionProviderVer9DTO>{};
            CohabitantPensionProviders = new List<PensionProviderVer9DTO>{};
        }

        public virtual SendPensionPlanHeader Header { get; set; }
        public virtual Pdf Pdf { get; set; }
        public virtual Pdf CohabitantPdf { get; set; }
        public virtual List<PensionProviderVer9DTO> PensionProviders { get; set; }
        public virtual List<PensionProviderVer9DTO> CohabitantPensionProviders { get; set; }
    }

}

namespace AlbaMfs.Common.PensionsInfo
{
    public partial class AnswerSendPensionPlanHeader
        : TransactionHeader
    {
        public AnswerSendPensionPlanHeader()
        {
            ProviderRemark = new byte[]{};
        }

        public virtual string SocialSecurityNumber { get; set; }
        public virtual bool ReportReceived { get; set; }
        public virtual byte[] ProviderRemark { get; set; }
        public virtual string ErrorText { get; set; }
    }

    public partial class BeneficiaryVer9DTO
    {
        public virtual string Name { get; set; }
        public virtual int? Percentage { get; set; }
        public virtual int? TypeNumber { get; set; }
        public virtual string TypeText { get; set; }
    }

    public partial class BenefitPaymentVer9DTO
    {
        public virtual int? BenefitPayment { get; set; }
        public virtual int? PaymentYearToDate { get; set; }
        public virtual DateTimeOffset? LatestPaymentDate { get; set; }
    }

    public partial class BenefitVer9DTO
    {
        public virtual int TransactionStatus { get; set; }
        public virtual int TypeNumber { get; set; }
        public virtual string TypeText { get; set; }
        public virtual int? SubscriptionTypeNumber { get; set; }
        public virtual string SubscriptionTypeText { get; set; }
        public virtual bool? CanBeShownInGraph { get; set; }
        public virtual string MoreInfoUrl { get; set; }
        public virtual string SystemInfo { get; set; }
        public virtual PremiumWaiverBenefitVer9DTO PremiumWaiverBenefit { get; set; }
        public virtual BenefitPaymentVer9DTO Payment { get; set; }
        public virtual PayoutVer9DTO Payout { get; set; }
        public virtual RiskBenefitVer9DTO Risk { get; set; }
        public virtual PensionBenefitVer9DTO Pension { get; set; }
        public virtual ICollection<RemarkVer9DTO> Remarks { get; set; }
    }

    public partial class DateAgeTypeVer9DTO
    {
        public virtual DateTimeOffset Date { get; set; }
        public virtual int Age { get; set; }
    }

    public partial class ForecastCalculationVer9DTO
    {
        public virtual int ForecastStartAge { get; set; }
        public virtual ICollection<RemarkVer9DTO> Remarks { get; set; }
        public virtual ICollection<ForecastVer9DTO> Forecasts { get; set; }
    }

    public partial class ForecastVer9DTO
    {
        public virtual int Age { get; set; }
        public virtual int? Amount { get; set; }
    }

    public partial class InvestmentDistributionVer9DTO
    {
        public virtual int? InvestmentFormNumber { get; set; }
        public virtual string InvestmentIdentification { get; set; }
        public virtual int? InvestmentValue { get; set; }
        public virtual DateTimeOffset? InvestmentValueDate { get; set; }
        public virtual int? PendingYieldAmount { get; set; }
    }

    public partial class PayoutForecastVer9DTO
    {
        public virtual int Age { get; set; }
        public virtual int? Amount { get; set; }
    }

    public partial class PayoutVer9DTO
    {
        public virtual bool? CurrentPayment { get; set; }
        public virtual ICollection<PayoutForecastVer9DTO> PayoutForecasts { get; set; }
        public virtual int? PaymentFormNumber { get; set; }
        public virtual string PaymentFormText { get; set; }
        public virtual int? PaymentTaxationNumber { get; set; }
        public virtual string PaymentTaxationText { get; set; }
        public virtual int? ReceiverNumber { get; set; }
        public virtual string ReceiverText { get; set; }
        public virtual int? ConditionNumber { get; set; }
        public virtual string ConditionText { get; set; }
        public virtual int? ConditionParameter { get; set; }
        public virtual ICollection<BeneficiaryVer9DTO> Beneficiaries { get; set; }
        public virtual DateAgeTypeVer9DTO PayoutStart { get; set; }
        public virtual DateAgeTypeVer9DTO PayoutEnd { get; set; }
        public virtual DateAgeTypeVer9DTO LatestPossiblePayout { get; set; }
        public virtual DateAgeTypeVer9DTO EarliestPossiblePayout { get; set; }
        public virtual DateAgeTypeVer9DTO LatestPayoutStart { get; set; }
        public virtual int? PaymentYears { get; set; }
    }

    public partial class Pdf
    {
        public Pdf()
        {
            PdfReport = new byte[]{};
        }

        public virtual byte[] PdfReport { get; set; }
    }

    public partial class PensionBenefitVer9DTO
    {
        public virtual int PensionTypeNumber { get; set; }
        public virtual string PensionType { get; set; }
        public virtual int? IndexContractCount { get; set; }
        public virtual ICollection<InvestmentDistributionVer9DTO> InvestmentDistributions { get; set; }
        public virtual PensionForecastsVer9DTO PensionForecasts { get; set; }
    }

    public partial class PensionForecastsVer9DTO
    {
        public virtual bool? PensionPayment { get; set; }
        public virtual bool? EarlyRetirementDeduction { get; set; }
        public virtual bool? CalculateForecasts { get; set; }
        public virtual int? ForecastInterestType { get; set; }
        public virtual bool? PriceIndexRegulated { get; set; }
        public virtual bool? RealIncomeRegulated { get; set; }
        public virtual bool? EnterPaymentEnabled { get; set; }
        public virtual DateTimeOffset? ForecastCalculationDate { get; set; }
        public virtual ICollection<ForecastCalculationVer9DTO> ForecastsCalculations { get; set; }
    }

    public partial class PensionProviderVer9DTO
    {
        public virtual int PensionProviderId { get; set; }
        public virtual string PensionProviderName { get; set; }
        public virtual int WordSplitCharacter { get; set; }
        public virtual string WebSiteUrl { get; set; }
        public virtual string CurrencyCode { get; set; }
        public virtual string AdvisorName { get; set; }
        public virtual bool? ReceiveDataForAdvisory { get; set; }
        public virtual int TransactionStatus { get; set; }
        public virtual ICollection<PensionSchemeVer9DTO> Schemes { get; set; }
        public virtual ICollection<RemarkVer9DTO> TransactionRemarks { get; set; }
    }

    public partial class PensionSchemeVer9DTO
    {
        public PensionSchemeVer9DTO()
        {
            RepurchaseText = new byte[]{};
        }

        public virtual int TransactionStatus { get; set; }
        public virtual string ReferenceNumber { get; set; }
        public virtual int? TypeNumber { get; set; }
        public virtual int? Phone { get; set; }
        public virtual string Contact { get; set; }
        public virtual string Email { get; set; }
        public virtual int? Payment { get; set; }
        public virtual DateTimeOffset? PaymentDate { get; set; }
        public virtual int? SavedValue { get; set; }
        public virtual DateTimeOffset? SavedValueDate { get; set; }
        public virtual int? SavedValuePresentation { get; set; }
        public virtual string SystemInfoScheme { get; set; }
        public virtual int? BusinessPartnerNumber { get; set; }
        public virtual int? Guarantees { get; set; }
        public virtual int? TransferCosts { get; set; }
        public virtual int? TransferCostsJobChange { get; set; }
        public virtual int? Repurchase { get; set; }
        public virtual byte[] RepurchaseText { get; set; }
        public virtual bool? HasWithdrawalPenalty { get; set; }
        public virtual bool? BenefitComposition { get; set; }
        public virtual int? InvestmentFormNumber { get; set; }
        public virtual string BusinessPartner { get; set; }
        public virtual int? WordSplitCharacter { get; set; }
        public virtual ICollection<RemarkVer9DTO> Remarks { get; set; }
        public virtual ICollection<BenefitVer9DTO> Benefits { get; set; }
    }

    public partial class PremiumWaiverBenefitVer9DTO
    {
        public virtual bool? IsEligible { get; set; }
        public virtual bool? IsActive { get; set; }
        public virtual int? Value { get; set; }
    }

    public partial class RemarkVer9DTO
    {
        public virtual int TypeNumber { get; set; }
        public virtual int Number { get; set; }
        public virtual string Text { get; set; }
    }

    public partial class RiskBenefitVer9DTO
    {
        public virtual bool? ShadowBenefit { get; set; }
        public virtual int? Amount { get; set; }
        public virtual DateTimeOffset? AmountDate { get; set; }
        public virtual DateAgeTypeVer9DTO RiskTermination { get; set; }
        public virtual int? BenefitExtentNumber { get; set; }
        public virtual ICollection<int> BenefitDetail { get; set; }
    }

    public partial class SendPensionPlanHeader
        : TransactionHeader
    {
        public SendPensionPlanHeader()
        {
            CustomerRemark = new byte[]{};
        }

        public virtual string SocialSecurityNumber { get; set; }
        public virtual string CohabitantSocialSecurityNumber { get; set; }
        public virtual byte[] CustomerRemark { get; set; }
        public virtual string SystemInfo { get; set; }
        public virtual int PensionProviderId { get; set; }
    }

    public partial class SendPensionPlanToProviderResponseVer9DTO
    {
        public virtual AnswerSendPensionPlanHeader Header { get; set; }
    }

    public partial class TransactionHeader
    {
        public virtual int VersionNumber { get; set; }
        public virtual string TransactionId { get; set; }
        public virtual int TransactionsTypeNumber { get; set; }
        public virtual DateTimeOffset EventTime { get; set; }
    }

}

C# PensionsInfoExtReq 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 /ext/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"}}