Inseego Fleet Logo
API docs by Redocly

Inseego Fleet API Documentation

Download OpenAPI specification:Download

Overview

Inseego WCF API is a webservice application interface into Inseego Fleet

With it you can create a custom integration between your fleet management solution and other business systems using secure telematics API connections. This will help you make more informed decisions, automate data collection, and improve your fleet operations.

Note:-

Request Samples are provided in Curl, Python and C#

Response Samples are provided in JSON

Fully SOAP and REST compatible endpoints available.

Getting Started


REST APIs

An API (Application Programming Interface) enables programs to talk to each other. REST APIs (Representational State Transfer) are APIs that use HTTP requests to access and consume data. Each HTTP request uses a unique URL, representing a different endpoint and each HTTP request that is sent is known as an API call. The API endpoints represent the specific content that can be accessed at that location. This content is known as a resource and each resource is usually accessed based on additional details that are expressed through parameters and their values included in the API call. Resources can be returned in different formats such as JSON or HTML. The Inseego Fleet API endpoints use HTTP request methods, which represent the actions that can be performed on or for those resources.
Following are the methods supported by the Inseego Fleet API:

  • GET — retrieves data

The Inseego Fleet API is divided into different groups of endpoints according to functionality. You can use these endpoints to retrieve information for your organisation such as:

Cost Centre structure

Telematics information

Driver information

Understanding the data that is available

The API can be broken down into 5 seperate modules

Cost Centre - This section allows you to see your current organisational structure within Inseego Fleet

Vehicles - This section allows you to retrieve information around core telematic details, vehicles, positions, trips and much more

Driver - This section allows you to find out information about divers

Location - This section allows you to look at any stored locations within Inseego Fleet

Queues - This section gives you access to our queues which helps remove any issues around collecting duplicate information

Which modules of the API you would need to use depends on your requirements, there are some API calls which will return data for your entire fleet and others that will only return data for the specific vehicle that you have requested.

API Features

Vehicle features:-

  • Vehicle data can be retrieved via numerous API calls.

Single vehicles can be isolated by passing the registration number, tracking cell number or MIT number within the call, multiple results can be achieved based on search criteria.

Most prominent details contained in a vehicle object are:

- Unit type in the vehicle.

+ Vehicle properties (such as registration number, serail number, MIT, description, make, model, etc).

+ Last reported time for the vehicle.

* Trips for vehicles based on a date range filter.

Trip information for a vehicle includes the following most used values:

- Duration and distance of the trip.

+ Odo reading at start and end.
+ Latitude/Longitude of trip start/stop including a reverse geocoding lookup description of the start and end.
+ Frequency and max value of trip based measurements, which include RPM, speed, freewheeling, excess idling, harsh braking and cornering.
+ Driver for the trip if tag is used.
+ Business/Private indicator.

  • Vehicle Positional data packets contain the following information.

    • Latitude/Longitude coordinates including a reverse geocoding lookup description
    • Status of the vehicle at the position.
    • Ignition indicator.
    • Speed.
    • Odo.
    • Vehicle heading.
    • POI distance and direction indicator if within limits.

Full real-time queue for positional data that can be consumed by the client.

This allows for only data to be passed if available and duplicated data will not be sent.

Trip Queues are also supported and is updated on a daily basis as we calculate trips.

Response Codes

All API requests receive a response with the appropriate HTTP response code. Each response class represents a different general message:

  • 2XX codes - successful responses.
  • 4XX codes - client error responses. There was an error in your request. Modify the request and try again. The 4XX error codes are listed in the table below.
  • 5XX codes - server error reponses. There may be a temporary issue on the Inseego side.

Error codes The following is a table of error codes to help you debug:

Status code Description
400 Bad request - general client error, possibly malformed data.
401 Unauthenticated - the API key is missing or invalid.
404 Not found - the API endpoint is invalid or a path parameter is missing or invalid.
405 Method not allowed - the API endpoint does not accept that HTTP method.
5XX Internal server errors - something went wrong with the Inseego API's servers. These responses are likely a temporary error, so try again in a few minutes.

How To use

This documentation gives you access to one of our test environments that has live vehicles which will allow you to test any calls on the documentation

you can find the login details for the API on the Membership section

The minimum requirement to use the API is to Login and obtain a Session Token.

This Session Token is valid for 60 minutes between inactivity, otherwise it refreshes.

Use this on subsequent call for authentication. The Steps below should give you a step by step guide of how to get a token and pass to call other endpoints in the API.



An example of an a response to the membership API can be found below 

 {
  "ErrorCode": "Success = 0",
  "UserId": 89471,
  "SessionToken": "9ed4bd2a-7fa1-4af3-9dd4-08ac76376b89",
  "SessionDurationMinutes": 60,
  "xml": null
}

