Interactive API

• Account

  • List Methods
  • Expand Methods

  • POST New Account /account/

    Create a new Carvoyant account.

    Parameter	Value	Type	Description
    Content-Type		string	Content type of the payload

    Request Body

    { "firstName": "Joe", "lastName": "Driver", "email": "joe@noemail.com", "username": "joedriver", "password": "joespassword", "zipcode": "33635", "phone": null, "timeZone": null, "preferredContact": "EMAIL" }

    { "firstName": "Joe", "lastName": "Driver", "email": "joe@noemail.com", "username": "joedriver", "password": "joespassword", "zipcode": "33635", "phone": null, "timeZone": null, "preferredContact": "EMAIL" }
  • POST Update Account /account/:accountId

    Update a Carvoyant account.

    Parameter	Value	Type	Description
    :accountId		number
    Content-Type		string	Content type of the payload

    Request Body

    { "firstName": "Joe", "lastName": "Driver", "email": "joe@noemail.com", "zipcode": "33635", "phone": null, "timeZone": null, "preferredContact": "EMAIL" }

    { "firstName": "Joe", "lastName": "Driver", "email": "joe@noemail.com", "zipcode": "33635", "phone": null, "timeZone": null, "preferredContact": "EMAIL" }
  • GET Account Details /account/:accountId

    Parameter	Value	Type	Description
    :accountId		number

  • GET List Accounts /account/
  • DELETE Delete Account /account/:accountId

    THIS IS A PERMANENT OPERATION. All account information will be deleted and will be unrecoverable. Use Caution.

    Parameter	Value	Type	Description
    :accountId		number

  • POST Create Access Token /account/:accountId/accessToken

    Parameter	Value	Type	Description
    :accountId		number

  • GET Get Access Tokens /account/:accountId/accessToken

    Parameter	Value	Type	Description
    :accountId		number

• Vehicle

  • List Methods
  • Expand Methods

  • GET List Vehicles /vehicle/
  • GET Vehicle Details /vehicle/:vehicleId

    Parameter	Value	Type	Description
    :vehicleId		number

  • POST New Vehicle /vehicle/

    Parameter	Value	Type	Description
    Content-Type		string	Content type of the payload

    Request Body

    { "deviceId": "", "vin": "", "label": "Custom dune buggy", "mileage": "159774" }

    { "deviceId": "", "vin": "", "label": "Custom dune buggy", "mileage": "159774" }
  • POST Update Vehicle /vehicle/:vehicleId

    Parameter	Value	Type	Description
    :vehicleId		number
    Content-Type		string	Content type of the payload

    Request Body

    { "deviceId": "", "vin": "", "label": "Custom dune buggy", "mileage": "159774" }

    { "deviceId": "", "vin": "", "label": "Custom dune buggy", "mileage": "159774" }
  • DELETE Delete Vehicle /vehicle/:vehicleId

    Parameter	Value	Type	Description
    :vehicleId		number

• DataPoint

  • List Methods
  • Expand Methods

  • GET List Data Points /vehicle/:vehicleId/data/

    Parameter	Value	Type	Description
    :vehicleId		number
    key		string
    mostRecentOnly	True False	boolean
    sortOrder	asc desc	string
    searchLimit		number
    searchOffset		number

• DataSet

  • List Methods
  • Expand Methods

  • GET List Data Sets /vehicle/:vehicleId/dataSet/

    Parameter	Value	Type	Description
    :vehicleId		number
    sortOrder	asc desc	string
    searchLimit		number
    searchOffset		number

  • GET DataSet Details /vehicle/:vehicleId/dataSet/:dataSetId

    Parameter	Value	Type	Description
    :vehicleId		number
    :dataSetId		number

• Trip

  • List Methods
  • Expand Methods

  • GET List Trips /vehicle/:vehicleId/trip/

    Parameter	Value	Type	Description
    :vehicleId		number
    includeData	True False	boolean
    startTime		string
    endTime		string
    sortOrder	asc desc	string
    searchLimit		number
    searchOffset		number

  • GET Trip Details /vehicle/:vehicleId/trip/:tripId

    Parameter	Value	Type	Description
    :vehicleId		number
    :tripId		number

