Requests the details of locations 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 event types from the specified system should be returned.
(optional) *
Indicates that only event types 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)
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 list of Location 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) *
callback
(optional)
date_format
(optional)
globalisation
(optional)
Response format
GET /event_types?auth=a78581e7935349c39873812572cda216 GET /event_types.xml?auth=a78581e7935349c39873812572cda216 GET /event_types.csv?auth=a78581e7935349c39873812572cda216 GET /event_types.json?auth=a78581e7935349c39873812572cda216&vehicle_id=8973754b-f084-4ba8-b954-483c6084f607
JSON body:
[{"SystemType":"AssetManagement","LocationId":"43ad4afe-24df-4e29-9df4-dc3273b68e11","Name":"MiX","Colour":"#0000255","Type":"Circle","Coordinates":[{"Longitude":18.84198,"Latitude":-33.97837}],"RadiusMetres":286}]
XML body:
<ArrayOfLocation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Location SystemType="AssetManagement" LocationId="43ad4afe-24df-4e29-9df4-dc3273b68e11">
<Name>MiX</Name>
<Colour>#0000255</Colour>
<Type>Circle</Type>
<Coordinates>
<Coordinate Longitude="18.84198" Latitude="-33.9783669"/>
</Coordinates>
<RadiusMetres>286</RadiusMetres>
</Location>
</ArrayOfLocation>
CSV body:
SystemType,LocationId,Name,Colour,Type,MinLatitude,MinLongitude,MaxLatitude,MaxLongitude,Coordinates,RadiusMetres,WidthMetres,Street,CityOrTown,StateOrProvince,ZipOrPostalCode,Country
AssetManagement,71b92b2d-da23-4c43-aa67-81dbe04e81bf,162 - loc2,#0000FF,Circle,48.71905,7.711805,48.96557,7.958321,"[{Longitude:7.835063,Latitude:48.84231}]",13721,, ,,,,
AssetManagement,e7ece224-9f80-421a-8038-c512ec28c41c,162-loc3,#0000FF,Polygon,48.58767,7.651562,48.7328,7.885022,"[{Longitude:7.651562,Latitude:48.7328},{Longitude:7.885022,Latitude:48.7328},{Longitude:7.885022,Latitude:48.58767},{Longitude:7.651562,Latitude:48.58767}]",,, ,,,,