Some Examples may have the (+) sign next to them meaning that they can be expanded to see the example




Usage Plans and Throttling Limits

** Please Note: - Only one API user can be issues per customer/company.**
** Multiple API users should not be requested as these are not permitted.**

We have introduced limits on API usage rates in terms of request per second minute, hour etc. This applies to both individual customers and collective usage for all customers

1. A customer's limit is set based on the Service description agreement that the customer is subscribed to
2. As customer's access the API at the same time there is an overall limit on how many requests are allowed in order to protect the service

These two scenarios will return an HTTP status code of 500 - AuthenticationFailed




Membership

This interface implements Membership functionality.

Login

Logs into user account based on username and password provided.

query Parameters
Username
required
string
Default: "API_Demo"

Username of login account.

Password
required
string <password>
Default: "Password01"

Password of login account.

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
private readonly IHttpClientFactory _httpClientFactory;
public static async Task Main(string[] args)
{
var client = _httpClientFactory.CreateClient();
var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/Membership/Login?Username=API_Demo&Password=Password01");
var response = await request.Content.ReadAsStringAsync();

Console.WriteLine(response);
}
}

Response samples

Content type
application/json
{
  • "ErrorCode": "Success = 0",
  • "UserId": 89471,
  • "SessionToken": "9ed4bd2a-7fa1-4af3-9dd4-08ac76376b89",
  • "SessionDurationMinutes": 60,
  • "xml": null
}

GetServiceVersion

Returns the current assembly version for the service.

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
  private readonly IHttpClientFactory _httpClientFactory;
  public static async Task Main(string[] args)
  {
    var client = _httpClientFactory.CreateClient();
    var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/Membership/GetServiceVersion");
    var response = await request.Content.ReadAsStringAsync();
    
    Console.WriteLine(response);
    }
    }

Response samples

Content type
application/json
{
  • "ErrorCode": 0,
  • "Version": {
    }
}

CostCentre

This interface implements CostCentre functionality

FindCostCentreContainingVehiclesNodeIds

FindCostCentreContainingVehiclesNodeIds takes an AuthenticationDetails object and a list of vehicles nodeIds as input. It determines if there exist a cost centre that contain that and only that list of vehicles and return the Cost Centre if indeed found.

path Parameters
authenticationToken
required
string

The authentication token for this session.

query Parameters
sVehicleNodeIds
required
string

The node ID's of the vehicles.

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
private readonly IHttpClientFactory _httpClientFactory;
public static async Task Main(string[] args)
    {
    var client = _httpClientFactory.CreateClient();
        var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
    var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/CostCentres/" + AuthenticationToken + "/FindCostCentreContainingVehiclesNodeIds?sVehicleNodeIds=string");
    var response = await request.Content.ReadAsStringAsync();
    
    Console.WriteLine(response);
    }
}

Response samples

Content type
application/json
{
  • "ErrorCode": 0,
  • "CostCentre": [
    ]
}

GetCostCentre

GetCostCentre method takes an AuthenticationDetails object and cost centre name as parameters to return a CostCentreDetails object. If successful a CostCentreDetails object is returned.

path Parameters
authenticationToken
required
string

The authentication token for this session.

query Parameters
name
required
string

The name of the cost centre.

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
private readonly IHttpClientFactory _httpClientFactory;
public static async Task Main(string[] args)
    {
    var client = _httpClientFactory.CreateClient();
        var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
    var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/CostCentres/" + AuthenticationToken + "/GetCostCentre?name=string");
    var response = await request.Content.ReadAsStringAsync();
    
    Console.WriteLine(response);
    }
}

Response samples

Content type
application/json
{
  • "ErrorCode": 0,
  • "CostCentre": [
    ]
}

GetCostCentres

GetCostCentres method takes an AuthenticationDetails object, it determines to which CostCentres this user belongs to and return those CostCentres.

path Parameters
authenticationToken
required
string

The authentication token for this session.

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
private readonly IHttpClientFactory _httpClientFactory;
    public static async Task Main(string[] args)
    {
    var client = _httpClientFactory.CreateClient();
        var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
    var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/CostCentres/" + AuthenticationToken + "/GetCostCentres");
    var response = await request.Content.ReadAsStringAsync();
    
    Console.WriteLine(response);
    }
}

Response samples

Content type
application/json
{
  • "ErrorCode": 0,
  • "CostCentre": [
    ]
}

GetCostCentresForUser

GetCostCentresForUser method takes an AuthenticationDetails object and a User object. It determines to which CostCentres the User object belongs to and return those CostCentres.

path Parameters
authenticationToken
required
string

