GET /event_types

Requests the list of event types.

Parameters

auth

(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.

system_type

(optional)

Indicates that only event types from the specified system should be returned.

organisation_id

(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.

callback

(optional)

Only available for JSON format. If supplied, the response will use JSONP format with a callback of the given name.

date_format

(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.

globalisation

(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.

Request Content Type

N/A

Response

Returns a list of EventType resources in the requested format.

Response Content Type

application/json, application/javascript (JSONP), application/xml or text/csv as requested

Give It A Try...

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

 

Request Examples

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

Response Examples

JSON body:

[{"SystemType":"AssetManagement","EventTypeId":"ab05a5ef-96bd-486d-b3f7-7c861892cca1","Description":"OverRevving"},
{"SystemType":"AssetManagement","EventTypeId":"55dcc25b-704f-4d39-a4bf-7362fd7334c4","Description":"Override"},
{"SystemType":"AssetManagement","EventTypeId":"6c88a95f-442b-45b9-af91-518c8cc30bd0","Description":"OverSpeeding"}]

XML body:

<ArrayOfEventType xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<EventType SystemType="AssetManagement" EventTypeId="9f38f27d-9b5a-48dc-a082-fc670db78474">
		<Description>OutOfGreenBandDriving</Description>
	</EventType>
	<EventType SystemType="AssetManagement" EventTypeId="ab05a5ef-96bd-486d-b3f7-7c861892cca1">
		<Description>OverRevving</Description>
	</EventType>
	<EventType SystemType="AssetManagement" EventTypeId="6c88a95f-442b-45b9-af91-518c8cc30bd0">
		<Description>OverSpeeding</Description>
	</EventType>
</ArrayOfEventType>

CSV body:

SystemType,EventTypeId,Description
AssetManagement,ab05a5ef-96bd-486d-b3f7-7c861892cca1,OverRevving
AssetManagement,6c88a95f-442b-45b9-af91-518c8cc30bd0,OverSpeeding