Live Position

curl --request GET \
  --url https://api.masternautconnect.com/connect-webservices/services/public/v1/customer/{customerId}/tracking/live \
  --header 'Authorization: Bearer <token>'

[
  {
    "assetRegistration": "<string>",
    "assetName": "<string>",
    "assetVin": "<string>",
    "assetId": "<string>",
    "driverId": "<string>",
    "driverName": "<string>",
    "driverGroupId": "<string>",
    "driverGroupName": "<string>",
    "assetGroupId": "<string>",
    "assetGroupName": "<string>",
    "date": "2023-11-07T05:31:56Z",
    "status": "<string>",
    "eventType": "<string>",
    "speed": 123,
    "odometer": 123,
    "heading": 123,
    "latitude": 123,
    "longitude": 123,
    "road": "<string>",
    "roadNumber": "<string>",
    "city": "<string>",
    "postCode": "<string>",
    "country": "<string>",
    "formattedAddress": "<string>",
    "division": "<string>",
    "locationName": "<string>",
    "locationGroupName": "<string>",
    "locationId": "<string>",
    "privacy": true,
    "tags": [
      "<string>"
    ],
    "assetType": "<string>",
    "energyType": "<string>",
    "fuelType": [
      "<string>"
    ],
    "electricRangeKm": 123,
    "electricRangeKmEstimated": true,
    "electricBatteryLevelPercent": 123,
    "electricBatteryLevelPercentEstimated": true,
    "electricCharging": true,
    "electricChargingTimeRemainingMins": 123,
    "fuelLevelLitres": 123,
    "fuelLevelPercentage": 123,
    "engineTotalHours": 123,
    "engineRpm": 123,
    "engineTotalHoursType": "<string>",
    "serialNumber": 123,
    "ignitionStatus": "<string>",
    "batteryVoltage": 123,
    "externalPowerVoltage": 123,
    "activeFaultCodes": [
      "<string>"
    ]
  }
]

GET

customer

{customerId}

tracking

live

Live Position

curl --request GET \
  --url https://api.masternautconnect.com/connect-webservices/services/public/v1/customer/{customerId}/tracking/live \
  --header 'Authorization: Bearer <token>'

[
  {
    "assetRegistration": "<string>",
    "assetName": "<string>",
    "assetVin": "<string>",
    "assetId": "<string>",
    "driverId": "<string>",
    "driverName": "<string>",
    "driverGroupId": "<string>",
    "driverGroupName": "<string>",
    "assetGroupId": "<string>",
    "assetGroupName": "<string>",
    "date": "2023-11-07T05:31:56Z",
    "status": "<string>",
    "eventType": "<string>",
    "speed": 123,
    "odometer": 123,
    "heading": 123,
    "latitude": 123,
    "longitude": 123,
    "road": "<string>",
    "roadNumber": "<string>",
    "city": "<string>",
    "postCode": "<string>",
    "country": "<string>",
    "formattedAddress": "<string>",
    "division": "<string>",
    "locationName": "<string>",
    "locationGroupName": "<string>",
    "locationId": "<string>",
    "privacy": true,
    "tags": [
      "<string>"
    ],
    "assetType": "<string>",
    "energyType": "<string>",
    "fuelType": [
      "<string>"
    ],
    "electricRangeKm": 123,
    "electricRangeKmEstimated": true,
    "electricBatteryLevelPercent": 123,
    "electricBatteryLevelPercentEstimated": true,
    "electricCharging": true,
    "electricChargingTimeRemainingMins": 123,
    "fuelLevelLitres": 123,
    "fuelLevelPercentage": 123,
    "engineTotalHours": 123,
    "engineRpm": 123,
    "engineTotalHoursType": "<string>",
    "serialNumber": 123,
    "ignitionStatus": "<string>",
    "batteryVoltage": 123,
    "externalPowerVoltage": 123,
    "activeFaultCodes": [
      "<string>"
    ]
  }
]

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customerId

string

required

Identifier of the customer.

Query Parameters

vehicleIds

string[]

CComma separated list of vehicle identifiers used for filtering.

groupIds

string[]

Comma separated list of group identifiers used for filtering.

driverIds

string[]

Comma separated list of driver identifiers used for filtering.

fromDateTime

string<date-time>

Start date used for filtering.

showAllVehicleStatus

boolean

By default, vehicles with a status of SOLD are excluded.
Set to TRUE to get details of all vehicles.

locale

string

Locale used for language.

hideSpeedIfSpeedSensitive

boolean

By default the vehicle's speed is included.
Set to TRUE exclude speed if either the vehicle's or driver's group is speed sensitive.

Response

Live position data successfully returned

assetRegistration

string

Registration of the asset.

assetName

string

Friendly name of the asset.

assetVin

string

The vehicle identification number (VIN) of the asset.

assetId

string

Unique, unchangeable system generated identifier (alphanumeric) for the asset.

driverId

string

Unique, unchangeable system generated identifier (alphanumeric) for the driver.

driverName

string

Name of the driver of the vehicle.

driverGroupId

string

Unique, unchangeable system generated identifier (alphanumeric) for the group the driver has been assigned to.

driverGroupName

string

Name of the group the driver has been assigned

assetGroupId

string

assetGroupName

string

date

string<date-time>

status

string

eventType

string

Category for the most recent tracking event status of the vehicle.
Can be one of the following: ● driving ○ Any tracking event sent when the vehicle is driving ● idling ○ An iding tracking event was received.
● stopped ○ Any tracking event indicating the vehicle has stopped.
● ping ○ A tracking event sent at set intervals.
For example received from an OBU attached to a trailer.
● input ○ Any tracking event indicating a change in an input attached to the OBU.
● unknown ○ A non-activity ping is received, which is sent from an electric vehicle to indicate if it’s charging or not.
● defect ○ Vehicle fault information read from the CANBUs has been received.

speed

number<double>

The current speed of the vehicle (in kph).
Not included if optional input parameter hideSpeedIfSpeedSensitive was set to true.

odometer

number<double>

Odometer (in km) for the latest tracking event that has been received.

heading

number<double>

Compass heading of the vehicle in degrees clockwise from north.

latitude

number<double>

longitude

number<double>

road

string

roadNumber

string

city

string

The name of the city where the asset is.

postCode

string

The postcode where the asset is.

country

string

The name of the country where the asset is.

formattedAddress

string

Country specific formatted address as a comma separated values using roadNumber, road, city, postcode and country.
For example, UK addresses formatted as: roadNumber, road, city, postcode, country French addresses formatted as: roadNumber, road, postcode, city, country

division

string

The region / county / State from the address.
For example: Normandy, Worcestershire, Tuscany, Arizona,

locationName

string

Name of a POI location if the vehicle is within the geo-fence boundary of a POI location.

locationGroupName

string

The name of the location category assigned to this POI location.

locationId

string

The identifier (alphanumeric) for the POI location.

privacy

boolean

Boolean (true / false) to indicate if the journey is a private journey.

API Documentation

Authorizations

Path Parameters

Query Parameters

Response