The authentication token for this session.

query Parameters
userId
required
integer

The ID of the user to be used for the query.

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
private readonly IHttpClientFactory _httpClientFactory;
public static async Task Main(string[] args)
    {
    var client = _httpClientFactory.CreateClient();
        var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
    var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/CostCentres/" + AuthenticationToken + "/GetCostCentresForUser?userId=0");
    var response = await request.Content.ReadAsStringAsync();
    
Console.WriteLine(response);
    }
}

Response samples

Content type
application/json
{
  • "ErrorCode": 0,
  • "CostCentre": [
    ]
}

GetCustomFieldsForCostCentre

GetCustomFields method takes AuthenticationDetails object, CostCentre object and will return the CustomFieldValue pairs for the Cost Centre. If successful a new CustomFieldValueResults object is created and returned.

path Parameters
authenticationToken
required
string

The authentication token for this session.

query Parameters
costCentreId
required
integer

ID of cost centre to be used for query.

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
    private readonly IHttpClientFactory _httpClientFactory;
    public static async Task Main(string[] args)
    {
    var client = _httpClientFactory.CreateClient();
        var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
    var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/CostCentres/" + AuthenticationToken + "/GetCustomFieldsForCostCentre?costCentreId=0");
    var response = await request.Content.ReadAsStringAsync();
    
    Console.WriteLine(response);
    }
}

Response samples

Content type
application/json
{
  • "ErrorCode": "VehicleTypeNotSupported = 7"
}

Vehicle

This interface implements Vehicle functionality.

GetVehicles

Multiple status values can be provided with comma separated strings

path Parameters
authenticationToken
required
string

Status values that need to be considered for filter

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
  private readonly IHttpClientFactory _httpClientFactory;
  public static async Task Main(string[] args)
  {
    var client = _httpClientFactory.CreateClient();
    var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
    var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/Vehicles/" + AuthenticationToken + "/GetVehicles");
    var response = await request.Content.ReadAsStringAsync();
    
    Console.WriteLine(response);
  }
}

Response samples

Content type
application/json
{
  • "ErrorCode": 0,
  • "VehicleList": [
    ]
}

GetVehicleDetail

Obtain the vehicle details of an individual vehicle .

path Parameters
authenticationToken
required
string

Status values that need to be considered for filter

query Parameters
costCentreId
required
integer

The Cost Centre nodeid the vehicle recides in

searchType
required
string

Define the Parameter to search using one of the following vehicleID, MIT, NodeId or SerialNumber

value
required
string

This would be the vehicleID, MIT, NodeId or SerialNumber of the vehiclce the details

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
  private readonly IHttpClientFactory _httpClientFactory;
  public static async Task Main(string[] args)
  {
    var client = _httpClientFactory.CreateClient();
    var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
    var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/Vehicles/" + AuthenticationToken + "/GetVehicleDetail?costCentreId=0&searchType=string&value=string");
    var response = await request.Content.ReadAsStringAsync();
    
    Console.WriteLine(response);
  }
}

Response samples

Content type
application/json
{
  • "ErrorCode": 0,
  • "VehicleList": [
    ]
}

GetLastVehiclePositionsforAuthenticatedUser

Multiple status values can be provided with comma separated strings

path Parameters
authenticationToken
required
string

Status values that need to be considered for filter

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
  private readonly IHttpClientFactory _httpClientFactory;
  public static async Task Main(string[] args)
  {
    var client = _httpClientFactory.CreateClient();
    var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
    var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/Vehicles/" + AuthenticationToken + "/GetLastVehiclePositionsforAuthenticatedUser");
    var response = await request.Content.ReadAsStringAsync();
    
    Console.WriteLine(response);
  }
}

Response samples

Content type
application/json
{
  • "ErrorCode": 0,
  • "LastVehiclePositions": [
    ]
}

GetLastVehiclePosition

Multiple status values can be provided with comma separated strings

path Parameters
authenticationToken
required
string

Status values that need to be considered for filter

query Parameters
svehicleNodeIds
required
Array of strings

List of vehicle node IDs that postition data should be retrieved on.

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
  private readonly IHttpClientFactory _httpClientFactory;
  public static async Task Main(string[] args)
  {
    var client = _httpClientFactory.CreateClient();
    var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
    var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/Vehicles/" + AuthenticationToken + "/GetLastVehiclePosition?svehicleNodeIds=string");
    var response = await request.Content.ReadAsStringAsync();
    
    Console.WriteLine(response);
  }
}

Response samples

Content type
application/json
{
  • "ErrorCode": 0,
  • "LastVehiclePosition": [
    ]
}

GetLastVehiclePositions

Multiple status values can be provided with comma separated strings

