Telemetry API

API change history

A collection of RESTful JSON-based data operations used to retrieve vehicle and account data from your telematics solution. NOTE: when using OAUTH2.0, add "Bearer " before your token in the Authorization header.

Event IDs

Gets all Event IDs (idEvent_Code) and descriptions.

Try it

Request

Request URL

Request headers

  • string

    ** Authorization Token is Required.

  • string

    ** Required. 3 character Environment Code.

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

Representations

[{
    "idEvent_Code": 0,
    "Event_Type": "Location",
    "Event_Description": "Location"
  },
  {
    "idEvent_Code": 1,
    "Event_Type": "Diagnostic",
    "Event_Description": "Diagnostic"
  },
  {
    "idEvent_Code": 2,
    "Event_Type": "Motion Start",
    "Event_Description": "Motion Start"
  },
  {
    "idEvent_Code": 3,
    "Event_Type": "In Motion",
    "Event_Description": "In Motion"
  },
  {
    "idEvent_Code": 4,
    "Event_Type": "Motion Stop",
    "Event_Description": "Motion Stop"
  },
  {
    "idEvent_Code": 5,
    "Event_Type": "Geofence #0",
    "Event_Description": "Geofence #0"
  },
  {
    "idEvent_Code": 6,
    "Event_Type": "Geofence #1",
    "Event_Description": "Geofence #1"
  },
  {
    "idEvent_Code": 7,
    "Event_Type": "Geofence #2",
    "Event_Description": "Geofence #2"
  },
  {
    "idEvent_Code": 8,
    "Event_Type": "Geofence #3",
    "Event_Description": "Geofence #3"
  },
  {
    "idEvent_Code": 9,
    "Event_Type": "Device Battery Low",
    "Event_Description": "Device Battery Low"
  },
  {
    "idEvent_Code": 10,
    "Event_Type": "Device Battery State",
    "Event_Description": "Device Battery State"
  },
  {
    "idEvent_Code": 11,
    "Event_Type": "Running",
    "Event_Description": "Running"
  },
  {
    "idEvent_Code": 12,
    "Event_Type": "Vehicle1",
    "Event_Description": "Vehicle1"
  },
  {
    "idEvent_Code": 13,
    "Event_Type": "Vehicle2",
    "Event_Description": "Vehicle2"
  },
  {
    "idEvent_Code": 14,
    "Event_Type": "Vehicle3",
    "Event_Description": "Vehicle3"
  },
  {
    "idEvent_Code": 15,
    "Event_Type": "VCM Detect",
    "Event_Description": "VCM Detect"
  },
  {
    "idEvent_Code": 16,
    "Event_Type": "Sensor #1",
    "Event_Description": "Sensor #1"
  },
  {
    "idEvent_Code": 17,
    "Event_Type": "Sensor #2",
    "Event_Description": "Sensor #2"
  },
  {
    "idEvent_Code": 18,
    "Event_Type": "Sensor #3",
    "Event_Description": "Sensor #3"
  },
  {
    "idEvent_Code": 19,
    "Event_Type": "Device Health",
    "Event_Description": "Device Health"
  },
  {
    "idEvent_Code": 20,
    "Event_Type": "Ignition On",
    "Event_Description": "Ignition On"
  },
  {
    "idEvent_Code": 21,
    "Event_Type": "Ignition Off",
    "Event_Description": "Ignition Off"
  },
  {
    "idEvent_Code": 22,
    "Event_Type": "Speed Thresholds Reached",
    "Event_Description": "Speed Thresholds Reached"
  },
  {
    "idEvent_Code": 23,
    "Event_Type": "Speed Thresholds Cleared",
    "Event_Description": "Speed Thresholds Cleared"
  },
  {
    "idEvent_Code": 24,
    "Event_Type": "RPM Thresholds Reached",
    "Event_Description": "RPM Thresholds Reached"
  },
  {
    "idEvent_Code": 25,
    "Event_Type": "RPM Thresholds Cleared",
    "Event_Description": "RPM Thresholds Cleared"
  },
  {
    "idEvent_Code": 26,
    "Event_Type": "Harsh Braking",
    "Event_Description": "Harsh Braking"
  },
  {
    "idEvent_Code": 27,
    "Event_Type": "Harsh Acceleration",
    "Event_Description": "Harsh Acceleration"
  },
  {
    "idEvent_Code": 28,
    "Event_Type": "Harsh Maneuver",
    "Event_Description": "Harsh Maneuver"
  },
  {
    "idEvent_Code": 29,
    "Event_Type": "DTCs Detected",
    "Event_Description": "DTCs Detected"
  },
  {
    "idEvent_Code": 30,
    "Event_Type": "DTCs Cleared",
    "Event_Description": "DTCs Cleared"
  },
  {
    "idEvent_Code": 31,
    "Event_Type": "Idle Threshold Exceeded",
    "Event_Description": "Idle Threshold Exceeded"
  },
  {
    "idEvent_Code": 32,
    "Event_Type": "Idle Cleared",
    "Event_Description": "Idle Threshold Cleared"
  },
  {
    "idEvent_Code": 33,
    "Event_Type": "Tow Detected",
    "Event_Description": "Tow Detected"
  },
  {
    "idEvent_Code": 34,
    "Event_Type": "Speed Threshold 2 Reached",
    "Event_Description": "Speed Threshold 2 Reached"
  },
  {
    "idEvent_Code": 35,
    "Event_Type": "Speed Threshold 2 Cleared",
    "Event_Description": "Speed Threshold 2 Cleared"
  },
  {
    "idEvent_Code": 36,
    "Event_Type": "Speed Threshold 3 Reached",
    "Event_Description": "Speed Threshold 3 Reached"
  },
  {
    "idEvent_Code": 37,
    "Event_Type": "Speed Threshold 3 Cleared",
    "Event_Description": "Speed Threshold 3 Cleared"
  },
  {
    "idEvent_Code": 39,
    "Event_Type": "Device Power On/Boot",
    "Event_Description": "Device Power On/Boot"
  },
  {
    "idEvent_Code": 40,
    "Event_Type": "Scan Tool Detect Report",
    "Event_Description": "Scan Tool Detect Report"
  },
  {
    "idEvent_Code": 41,
    "Event_Type": "Configurable DTC Active Report",
    "Event_Description": "Configurable DTC Active Report"
  },
  {
    "idEvent_Code": 42,
    "Event_Type": "Configurable DTC Clear Report",
    "Event_Description": "Configurable DTC Clear Report"
  },
  {
    "idEvent_Code": 43,
    "Event_Type": "OTA Sys Log Report",
    "Event_Description": "OTA Sys Log Report"
  },
  {
    "idEvent_Code": 44,
    "Event_Type": "OTA Comm Log Report",
    "Event_Description": "OTA Comm Log Report"
  },
  {
    "idEvent_Code": 247,
    "Event_Type": "Sensor #0",
    "Event_Description": "Sensor #0"
  },
  {
    "idEvent_Code": 248,
    "Event_Type": "Temperature Sensor",
    "Event_Description": "Temperature Sensor"
  },
  {
    "idEvent_Code": 249,
    "Event_Type": "Sleep Entry",
    "Event_Description": "Sleep Entry"
  },
  {
    "idEvent_Code": 250,
    "Event_Type": "Tow In Motion",
    "Event_Description": "Tow In Motion"
  },
  {
    "idEvent_Code": 251,
    "Event_Type": "Tow Stop",
    "Event_Description": "Tow Stop"
  },
  {
    "idEvent_Code": 252,
    "Event_Type": "Camera On",
    "Event_Description": "Camera On"
  },
  {
    "idEvent_Code": 253,
    "Event_Type": "Wake Up",
    "Event_Description": "Wake Up"
  },
  {
    "idEvent_Code": 254,
    "Event_Type": "Tethered Power Loss",
    "Event_Description": "Tethered Power Loss"
  },
  {
    "idEvent_Code": 255,
    "Event_Type": "Tethered Power On",
    "Event_Description": "Tethered Power On"
  },
  {
    "idEvent_Code": 256,
    "Event_Type": "SerialDataMessage",
    "Event_Description": "Serial Data Message"
  },
  {
    "idEvent_Code": 976,
    "Event_Type": "Power Loss",
    "Event_Description": "Power Loss"
  },
  {
    "idEvent_Code": 1023,
    "Event_Type": "ERROR",
    "Event_Description": "SCRIPT ERROR"
  },
  {
    "idEvent_Code": 2000,
    "Event_Type": "SmartWitness Alarm In",
    "Event_Description": "Alarm In"
  },
  {
    "idEvent_Code": 2001,
    "Event_Type": "SmartWitness Signal",
    "Event_Description": "Signal"
  },
  {
    "idEvent_Code": 2002,
    "Event_Type": "SmartWitness Shock",
    "Event_Description": "Shock"
  },
  {
    "idEvent_Code": 2003,
    "Event_Type": "SmartWitness Panic Button",
    "Event_Description": "Panic Button"
  },
  {
    "idEvent_Code": 2004,
    "Event_Type": "SmartWitness AlarmOutControl",
    "Event_Description": "AlarmOutControl"
  },
  {
    "idEvent_Code": 2005,
    "Event_Type": "SmartWitness Device Offline",
    "Event_Description": "Device Offline"
  },
  {
    "idEvent_Code": 2006,
    "Event_Type": "SmartWitness Device Online",
    "Event_Description": "Device Online"
  },
  {
    "idEvent_Code": 2007,
    "Event_Type": "SmartWitness Severe Shock",
    "Event_Description": "Severe Shock"
  },
  {
    "idEvent_Code": 2099,
    "Event_Type": "SmartWitness Unknown Event",
    "Event_Description": "Unknown Event"
  },
  {
    "idEvent_Code": 3000,
    "Event_Type": "TrackerAppStarted",
    "Event_Description": "Tracker App Started"
  },
  {
    "idEvent_Code": 3001,
    "Event_Type": "TrackerAppStopped",
    "Event_Description": "Tracker App Stopped"
  },
  {
    "idEvent_Code": 3002,
    "Event_Type": "PhoneShake",
    "Event_Description": "Phone Shake"
  }
]

