MB Key2Key CCD API

<back to all web services

GetKey2keyDataRequest

Requires Authentication
The following routes are available for this service:
POST/GetKey2keyData/
import 'package:servicestack/servicestack.dart';

// @DataContract
class GetKey2keyDataResponse implements IConvertible
{
    // @DataMember
    String? Code;

    // @DataMember
    String? Message;

    GetKey2keyDataResponse({this.Code,this.Message});
    GetKey2keyDataResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Code = json['Code'];
        Message = json['Message'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Code': Code,
        'Message': Message
    };

    getTypeName() => "GetKey2keyDataResponse";
    TypeContext? context = _ctx;
}

class Offer implements IConvertible
{
    String? OfferDescription;
    String? ParityLeadType;
    double? EquityFigure;
    double? ParityFigure;

    Offer({this.OfferDescription,this.ParityLeadType,this.EquityFigure,this.ParityFigure});
    Offer.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        OfferDescription = json['OfferDescription'];
        ParityLeadType = json['ParityLeadType'];
        EquityFigure = JsonConverters.toDouble(json['EquityFigure']);
        ParityFigure = JsonConverters.toDouble(json['ParityFigure']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'OfferDescription': OfferDescription,
        'ParityLeadType': ParityLeadType,
        'EquityFigure': EquityFigure,
        'ParityFigure': ParityFigure
    };

    getTypeName() => "Offer";
    TypeContext? context = _ctx;
}

class Comments implements IConvertible
{
    String? Comment;
    DateTime? Created;

    Comments({this.Comment,this.Created});
    Comments.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Comment = json['Comment'];
        Created = JsonConverters.fromJson(json['Created'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Comment': Comment,
        'Created': JsonConverters.toJson(Created,'DateTime',context!)
    };

    getTypeName() => "Comments";
    TypeContext? context = _ctx;
}

// @DataContract
class GetKey2keyDataRequest implements IConvertible
{
    // @DataMember
    String? ContractNumber;

    // @DataMember
    int? BPID;

    // @DataMember
    String? AppointmentDate;

    // @DataMember
    List<Offer>? Offers;

    // @DataMember
    double? EstimatedSettlement;

    // @DataMember
    double? Valuation;

    // @DataMember
    String? K2KActivityStatus;

    // @DataMember
    int? K2KMileage;

    // @DataMember
    List<Comments>? Comments;

    // @DataMember
    String? UpdatedDate;

    GetKey2keyDataRequest({this.ContractNumber,this.BPID,this.AppointmentDate,this.Offers,this.EstimatedSettlement,this.Valuation,this.K2KActivityStatus,this.K2KMileage,this.Comments,this.UpdatedDate});
    GetKey2keyDataRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ContractNumber = json['ContractNumber'];
        BPID = json['BPID'];
        AppointmentDate = json['AppointmentDate'];
        Offers = JsonConverters.fromJson(json['Offers'],'List<Offer>',context!);
        EstimatedSettlement = JsonConverters.toDouble(json['EstimatedSettlement']);
        Valuation = JsonConverters.toDouble(json['Valuation']);
        K2KActivityStatus = json['K2KActivityStatus'];
        K2KMileage = json['K2KMileage'];
        Comments = JsonConverters.fromJson(json['Comments'],'List<Comments>',context!);
        UpdatedDate = json['UpdatedDate'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ContractNumber': ContractNumber,
        'BPID': BPID,
        'AppointmentDate': AppointmentDate,
        'Offers': JsonConverters.toJson(Offers,'List<Offer>',context!),
        'EstimatedSettlement': EstimatedSettlement,
        'Valuation': Valuation,
        'K2KActivityStatus': K2KActivityStatus,
        'K2KMileage': K2KMileage,
        'Comments': JsonConverters.toJson(Comments,'List<Comments>',context!),
        'UpdatedDate': UpdatedDate
    };

    getTypeName() => "GetKey2keyDataRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'webservices.mbukdatabase.co.uk', types: <String, TypeInfo> {
    'GetKey2keyDataResponse': TypeInfo(TypeOf.Class, create:() => GetKey2keyDataResponse()),
    'Offer': TypeInfo(TypeOf.Class, create:() => Offer()),
    'Comments': TypeInfo(TypeOf.Class, create:() => Comments()),
    'GetKey2keyDataRequest': TypeInfo(TypeOf.Class, create:() => GetKey2keyDataRequest()),
    'List<Offer>': TypeInfo(TypeOf.Class, create:() => <Offer>[]),
    'List<Comments>': TypeInfo(TypeOf.Class, create:() => <Comments>[]),
});

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