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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<GetKey2keyDataRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MBKey2keyCCD.GetKey2keyData">
  <AppointmentDate>String</AppointmentDate>
  <BPID>0</BPID>
  <Comments xmlns:d2p1="http://schemas.datacontract.org/2004/07/MBKey2keyCCD.DomainClasses">
    <d2p1:Comments>
      <d2p1:Comment>String</d2p1:Comment>
      <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
    </d2p1:Comments>
  </Comments>
  <ContractNumber>String</ContractNumber>
  <EstimatedSettlement>0</EstimatedSettlement>
  <K2KActivityStatus>String</K2KActivityStatus>
  <K2KMileage>0</K2KMileage>
  <Offers xmlns:d2p1="http://schemas.datacontract.org/2004/07/MBKey2keyCCD.BusinessLib.DomainClasses">
    <d2p1:Offer>
      <d2p1:EquityFigure>0</d2p1:EquityFigure>
      <d2p1:OfferDescription>String</d2p1:OfferDescription>
      <d2p1:ParityFigure>0</d2p1:ParityFigure>
      <d2p1:ParityLeadType>String</d2p1:ParityLeadType>
    </d2p1:Offer>
  </Offers>
  <UpdatedDate>String</UpdatedDate>
  <Valuation>0</Valuation>
</GetKey2keyDataRequest>

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

<GetKey2keyDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MBKey2keyCCD.GetKey2keyData">
  <Code>String</Code>
  <Message>String</Message>
</GetKey2keyDataResponse>