path Parameters
authenticationToken
required
string

Status values that need to be considered for filter

query Parameters
svehicleNodeIds
required
Array of strings

List of vehicle node IDs that postition data should be retrieved on.

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
    private readonly IHttpClientFactory _httpClientFactory;
    public static async Task Main(string[] args)
    {
    var client = _httpClientFactory.CreateClient();
      var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
    var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/Vehicles/" + AuthenticationToken + "/GetLastVehiclePositions?svehicleNodeIds=string");
    var response = await request.Content.ReadAsStringAsync();
    Console.WriteLine(response);
    
    }
}

Response samples

Content type
application/json
{
  • "ErrorCode": 0,
  • "LastVehiclePositions": [
    ]
}

GetVehiclePositionsDetailed

Multiple status values can be provided with comma separated strings

path Parameters
authenticationToken
required
string

Status values that need to be considered for filter

query Parameters
vehicleNodeId
required
integer

NodeId of the vehicle

fromDateTimeUTC
required
string <datetime>

Time format in YYYY-MM-DDTHH:MM:SSZ

toDateTimeUTC
required
string <datetime>

Time format in YYYY-MM-DDTHH:MM:SSZ

Responses

Request samples 

import requests

authentication_token = "YOUR_authenticationToken_PARAMETER"
url = "https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/Vehicles/" + authentication_token + "/GetLastVehiclePositions"

query = {
    "svehicleNodeIds": "string"
 }
 
 response = requests.get(url, params=query)
 
 data = response.json()
 print(data)

Response samples

Content type
application/json
{
  • "ErrorCode": 0,
  • "LastVehiclePositionsDetailed": [
    ]
}

GetVehicleOdoattime

Multiple status values can be provided with comma separated strings

path Parameters
authenticationToken
required
string

Status values that need to be considered for filter

query Parameters
searchType
required
Array of strings

Define the Parameter to search using one of the following vehicleID, MIT, NodeId or SerialNumber.

odoDateTime
required
string <datetime>

Time format in YYYY-MM-DDTHH:MM:SSZ

sValues
required
Array of strings

List of vehicle node IDs that postition data should be retrieved on.

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
    private readonly IHttpClientFactory _httpClientFactory;
    public static async Task Main(string[] args)
    {
        var client = _httpClientFactory.CreateClient();
          var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
        var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/Vehicles/" + AuthenticationToken + "/GetVehicleOdoattime?searchType=string&odoDateTime=string&sValues=string");
        var response = await request.Content.ReadAsStringAsync();
        
        Console.WriteLine(response);
    }
}

Response samples

Content type
application/json
{
  • "ErrorCode": 0,
  • "VehicleOdoList": [
    ]
}

GetVehicleOdoOverPeriod

Multiple status values can be provided with comma separated strings

path Parameters
authenticationToken
required
string

Status values that need to be considered for filter

query Parameters
vehicleNodeId
required
Array of strings

List of vehicle node IDs that postition data should be retrieved on.

fromDateTimeUTC
required
string <datetime>

Time format in YYYY-MM-DDTHH:MM:SSZ

toDateTimeUTC
required
string <datetime>

Time format in YYYY-MM-DDTHH:MM:SSZ

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
    private readonly IHttpClientFactory _httpClientFactory;
    public static async Task Main(string[] args)
    {
        var client = _httpClientFactory.CreateClient();
          var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
        var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/Vehicles/" + AuthenticationToken + "/GetVehicleOdoOverPeriod?vehicleNodeId=string&fromDateTimeUTC=string&toDateTimeUTC=string");
        var response = await request.Content.ReadAsStringAsync();
        
        Console.WriteLine(response);
    }
}

Response samples

Content type
application/json
{
  • "ErrorCode": 0,
  • "VehicleRegistration": "Trailer 4 (2G)",
  • "DriverId": "string",
  • "VehicleOdo": 0,
  • "OdoTimestamp": "2017-04-30T02:01:26Z"
}

GetVehicleRunningHours

Obtain trip data that occured for a specified vehicle between specified dates.

path Parameters
authenticationToken
required
string

Status values that need to be considered for filter

query Parameters
vehicleNodeId
required
integer

Status values that need to be considered for filter

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
   private readonly IHttpClientFactory _httpClientFactory;
   public static async Task Main(string[] args)
   {
    var client = _httpClientFactory.CreateClient();
      var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
    var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/Vehicles/" + AuthenticationToken + "/GetVehicleRunningHours?vehicleNodeId=0");
    var response = await request.Content.ReadAsStringAsync();
    
    Console.WriteLine(response);
    }
}

Response samples

