Mercedes.Agency.Orchestration.API

<back to all web services

VehicleSwapActiveRequest

VehicleSwapActive
Requires Authentication
The following routes are available for this service:
GET/v1/VehicleSwap/ActiveGet Active Vehicle Swap recordsThis endpoint calls the same named endpoint in the Agency API to return active Vehicle Swap records.
"use strict";
export class VehicleSwapActive {
    /** @param {{Id?:number,Reference?:string,OrderType?:string,VehicleSwapGuid?:string,OrderGuid?:string,Showroom?:string,CommissionNumber?:string,RequestReason?:string,SentToCesar?:boolean,CreationDate?:string,MaintenanceDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Reference;
    /** @type {string} */
    OrderType;
    /** @type {string} */
    VehicleSwapGuid;
    /** @type {string} */
    OrderGuid;
    /** @type {?string} */
    Showroom;
    /** @type {?string} */
    CommissionNumber;
    /** @type {?string} */
    RequestReason;
    /** @type {boolean} */
    SentToCesar;
    /** @type {string} */
    CreationDate;
    /** @type {?string} */
    MaintenanceDate;
}
export class VehicleSwapActiveResponse {
    /** @param {{ActiveVehicleSwaps?:VehicleSwapActive[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {VehicleSwapActive[]} */
    ActiveVehicleSwaps = [];
}
export class VehicleSwapActiveRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript VehicleSwapActiveRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/VehicleSwap/Active HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ActiveVehicleSwaps":[{"Id":0,"Reference":"String","OrderType":"String","VehicleSwapGuid":"00000000000000000000000000000000","OrderGuid":"00000000000000000000000000000000","Showroom":"String","CommissionNumber":"String","RequestReason":"String","SentToCesar":false,"CreationDate":"\/Date(-62135596800000-0000)\/","MaintenanceDate":"\/Date(-62135596800000-0000)\/"}]}