MB Key2Key CCD API

<back to all web services

GetKey2keyDataRequest

Requires Authentication
The following routes are available for this service:
POST/GetKey2keyData/
"use strict";
export class GetKey2keyDataResponse {
    /** @param {{Code?:string,Message?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Code;
    /** @type {string} */
    Message;
}
export class Offer {
    /** @param {{OfferDescription?:string,ParityLeadType?:string,EquityFigure?:number,ParityFigure?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    OfferDescription;
    /** @type {string} */
    ParityLeadType;
    /** @type {?number} */
    EquityFigure;
    /** @type {?number} */
    ParityFigure;
}
export class Comments {
    /** @param {{Comment?:string,Created?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Comment;
    /** @type {?string} */
    Created;
}
export class GetKey2keyDataRequest {
    /** @param {{ContractNumber?:string,BPID?:number,AppointmentDate?:string,Offers?:Offer[],EstimatedSettlement?:number,Valuation?:number,K2KActivityStatus?:string,K2KMileage?:number,Comments?:Comments[],UpdatedDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ContractNumber;
    /** @type {?number} */
    BPID;
    /** @type {string} */
    AppointmentDate;
    /** @type {Offer[]} */
    Offers;
    /** @type {?number} */
    EstimatedSettlement;
    /** @type {?number} */
    Valuation;
    /** @type {string} */
    K2KActivityStatus;
    /** @type {?number} */
    K2KMileage;
    /** @type {Comments[]} */
    Comments;
    /** @type {string} */
    UpdatedDate;
}

JavaScript GetKey2keyDataRequest DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /GetKey2keyData/ HTTP/1.1 
Host: webservices.mbukdatabase.co.uk 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ContractNumber":"String","BPID":0,"AppointmentDate":"String","Offers":[{"OfferDescription":"String","ParityLeadType":"String","EquityFigure":0,"ParityFigure":0}],"EstimatedSettlement":0,"Valuation":0,"K2KActivityStatus":"String","K2KMileage":0,"Comments":[{"Comment":"String","Created":"\/Date(-62135596800000-0000)\/"}],"UpdatedDate":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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