Content type
application/json
{
  • "ErrorCode": 0,
  • "VehicleRunningHours": [
    ]
}

GetVehiclesRunningHours

Obtain trip data that occured for a specified vehicle between specified dates.

path Parameters
authenticationToken
required
string

Status values that need to be considered for filter

query Parameters
vehicleNodeId
required
integer

Status values that need to be considered for filter

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
   private readonly IHttpClientFactory _httpClientFactory;
   public static async Task Main(string[] args)
   {
    var client = _httpClientFactory.CreateClient();
      var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
    var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/Vehicles/" + AuthenticationToken + "/GetVehiclesRunningHours?vehicleNodeId=0");
    var response = await request.Content.ReadAsStringAsync();
    
    Console.WriteLine(response);
    }
}

Response samples

Content type
application/json
{
  • "ErrorCode": 0,
  • "VehicleRunningHours": [
    ]
}

GetVehicleTrips

Obtain trip data that occured for a specified vehicle between specified dates.

path Parameters
authenticationToken
required
string

Status values that need to be considered for filter

query Parameters
vehicleNodeId
required
integer

Status values that need to be considered for filter

fromDateTimeUTC
required
string <datetime>

Time format in YYYY-MM-DDTHH:MM:SSZ

toDateTimeUTC
required
string <datetime>

Time format in YYYY-MM-DDTHH:MM:SSZ

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
    private readonly IHttpClientFactory _httpClientFactory;
    public static async Task Main(string[] args)
    {
    var client = _httpClientFactory.CreateClient();
        var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
    var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/Vehicles/" + AuthenticationToken + "/GetVehicleTrips?vehicleNodeId=0&fromDateTimeUTC=string&toDateTimeUTC=string");
    var response = await request.Content.ReadAsStringAsync();
    Console.WriteLine(response);
    }
}

Response samples

Content type
application/json
{
  • "ErrorCode": 0,
  • "VehicleTrips": [
    ]
}

GetVehicleTripsDetailed

Obtain trip data that occured for a specified vehicle between specified dates.

path Parameters
authenticationToken
required
string

Status values that need to be considered for filter

query Parameters
vehicleNodeId
required
integer

Status values that need to be considered for filter

fromDateTimeUTC
required
string <datetime>

Time format in YYYY-MM-DDTHH:MM:SSZ

toDateTimeUTC
required
string <datetime>

Time format in YYYY-MM-DDTHH:MM:SSZ

Responses

Request samples 

using System;
    using System.Net.Http;
    using System.Threading.Tasks;
    
    public class Program
        {
        private readonly IHttpClientFactory _httpClientFactory;
        public static async Task Main(string[] args)
        {
        var client = _httpClientFactory.CreateClient();
            var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
        var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/Vehicles/" + AuthenticationToken + "/GetVehicleTripsDetailed?vehicleNodeId=0&fromDateTimeUTC=string&toDateTimeUTC=string");
        var response = await request.Content.ReadAsStringAsync();
        
        Console.WriteLine(response);
        }
    }

Response samples

Content type
application/json
{
  • "NodeId": 0,
  • "DrivingTime": 0,
  • "StartOdometerReading": 0,
  • "EndOdometerReading": 0,
  • "TripDistance": 0,
  • "StartLatitude": 0.1,
  • "StartLongitude": 0.1,
  • "EndLatitude": 0.1,
  • "EndLongitude": 0.1,
  • "StartLocation": "string",
  • "EndLocation": "string",
  • "OverRevCount": 0,
  • "MaxRPM": 0,
  • "OverRevDuration": 0,
  • "RPMLimit": 0,
  • "OverSpeedCount": 0,
  • "MaxSpeed": 0,
  • "OverSpeedDuration": 0,
  • "SpeedLimit": 0,
  • "ExcessIdleCount": 0,
  • "ExcessIdleTime": 0,
  • "ExcessIdleSpeed": 0,
  • "ExcessIdleRPM": 0,
  • "FreeWheeling": 0,
  • "FreeWheelingTime": 0,
  • "FreeWheelingSpeed": 0,
  • "FreeWheelingRPM": 0,
  • "HarshBrakeCount": 0,
  • "HarshAccelerateCount": 0,
  • "HarshCornerCount": 0,
  • "HarshBumpCount": 0,
  • "GreenBandTime": 0,
  • "GreenBandLo": 0,
  • "GreenBandHi": 0,
  • "TripFuel": 0,
  • "FuelDataSource": 0,
  • "Tag": "string",
  • "DriverId": "string",
  • "DriverName": "string",
  • "IsBusinessPrivate": 0,
  • "Comment": "string",
  • "CustomIdentifier": "string",
  • "DeliveryTag": 0
}

GetVehiclesTripDistances

