MBOnlineCreditApplicationService

<back to all web services

CreateOCARequest

The following routes are available for this service:
PUT/CreateOCA/
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports MBOnlineCreditApplicationService.CreateOCA
Imports MBOnlineCreditApplicationService.BusinessLib.DomainClasses

Namespace Global

    Namespace MBOnlineCreditApplicationService.BusinessLib.DomainClasses

        Public Partial Class Address
            Public Overridable Property AddressLine1 As String
            Public Overridable Property AddressLine2 As String
            Public Overridable Property AddressLine3 As String
            Public Overridable Property AddressLine4 As String
            Public Overridable Property AddressLine5 As String
            Public Overridable Property Postcode As String
        End Class

        Public Partial Class AddressWithTimeLine
            Public Overridable Property AddressLine1 As String
            Public Overridable Property AddressLine2 As String
            Public Overridable Property AddressLine3 As String
            Public Overridable Property Town As String
            Public Overridable Property County As String
            Public Overridable Property Country As String
            Public Overridable Property Postcode As String
            Public Overridable Property Duration As String
            Public Overridable Property DateStarted As String
        End Class

        Public Partial Class BusinessPartner
            Public Sub New()
                PreviousAddresses = New PreviousAddress(){}
                PreviousEmploymentDetails = New PreviousEmployment(){}
            End Sub

            Public Overridable Property Seq As Integer
            Public Overridable Property Title As String
            Public Overridable Property Initial As String
            Public Overridable Property FirstName As String
            Public Overridable Property Surname As String
            Public Overridable Property DateofBirth As String
            Public Overridable Property Gender As String
            Public Overridable Property MaritalStatus As String
            Public Overridable Property ResidentialStatus As String
            Public Overridable Property CurrentAddress As AddressWithTimeLine
            Public Overridable Property PreviousAddresses As PreviousAddress()
            Public Overridable Property HomePhone As String
            Public Overridable Property MobilePhone As String
            Public Overridable Property BusinessPhone As String
            Public Overridable Property Relationship As String
            Public Overridable Property Email As String
            Public Overridable Property CurrentEmploymentDetails As CurrentEmploymentDetails
            Public Overridable Property PreviousEmploymentDetails As PreviousEmployment()
            Public Overridable Property PartnerType As String
        End Class

        Public Partial Class CreditApplicationBusiness
            Public Sub New()
                BusinessPartners = New BusinessPartner(){}
            End Sub

            Public Overridable Property TypeOfBusiness As String
            Public Overridable Property BusinessContactPosition As String
            Public Overridable Property Title As String
            Public Overridable Property Initial As String
            Public Overridable Property FirstName As String
            Public Overridable Property Surname As String
            Public Overridable Property CurrentHomeAddress As AddressWithTimeLine
            Public Overridable Property HomePhone As String
            Public Overridable Property WorkPhone As String
            Public Overridable Property MobilePhone As String
            Public Overridable Property Email As String
            Public Overridable Property DoNotEmail As String
            Public Overridable Property DoNotMail As String
            Public Overridable Property DoNotPhone As String
            Public Overridable Property DoNotSMS As String
            Public Overridable Property CompanyName As String
            Public Overridable Property CompanyRegistrationNumber As String
            Public Overridable Property TradingAs As String
            Public Overridable Property BusinessActivity As String
            Public Overridable Property NumberOfEmployees As Integer
            Public Overridable Property YearsTrading As Integer
            Public Overridable Property Position As String
            Public Overridable Property BankSortCode As String
            Public Overridable Property BankAccountNumber As String
            Public Overridable Property BankAccountName As String
            Public Overridable Property BankName As String
            Public Overridable Property BankAddress As Address
            Public Overridable Property NumberofPartners As Integer
            Public Overridable Property BusinessPartners As BusinessPartner()
        End Class

        Public Partial Class CreditApplicationIndividual
            Public Sub New()
                PreviousAddresses = New PreviousAddress(){}
                PreviousEmploymentDetails = New PreviousEmployment(){}
            End Sub

            Public Overridable Property Title As String
            Public Overridable Property Initial As String
            Public Overridable Property FirstName As String
            Public Overridable Property Surname As String
            Public Overridable Property DateofBirth As String
            Public Overridable Property Gender As String
            Public Overridable Property MaritalStatus As String
            Public Overridable Property ResidentialStatus As String
            Public Overridable Property CurrentAddress As AddressWithTimeLine
            Public Overridable Property PreviousAddresses As PreviousAddress()
            Public Overridable Property HomePhone As String
            Public Overridable Property MobilePhone As String
            Public Overridable Property WorkPhone As String
            Public Overridable Property Email As String
            Public Overridable Property BankSortCode As String
            Public Overridable Property BankAccountNumber As String
            Public Overridable Property BankAccountName As String
            Public Overridable Property BankName As String
            Public Overridable Property BankAddress As Address
            Public Overridable Property DoNotEmail As String
            Public Overridable Property DoNotMail As String
            Public Overridable Property DoNotPhone As String
            Public Overridable Property DoNotSMS As String
            Public Overridable Property DrivingLicenceNumber As String
            Public Overridable Property CurrentEmploymentDetails As CurrentEmploymentDetails
            Public Overridable Property PreviousEmploymentDetails As PreviousEmployment()
        End Class

        Public Partial Class CurrentEmploymentDetails
            Public Overridable Property EmployerDetails As EmployerDetails
            Public Overridable Property MonthsAtEmployer As String
            Public Overridable Property DateEmploymentCommenced As String
            Public Overridable Property AnnualIncome As String
        End Class

        Public Partial Class DeliveryDetails
            Public Overridable Property DealerCode As String
            Public Overridable Property DeliveryPreference As String
        End Class

        Public Partial Class DiPDetails
            Public Sub New()
                diPReasons = New DiPReasons(){}
            End Sub

            Public Overridable Property DiPCustomerId As String
            Public Overridable Property DiPTimestamp As String
            Public Overridable Property DiPRequestID As String
            Public Overridable Property DiPDecisionType As String
            Public Overridable Property DiPPrimaryDecisionCode As String
            Public Overridable Property DiPDecisionDescription As String
            Public Overridable Property DipDecisionDescriptionCode As String
            Public Overridable Property DipPrimaryDecisionReason As String
            Public Overridable Property DiPPrimaryDecisionReasonDealerMessage As String
            Public Overridable Property diPReasons As DiPReasons()
        End Class

        Public Partial Class DiPReasons
            Public Overridable Property DipReasonSeq As Integer
            Public Overridable Property DipDecisionCode As String
            Public Overridable Property DiPDecisionReason As String
            Public Overridable Property DiPDealerMessage As String
        End Class

        Public Partial Class EmployerDetails
            Public Overridable Property EmploymentType As String
            Public Overridable Property EmployersName As String
            Public Overridable Property Occupation As String
            Public Overridable Property EmployersAddress As AddressWithTimeLine
        End Class

        Public Partial Class ExistingVehicleDetails
            Public Overridable Property TradeInFlag As String
            Public Overridable Property TradeInValue As Decimal
            Public Overridable Property TradeInRegNo As String
            Public Overridable Property SettlementFlag As String
            Public Overridable Property SettlementValue As Decimal
            Public Overridable Property SettlementRegNo As String
        End Class

        Public Partial Class FinanceDetails
            Public Overridable Property FinancialProduct As String
            Public Overridable Property Duration As Integer
            Public Overridable Property PaymentRentalAmount As Decimal
            Public Overridable Property AnnualMileage As Integer
            Public Overridable Property ExcessMileageRate As Decimal
            Public Overridable Property CustomerDepositContribution As Nullable(Of Decimal)
            Public Overridable Property RetailerDepositContribution As Nullable(Of Decimal)
            Public Overridable Property ManufacturerDepositContribution As Nullable(Of Decimal)
            Public Overridable Property TotalDepositContribution As Nullable(Of Decimal)
            Public Overridable Property CostForCredit As Nullable(Of Decimal)
            Public Overridable Property PurchaseActivationFee As Nullable(Of Decimal)
            Public Overridable Property TotalAmountPayable As Nullable(Of Decimal)
            Public Overridable Property FixedInterestRate As Nullable(Of Decimal)
            Public Overridable Property RepresentativeAPR As Nullable(Of Decimal)
            Public Overridable Property OptionalPurchasePayment As Nullable(Of Decimal)
            Public Overridable Property AdvancedRentalAmount As Decimal
            Public Overridable Property PaymentProfile As String
            Public Overridable Property RandMIncluded As String
            Public Overridable Property RandMLevel As String
            Public Overridable Property ProductType As String
            Public Overridable Property Frequency As String
            Public Overridable Property PauseType As String
        End Class

        Public Partial Class GeneralDetails
            Public Overridable Property OCAApprovalNumber As String
            Public Overridable Property EnquiryDateTime As String
            Public Overridable Property Brand As Integer
            Public Overridable Property CustomerReferenceNumber As String
            Public Overridable Property CustomerType As String
            Public Overridable Property SourceofBusiness As String
            Public Overridable Property TagURL As String
            Public Overridable Property RequestSource As Integer
            Public Overridable Property FormID As String
        End Class

        Public Partial Class ModelOptionDetails
            Public Overridable Property Seq As Integer
            Public Overridable Property Code As String
            Public Overridable Property Description As String
            Public Overridable Property Price As Decimal
        End Class

        Public Partial Class PaymentDetail
            Public Overridable Property Seq As Integer
            Public Overridable Property PaymentType As String
            Public Overridable Property AmountPaid As Decimal
            Public Overridable Property PaymentTransactionID As String
            Public Overridable Property Description As String
            Public Overridable Property PaymentDateTime As String
        End Class

        Public Partial Class PaymentDetails
            Public Sub New()
                paymentDetails = New PaymentDetail(){}
            End Sub

            Public Overridable Property paymentDetails As PaymentDetail()
        End Class

        Public Partial Class PreviousAddress
            Public Overridable Property Seq As Integer
            Public Overridable Property Address As AddressWithTimeLine
        End Class

        Public Partial Class PreviousEmployment
            Public Overridable Property Seq As Integer
            Public Overridable Property previousEmployment As EmployerDetails
        End Class

        Public Partial Class VehicleDetails
            Public Sub New()
                NewVehicleModelOptionDetails = New ModelOptionDetails(){}
            End Sub

            Public Overridable Property OnlineCode As String
            Public Overridable Property ModelClass As String
            Public Overridable Property ModelBody As String
            Public Overridable Property ModelDerivative As String
            Public Overridable Property TotalPrice As Decimal
            Public Overridable Property OTRPrice As Decimal
            Public Overridable Property VIN As String
            Public Overridable Property RegNo As String
            Public Overridable Property CurrentMileage As Integer
            Public Overridable Property FirstRegistrationDate As String
            Public Overridable Property NewUsedFlag As String
            Public Overridable Property NewVehicleModelOptionDetails As ModelOptionDetails()
        End Class
    End Namespace

    Namespace MBOnlineCreditApplicationService.CreateOCA

        <DataContract>
        Public Partial Class CreateOCARequest
            <DataMember>
            Public Overridable Property Username As String

            <DataMember>
            Public Overridable Property Timestamp As String

            <DataMember>
            Public Overridable Property Token As String

            <DataMember>
            Public Overridable Property GeneralDetails As GeneralDetails

            <DataMember>
            Public Overridable Property FinanceDetails As FinanceDetails

            <DataMember>
            Public Overridable Property VehicleDetails As VehicleDetails

            <DataMember>
            Public Overridable Property DeliveryDetails As DeliveryDetails

            <DataMember>
            Public Overridable Property ExistingVehicleDetails As ExistingVehicleDetails

            <DataMember>
            Public Overridable Property CreditApplicationIndividual As CreditApplicationIndividual

            <DataMember>
            Public Overridable Property CreditApplicationBusiness As CreditApplicationBusiness

            <DataMember>
            Public Overridable Property PaymentDetails As PaymentDetails

            <DataMember>
            Public Overridable Property DiPDetails As DiPDetails
        End Class

        <DataContract>
        Public Partial Class CreateOCARequestResponse
            <DataMember>
            Public Overridable Property Code As String

            <DataMember>
            Public Overridable Property Message As String

            <DataMember>
            Public Overridable Property URN As Integer
        End Class
    End Namespace
