GET api/asset/{asset}/{include}

View asset information

Request Information

URI Parameters

Name	Description	Type	Additional information
asset	The name of the asset to query. Leave blank to view all assets.	string	Default value is
include	The types of asset information to return.	string	Default value is

Body Parameters

None.

Response Information

Resource Description

Collection of Asset

Name	Description	Type	Additional information
AssetID	Unique ID of Asset	integer	None.
AssetName	Asset Name	string	String length: inclusive between 0 and 20
Registration	Asset Registration	string	String length: inclusive between 0 and 20
DeviceIMEI	The unique ID of the telematics device assigned to this asset.	string	String length: inclusive between 0 and 30
Description	Asset Description	string	String length: inclusive between 0 and 30
Make	Asset Make	string	String length: inclusive between 0 and 100
Model	Asset model	string	String length: inclusive between 0 and 100
CircuitName	Current home circuit assignment	string	String length: inclusive between 0 and 50
RegistrationDate	Date of Registration	date	None.
AssetComment	General comments stored against asset	string	String length: inclusive between 0 and 100
AssetType	Asset type assigned to this asset	string	String length: inclusive between 0 and 100
Colour	Colour of asset	string	String length: inclusive between 0 and 20
CurrentOdometer	Last recorded mileage (as taken from CANbus or incrementally calculated by GPS for non CANbus)	decimal number	None.
CurrentOdometerUnit	The unit of the CurrentOdometer value	DistanceUnit	None.
TelephoneNumber	Vehicle telephone number	string	String length: inclusive between 0 and 20
ServiceSchedule	ServiceSchedule Settings	ServiceSchedule	None.
SupaTrakSettings	SupaTrak reporting settings	SupaTrakSettings	None.
EcoTrakSettings	EcoTrak reporting settings	EcoTrakSettings	None.
SDASettings	SDA settings	SDASettings	None.
EEDISettings	EEDI Settings	EEDISettings	None.
MiscSettings	Miscellaneous Settings	MiscSettings	None.
HomeCircuitID	A refrence to the	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "AssetID": 1,
    "AssetName": "sample string 2",
    "Registration": "sample string 3",
    "DeviceIMEI": "sample string 4",
    "Description": "sample string 5",
    "Make": "sample string 6",
    "Model": "sample string 7",
    "CircuitName": "sample string 8",
    "RegistrationDate": "2025-04-29T18:50:37.209938+01:00",
    "AssetComment": "sample string 9",
    "AssetType": "sample string 10",
    "Colour": "sample string 11",
    "CurrentOdometer": 1.1,
    "CurrentOdometerUnit": 0,
    "TelephoneNumber": "sample string 12",
    "ServiceSchedule": {
      "LastServiceDistance": 1.1,
      "LastServiceDistanceUnit": 0,
      "ServiceIntervalDistance": 1.1,
      "ServiceIntervalDistanceUnit": 0,
      "ServiceIntervalWeeks": 1
    },
    "SupaTrakSettings": {
      "AccelerationThreshold": 1.1,
      "BrakingThreshold": 1.1,
      "CorneringThreshold": 1.1,
      "SpeedThreshold": 1.1,
      "SpeedThresholdUnit": 0,
      "IdleThreshold": 1,
      "CrashLogThreshold": 1.1
    },
    "EcoTrakSettings": {
      "CANbusProtocol": 0,
      "FuelType": 0,
      "FuelTankCapacity": 1,
      "FuelTankAlert": 1.1,
      "GreenBandStart": 1,
      "GreenBandEnd": 1,
      "PTORPMStart": 1,
      "PTORPMEnd": 1,
      "OverRevvingAlertDelay": 1,
      "EngineLoadThreshold": 1,
      "OverRevvingAlert": 1,
      "ThrottleAlert": 1,
      "UseCANbusWheelSpeed": true,
      "UsePTORevRange": true
    },
    "SDASettings": {
      "SDAInstalled": true,
      "SDAEnabled": true,
      "EnableHArshAccelerationAlerts": true,
      "EnableHarshBrakingAlerts": true,
      "EnableHarshCorneringAlerts": true,
      "EnableIdlingAlerts": true,
      "EnableOverRevvingAlerts": true,
      "EnableSpeedingAlerts": true,
      "EnableThrottleAlerts": true,
      "EnableUnauthorisedUsageAlerts": true,
      "SoundBuzzerAlerts": true
    },
    "EEDISettings": {
      "EEDIType": "sample string 1",
      "TargetEEDIScore": 1,
      "TargetFuelConsumption": 1.1,
      "TargetFuelConsumptionUnit": 0,
      "FuelBenchmarkPeriod": {
        "StartDate": "2025-04-29T18:50:37.209938+01:00",
        "EndDate": "2025-04-29T18:50:37.209938+01:00",
        "EEDIScore": 1,
        "FuelConsumption": 1.1,
        "FuelConsumptionUnit": 0,
        "Distance": 1.1,
        "DistanceUnit": 0,
        "FuelUsed": 1.1
      }
    },
    "MiscSettings": {
      "Post2011Tacho": true,
      "InternalBatteryAlert": 1.1,
      "AutoDriverAllocation": true,
      "AutoTractorAllocation": true
    },
    "HomeCircuitID": 13
  },
  {
    "AssetID": 1,
    "AssetName": "sample string 2",
    "Registration": "sample string 3",
    "DeviceIMEI": "sample string 4",
    "Description": "sample string 5",
    "Make": "sample string 6",
    "Model": "sample string 7",
    "CircuitName": "sample string 8",
    "RegistrationDate": "2025-04-29T18:50:37.209938+01:00",
    "AssetComment": "sample string 9",
    "AssetType": "sample string 10",
    "Colour": "sample string 11",
    "CurrentOdometer": 1.1,
    "CurrentOdometerUnit": 0,
    "TelephoneNumber": "sample string 12",
    "ServiceSchedule": {
      "LastServiceDistance": 1.1,
      "LastServiceDistanceUnit": 0,
      "ServiceIntervalDistance": 1.1,
      "ServiceIntervalDistanceUnit": 0,
      "ServiceIntervalWeeks": 1
    },
    "SupaTrakSettings": {
      "AccelerationThreshold": 1.1,
      "BrakingThreshold": 1.1,
      "CorneringThreshold": 1.1,
      "SpeedThreshold": 1.1,
      "SpeedThresholdUnit": 0,
      "IdleThreshold": 1,
      "CrashLogThreshold": 1.1
    },
    "EcoTrakSettings": {
      "CANbusProtocol": 0,
      "FuelType": 0,
      "FuelTankCapacity": 1,
      "FuelTankAlert": 1.1,
      "GreenBandStart": 1,
      "GreenBandEnd": 1,
      "PTORPMStart": 1,
      "PTORPMEnd": 1,
      "OverRevvingAlertDelay": 1,
      "EngineLoadThreshold": 1,
      "OverRevvingAlert": 1,
      "ThrottleAlert": 1,
      "UseCANbusWheelSpeed": true,
      "UsePTORevRange": true
    },
    "SDASettings": {
      "SDAInstalled": true,
      "SDAEnabled": true,
      "EnableHArshAccelerationAlerts": true,
      "EnableHarshBrakingAlerts": true,
      "EnableHarshCorneringAlerts": true,
      "EnableIdlingAlerts": true,
      "EnableOverRevvingAlerts": true,
      "EnableSpeedingAlerts": true,
      "EnableThrottleAlerts": true,
      "EnableUnauthorisedUsageAlerts": true,
      "SoundBuzzerAlerts": true
    },
    "EEDISettings": {
      "EEDIType": "sample string 1",
      "TargetEEDIScore": 1,
      "TargetFuelConsumption": 1.1,
      "TargetFuelConsumptionUnit": 0,
      "FuelBenchmarkPeriod": {
        "StartDate": "2025-04-29T18:50:37.209938+01:00",
        "EndDate": "2025-04-29T18:50:37.209938+01:00",
        "EEDIScore": 1,
        "FuelConsumption": 1.1,
        "FuelConsumptionUnit": 0,
        "Distance": 1.1,
        "DistanceUnit": 0,
        "FuelUsed": 1.1
      }
    },
    "MiscSettings": {
      "Post2011Tacho": true,
      "InternalBatteryAlert": 1.1,
      "AutoDriverAllocation": true,
      "AutoTractorAllocation": true
    },
    "HomeCircuitID": 13
  }
]

