GET api/vehicle?userID={userID}&token={token}&groupID={groupID}&vehicleID={vehicleID}
Returns the details for either a single vehicle or all vehicles in the supplied group
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
userID |
The ID returned from a successful login |
unsigned integer |
Required |
token |
The authentication token returned from a successful login |
string |
Required |
groupID |
A group id to query vehicles for |
unsigned integer |
Required |
vehicleID |
Query an individual vehicle |
unsigned integer |
Default value is 0 |
Body Parameters
None.
Response Information
Resource Description
Collection of VehicleResponseName | Description | Type | Additional information |
---|---|---|---|
ID | unsigned integer |
None. |
|
Reg | string |
None. |
|
Lat | string |
None. |
|
Long | string |
None. |
|
Icon | string |
None. |
|
POI | string |
None. |
|
Upd | string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "ID": 1, "Reg": "sample string 2", "Lat": "sample string 3", "Long": "sample string 4", "Icon": "sample string 5", "POI": "sample string 6", "Upd": "sample string 7" }, { "ID": 1, "Reg": "sample string 2", "Lat": "sample string 3", "Long": "sample string 4", "Icon": "sample string 5", "POI": "sample string 6", "Upd": "sample string 7" } ]
application/xml, text/xml
Sample:
<ArrayOfVehicleResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <VehicleResponse> <ID>1</ID> <Reg>sample string 2</Reg> <Lat>sample string 3</Lat> <Long>sample string 4</Long> <Icon>sample string 5</Icon> <POI>sample string 6</POI> <Upd>sample string 7</Upd> </VehicleResponse> <VehicleResponse> <ID>1</ID> <Reg>sample string 2</Reg> <Lat>sample string 3</Lat> <Long>sample string 4</Long> <Icon>sample string 5</Icon> <POI>sample string 6</POI> <Upd>sample string 7</Upd> </VehicleResponse> </ArrayOfVehicleResponse>