Requests the details of devices visible to the authenticated user.
(required)
The authentication token received in response to the call to POST authentication_credentials or GET authentication_token. Applications should pass the authentication token in the custom "X-auth" HTTP header to avoid passing it in in the query string.
(optional)
Indicates that only devices from the specified system should be returned.
(optional) *
Indicates that only devices belonging to the specified organisation should be returned. * Required when retrieving data from the Fleet Manager system. Ignored when retrieving data from the X-Drive system.
(optional) *
Indicates that only devices belonging to the specified site should be returned. * Ignored when retrieving data from the Asset Management or X-Drive system.
(optional)
Only available for JSON format. If supplied, the response will use JSONP format with a callback of the given name.
(optional)
Only available for JSON format. If supplied, the response will contain JSON dates serialized in the specified format. 0 = Timestamp with offset e.g. "\/Date(1346080140000+0500)\/". 2 = ISO8601 e.g. "2012-08-27T15:09:00.0000000+05:00". Applications may pass this parameter in the custom "X-DateFormat" custom HTTP header instead of this query parameter.
(optional)
The authenticated user's globalisation preferences as received in response to the call to GET account/profile or in the custom "X-Globalisation" HTTP header returned in response to authenticated calls. Applications should pass this back to the server with every call, either in this parameter, or in the the custom "X-Globalisation" HTTP header if automatic conversion of values is required.
N/A
Returns a collection of one or more Device resources in the requested format.
application/json, application/javascript (JSONP), application/xml or text/csv as requested
Enter appropriate parameter values then click on the link which appears to try the API call...
Note: You must have JavaScript support enabled in your browser to use this feature.
auth
(required)
system_type
(optional)
organisation_id
(optional) *
site_id
(optional) *
callback
(optional)
date_format
(optional)
globalisation
(optional)
Response format
GET /devices?auth=e722fa0c702f42b68e2fdb771a80caed GET /devices.json?auth=e722fa0c702f42b68e2fdb771a80caed GET /devices.xml?auth=e722fa0c702f42b68e2fdb771a80caed GET /devices.csv?auth=e722fa0c702f42b68e2fdb771a80caed GET /devices?auth=e722fa0c702f42b68e2fdb771a80caed&system_type=AssetManagement
JSON body:
[{"SystemType":"AssetManagement","DeviceType":"DataTrak","DeviceId":"290bc6ba-a4af-487a-a663-f6d0a8506c54","InstalledInVehicleId":"01554cdd-287e-4c0d-8a17-07ae1c372fda"},
{"SystemType":"AssetManagement","DeviceType":"DataTrak","DeviceId":"3dfc5c86-5d44-4275-a4a6-5042e5ad0339","InstalledInVehicleId":"c50bdc16-d7be-4a89-8e43-0caf4ec413e3"}]
XML body:
<ArrayOfDevice xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Device SystemType="AssetManagement" DeviceType="FM5000Series" DeviceId="8e8be430-d732-40c2-85ef-67e132cf6f5c">
<SerialNumber>0755009910</SerialNumber>
<ImeiNumber>356021013779133</ImeiNumber>
<InstalledInVehicleId>87727014-4e65-45d9-b36c-12d3a1b8e44b</InstalledInVehicleId>
</Device>
<Device SystemType="AssetManagement" DeviceType="FM5000Series" DeviceId="3fb0f476-fc46-4223-9a2f-cb4a8f6d0f8d">
<SerialNumber>0755009909</SerialNumber>
<ImeiNumber>356021013778838</ImeiNumber>
<InstalledInVehicleId>5251a99a-f5cb-4834-a513-d38ce843f6ed</InstalledInVehicleId>
</Device>
</ArrayOfDevice>
CSV body:
SystemType,DeviceType,DeviceId,OrganisationId,SiteId,SerialNumber,ImeiNumber,InstalledInVehicleId
AssetManagement,FM5000Series,04af8739-727a-4952-87b5-0eae0c9504d2,29b66708-c14d-464b-a416-2a2f4950b8ce,,0755007170,356021013612714,f1597332-7968-4ce4-a3c1-a3ba679f399b
AssetManagement,FM5000Series,0671317e-4a71-4184-ad7f-a9aaa6f4ceba,29b66708-c14d-464b-a416-2a2f4950b8ce,,0755002158,356021013203985,5303affe-8050-4c8e-a82c-2299b963577a