Code samples

@ECHO OFF

curl -v -X GET "https://temeda.azure-api.net/telemetry/eventcodes"
-H "Authorization: "
-H "EnvironmentCode: "
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Authorization", "");
            client.DefaultRequestHeaders.Add("EnvironmentCode", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://temeda.azure-api.net/telemetry/eventcodes?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://temeda.azure-api.net/telemetry/eventcodes");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Authorization", "");
            request.setHeader("EnvironmentCode", "");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://temeda.azure-api.net/telemetry/eventcodes?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Authorization","");
                xhrObj.setRequestHeader("EnvironmentCode","");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://temeda.azure-api.net/telemetry/eventcodes";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"Authorization"];
    [_request setValue:@"" forHTTPHeaderField:@"EnvironmentCode"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://temeda.azure-api.net/telemetry/eventcodes');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Authorization' => '',
    'EnvironmentCode' => '',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Authorization': '',
    'EnvironmentCode': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('temeda.azure-api.net')
    conn.request("GET", "/telemetry/eventcodes?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Authorization': '',
    'EnvironmentCode': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('temeda.azure-api.net')
    conn.request("GET", "/telemetry/eventcodes?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://temeda.azure-api.net/telemetry/eventcodes')


request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Authorization'] = ''
# Request headers
request['EnvironmentCode'] = ''
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body