• EventSubscription

  • List Methods
  • Expand Methods

  • GET List Event Subscriptions /vehicle/:vehicleId/eventSubscription/

    Parameter	Value	Type	Description
    :vehicleId		number

  • GET Event Subscription Details /vehicle/:vehicleId/eventSubscription/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

  • DELETE Delete Subscription /vehicle/:vehicleId/eventSubscription/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

• GeoFence Subscription

  • List Methods
  • Expand Methods

  • GET List GeoFence Subscriptions /vehicle/:vehicleId/eventSubscription/geoFence

    Parameter	Value	Type	Description
    :vehicleId		number

  • GET GeoFence Subscription Details /vehicle/:vehicleId/eventSubscription/geoFence/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

  • POST Create GeoFence Subscription /vehicle/:vehicleId/eventSubscription/geoFence

    Parameter	Value	Type	Description
    :vehicleId		number
    Content-Type		string	Content type of the payload

    Request Body

    { "minimumTime": "", "postUrl": "", "notificationPeriod": "", "origin": { "latitude": "", "longitude": "" }, "radius": "", "ignitionStatus": "", "boundaryCondition": "" }

    { "minimumTime": "", "postUrl": "", "notificationPeriod": "", "origin": { "latitude": "", "longitude": "" }, "radius": "", "ignitionStatus": "", "boundaryCondition": "" }
  • DELETE Delete GeoFence Subscription /vehicle/:vehicleId/eventSubscription/geoFence/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

• IgnitionStatus Subscription

  • List Methods
  • Expand Methods

  • GET List IgnitionStatus Subscriptions /vehicle/:vehicleId/eventSubscription/ignitionStatus

    Parameter	Value	Type	Description
    :vehicleId		number

  • GET IgnitionStatus Subscription Details /vehicle/:vehicleId/eventSubscription/ignitionStatus/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

  • POST Create IgnitionStatus Subscription /vehicle/:vehicleId/eventSubscription/ignitionStatus

    Parameter	Value	Type	Description
    :vehicleId		number
    Content-Type		string	Content type of the payload

    Request Body

    { "minimumTime": "", "postUrl": "", "notificationPeriod": "" }

    { "minimumTime": "", "postUrl": "", "notificationPeriod": "" }
  • DELETE Delete IgnitionStatus Subscription /vehicle/:vehicleId/eventSubscription/ignitionStatus/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

• LowBattery Subscription

  • List Methods
  • Expand Methods

  • GET List LowBattery Subscriptions /vehicle/:vehicleId/eventSubscription/lowBattery

    Parameter	Value	Type	Description
    :vehicleId		number

  • GET LowBattery Subscription Details /vehicle/:vehicleId/eventSubscription/lowBattery/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

  • POST Create LowBattery Subscription /vehicle/:vehicleId/eventSubscription/lowBattery

    Parameter	Value	Type	Description
    :vehicleId		number
    Content-Type		string	Content type of the payload

    Request Body

    { "minimumTime": "", "postUrl": "", "notificationPeriod": "" }

    { "minimumTime": "", "postUrl": "", "notificationPeriod": "" }
  • DELETE Delete LowBattery Subscription /vehicle/:vehicleId/eventSubscription/lowBattery/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

• NumericDataKey Subscription

  • List Methods
  • Expand Methods

  • GET List NumericDataKey Subscriptions /vehicle/:vehicleId/eventSubscription/numericDataKey

    Parameter	Value	Type	Description
    :vehicleId		number

  • GET NumericDataKey Subscription Details /vehicle/:vehicleId/eventSubscription/numericDataKey/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

  • POST Create NumericDataKey Subscription /vehicle/:vehicleId/eventSubscription/numericDataKey

    Parameter	Value	Type	Description
    :vehicleId		number
    Content-Type		string	Content type of the payload

    Request Body

    { "minimumTime": "", "postUrl": "", "notificationPeriod": "", "dataKey": "", "thresholdValue": "", "relationship": "" }

    { "minimumTime": "", "postUrl": "", "notificationPeriod": "", "dataKey": "", "thresholdValue": "", "relationship": "" }
  • DELETE Delete NumericDataKey Subscription /vehicle/:vehicleId/eventSubscription/numericDataKey/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