Obtain trip data that occured for a specified vehicle between specified dates.

path Parameters
authenticationToken
required
string

Status values that need to be considered for filter

query Parameters
fromDateTimeUTC
required
string <datetime>

Time format in YYYY-MM-DDTHH:MM:SSZ

toDateTimeUTC
required
string <datetime>

Time format in YYYY-MM-DDTHH:MM:SSZ

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
    {
    private readonly IHttpClientFactory _httpClientFactory;
    public static async Task Main(string[] args)
    {
    var client = _httpClientFactory.CreateClient();
        var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
    var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/Vehicles/" + AuthenticationToken + "/GetVehiclesTripDistances?fromDateTimeUTC=string&toDateTimeUTC=string");
    var response = await request.Content.ReadAsStringAsync();
    
    Console.WriteLine(response);
    }
}

Response samples

Content type
application/json
{
  • "ErrorCode": 0,
  • "VehicleTripPeriodDistances": [
    ]
}

GetVehicleCostCentres

Obtain trip data that occured for a specified vehicle between specified dates.

path Parameters
authenticationToken
required
string

Status values that need to be considered for filter

query Parameters
vehicleNodeId
required
string

Status values that need to be considered for filter

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
    private readonly IHttpClientFactory _httpClientFactory;
    public static async Task Main(string[] args)
    {
    var client = _httpClientFactory.CreateClient();
        var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
    var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/Vehicles/" + AuthenticationToken + "/GetVehicleCostCentres?vehicleNodeId=string");
    var response = await request.Content.ReadAsStringAsync();
    
    Console.WriteLine(response);
    }
}

Response samples

Content type
application/json
{
  • "ErrorCode": 0,
  • "CostCentre": [
    ]
}

GetVehiclesinCostCentre

Obtain the vehicles within the specified Cost Centre.

path Parameters
authenticationToken
required
string

Status values that need to be considered for filter

query Parameters
costCentreId
required
string

Status values that need to be considered for filter

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
    private readonly IHttpClientFactory _httpClientFactory;
    public static async Task Main(string[] args)
    {
    var client = _httpClientFactory.CreateClient();
        var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
    var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/Vehicles/" + AuthenticationToken + "/GetVehiclesinCostCentre?costCentreId=string");
    var response = await request.Content.ReadAsStringAsync();
    
    Console.WriteLine(response);
    }
}

Response samples

Content type
application/json
{
  • "ErrorCode": 0,
  • "VehicleList": [
    ]
}

getgritterstatus

Obtain the Gritter status for the specified vehicle.

path Parameters
authenticationToken
required
string

Status values that need to be considered for filter

query Parameters
vehicleNodeId
required
string

Status values that need to be considered for filter

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
    private readonly IHttpClientFactory _httpClientFactory;
    public static async Task Main(string[] args)
    {
    var client = _httpClientFactory.CreateClient();
        var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
    var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/Vehicles/" + AuthenticationToken + "/getgritterstatus?vehicleNodeId=string");
    var response = await request.Content.ReadAsStringAsync();
    
    Console.WriteLine(response);
    }
}

Response samples

Content type
application/json
{
  • "ErrorCode": "VehicleTypeNotSupported = 7"
}

getgritterstatusForAuthenticatedUser

Obtain the Gritter status for vehicles user has access to.

path Parameters
authenticationToken
required
string

Status values that need to be considered for filter

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
    private readonly IHttpClientFactory _httpClientFactory;
    public static async Task Main(string[] args)
    {
        var client = _httpClientFactory.CreateClient();
    var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
    var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/Vehicles/" + AuthenticationToken + "/getgritterstatusForAuthenticatedUser");
    var response = await request.Content.ReadAsStringAsync();
    
    Console.WriteLine(response);
    }
}

Response samples

Content type
application/json
{
  • "ErrorCode": "VehicleTypeNotSupported = 7"
}

GetVehicleDrivingBehaviour

Obtain the driving behaviour status for vehicles user has access to.

path Parameters
authenticationToken
required
string

Status values that need to be considered for filter

query Parameters
vehicleNodeId
required
string

Status values that need to be considered for filter

fromDateTimeUTC
required
string <datetime>

Time format in YYYY-MM-DDTHH:MM:SSZ

toDateTimeUTC
required
string <datetime>

Time format in YYYY-MM-DDTHH:MM:SSZ

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
    private readonly IHttpClientFactory _httpClientFactory;
    public static async Task Main(string[] args)
    {
    var client = _httpClientFactory.CreateClient();
        var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
    var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/Vehicles/" + AuthenticationToken + "/GetVehicleDrivingBehaviour?vehicleNodeId=string&fromDateTimeUTC=string&toDateTimeUTC=string");
    var response = await request.Content.ReadAsStringAsync();
    
    Console.WriteLine(response);
    }
}

