MB Key2Key CCD API

GetKey2keyDataRequest

The following routes are available for this service:
POST	/GetKey2keyData/

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
Object = TypeVar('Object')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetKey2keyDataResponse:
    code: Optional[str] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Offer:
    offer_description: Optional[str] = None
    parity_lead_type: Optional[str] = None
    equity_figure: Optional[Decimal] = None
    parity_figure: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Comments:
    comment: Optional[str] = None
    created: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetKey2keyDataRequest:
    contract_number: Optional[str] = None
    bpid: Optional[int] = None
    appointment_date: Optional[str] = None
    offers: Optional[List[Offer]] = None
    estimated_settlement: Optional[Decimal] = None
    valuation: Optional[Decimal] = None
    k2_k_activity_status: Optional[str] = None
    k2_k_mileage: Optional[int] = None
    comments: Optional[List[Comments]] = None
    updated_date: Optional[str] = None

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