GET api/v4/vehiclecandtccontroller/{userID}/{token}/{serviceID}/{from}/{to}

Pulls back can DTC records - Maps to V3 GetVehicleCanDtcData web service method

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userID

The ID returned from a successful login

unsigned integer

Required

token

The authentication token returned from a successful login

string

Required

serviceID

The service id of the vehicle being queried

unsigned integer

Required

from

The start date being queried yyyyMMddHHmmss

string

Required

to

The end date being queried yyyyMMddHHmmss

string

Required

Body Parameters

None.

Response Information

Resource Description

A list of can dtc records

Collection of Can_Dtc
NameDescriptionTypeAdditional information
Id

Unique id of can DTC record

unsigned integer

None.

ServiceId

Service id which raised the DTC

unsigned integer

None.

CanSystemCode

The can system code

integer

None.

CanSubSystemCode

The can sub system code

integer

None.

CanCodeType

The can code type

integer

None.

CanProblemCode

The can problem code

integer

None.

CanStatus

The can status

integer

None.

CanFaultCount

The can fault count

integer

None.

CanSID

The can sid

string

None.

GpsTime

The GPS time the DTC occurred

date

None.

GpsLatitude

The latitude where the service was when the DTC occurred

decimal number

None.

GpsLongitude

The longitude where the service was when the DTC occurred

decimal number

None.

GpsOrientation

The GPS heading where the service was when the DTC occurred

decimal number

None.

GpsSpeed

The GPS speed of the vehicle when the DTC occurred

decimal number

None.

GpsFix

The GPS fix

integer

None.

GeoStreet

The street where the service was when the DTC occurred

string

None.

GeoTown

The town where the service was when the DTC occurred

string

None.

GeoCountry

The country where the service was when the DTC occurred

string

None.

GeoPostcode

The post code where the service was when the DTC occurred

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "ServiceId": 2,
    "CanSystemCode": 3,
    "CanSubSystemCode": 4,
    "CanCodeType": 5,
    "CanProblemCode": 6,
    "CanStatus": 7,
    "CanFaultCount": 8,
    "CanSID": "sample string 9",
    "GpsTime": "2025-04-27T15:52:12.8768655+00:00",
    "GpsLatitude": 11.1,
    "GpsLongitude": 12.1,
    "GpsOrientation": 13.1,
    "GpsSpeed": 14.1,
    "GpsFix": 15,
    "GeoStreet": "sample string 16",
    "GeoTown": "sample string 17",
    "GeoCountry": "sample string 18",
    "GeoPostcode": "sample string 19"
  },
  {
    "Id": 1,
    "ServiceId": 2,
    "CanSystemCode": 3,
    "CanSubSystemCode": 4,
    "CanCodeType": 5,
    "CanProblemCode": 6,
    "CanStatus": 7,
    "CanFaultCount": 8,
    "CanSID": "sample string 9",
    "GpsTime": "2025-04-27T15:52:12.8768655+00:00",
    "GpsLatitude": 11.1,
    "GpsLongitude": 12.1,
    "GpsOrientation": 13.1,
    "GpsSpeed": 14.1,
    "GpsFix": 15,
    "GeoStreet": "sample string 16",
    "GeoTown": "sample string 17",
    "GeoCountry": "sample string 18",
    "GeoPostcode": "sample string 19"
  }
]

application/xml, text/xml

Sample:
<ArrayOfCan_Dtc xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Can_Dtc>
    <Id>1</Id>
    <ServiceId>2</ServiceId>
    <CanSystemCode>3</CanSystemCode>
    <CanSubSystemCode>4</CanSubSystemCode>
    <CanCodeType>5</CanCodeType>
    <CanProblemCode>6</CanProblemCode>
    <CanStatus>7</CanStatus>
    <CanFaultCount>8</CanFaultCount>
    <CanSID>sample string 9</CanSID>
    <GpsTime>2025-04-27T15:52:12.8768655+00:00</GpsTime>
    <GpsLatitude>11.1</GpsLatitude>
    <GpsLongitude>12.1</GpsLongitude>
    <GpsOrientation>13.1</GpsOrientation>
    <GpsSpeed>14.1</GpsSpeed>
    <GpsFix>15</GpsFix>
    <GeoStreet>sample string 16</GeoStreet>
    <GeoTown>sample string 17</GeoTown>
    <GeoCountry>sample string 18</GeoCountry>
    <GeoPostcode>sample string 19</GeoPostcode>
  </Can_Dtc>
  <Can_Dtc>
    <Id>1</Id>
    <ServiceId>2</ServiceId>
    <CanSystemCode>3</CanSystemCode>
    <CanSubSystemCode>4</CanSubSystemCode>
    <CanCodeType>5</CanCodeType>
    <CanProblemCode>6</CanProblemCode>
    <CanStatus>7</CanStatus>
    <CanFaultCount>8</CanFaultCount>
    <CanSID>sample string 9</CanSID>
    <GpsTime>2025-04-27T15:52:12.8768655+00:00</GpsTime>
    <GpsLatitude>11.1</GpsLatitude>
    <GpsLongitude>12.1</GpsLongitude>
    <GpsOrientation>13.1</GpsOrientation>
    <GpsSpeed>14.1</GpsSpeed>
    <GpsFix>15</GpsFix>
    <GeoStreet>sample string 16</GeoStreet>
    <GeoTown>sample string 17</GeoTown>
    <GeoCountry>sample string 18</GeoCountry>
    <GeoPostcode>sample string 19</GeoPostcode>
  </Can_Dtc>
</ArrayOfCan_Dtc>