| GET | /galaxy/vehicle/list | Retrieve a list of a user's vehicles. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IdNumber | query | string | Yes | ID Number of the user making this request. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | form | string | Yes | The API Key required for authentication |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Vehicles | form | IEnumerable<VehicleData> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Description | form | string | No | |
| Heading | form | string | No | |
| WasSuccessful | form | bool | No | |
| ModelState | form | Object | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | The ID of the vehicle. |
| HasLicense | form | bool | No | Whether the vehicle has license disk information. |
| LicenseNumber | form | string | No | The vehicle license number. |
| RegistrationNumber | form | string | No | The vehicle registration number. |
| Vin | form | string | No | The vehicle VIN number. |
| Make | form | string | No | The vehicle make. |
| Series | form | string | No | The vehicle series. |
| Colour | form | string | No | The vehicle colour. |
| Expiry | form | string | No | The vehicle license expiry date in ISO 8601 format. |
| ExpiresSoon | form | bool | No | True if this vehicle's licence expiring soon. |
| Expired | form | bool | No | True if this vehicle's license expired. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /galaxy/vehicle/list HTTP/1.1 Host: galaxymobile.api.client.prod.86degrees.com Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <VehicleListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Vehicles"> <Description xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Description> <Heading xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Heading> <ModelState xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base" /> <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">false</WasSuccessful> <Vehicles i:nil="true" /> </VehicleListResponse>