Mercedes.Agency.Orchestration.API

<back to all web services

GetVehicleBackOrderValidateRequest

Vehicle
Requires Authentication
The following routes are available for this service:
POST/v1/vehicle/backordervalidate/{VehicleIdentifier}Validate Vehicle assignment to BackOrder by Vin or Commission Number
"use strict";
export class GetVehicleBackOrderValidateResponse {
    /** @param {{CommissionNumber?:string,Vin?:string,IsDisplayStock?:boolean,Specialist?:boolean,DisplayRetailer?:string,IsValid?:boolean,ErrorMessage?:string,NotMotability?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    CommissionNumber;
    /** @type {?string} */
    Vin;
    /** @type {boolean} */
    IsDisplayStock;
    /** @type {boolean} */
    Specialist;
    /** @type {?string} */
    DisplayRetailer;
    /** @type {boolean} */
    IsValid;
    /** @type {?string} */
    ErrorMessage;
    /** @type {?boolean} */
    NotMotability;
}
export class GetVehicleBackOrderValidateRequest {
    /** @param {{VehicleIdentifier?:string,BackOrderGuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    VehicleIdentifier;
    /** @type {?string} */
    BackOrderGuid;
}

JavaScript GetVehicleBackOrderValidateRequest 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 /v1/vehicle/backordervalidate/{VehicleIdentifier} HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetVehicleBackOrderValidateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.ServiceModel.Vehicles">
  <BackOrderGuid>00000000-0000-0000-0000-000000000000</BackOrderGuid>
  <VehicleIdentifier>String</VehicleIdentifier>
</GetVehicleBackOrderValidateRequest>

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

<GetVehicleBackOrderValidateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.ServiceModel.Vehicles">
  <CommissionNumber>String</CommissionNumber>
  <DisplayRetailer>String</DisplayRetailer>
  <ErrorMessage>String</ErrorMessage>
  <IsDisplayStock>false</IsDisplayStock>
  <IsValid>false</IsValid>
  <NotMotability>false</NotMotability>
  <Specialist>false</Specialist>
  <Vin>String</Vin>
</GetVehicleBackOrderValidateResponse>