Response samples

Content type
application/json
{
  • "ErrorCode": "VehicleTypeNotSupported = 7"
}

Driver

This interface implements Driver functionality

GetDriversInCostCentre

Returnes The drivers associated with a Specific Cost Centre.

path Parameters
authenticationToken
required
string

Status values that need to be considered for filter

query Parameters
costCentreId
required
string

Status values that need to be considered for filter

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
    private readonly IHttpClientFactory _httpClientFactory;
    public static async Task Main(string[] args)
    {
    var client = _httpClientFactory.CreateClient();
        var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
    var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/Driver/" + AuthenticationToken + "/GetDriversInCostCentre?costCentreId=string");
    var response = await request.Content.ReadAsStringAsync();
    
    Console.WriteLine(response);
    }
}

Response samples

Content type
application/json
{
  • "ErrorCode": 0,
  • "DriverList": [
    ]
}

GetDriver

Returnes The drivers associated with a Specific Cost Centre.

path Parameters
authenticationToken
required
string

Status values that need to be considered for filter

query Parameters
costCentreId
required
string

Status values that need to be considered for filter

searchType
required
string

Status values that need to be considered for filter

Value
required
string

Status values that need to be considered for filter

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
    private readonly IHttpClientFactory _httpClientFactory;
    public static async Task Main(string[] args)
    {
    var client = _httpClientFactory.CreateClient();
        var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
    var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/Driver/" + AuthenticationToken + "/GetDriver?costCentreId=string&searchType=string&Value=string");
    var response = await request.Content.ReadAsStringAsync();
    
    Console.WriteLine(response);
    }     
}

Response samples

Content type
application/json
{
  • "ErrorCode": 0,
  • "Driver": {
    }
}

GetDriversAssociatedWithVehicle

Returnes The drivers associated with a Specific Cost Centre.

path Parameters
authenticationToken
required
string

Status values that need to be considered for filter

query Parameters
vehicleNodeId
required
string

Status values that need to be considered for filter

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
    private readonly IHttpClientFactory _httpClientFactory;
    public static async Task Main(string[] args)
{
    var client = _httpClientFactory.CreateClient();
      var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
    var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/Driver/" + AuthenticationToken + "/GetDriversAssociatedWithVehicle?vehicleNodeId=string");
    var response = await request.Content.ReadAsStringAsync();Console.WriteLine(response);
    }
}

Response samples

Content type
application/json
{
  • "ErrorCode": 0,
  • "DriverList": [
    ]
}

Location

This interface implements Location functionality

GetPointPOIs

GetPointPOIs takes an AuthenticationDetails object and a Cost Centre nodeId as input.
It determines if there exist a cost centre that contain that and only that list of POIs and return the Cost Centre if indeed found.

path Parameters
authenticationToken
required
string

The authentication token for this session.

query Parameters
CostCentreNodeGroupId
required
string

The node ID of the Cost Centre.

modifiedAfter
required
string <datetime>

Status values that need to be considered for filter

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
private readonly IHttpClientFactory _httpClientFactory;
public static async Task Main(string[] args)
    {
    var client = _httpClientFactory.CreateClient();
        var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
    var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/Location/" + AuthenticationToken + "/GetPointPOIs?CostCentreNodeGroupId=string&modifiedAfter=string");
    var response = await request.Content.ReadAsStringAsync();
    
    Console.WriteLine(response);
    }
}

Response samples

Content type
application/json
{
  • "ErrorCode": 0,
  • "Points": [
    ]
}

GetLocationString

GetLocationString takes an AuthenticationDetails object and a Vehicle nodeid and Logitude and Latitude as input. .

path Parameters
authenticationToken
required
string

The authentication token for this session.

query Parameters
vehicleNodeId
required
string

The node ID of the Vehicle.

latitude
required
string

The latitude.

longitude
required
string

The longitude.

useMetric
required
string

The .

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
private readonly IHttpClientFactory _httpClientFactory;
public static async Task Main(string[] args)
    {
    var client = _httpClientFactory.CreateClient();
        var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
    var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/Location/" + AuthenticationToken + "/GetLocationString?vehicleNodeId=string&latitude=string&longitude=string&useMetric%20=string");
    var response = await request.Content.ReadAsStringAsync();
    
    Console.WriteLine(response);
    }
}

Response samples

Content type
application/json
{
  • "ErrorCode": "VehicleTypeNotSupported = 7"
}

Queues

This interface implements Queues functionality.

Subscribe

Allows you to subscribe to a a specified queue.

path Parameters
authenticationToken
required
string