• TimeOfDay Subscription

  • List Methods
  • Expand Methods

  • GET List TimeOfDay Subscriptions /vehicle/:vehicleId/eventSubscription/timeOfDay

    Parameter	Value	Type	Description
    :vehicleId		number

  • GET TimeOfDay Subscription Details /vehicle/:vehicleId/eventSubscription/timeOfDay/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

  • POST Create TimeOfDay Subscription /vehicle/:vehicleId/eventSubscription/timeOfDay

    Parameter	Value	Type	Description
    :vehicleId		number
    Content-Type		string	Content type of the payload

    Request Body

    { "minimumTime": "", "postUrl": "", "notificationPeriod": "", "startTime": "", "endTime": "", "daysOfWeek": [""], "ignitionStatus": "" }

    { "minimumTime": "", "postUrl": "", "notificationPeriod": "", "startTime": "", "endTime": "", "daysOfWeek": [""], "ignitionStatus": "" }
  • DELETE Delete TimeOfDay Subscription /vehicle/:vehicleId/eventSubscription/timeOfDay/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

• TroubleCode Subscription

  • List Methods
  • Expand Methods

  • GET List TroubleCode Subscriptions /vehicle/:vehicleId/eventSubscription/troubleCode

    Parameter	Value	Type	Description
    :vehicleId		number

  • GET TroubleCode Subscription Details /vehicle/:vehicleId/eventSubscription/troubleCode/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

  • POST Create TroubleCode Subscription /vehicle/:vehicleId/eventSubscription/troubleCode

    Parameter	Value	Type	Description
    :vehicleId		number
    Content-Type		string	Content type of the payload

    Request Body

    { "minimumTime": "", "postUrl": "", "notificationPeriod": "" }

    { "minimumTime": "", "postUrl": "", "notificationPeriod": "" }
  • DELETE Delete TroubleCode Subscription /vehicle/:vehicleId/eventSubscription/troubleCode/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

• EventNotification

  • List Methods
  • Expand Methods

  • GET List Event Notifications /vehicle/:vehicleId/eventNotification

    Parameter	Value	Type	Description
    :vehicleId		number

  • GET Event Notification Details /vehicle/:vehicleId/eventNotification/:notificationId

    Parameter	Value	Type	Description
    :vehicleId		number
    :notificationId		number

  • GET Event Notification By Subscription /vehicle/:vehicleId/eventSubscription/:subscriptionId/eventNotification

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

• GeoFence EventNotification

  • List Methods
  • Expand Methods

  • GET List GeoFence Notifications /vehicle/:vehicleId/eventNotification/geoFence

    Parameter	Value	Type	Description
    :vehicleId		number

  • GET GeoFence Notification Details /vehicle/:vehicleId/eventNotification/geoFence/:notificationId

    Parameter	Value	Type	Description
    :vehicleId		number
    :notificationId		number

• IgnitionStatus EventNotification

  • List Methods
  • Expand Methods

  • GET List IgnitionStatus Notifications /vehicle/:vehicleId/eventNotification/ignitionStatus

    Parameter	Value	Type	Description
    :vehicleId		number

  • GET IgnitionStatus Notification Details /vehicle/:vehicleId/eventNotification/ignitionStatus/:notificationId

    Parameter	Value	Type	Description
    :vehicleId		number
    :notificationId		number

• LowBattery EventNotification

  • List Methods
  • Expand Methods

  • GET List LowBattery Notifications /vehicle/:vehicleId/eventNotification/lowBattery

    Parameter	Value	Type	Description
    :vehicleId		number

  • GET LowBattery Notification Details /vehicle/:vehicleId/eventNotification/lowBattery/:notificationId

    Parameter	Value	Type	Description
    :vehicleId		number
    :notificationId		number

