Mercedes.Agency.Orchestration.API

<back to all web services

UpdateBackOrderRequest

BackOrder
Requires Authentication
The following routes are available for this service:
PUT/v1/backorder/{Guid}Update Back Order by Guid
"use strict";
export class UpdateBackOrderResponse {
    constructor(init) { Object.assign(this, init) }
}
export class JsonVersion {
    /** @param {{Version?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Version;
}
export class CriteriaModel {
    /** @param {{Description?:string,Id?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Description;
    /** @type {number} */
    Id;
}
export class CriteriaDifference {
    /** @param {{Model?:boolean,Transmission?:boolean,Fuel?:boolean,Upholstery?:boolean,Equipment?:boolean,Line?:boolean,BodyStyle?:boolean,ColourGroup?:boolean,Packages?:boolean,Engine?:boolean,AdditionalInformation?:boolean,UrlReferrer?:boolean,PreferredDeliveryDate?:boolean,IsSmart?:boolean,IsSpecialised?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    Model;
    /** @type {boolean} */
    Transmission;
    /** @type {boolean} */
    Fuel;
    /** @type {boolean} */
    Upholstery;
    /** @type {boolean} */
    Equipment;
    /** @type {boolean} */
    Line;
    /** @type {boolean} */
    BodyStyle;
    /** @type {boolean} */
    ColourGroup;
    /** @type {boolean} */
    Packages;
    /** @type {boolean} */
    Engine;
    /** @type {boolean} */
    AdditionalInformation;
    /** @type {boolean} */
    UrlReferrer;
    /** @type {boolean} */
    PreferredDeliveryDate;
    /** @type {boolean} */
    IsSmart;
    /** @type {boolean} */
    IsSpecialised;
}
export class CriteriaBase extends JsonVersion {
    /** @param {{Transmission?:string[],Fuel?:string[],Upholstery?:string[],Equipment?:string[],Line?:string[],BodyStyle?:string[],ColourGroup?:string[],Packages?:string[],Model?:CriteriaModel[],UrlReferrer?:string,PreferredDeliveryDate?:string,IsNewModel?:boolean,IsSmart?:boolean,IsSpecialised?:boolean,CriteriaDifference?:CriteriaDifference,Version?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string[]} */
    Transmission = [];
    /** @type {string[]} */
    Fuel = [];
    /** @type {string[]} */
    Upholstery = [];
    /** @type {string[]} */
    Equipment = [];
    /** @type {string[]} */
    Line = [];
    /** @type {string[]} */
    BodyStyle = [];
    /** @type {string[]} */
    ColourGroup = [];
    /** @type {string[]} */
    Packages = [];
    /** @type {CriteriaModel[]} */
    Model = [];
    /** @type {string} */
    UrlReferrer;
    /** @type {string} */
    PreferredDeliveryDate;
    /** @type {boolean} */
    IsNewModel;
    /** @type {boolean} */
    IsSmart;
    /** @type {boolean} */
    IsSpecialised;
    /** @type {CriteriaDifference} */
    CriteriaDifference;
}
export class V2EngineCriteria {
    /** @param {{Badge?:string,Brand?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Badge;
    /** @type {string} */
    Brand;
}
export class V2Criteria extends CriteriaBase {
    /** @param {{Engine?:V2EngineCriteria[],Transmission?:string[],Fuel?:string[],Upholstery?:string[],Equipment?:string[],Line?:string[],BodyStyle?:string[],ColourGroup?:string[],Packages?:string[],Model?:CriteriaModel[],UrlReferrer?:string,PreferredDeliveryDate?:string,IsNewModel?:boolean,IsSmart?:boolean,IsSpecialised?:boolean,CriteriaDifference?:CriteriaDifference,Version?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {V2EngineCriteria[]} */
    Engine = [];
}
export class UpdateBackOrderRequest {
    /** @param {{Guid?:string,AgentCriteria?:V2Criteria,AdditionalInformation?:string,ConfigCode?:string,MotabilityPricingId?:number,AssistanceProviderId?:number,AssistanceDetail?:string,IsCOPConverter?:boolean,ConfiguratorCode?:string,IsOneAdminUpdate?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {V2Criteria} */
    AgentCriteria;
    /** @type {string} */
    AdditionalInformation;
    /** @type {string} */
    ConfigCode;
    /** @type {?number} */
    MotabilityPricingId;
    /** @type {?number} */
    AssistanceProviderId;
    /** @type {?string} */
    AssistanceDetail;
    /** @type {boolean} */
    IsCOPConverter;
    /** @type {?string} */
    ConfiguratorCode;
    /** @type {boolean} */
    IsOneAdminUpdate;
}

JavaScript UpdateBackOrderRequest 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.

PUT /v1/backorder/{Guid} HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Guid":"00000000000000000000000000000000","AgentCriteria":{"Engine":[{"Badge":"String","Brand":"String"}],"Transmission":["String"],"Fuel":["String"],"Upholstery":["String"],"Equipment":["String"],"Line":["String"],"BodyStyle":["String"],"ColourGroup":["String"],"Packages":["String"],"Model":[{"Description":"String","Id":0}],"UrlReferrer":"String","PreferredDeliveryDate":"String","IsNewModel":false,"IsSmart":false,"IsSpecialised":false,"CriteriaDifference":{"Model":false,"Transmission":false,"Fuel":false,"Upholstery":false,"Equipment":false,"Line":false,"BodyStyle":false,"ColourGroup":false,"Packages":false,"Engine":false,"AdditionalInformation":false,"UrlReferrer":false,"PreferredDeliveryDate":false,"IsSmart":false,"IsSpecialised":false},"Version":0},"AdditionalInformation":"String","ConfigCode":"String","MotabilityPricingId":0,"AssistanceProviderId":0,"AssistanceDetail":"String","IsCOPConverter":false,"ConfiguratorCode":"String","IsOneAdminUpdate":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{}