Status values that need to be considered for filter

query Parameters
type
required
string

we have three types of queue to subscribe to Positions, Trips or Scripts

directAccess
required
boolean

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
private readonly IHttpClientFactory _httpClientFactory;
public static async Task Main(string[] args)
    {
    var client = _httpClientFactory.CreateClient();
        var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
    var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/Queues/" + AuthenticationToken + "/Subscribe?type=string&directAccess=true");
    var response = await request.Content.ReadAsStringAsync();
    
    Console.WriteLine(response);
    }
}

Response samples

Content type
application/json
{
  • "ErrorCode": 0,
  • "Subscribe": "Success"
}

GetTrips

Obtain trips data for a 24 hours period.

path Parameters
authenticationToken
required
string

Status values that need to be considered for filter

query Parameters
autoack
required
boolean

Status values that need to be considered for filter

limit
required
integer

Status values that need to be considered for filter

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
private readonly IHttpClientFactory _httpClientFactory;
public static async Task Main(string[] args)
    {
    var client = _httpClientFactory.CreateClient();
        var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
    var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/Queues/" + AuthenticationToken + "/GetTrips?autoack=true&limit=0");
    var response = await request.Content.ReadAsStringAsync();
    
    Console.WriteLine(response);
    }
}

Response samples

Content type
application/json
{
  • "NodeId": 0,
  • "DrivingTime": 0,
  • "StartOdometerReading": 0,
  • "EndOdometerReading": 0,
  • "TripDistance": 0,
  • "StartLatitude": 0.1,
  • "StartLongitude": 0.1,
  • "EndLatitude": 0.1,
  • "EndLongitude": 0.1,
  • "StartLocation": "string",
  • "EndLocation": "string",
  • "OverRevCount": 0,
  • "MaxRPM": 0,
  • "OverRevDuration": 0,
  • "RPMLimit": 0,
  • "OverSpeedCount": 0,
  • "MaxSpeed": 0,
  • "OverSpeedDuration": 0,
  • "SpeedLimit": 0,
  • "ExcessIdleCount": 0,
  • "ExcessIdleTime": 0,
  • "ExcessIdleSpeed": 0,
  • "ExcessIdleRPM": 0,
  • "FreeWheeling": 0,
  • "FreeWheelingTime": 0,
  • "FreeWheelingSpeed": 0,
  • "FreeWheelingRPM": 0,
  • "HarshBrakeCount": 0,
  • "HarshAccelerateCount": 0,
  • "HarshCornerCount": 0,
  • "HarshBumpCount": 0,
  • "GreenBandTime": 0,
  • "GreenBandLo": 0,
  • "GreenBandHi": 0,
  • "TripFuel": 0,
  • "FuelDataSource": 0,
  • "Tag": "string",
  • "DriverId": "string",
  • "DriverName": "string",
  • "IsBusinessPrivate": 0,
  • "Comment": "string",
  • "CustomIdentifier": "string",
  • "DeliveryTag": 0
}

GetPositions

Obtains positional data.

path Parameters
authenticationToken
required
string

Status values that need to be considered for filter

query Parameters
autoack
required
boolean

Status values that need to be considered for filter

limit
required
integer

Status values that need to be considered for filter

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
private readonly IHttpClientFactory _httpClientFactory;
public static async Task Main(string[] args)
    {
    var client = _httpClientFactory.CreateClient();
        var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
    var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/Queues/" + AuthenticationToken + "/GetPositions?autoack=true&limit=0");
    var response = await request.Content.ReadAsStringAsync();
    
    Console.WriteLine(response);
    }
}

Response samples

Content type
application/json
{
  • "ErrorCode": 0,
  • "LastVehiclePositionsDetailed": [
    ]
}

GetScripts

Obtain extended data data for specified vehicles.

path Parameters
authenticationToken
required
string

Status values that need to be considered for filter

query Parameters
autoack
required
boolean

Status values that need to be considered for filter

limit
required
integer

Status values that need to be considered for filter

Responses

Request samples 

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
private readonly IHttpClientFactory _httpClientFactory;
public static async Task Main(string[] args)
    {
    var client = _httpClientFactory.CreateClient();
        var AuthenticationToken = "YOUR_authenticationToken_PARAMETER";
    var request = await client.GetAsync("https://uksb-fleet.inseego.com/DCTTPIEngine/TPIEngine/REST/Queues/" + AuthenticationToken + "/GetScripts?autoack=true&limit=0");
    var response = await request.Content.ReadAsStringAsync();
    
    Console.WriteLine(response);
    }
}

Response samples

Content type
application/json
{
  • "ErrorCode": "VehicleTypeNotSupported = 7"
}