• NumericDataKey EventNotification

  • List Methods
  • Expand Methods

  • GET List NumericDataKey Notifications /vehicle/:vehicleId/eventNotification/numericDataKey

    Parameter	Value	Type	Description
    :vehicleId		number

  • GET NumericDataKey Notification Details /vehicle/:vehicleId/eventNotification/numericDataKey/:notificationId

    Parameter	Value	Type	Description
    :vehicleId		number
    :notificationId		number

• TimeOfDay EventNotification

  • List Methods
  • Expand Methods

  • GET List TimeOfDay Notifications /vehicle/:vehicleId/eventNotification/timeOfDay

    Parameter	Value	Type	Description
    :vehicleId		number

  • GET TimeOfDay Notification Details /vehicle/:vehicleId/eventNotification/timeOfDay/:notificationId

    Parameter	Value	Type	Description
    :vehicleId		number
    :notificationId		number

• TroubleCode EventNotification

  • List Methods
  • Expand Methods

  • GET List TroubleCode Notifications /vehicle/:vehicleId/eventNotification/troubleCode

    Parameter	Value	Type	Description
    :vehicleId		number

  • GET TroubleCode Notification Details /vehicle/:vehicleId/eventNotification/troubleCode/:notificationId

    Parameter	Value	Type	Description
    :vehicleId		number
    :notificationId		number

• Account

  • List Methods
  • Expand Methods

  • POST New Account /account/

    Create a new Carvoyant account.

    Parameter	Value	Type	Description
    Content-Type		string	Content type of the payload

    Request Body

    { "firstName": "Joe", "lastName": "Driver", "email": "joe@noemail.com", "username": "joedriver", "password": "joespassword", "zipcode": "33635", "phone": null, "timeZone": null, "preferredContact": "EMAIL" }

    { "firstName": "Joe", "lastName": "Driver", "email": "joe@noemail.com", "username": "joedriver", "password": "joespassword", "zipcode": "33635", "phone": null, "timeZone": null, "preferredContact": "EMAIL" }
  • POST Update Account /account/:accountId

    Update a Carvoyant account.

    Parameter	Value	Type	Description
    :accountId		number
    Content-Type		string	Content type of the payload

    Request Body

    { "firstName": "Joe", "lastName": "Driver", "email": "joe@noemail.com", "zipcode": "33635", "phone": null, "timeZone": null, "preferredContact": "EMAIL" }

    { "firstName": "Joe", "lastName": "Driver", "email": "joe@noemail.com", "zipcode": "33635", "phone": null, "timeZone": null, "preferredContact": "EMAIL" }
  • GET Account Details /account/:accountId

    Parameter	Value	Type	Description
    :accountId		number

  • GET List Accounts /account/
  • DELETE Delete Account /account/:accountId

    THIS IS A PERMANENT OPERATION. All account information will be deleted and will be unrecoverable. Use Caution.

    Parameter	Value	Type	Description
    :accountId		number

  • POST Create Access Token /account/:accountId/accessToken

    Parameter	Value	Type	Description
    :accountId		number

  • GET Get Access Tokens /account/:accountId/accessToken

    Parameter	Value	Type	Description
    :accountId		number

• Vehicle

  • List Methods
  • Expand Methods

  • GET List Vehicles /vehicle/
  • GET Vehicle Details /vehicle/:vehicleId

    Parameter	Value	Type	Description
    :vehicleId		number

  • POST New Vehicle /vehicle/

    Parameter	Value	Type	Description
    Content-Type		string	Content type of the payload

    Request Body

    { "deviceId": "", "vin": "", "label": "Custom dune buggy", "mileage": "159774" }

    { "deviceId": "", "vin": "", "label": "Custom dune buggy", "mileage": "159774" }
  • POST Update Vehicle /vehicle/:vehicleId

    Parameter	Value	Type	Description
    :vehicleId		number
    Content-Type		string	Content type of the payload

    Request Body

    { "deviceId": "", "vin": "", "label": "Custom dune buggy", "mileage": "159774" }

    { "deviceId": "", "vin": "", "label": "Custom dune buggy", "mileage": "159774" }
  • DELETE Delete Vehicle /vehicle/:vehicleId

    Parameter	Value	Type	Description
    :vehicleId		number

