Mercedes.Agency.Orchestration.API

<back to all web services

VehicleSwapHistoricalRequest

VehicleSwapHistorical
Requires Authentication
The following routes are available for this service:
GET/v1/VehicleSwap/HistoricalGet Historical Vehicle RecordsThis endpoint calls the same named endpoint in the Agency API to return historical Vehicle Swap records.
"use strict";
export class VehicleSwapHistorical {
    /** @param {{Reference?:string,OrderType?:string,VehicleSwapGuid?:string,OrderGuid?:string,Showroom?:string,GasUserId?:string,OldCommissionNumber?:string,NewCommissionNumber?:string,RequestReason?:string,SentToCesar?:boolean,StatusId?:number,Status?:string,SwapCreated?:string,SwapUpdated?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Reference;
    /** @type {string} */
    OrderType;
    /** @type {string} */
    VehicleSwapGuid;
    /** @type {string} */
    OrderGuid;
    /** @type {?string} */
    Showroom;
    /** @type {?string} */
    GasUserId;
    /** @type {?string} */
    OldCommissionNumber;
    /** @type {?string} */
    NewCommissionNumber;
    /** @type {?string} */
    RequestReason;
    /** @type {boolean} */
    SentToCesar;
    /** @type {number} */
    StatusId;
    /** @type {string} */
    Status;
    /** @type {string} */
    SwapCreated;
    /** @type {?string} */
    SwapUpdated;
}
export class VehicleSwapHistoricalResponse {
    /** @param {{HistoricalVehicleSwaps?:VehicleSwapHistorical[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {VehicleSwapHistorical[]} */
    HistoricalVehicleSwaps = [];
}
export class VehicleSwapHistoricalRequest {
    constructor(init) { Object.assign(this, init) }
}

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

GET /v1/VehicleSwap/Historical HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: application/json

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

{"HistoricalVehicleSwaps":[{"Reference":"String","OrderType":"String","VehicleSwapGuid":"00000000000000000000000000000000","OrderGuid":"00000000000000000000000000000000","Showroom":"String","GasUserId":"String","OldCommissionNumber":"String","NewCommissionNumber":"String","RequestReason":"String","SentToCesar":false,"StatusId":0,"SwapCreated":"\/Date(-62135596800000-0000)\/","SwapUpdated":"\/Date(-62135596800000-0000)\/"}]}