MB Key2Key CCD API

<back to all web services

GetKey2keyDataRequest

Requires Authentication
The following routes are available for this service:
POST/GetKey2keyData/
import Foundation
import ServiceStack

// @DataContract
public class GetKey2keyDataRequest : Codable
{
    // @DataMember
    public var contractNumber:String

    // @DataMember
    public var bpid:Int?

    // @DataMember
    public var appointmentDate:String

    // @DataMember
    public var offers:[Offer]

    // @DataMember
    public var estimatedSettlement:Double?

    // @DataMember
    public var valuation:Double?

    // @DataMember
    public var k2KActivityStatus:String

    // @DataMember
    public var k2KMileage:Int?

    // @DataMember
    public var comments:[Comments]

    // @DataMember
    public var updatedDate:String

    required public init(){}
}

public class Offer : Codable
{
    public var offerDescription:String
    public var parityLeadType:String
    public var equityFigure:Double?
    public var parityFigure:Double?

    required public init(){}
}

public class Comments : Codable
{
    public var comment:String
    public var created:Date?

    required public init(){}
}

// @DataContract
public class GetKey2keyDataResponse : Codable
{
    // @DataMember
    public var code:String

    // @DataMember
    public var message:String

    required public init(){}
}

Swift 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>