• DataPoint

  • List Methods
  • Expand Methods

  • GET List Data Points /vehicle/:vehicleId/data/

    Parameter	Value	Type	Description
    :vehicleId		number
    key		string
    mostRecentOnly	True False	boolean
    sortOrder	asc desc	string
    searchLimit		number
    searchOffset		number

• DataSet

  • List Methods
  • Expand Methods

  • GET List Data Sets /vehicle/:vehicleId/dataSet/

    Parameter	Value	Type	Description
    :vehicleId		number
    sortOrder	asc desc	string
    searchLimit		number
    searchOffset		number

  • POST New DataSet /vehicle/:vehicleId/dataSet/

    Parameter	Value	Type	Description
    :vehicleId		number
    Content-Type		string	Content type of the payload

    Request Body

    { "deviceId":"", "timestamp":"20140729T151058+0000", "ignitionStatus":"", "datum":[{ "timestamp":"20140729T151058+0000", "key":"GEN_WAYPOINT", "value":"47.882484,-122.012523" },{ "timestamp":"20140729T151058+0000", "key":"GEN_HEADING", "value":179 }] }

    { "deviceId":"", "timestamp":"20140729T151058+0000", "ignitionStatus":"", "datum":[{ "timestamp":"20140729T151058+0000", "key":"GEN_WAYPOINT", "value":"47.882484,-122.012523" },{ "timestamp":"20140729T151058+0000", "key":"GEN_HEADING", "value":179 }] }
  • GET DataSet Details /vehicle/:vehicleId/dataSet/:dataSetId

    Parameter	Value	Type	Description
    :vehicleId		number
    :dataSetId		number

• Trip

  • List Methods
  • Expand Methods

  • GET List Trips /vehicle/:vehicleId/trip/

    Parameter	Value	Type	Description
    :vehicleId		number
    includeData	True False	boolean
    startTime		string
    endTime		string
    sortOrder	asc desc	string
    searchLimit		number
    searchOffset		number

  • GET Trip Details /vehicle/:vehicleId/trip/:tripId

    Parameter	Value	Type	Description
    :vehicleId		number
    :tripId		number

• EventSubscription

  • List Methods
  • Expand Methods

  • GET List Event Subscriptions /vehicle/:vehicleId/eventSubscription/

    Parameter	Value	Type	Description
    :vehicleId		number

  • GET Event Subscription Details /vehicle/:vehicleId/eventSubscription/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

  • DELETE Delete Subscription /vehicle/:vehicleId/eventSubscription/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

• GeoFence Subscription

  • List Methods
  • Expand Methods

  • GET List GeoFence Subscriptions /vehicle/:vehicleId/eventSubscription/geoFence

    Parameter	Value	Type	Description
    :vehicleId		number

  • GET GeoFence Subscription Details /vehicle/:vehicleId/eventSubscription/geoFence/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

  • POST Create GeoFence Subscription /vehicle/:vehicleId/eventSubscription/geoFence

    Parameter	Value	Type	Description
    :vehicleId		number
    Content-Type		string	Content type of the payload

    Request Body

    { "minimumTime": "", "postUrl": "", "notificationPeriod": "", "origin": { "latitude": "", "longitude": "" }, "radius": "", "ignitionStatus": "", "boundaryCondition": "" }

    { "minimumTime": "", "postUrl": "", "notificationPeriod": "", "origin": { "latitude": "", "longitude": "" }, "radius": "", "ignitionStatus": "", "boundaryCondition": "" }
  • DELETE Delete GeoFence Subscription /vehicle/:vehicleId/eventSubscription/geoFence/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

• IgnitionStatus Subscription

  • List Methods
  • Expand Methods

  • GET List IgnitionStatus Subscriptions /vehicle/:vehicleId/eventSubscription/ignitionStatus

    Parameter	Value	Type	Description
    :vehicleId		number

  • GET IgnitionStatus Subscription Details /vehicle/:vehicleId/eventSubscription/ignitionStatus/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

  • POST Create IgnitionStatus Subscription /vehicle/:vehicleId/eventSubscription/ignitionStatus

    Parameter	Value	Type	Description
    :vehicleId		number
    Content-Type		string	Content type of the payload

    Request Body

    { "minimumTime": "", "postUrl": "", "notificationPeriod": "" }

    { "minimumTime": "", "postUrl": "", "notificationPeriod": "" }
  • DELETE Delete IgnitionStatus Subscription /vehicle/:vehicleId/eventSubscription/ignitionStatus/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

