Mercedes.Agency.Orchestration.API

<back to all web services

ValidateOutRightPurchaseRequest

OutrightPurchase
Requires Authentication
The following routes are available for this service:
POST/v1/outrightpurchase/validateValidate Outright Purchase
"use strict";
export class OutrightPurchaseDiscount {
    /** @param {{BaumusterNST?:string,DiscountPercentage?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    BaumusterNST;
    /** @type {number} */
    DiscountPercentage;
}
export class OutrightPurchaseFleetCustomer {
    /** @param {{CustomerIdentifier?:string,CompanyName?:string,Title?:string,FirstName?:string,LastName?:string,Email?:string,PhoneNumber?:string,HouseNumber?:string,AddressLine2?:string,Town?:string,County?:string,PostCode?:string,OutrightPurchaseCustomerDiscounts?:OutrightPurchaseDiscount[],ImportSucessful?:boolean,IsEligibleCOPConverter?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CustomerIdentifier;
    /** @type {string} */
    CompanyName;
    /** @type {string} */
    Title;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {string} */
    Email;
    /** @type {string} */
    PhoneNumber;
    /** @type {string} */
    HouseNumber;
    /** @type {string} */
    AddressLine2;
    /** @type {string} */
    Town;
    /** @type {string} */
    County;
    /** @type {string} */
    PostCode;
    /** @type {OutrightPurchaseDiscount[]} */
    OutrightPurchaseCustomerDiscounts = [];
    /** @type {boolean} */
    ImportSucessful;
    /** @type {boolean} */
    IsEligibleCOPConverter;
}
export class ValidateOutRightPurchaseResponse {
    /** @param {{OutrightPurchaseFleetCustomer?:OutrightPurchaseFleetCustomer,IsBackOrder?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {OutrightPurchaseFleetCustomer} */
    OutrightPurchaseFleetCustomer;
    /** @type {?boolean} */
    IsBackOrder;
}
export class ValidateOutRightPurchaseRequest extends ValidateOutRightPurchaseRequest {
    constructor(init) { super(init); Object.assign(this, init) }
}

JavaScript ValidateOutRightPurchaseRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /v1/outrightpurchase/validate HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Criteria":{"Reference":"String","Bm7NST":"String","IsBackOrder":false}}

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

{"OutrightPurchaseFleetCustomer":{"CustomerIdentifier":"String","CompanyName":"String","Title":"String","FirstName":"String","LastName":"String","Email":"String","PhoneNumber":"String","HouseNumber":"String","AddressLine2":"String","Town":"String","County":"String","PostCode":"String","OutrightPurchaseCustomerDiscounts":[{"BaumusterNST":"String","DiscountPercentage":0}],"ImportSucessful":false,"IsEligibleCOPConverter":false},"IsBackOrder":false}