| PUT | /v1/VehicleSwap | Updates vehicle swap, order and back order records | This endpoint validates a swap vehicle and then calls an endpoint in the Agency API to update vehicle swap, order and back order and sends a message to OneAgent with the updated order vehicle and offers |
|---|
export class VehicleError
{
public Field: string;
public Message: string;
public constructor(init?: Partial<VehicleError>) { (Object as any).assign(this, init); }
}
export class UpdateVehicleSwapResponse
{
public Errors?: VehicleError[];
public constructor(init?: Partial<UpdateVehicleSwapResponse>) { (Object as any).assign(this, init); }
}
export class UpdateVehicleSwapRequest implements IPost
{
public VehicleSwapGuid: string;
public OrderGuid: string;
public BackOrderGuid?: string;
public GssnId: string;
public Agent: string;
public ExistingVin: string;
public SwapVin: string;
public PersonalisedItemOfferIds?: number[];
public constructor(init?: Partial<UpdateVehicleSwapRequest>) { (Object as any).assign(this, init); }
}
TypeScript UpdateVehicleSwapRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /v1/VehicleSwap HTTP/1.1
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
VehicleSwapGuid: 00000000000000000000000000000000,
OrderGuid: 00000000000000000000000000000000,
BackOrderGuid: 00000000000000000000000000000000,
GssnId: String,
Agent: String,
ExistingVin: String,
SwapVin: String,
PersonalisedItemOfferIds:
[
0
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Errors:
[
{
Field: String,
Message: String
}
]
}