• Waypoint Subscription

  • List Methods
  • Expand Methods

  • GET List Waypoint Subscriptions /vehicle/:vehicleId/eventSubscription/waypoint

    Parameter	Value	Type	Description
    :vehicleId		number

  • GET Waypoint Subscription Details /vehicle/:vehicleId/eventSubscription/waypoint/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

  • POST Create Waypoint Subscription /vehicle/:vehicleId/eventSubscription/waypoint

    Parameter	Value	Type	Description
    :vehicleId		number
    Content-Type		string	Content type of the payload

    Request Body

    { "minimumTime": "", "postUrl": "", "notificationPeriod": "" }

    { "minimumTime": "", "postUrl": "", "notificationPeriod": "" }
  • DELETE Delete Waypoint Subscription /vehicle/:vehicleId/eventSubscription/waypoint/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

• LowBattery Subscription

  • List Methods
  • Expand Methods

  • GET List LowBattery Subscriptions /vehicle/:vehicleId/eventSubscription/lowBattery

    Parameter	Value	Type	Description
    :vehicleId		number

  • GET LowBattery Subscription Details /vehicle/:vehicleId/eventSubscription/lowBattery/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

  • POST Create LowBattery Subscription /vehicle/:vehicleId/eventSubscription/lowBattery

    Parameter	Value	Type	Description
    :vehicleId		number
    Content-Type		string	Content type of the payload

    Request Body

    { "minimumTime": "", "postUrl": "", "notificationPeriod": "" }

    { "minimumTime": "", "postUrl": "", "notificationPeriod": "" }
  • DELETE Delete LowBattery Subscription /vehicle/:vehicleId/eventSubscription/lowBattery/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

• NumericDataKey Subscription

  • List Methods
  • Expand Methods

  • GET List NumericDataKey Subscriptions /vehicle/:vehicleId/eventSubscription/numericDataKey

    Parameter	Value	Type	Description
    :vehicleId		number

  • GET NumericDataKey Subscription Details /vehicle/:vehicleId/eventSubscription/numericDataKey/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

  • POST Create NumericDataKey Subscription /vehicle/:vehicleId/eventSubscription/numericDataKey

    Parameter	Value	Type	Description
    :vehicleId		number
    Content-Type		string	Content type of the payload

    Request Body

    { "minimumTime": "", "postUrl": "", "notificationPeriod": "", "dataKey": "", "thresholdValue": "", "relationship": "" }

    { "minimumTime": "", "postUrl": "", "notificationPeriod": "", "dataKey": "", "thresholdValue": "", "relationship": "" }
  • DELETE Delete NumericDataKey Subscription /vehicle/:vehicleId/eventSubscription/numericDataKey/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

• TimeOfDay Subscription

  • List Methods
  • Expand Methods

  • GET List TimeOfDay Subscriptions /vehicle/:vehicleId/eventSubscription/timeOfDay

    Parameter	Value	Type	Description
    :vehicleId		number

  • GET TimeOfDay Subscription Details /vehicle/:vehicleId/eventSubscription/timeOfDay/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

  • POST Create TimeOfDay Subscription /vehicle/:vehicleId/eventSubscription/timeOfDay

    Parameter	Value	Type	Description
    :vehicleId		number
    Content-Type		string	Content type of the payload

    Request Body

    { "minimumTime": "", "postUrl": "", "notificationPeriod": "", "startTime": "", "endTime": "", "daysOfWeek": [""], "ignitionStatus": "" }

    { "minimumTime": "", "postUrl": "", "notificationPeriod": "", "startTime": "", "endTime": "", "daysOfWeek": [""], "ignitionStatus": "" }
  • DELETE Delete TimeOfDay Subscription /vehicle/:vehicleId/eventSubscription/timeOfDay/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

