PUT | /CreateOCA/ |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Username | body | string | No | |
Timestamp | body | string | No | |
Token | body | string | No | |
GeneralDetails | body | GeneralDetails | No | |
FinanceDetails | body | FinanceDetails | No | |
VehicleDetails | body | VehicleDetails | No | |
DeliveryDetails | body | DeliveryDetails | No | |
ExistingVehicleDetails | body | ExistingVehicleDetails | No | |
CreditApplicationIndividual | body | CreditApplicationIndividual | No | |
CreditApplicationBusiness | body | CreditApplicationBusiness | No | |
PaymentDetails | body | PaymentDetails | No | |
DiPDetails | body | DiPDetails | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OCAApprovalNumber | form | string | No | |
EnquiryDateTime | form | string | No | |
Brand | form | int | No | |
CustomerReferenceNumber | form | string | No | |
CustomerType | form | string | No | |
SourceofBusiness | form | string | No | |
TagURL | form | string | No | |
RequestSource | form | int | No | |
FormID | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FinancialProduct | form | string | No | |
Duration | form | int | No | |
PaymentRentalAmount | form | decimal | No | |
AnnualMileage | form | int | No | |
ExcessMileageRate | form | decimal | No | |
CustomerDepositContribution | form | decimal? | No | |
RetailerDepositContribution | form | decimal? | No | |
ManufacturerDepositContribution | form | decimal? | No | |
TotalDepositContribution | form | decimal? | No | |
CostForCredit | form | decimal? | No | |
PurchaseActivationFee | form | decimal? | No | |
TotalAmountPayable | form | decimal? | No | |
FixedInterestRate | form | decimal? | No | |
RepresentativeAPR | form | decimal? | No | |
OptionalPurchasePayment | form | decimal? | No | |
AdvancedRentalAmount | form | decimal | No | |
PaymentProfile | form | string | No | |
RandMIncluded | form | string | No | |
RandMLevel | form | string | No | |
ProductType | form | string | No | |
Frequency | form | string | No | |
PauseType | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OnlineCode | form | string | No | |
ModelClass | form | string | No | |
ModelBody | form | string | No | |
ModelDerivative | form | string | No | |
TotalPrice | form | decimal | No | |
OTRPrice | form | decimal | No | |
VIN | form | string | No | |
RegNo | form | string | No | |
CurrentMileage | form | int | No | |
FirstRegistrationDate | form | string | No | |
NewUsedFlag | form | string | No | |
NewVehicleModelOptionDetails | form | ModelOptionDetails[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Seq | form | int | No | |
Code | form | string | No | |
Description | form | string | No | |
Price | form | decimal | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DealerCode | form | string | No | |
DeliveryPreference | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TradeInFlag | form | string | No | |
TradeInValue | form | decimal | No | |
TradeInRegNo | form | string | No | |
SettlementFlag | form | string | No | |
SettlementValue | form | decimal | No | |
SettlementRegNo | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Title | form | string | No | |
Initial | form | string | No | |
FirstName | form | string | No | |
Surname | form | string | No | |
DateofBirth | form | string | No | |
Gender | form | string | No | |
MaritalStatus | form | string | No | |
ResidentialStatus | form | string | No | |
CurrentAddress | form | AddressWithTimeLine | No | |
PreviousAddresses | form | PreviousAddress[] | No | |
HomePhone | form | string | No | |
MobilePhone | form | string | No | |
WorkPhone | form | string | No | |
form | string | No | ||
BankSortCode | form | string | No | |
BankAccountNumber | form | string | No | |
BankAccountName | form | string | No | |
BankName | form | string | No | |
BankAddress | form | Address | No | |
DoNotEmail | form | string | No | |
DoNotMail | form | string | No | |
DoNotPhone | form | string | No | |
DoNotSMS | form | string | No | |
DrivingLicenceNumber | form | string | No | |
CurrentEmploymentDetails | form | CurrentEmploymentDetails | No | |
PreviousEmploymentDetails | form | PreviousEmployment[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AddressLine1 | form | string | No | |
AddressLine2 | form | string | No | |
AddressLine3 | form | string | No | |
Town | form | string | No | |
County | form | string | No | |
Country | form | string | No | |
Postcode | form | string | No | |
Duration | form | string | No | |
DateStarted | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Seq | form | int | No | |
Address | form | AddressWithTimeLine | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AddressLine1 | form | string | No | |
AddressLine2 | form | string | No | |
AddressLine3 | form | string | No | |
AddressLine4 | form | string | No | |
AddressLine5 | form | string | No | |
Postcode | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
EmployerDetails | form | EmployerDetails | No | |
MonthsAtEmployer | form | string | No | |
DateEmploymentCommenced | form | string | No | |
AnnualIncome | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
EmploymentType | form | string | No | |
EmployersName | form | string | No | |
Occupation | form | string | No | |
EmployersAddress | form | AddressWithTimeLine | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Seq | form | int | No | |
previousEmployment | form | EmployerDetails | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TypeOfBusiness | form | string | No | |
BusinessContactPosition | form | string | No | |
Title | form | string | No | |
Initial | form | string | No | |
FirstName | form | string | No | |
Surname | form | string | No | |
CurrentHomeAddress | form | AddressWithTimeLine | No | |
HomePhone | form | string | No | |
WorkPhone | form | string | No | |
MobilePhone | form | string | No | |
form | string | No | ||
DoNotEmail | form | string | No | |
DoNotMail | form | string | No | |
DoNotPhone | form | string | No | |
DoNotSMS | form | string | No | |
CompanyName | form | string | No | |
CompanyRegistrationNumber | form | string | No | |
TradingAs | form | string | No | |
BusinessActivity | form | string | No | |
NumberOfEmployees | form | int | No | |
YearsTrading | form | int | No | |
Position | form | string | No | |
BankSortCode | form | string | No | |
BankAccountNumber | form | string | No | |
BankAccountName | form | string | No | |
BankName | form | string | No | |
BankAddress | form | Address | No | |
NumberofPartners | form | int | No | |
BusinessPartners | form | BusinessPartner[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Seq | form | int | No | |
Title | form | string | No | |
Initial | form | string | No | |
FirstName | form | string | No | |
Surname | form | string | No | |
DateofBirth | form | string | No | |
Gender | form | string | No | |
MaritalStatus | form | string | No | |
ResidentialStatus | form | string | No | |
CurrentAddress | form | AddressWithTimeLine | No | |
PreviousAddresses | form | PreviousAddress[] | No | |
HomePhone | form | string | No | |
MobilePhone | form | string | No | |
BusinessPhone | form | string | No | |
Relationship | form | string | No | |
form | string | No | ||
CurrentEmploymentDetails | form | CurrentEmploymentDetails | No | |
PreviousEmploymentDetails | form | PreviousEmployment[] | No | |
PartnerType | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
paymentDetails | form | PaymentDetail[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Seq | form | int | No | |
PaymentType | form | string | No | |
AmountPaid | form | decimal | No | |
PaymentTransactionID | form | string | No | |
Description | form | string | No | |
PaymentDateTime | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DiPCustomerId | form | string | No | |
DiPTimestamp | form | string | No | |
DiPRequestID | form | string | No | |
DiPDecisionType | form | string | No | |
DiPPrimaryDecisionCode | form | string | No | |
DiPDecisionDescription | form | string | No | |
DipDecisionDescriptionCode | form | string | No | |
DipPrimaryDecisionReason | form | string | No | |
DiPPrimaryDecisionReasonDealerMessage | form | string | No | |
diPReasons | form | DiPReasons[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DipReasonSeq | form | int | No | |
DipDecisionCode | form | string | No | |
DiPDecisionReason | form | string | No | |
DiPDealerMessage | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Code | form | string | No | |
Message | form | string | No | |
URN | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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: text/csv
Content-Type: text/csv
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: text/csv Content-Length: length {"Code":"String","Message":"String","URN":0}