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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	TotalVehicles: 0,
	Vehicles: 
	[
		{
			CommissionNumber: String,
			Vin: String,
			Vtn: String,
			Description: String,
			Model: String,
			BM7NST: String,
			ModelYearCode: String,
			HalfModelYearCode: String,
			FullModelYearCode: String.String,
			Fuel: String,
			PrimaryPaintColourCode: String,
			Colour: String,
			PrimaryUpholsteryCode: String,
			Upholstery: String,
			Account: String,
			Location: String,
			IsDisplayStock: False,
			DisplayStockAgent: String,
			IsSellable: False
		}
	]
}