| GET | /v1/VehicleSwap/Historical | Get Historical Vehicle Records | This endpoint calls the same named endpoint in the Agency API to return historical Vehicle Swap records. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| HistoricalVehicleSwaps | form | List<VehicleSwapHistorical> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Reference | form | string | Yes | |
| OrderType | form | string | Yes | |
| VehicleSwapGuid | form | Guid | No | |
| OrderGuid | form | Guid | No | |
| Showroom | form | string | No | |
| GasUserId | form | string | No | |
| OldCommissionNumber | form | string | No | |
| NewCommissionNumber | form | string | No | |
| RequestReason | form | string | No | |
| SentToCesar | form | bool | No | |
| StatusId | form | int | No | |
| Status | form | string | Yes | |
| SwapCreated | form | DateTime | No | |
| SwapUpdated | form | DateTime? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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)\/"}]}