Mercedes.Agency.Orchestration.API

<back to all web services

GetMotabilityVehiclesRequest

Vehicle
Requires Authentication
The following routes are available for this service:
GET/v1/vehicle/MotabilityVehiclesGet motability eligible vehicles
"use strict";
export class GetMotabilityVehiclesRequest {
    constructor(init) { Object.assign(this, init) }
}
export class Package {
    /** @param {{Id?:number,Description?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {?string} */
    Description;
}
export class MotabilityVehicle {
    /** @param {{CommissionNumber?:string,Vin?:string,Vtn?:string,Description?:string,Model?:string,BM7NST?:string,ModelYearCode?:string,HalfModelYearCode?:string,FullModelYearCode?:string,Fuel?:string,PrimaryPaintColourCode?:string,Colour?:string,PrimaryUpholsteryCode?:string,Upholstery?:string,Packages?:Package[],Account?:string,Location?:string,IsDisplayStock?:boolean,DisplayStockAgent?:string,IsSellable?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CommissionNumber;
    /** @type {string} */
    Vin;
    /** @type {?string} */
    Vtn;
    /** @type {string} */
    Description;
    /** @type {string} */
    Model;
    /** @type {string} */
    BM7NST;
    /** @type {string} */
    ModelYearCode;
    /** @type {string} */
    HalfModelYearCode;
    /** @type {string} */
    FullModelYearCode;
    /** @type {string} */
    Fuel;
    /** @type {string} */
    PrimaryPaintColourCode;
    /** @type {string} */
    Colour;
    /** @type {string} */
    PrimaryUpholsteryCode;
    /** @type {string} */
    Upholstery;
    /** @type {Package[]} */
    Packages;
    /** @type {string} */
    Account;
    /** @type {string} */
    Location;
    /** @type {boolean} */
    IsDisplayStock;
    /** @type {string} */
    DisplayStockAgent;
    /** @type {boolean} */
    IsSellable;
}
/** @typedef T {any} */
export class MotabilityStockResponse {
    /** @param {{TotalVehicles?:number,Vehicles?:MotabilityVehicle[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    TotalVehicles;
    /** @type {MotabilityVehicle[]} */
    Vehicles = [];
}

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

GET /v1/vehicle/MotabilityVehicles HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MotabilityStockResponseOfMotabilityVehicleQN4VPG_PB xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO">
  <TotalVehicles>0</TotalVehicles>
  <Vehicles xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mercedes.OS.Vehicle.Shared.POCO">
    <d2p1:MotabilityVehicle>
      <d2p1:Account>String</d2p1:Account>
      <d2p1:BM7NST>String</d2p1:BM7NST>
      <d2p1:Colour>String</d2p1:Colour>
      <d2p1:CommissionNumber>String</d2p1:CommissionNumber>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:DisplayStockAgent>String</d2p1:DisplayStockAgent>
      <d2p1:Fuel>String</d2p1:Fuel>
      <d2p1:HalfModelYearCode>String</d2p1:HalfModelYearCode>
      <d2p1:IsDisplayStock>false</d2p1:IsDisplayStock>
      <d2p1:IsSellable>false</d2p1:IsSellable>
      <d2p1:Location>String</d2p1:Location>
      <d2p1:Model>String</d2p1:Model>
      <d2p1:ModelYearCode>String</d2p1:ModelYearCode>
      <d2p1:Packages xmlns:d4p1="http://schemas.datacontract.org/2004/07/Mercedes.OS.Vehicle.Shared.POCO.Filters.v3" i:nil="true" />
      <d2p1:PrimaryPaintColourCode>String</d2p1:PrimaryPaintColourCode>
      <d2p1:PrimaryUpholsteryCode>String</d2p1:PrimaryUpholsteryCode>
      <d2p1:Upholstery>String</d2p1:Upholstery>
      <d2p1:Vin>String</d2p1:Vin>
      <d2p1:Vtn>String</d2p1:Vtn>
    </d2p1:MotabilityVehicle>
  </Vehicles>
</MotabilityStockResponseOfMotabilityVehicleQN4VPG_PB>