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.

export class VehicleSwapHistorical
{
    public Reference: string;
    public OrderType: string;
    public VehicleSwapGuid: string;
    public OrderGuid: string;
    public Showroom?: string;
    public GasUserId?: string;
    public OldCommissionNumber?: string;
    public NewCommissionNumber?: string;
    public RequestReason?: string;
    public SentToCesar: boolean;
    public StatusId: number;
    public Status: string;
    public SwapCreated: string;
    public SwapUpdated?: string;

    public constructor(init?: Partial<VehicleSwapHistorical>) { (Object as any).assign(this, init); }
}

export class VehicleSwapHistoricalResponse
{
    public HistoricalVehicleSwaps: VehicleSwapHistorical[] = [];

    public constructor(init?: Partial<VehicleSwapHistoricalResponse>) { (Object as any).assign(this, init); }
}

export class VehicleSwapHistoricalRequest implements IPost
{

    public constructor(init?: Partial<VehicleSwapHistoricalRequest>) { (Object as any).assign(this, init); }
}

TypeScript VehicleSwapHistoricalRequest 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/VehicleSwap/Historical 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

{
	HistoricalVehicleSwaps: 
	[
		{
			Reference: String,
			OrderType: String,
			VehicleSwapGuid: 00000000000000000000000000000000,
			OrderGuid: 00000000000000000000000000000000,
			Showroom: String,
			GasUserId: String,
			OldCommissionNumber: String,
			NewCommissionNumber: String,
			RequestReason: String,
			SentToCesar: False,
			StatusId: 0,
			SwapCreated: 0001-01-01,
			SwapUpdated: 0001-01-01
		}
	]
}