| GET | /v1/VehicleSwap/Active | Get Active Vehicle Swap records | This endpoint calls the same named endpoint in the Agency API to return active Vehicle Swap records. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ActiveVehicleSwaps | form | List<VehicleSwapActive> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| Reference | form | string | Yes | |
| OrderType | form | string | Yes | |
| VehicleSwapGuid | form | Guid | No | |
| OrderGuid | form | Guid | No | |
| Showroom | form | string | No | |
| CommissionNumber | form | string | No | |
| RequestReason | form | string | No | |
| SentToCesar | form | bool | No | |
| CreationDate | form | DateTime | No | |
| MaintenanceDate | form | DateTime? | No |
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.
GET /v1/VehicleSwap/Active 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
{
ActiveVehicleSwaps:
[
{
Id: 0,
Reference: String,
OrderType: String,
VehicleSwapGuid: 00000000000000000000000000000000,
OrderGuid: 00000000000000000000000000000000,
Showroom: String,
CommissionNumber: String,
RequestReason: String,
SentToCesar: False,
CreationDate: 0001-01-01,
MaintenanceDate: 0001-01-01
}
]
}