• TroubleCode Subscription

  • List Methods
  • Expand Methods

  • GET List TroubleCode Subscriptions /vehicle/:vehicleId/eventSubscription/troubleCode

    Parameter	Value	Type	Description
    :vehicleId		number

  • GET TroubleCode Subscription Details /vehicle/:vehicleId/eventSubscription/troubleCode/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

  • POST Create TroubleCode Subscription /vehicle/:vehicleId/eventSubscription/troubleCode

    Parameter	Value	Type	Description
    :vehicleId		number
    Content-Type		string	Content type of the payload

    Request Body

    { "minimumTime": "", "postUrl": "", "notificationPeriod": "" }

    { "minimumTime": "", "postUrl": "", "notificationPeriod": "" }
  • DELETE Delete TroubleCode Subscription /vehicle/:vehicleId/eventSubscription/troubleCode/:subscriptionId

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

• EventNotification

  • List Methods
  • Expand Methods

  • GET List Event Notifications /vehicle/:vehicleId/eventNotification

    Parameter	Value	Type	Description
    :vehicleId		number

  • GET Event Notification Details /vehicle/:vehicleId/eventNotification/:notificationId

    Parameter	Value	Type	Description
    :vehicleId		number
    :notificationId		number

  • GET Event Notification By Subscription /vehicle/:vehicleId/eventSubscription/:subscriptionId/eventNotification

    Parameter	Value	Type	Description
    :vehicleId		number
    :subscriptionId		number

• GeoFence EventNotification

  • List Methods
  • Expand Methods

  • GET List GeoFence Notifications /vehicle/:vehicleId/eventNotification/geoFence

    Parameter	Value	Type	Description
    :vehicleId		number

  • GET GeoFence Notification Details /vehicle/:vehicleId/eventNotification/geoFence/:notificationId

    Parameter	Value	Type	Description
    :vehicleId		number
    :notificationId		number

• IgnitionStatus EventNotification

  • List Methods
  • Expand Methods

  • GET List IgnitionStatus Notifications /vehicle/:vehicleId/eventNotification/ignitionStatus

    Parameter	Value	Type	Description
    :vehicleId		number

  • GET IgnitionStatus Notification Details /vehicle/:vehicleId/eventNotification/ignitionStatus/:notificationId

    Parameter	Value	Type	Description
    :vehicleId		number
    :notificationId		number

• LowBattery EventNotification

  • List Methods
  • Expand Methods

  • GET List LowBattery Notifications /vehicle/:vehicleId/eventNotification/lowBattery

    Parameter	Value	Type	Description
    :vehicleId		number

  • GET LowBattery Notification Details /vehicle/:vehicleId/eventNotification/lowBattery/:notificationId

    Parameter	Value	Type	Description
    :vehicleId		number
    :notificationId		number

• NumericDataKey EventNotification

  • List Methods
  • Expand Methods

  • GET List NumericDataKey Notifications /vehicle/:vehicleId/eventNotification/numericDataKey

    Parameter	Value	Type	Description
    :vehicleId		number

  • GET NumericDataKey Notification Details /vehicle/:vehicleId/eventNotification/numericDataKey/:notificationId

    Parameter	Value	Type	Description
    :vehicleId		number
    :notificationId		number

• TimeOfDay EventNotification

  • List Methods
  • Expand Methods

  • GET List TimeOfDay Notifications /vehicle/:vehicleId/eventNotification/timeOfDay

    Parameter	Value	Type	Description
    :vehicleId		number

  • GET TimeOfDay Notification Details /vehicle/:vehicleId/eventNotification/timeOfDay/:notificationId

    Parameter	Value	Type	Description
    :vehicleId		number
    :notificationId		number

• TroubleCode EventNotification

  • List Methods
  • Expand Methods

  • GET List TroubleCode Notifications /vehicle/:vehicleId/eventNotification/troubleCode

    Parameter	Value	Type	Description
    :vehicleId		number

  • GET TroubleCode Notification Details /vehicle/:vehicleId/eventNotification/troubleCode/:notificationId

    Parameter	Value	Type	Description
    :vehicleId		number
    :notificationId		number