End Namespace

VB.NET CreateOCARequest 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.

PUT /CreateOCA/ HTTP/1.1 
Host: webservices.mbukdatabase.co.uk 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Username":"String","Timestamp":"String","Token":"String","GeneralDetails":{"OCAApprovalNumber":"String","EnquiryDateTime":"String","Brand":0,"CustomerReferenceNumber":"String","CustomerType":"String","SourceofBusiness":"String","TagURL":"String","RequestSource":0,"FormID":"String"},"FinanceDetails":{"FinancialProduct":"String","Duration":0,"PaymentRentalAmount":0,"AnnualMileage":0,"ExcessMileageRate":0,"CustomerDepositContribution":0,"RetailerDepositContribution":0,"ManufacturerDepositContribution":0,"TotalDepositContribution":0,"CostForCredit":0,"PurchaseActivationFee":0,"TotalAmountPayable":0,"FixedInterestRate":0,"RepresentativeAPR":0,"OptionalPurchasePayment":0,"AdvancedRentalAmount":0,"PaymentProfile":"String","RandMIncluded":"String","RandMLevel":"String","ProductType":"String","Frequency":"String","PauseType":"String"},"VehicleDetails":{"OnlineCode":"String","ModelClass":"String","ModelBody":"String","ModelDerivative":"String","TotalPrice":0,"OTRPrice":0,"VIN":"String","RegNo":"String","CurrentMileage":0,"FirstRegistrationDate":"String","NewUsedFlag":"String","NewVehicleModelOptionDetails":[{"Seq":0,"Code":"String","Description":"String","Price":0}]},"DeliveryDetails":{"DealerCode":"String","DeliveryPreference":"String"},"ExistingVehicleDetails":{"TradeInFlag":"String","TradeInValue":0,"TradeInRegNo":"String","SettlementFlag":"String","SettlementValue":0,"SettlementRegNo":"String"},"CreditApplicationIndividual":{"Title":"String","Initial":"String","FirstName":"String","Surname":"String","DateofBirth":"String","Gender":"String","MaritalStatus":"String","ResidentialStatus":"String","CurrentAddress":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","Town":"String","County":"String","Country":"String","Postcode":"String","Duration":"String","DateStarted":"String"},"PreviousAddresses":[{"Seq":0,"Address":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","Town":"String","County":"String","Country":"String","Postcode":"String","Duration":"String","DateStarted":"String"}}],"HomePhone":"String","MobilePhone":"String","WorkPhone":"String","Email":"String","BankSortCode":"String","BankAccountNumber":"String","BankAccountName":"String","BankName":"String","BankAddress":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","AddressLine4":"String","AddressLine5":"String","Postcode":"String"},"DoNotEmail":"String","DoNotMail":"String","DoNotPhone":"String","DoNotSMS":"String","DrivingLicenceNumber":"String","CurrentEmploymentDetails":{"EmployerDetails":{"EmploymentType":"String","EmployersName":"String","Occupation":"String","EmployersAddress":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","Town":"String","County":"String","Country":"String","Postcode":"String","Duration":"String","DateStarted":"String"}},"MonthsAtEmployer":"String","DateEmploymentCommenced":"String","AnnualIncome":"String"},"PreviousEmploymentDetails":[{"Seq":0,"previousEmployment":{"EmploymentType":"String","EmployersName":"String","Occupation":"String","EmployersAddress":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","Town":"String","County":"String","Country":"String","Postcode":"String","Duration":"String","DateStarted":"String"}}}]},"CreditApplicationBusiness":{"TypeOfBusiness":"String","BusinessContactPosition":"String","Title":"String","Initial":"String","FirstName":"String","Surname":"String","CurrentHomeAddress":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","Town":"String","County":"String","Country":"String","Postcode":"String","Duration":"String","DateStarted":"String"},"HomePhone":"String","WorkPhone":"String","MobilePhone":"String","Email":"String","DoNotEmail":"String","DoNotMail":"String","DoNotPhone":"String","DoNotSMS":"String","CompanyName":"String","CompanyRegistrationNumber":"String","TradingAs":"String","BusinessActivity":"String","NumberOfEmployees":0,"YearsTrading":0,"Position":"String","BankSortCode":"String","BankAccountNumber":"String","BankAccountName":"String","BankName":"String","BankAddress":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","AddressLine4":"String","AddressLine5":"String","Postcode":"String"},"NumberofPartners":0,"BusinessPartners":[{"Seq":0,"Title":"String","Initial":"String","FirstName":"String","Surname":"String","DateofBirth":"String","Gender":"String","MaritalStatus":"String","ResidentialStatus":"String","CurrentAddress":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","Town":"String","County":"String","Country":"String","Postcode":"String","Duration":"String","DateStarted":"String"},"PreviousAddresses":[{"Seq":0,"Address":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","Town":"String","County":"String","Country":"String","Postcode":"String","Duration":"String","DateStarted":"String"}}],"HomePhone":"String","MobilePhone":"String","BusinessPhone":"String","Relationship":"String","Email":"String","CurrentEmploymentDetails":{"EmployerDetails":{"EmploymentType":"String","EmployersName":"String","Occupation":"String","EmployersAddress":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","Town":"String","County":"String","Country":"String","Postcode":"String","Duration":"String","DateStarted":"String"}},"MonthsAtEmployer":"String","DateEmploymentCommenced":"String","AnnualIncome":"String"},"PreviousEmploymentDetails":[{"Seq":0,"previousEmployment":{"EmploymentType":"String","EmployersName":"String","Occupation":"String","EmployersAddress":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","Town":"String","County":"String","Country":"String","Postcode":"String","Duration":"String","DateStarted":"String"}}}],"PartnerType":"String"}]},"PaymentDetails":{"paymentDetails":[{"Seq":0,"PaymentType":"String","AmountPaid":0,"PaymentTransactionID":"String","Description":"String","PaymentDateTime":"String"}]},"DiPDetails":{"DiPCustomerId":"String","DiPTimestamp":"String","DiPRequestID":"String","DiPDecisionType":"String","DiPPrimaryDecisionCode":"String","DiPDecisionDescription":"String","DipDecisionDescriptionCode":"String","DipPrimaryDecisionReason":"String","DiPPrimaryDecisionReasonDealerMessage":"String","diPReasons":[{"DipReasonSeq":0,"DipDecisionCode":"String","DiPDecisionReason":"String","DiPDealerMessage":"String"}]}}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Code":"String","Message":"String","URN":0}