application/xml, text/xml

Sample:

<ArrayOfAsset xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Asset>
    <AssetID>1</AssetID>
    <AssetName>sample string 2</AssetName>
    <Registration>sample string 3</Registration>
    <DeviceIMEI>sample string 4</DeviceIMEI>
    <Description>sample string 5</Description>
    <Make>sample string 6</Make>
    <Model>sample string 7</Model>
    <CircuitName>sample string 8</CircuitName>
    <RegistrationDate>2025-04-29T18:50:37.209938+01:00</RegistrationDate>
    <AssetComment>sample string 9</AssetComment>
    <AssetType>sample string 10</AssetType>
    <Colour>sample string 11</Colour>
    <CurrentOdometer>1.1</CurrentOdometer>
    <CurrentOdometerUnit>Miles</CurrentOdometerUnit>
    <TelephoneNumber>sample string 12</TelephoneNumber>
    <ServiceSchedule>
      <LastServiceDistance>1.1</LastServiceDistance>
      <LastServiceDistanceUnit>Miles</LastServiceDistanceUnit>
      <ServiceIntervalDistance>1.1</ServiceIntervalDistance>
      <ServiceIntervalDistanceUnit>Miles</ServiceIntervalDistanceUnit>
      <ServiceIntervalWeeks>1</ServiceIntervalWeeks>
    </ServiceSchedule>
    <SupaTrakSettings>
      <AccelerationThreshold>1.1</AccelerationThreshold>
      <BrakingThreshold>1.1</BrakingThreshold>
      <CorneringThreshold>1.1</CorneringThreshold>
      <SpeedThreshold>1.1</SpeedThreshold>
      <SpeedThresholdUnit>MPH</SpeedThresholdUnit>
      <IdleThreshold>1</IdleThreshold>
      <CrashLogThreshold>1.1</CrashLogThreshold>
    </SupaTrakSettings>
    <EcoTrakSettings>
      <CANbusProtocol>J1939</CANbusProtocol>
      <FuelType>Petrol</FuelType>
      <FuelTankCapacity>1</FuelTankCapacity>
      <FuelTankAlert>1.1</FuelTankAlert>
      <GreenBandStart>1</GreenBandStart>
      <GreenBandEnd>1</GreenBandEnd>
      <PTORPMStart>1</PTORPMStart>
      <PTORPMEnd>1</PTORPMEnd>
      <OverRevvingAlertDelay>1</OverRevvingAlertDelay>
      <EngineLoadThreshold>1</EngineLoadThreshold>
      <OverRevvingAlert>1</OverRevvingAlert>
      <ThrottleAlert>1</ThrottleAlert>
      <UseCANbusWheelSpeed>true</UseCANbusWheelSpeed>
      <UsePTORevRange>true</UsePTORevRange>
    </EcoTrakSettings>
    <SDASettings>
      <SDAInstalled>true</SDAInstalled>
      <SDAEnabled>true</SDAEnabled>
      <EnableHArshAccelerationAlerts>true</EnableHArshAccelerationAlerts>
      <EnableHarshBrakingAlerts>true</EnableHarshBrakingAlerts>
      <EnableHarshCorneringAlerts>true</EnableHarshCorneringAlerts>
      <EnableIdlingAlerts>true</EnableIdlingAlerts>
      <EnableOverRevvingAlerts>true</EnableOverRevvingAlerts>
      <EnableSpeedingAlerts>true</EnableSpeedingAlerts>
      <EnableThrottleAlerts>true</EnableThrottleAlerts>
      <EnableUnauthorisedUsageAlerts>true</EnableUnauthorisedUsageAlerts>
      <SoundBuzzerAlerts>true</SoundBuzzerAlerts>
    </SDASettings>
    <EEDISettings>
      <EEDIType>sample string 1</EEDIType>
      <TargetEEDIScore>1</TargetEEDIScore>
      <TargetFuelConsumption>1.1</TargetFuelConsumption>
      <TargetFuelConsumptionUnit>MPG</TargetFuelConsumptionUnit>
      <FuelBenchmarkPeriod>
        <StartDate>2025-04-29T18:50:37.209938+01:00</StartDate>
        <EndDate>2025-04-29T18:50:37.209938+01:00</EndDate>
        <EEDIScore>1</EEDIScore>
        <FuelConsumption>1.1</FuelConsumption>
        <FuelConsumptionUnit>MPG</FuelConsumptionUnit>
        <Distance>1.1</Distance>
        <DistanceUnit>Miles</DistanceUnit>
        <FuelUsed>1.1</FuelUsed>
      </FuelBenchmarkPeriod>
    </EEDISettings>
    <MiscSettings>
      <Post2011Tacho>true</Post2011Tacho>
      <InternalBatteryAlert>1.1</InternalBatteryAlert>
      <AutoDriverAllocation>true</AutoDriverAllocation>
      <AutoTractorAllocation>true</AutoTractorAllocation>
    </MiscSettings>
    <HomeCircuitID>13</HomeCircuitID>
  </Asset>
  <Asset>
    <AssetID>1</AssetID>
    <AssetName>sample string 2</AssetName>
    <Registration>sample string 3</Registration>
    <DeviceIMEI>sample string 4</DeviceIMEI>
    <Description>sample string 5</Description>
    <Make>sample string 6</Make>
    <Model>sample string 7</Model>
    <CircuitName>sample string 8</CircuitName>
    <RegistrationDate>2025-04-29T18:50:37.209938+01:00</RegistrationDate>
    <AssetComment>sample string 9</AssetComment>
    <AssetType>sample string 10</AssetType>
    <Colour>sample string 11</Colour>
    <CurrentOdometer>1.1</CurrentOdometer>
    <CurrentOdometerUnit>Miles</CurrentOdometerUnit>
    <TelephoneNumber>sample string 12</TelephoneNumber>
    <ServiceSchedule>
      <LastServiceDistance>1.1</LastServiceDistance>
      <LastServiceDistanceUnit>Miles</LastServiceDistanceUnit>
      <ServiceIntervalDistance>1.1</ServiceIntervalDistance>
      <ServiceIntervalDistanceUnit>Miles</ServiceIntervalDistanceUnit>
      <ServiceIntervalWeeks>1</ServiceIntervalWeeks>
    </ServiceSchedule>
    <SupaTrakSettings>
      <AccelerationThreshold>1.1</AccelerationThreshold>
      <BrakingThreshold>1.1</BrakingThreshold>
      <CorneringThreshold>1.1</CorneringThreshold>
      <SpeedThreshold>1.1</SpeedThreshold>
      <SpeedThresholdUnit>MPH</SpeedThresholdUnit>
      <IdleThreshold>1</IdleThreshold>
      <CrashLogThreshold>1.1</CrashLogThreshold>
    </SupaTrakSettings>
    <EcoTrakSettings>
      <CANbusProtocol>J1939</CANbusProtocol>
      <FuelType>Petrol</FuelType>
      <FuelTankCapacity>1</FuelTankCapacity>
      <FuelTankAlert>1.1</FuelTankAlert>
      <GreenBandStart>1</GreenBandStart>
      <GreenBandEnd>1</GreenBandEnd>
      <PTORPMStart>1</PTORPMStart>
      <PTORPMEnd>1</PTORPMEnd>
      <OverRevvingAlertDelay>1</OverRevvingAlertDelay>
      <EngineLoadThreshold>1</EngineLoadThreshold>
      <OverRevvingAlert>1</OverRevvingAlert>
      <ThrottleAlert>1</ThrottleAlert>
      <UseCANbusWheelSpeed>true</UseCANbusWheelSpeed>
      <UsePTORevRange>true</UsePTORevRange>
    </EcoTrakSettings>
    <SDASettings>
      <SDAInstalled>true</SDAInstalled>
      <SDAEnabled>true</SDAEnabled>
      <EnableHArshAccelerationAlerts>true</EnableHArshAccelerationAlerts>
      <EnableHarshBrakingAlerts>true</EnableHarshBrakingAlerts>
      <EnableHarshCorneringAlerts>true</EnableHarshCorneringAlerts>
      <EnableIdlingAlerts>true</EnableIdlingAlerts>
      <EnableOverRevvingAlerts>true</EnableOverRevvingAlerts>
      <EnableSpeedingAlerts>true</EnableSpeedingAlerts>
      <EnableThrottleAlerts>true</EnableThrottleAlerts>
      <EnableUnauthorisedUsageAlerts>true</EnableUnauthorisedUsageAlerts>
      <SoundBuzzerAlerts>true</SoundBuzzerAlerts>
    </SDASettings>
    <EEDISettings>
      <EEDIType>sample string 1</EEDIType>
      <TargetEEDIScore>1</TargetEEDIScore>
      <TargetFuelConsumption>1.1</TargetFuelConsumption>
      <TargetFuelConsumptionUnit>MPG</TargetFuelConsumptionUnit>
      <FuelBenchmarkPeriod>
        <StartDate>2025-04-29T18:50:37.209938+01:00</StartDate>
        <EndDate>2025-04-29T18:50:37.209938+01:00</EndDate>
        <EEDIScore>1</EEDIScore>
        <FuelConsumption>1.1</FuelConsumption>
        <FuelConsumptionUnit>MPG</FuelConsumptionUnit>
        <Distance>1.1</Distance>
        <DistanceUnit>Miles</DistanceUnit>
        <FuelUsed>1.1</FuelUsed>
      </FuelBenchmarkPeriod>
    </EEDISettings>
    <MiscSettings>
      <Post2011Tacho>true</Post2011Tacho>
      <InternalBatteryAlert>1.1</InternalBatteryAlert>
      <AutoDriverAllocation>true</AutoDriverAllocation>
      <AutoTractorAllocation>true</AutoTractorAllocation>
    </MiscSettings>
    <HomeCircuitID>13</HomeCircuitID>
  </Asset>
</ArrayOfAsset>