GET api/v4/asset?userID={userID}&token={token}&assetID={assetID}&groupID={groupID}

Get a list of assets by asset id or by group id

Request Information

URI Parameters

Name	Description	Type	Additional information
userID	The user id being used for authentication	unsigned integer	Required
token	The token being used for authentication	string	Required
assetID	The asset id being searched for. Asset id takes priority over group id	unsigned integer	Default value is 0
groupID	The group id being used in an asset search. Asset id takes priority over group id	unsigned integer	Default value is 0

Body Parameters

None.

Response Information

Resource Description

A list of assets

Collection of Asset

Name	Description	Type	Additional information
ID	The unique asset id	unsigned integer	None.
TagID	The tag ID number	string	None.
SiteCode	The site code of the asset	string	None.
UserID	The user ID who owns the asset	unsigned integer	None.
Type	The type of the asset	AssetType	None.
Icon	The icon used for the asset	string	None.
Name	The name of the asset	string	None.
FirstName	The first name of the person using the asset	string	None.
LastName	The last name of the person using the asset	string	None.
Address1	The address line 1 of the person using the asset	string	None.
Address2	The address line 2 of the person using the asset	string	None.
Address3	The address line 3 of the person using the asset	string	None.
Town	The town of the person using the asset	string	None.
Postcode	The post code of the person using the asset	string	None.
Phone	The phone number of the person using the asset	string	None.
Mobile	The mobile phone number of the person using the asset	string	None.
Email	The email of the person using the asset	string	None.
MinTempThreshold	A minimum temperature threshold used if the asset is a temperature sensor	decimal number	None.
MaxTempThreshold	A maximum temperature threshold used if the asset is a temperature sensor	decimal number	None.
WeekdayAuthStart	Authorised times	string	None.
WeekdayAuthEnd	Authorised times	string	None.
WeekendAuthStart	Authorised times	string	None.
WeekendAuthEnd	Authorised times	string	None.
DespatchLoginPassword	Unused	string	None.
DespatchNotAcceptingJobs	Unused	boolean	None.
DespatchSinbinInterval	Unused	integer	None.
DespatchSinbinEndTime	Unused	date	None.
DespatchAcceptContactJobs	Unused	boolean	None.
Temperature	The current temperature if the asset is a temperature sensor	decimal number	None.
GPSPosition	The last GPS position of the asset	Position	None.
GPSTime	The last GPS position of the asset	date	None.
GeoStreet	The last street the asset was located on	string	None.
GeoTown	The last town the asset was located on	string	None.
GeoCountry	The last country the asset was located on	string	None.
GeoPostcode	The last post code the asset was located on	string	None.
Log	Log information from the asset	string	None.
Username		string	None.
Password		string	None.
TelTyrePressure		decimal number	None.
TelTyreStatus		integer	None.
TyreSensorVehicleLocation		integer	None.
TyreSensorPosition		integer	None.
AppType	App Type Driive or Productiv for now	integer	None.
DynamicsId		string	None.
IsGreyFleet		boolean	None.
IsDriiveAcademy		boolean	None.
AssignProfiler		boolean	None.
hasValidUkDrivingLicence		boolean	None.
ArchivedDate		date	None.
LinkedAssetId		unsigned integer	None.
PayrollNumber		string	None.
DriverLicenceNumber		string	None.
BrandingId		integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "tag_id": "sample string 2",
    "site_code": "sample string 3",
    "type": {
      "id": 1,
      "name": "sample string 2"
    },
    "user_id": 4,
    "icon": "sample string 5",
    "name": "sample string 6",
    "first_name": "sample string 7",
    "last_name": "sample string 8",
    "address_1": "sample string 9",
    "address_2": "sample string 10",
    "address_3": "sample string 11",
    "address_town": "sample string 12",
    "postcode": "sample string 13",
    "phone": "14",
    "mobile": "15",
    "email": "sample string 16",
    "min_temp_threshold": 17.1,
    "max_temp_threshold": 18.1,
    "weekday_auth_start": "sample string 19",
    "weekday_auth_end": "sample string 20",
    "weekend_auth_start": "sample string 21",
    "weekend_auth_end": "sample string 22",
    "despatch_login_password": "sample string 23",
    "despatch_not_accepting_jobs": true,
    "despatch_sinbin_interval": 25,
    "despatch_sinbin_end_time": "2025-04-27T15:54:48.5874463+00:00",
    "despatch_accept_contract_jobs": true,
    "tel_temperature": 28.1,
    "gps_position": {
      "_latitude": {
        "_element": 120.32113697747289
      },
      "_longitude": {
        "_element": 120.32113697747289
      },
      "_foLat": {
        "_element": 49.0
      },
      "_foLong": {
        "_element": -2.0
      },
      "_af0": 6375585.7452000007,
      "_bf0": 6354209.61327432
    },
    "gps_time": "2025-04-27T15:54:48.5874463+00:00",
    "geo_street": "sample string 30",
    "geo_town": "sample string 31",
    "geo_country": "sample string 32",
    "geo_postcode": "sample string 33",
    "log": "sample string 34",
    "<Username>k__BackingField": "sample string 35",
    "<Password>k__BackingField": "sample string 36",
    "<TelTyrePressure>k__BackingField": 37.1,
    "<TelTyreStatus>k__BackingField": 38,
    "<TyreSensorVehicleLocation>k__BackingField": 39,
    "<TyreSensorPosition>k__BackingField": 40,
    "<AppType>k__BackingField": 41,
    "<DynamicsId>k__BackingField": "sample string 42",
    "<IsGreyFleet>k__BackingField": true,
    "<IsDriiveAcademy>k__BackingField": true,
    "<AssignProfiler>k__BackingField": true,
    "<hasValidUkDrivingLicence>k__BackingField": true,
    "<ArchivedDate>k__BackingField": "2025-04-27T15:54:48.5874463+00:00",
    "<LinkedAssetId>k__BackingField": 48,
    "<PayrollNumber>k__BackingField": "sample string 49",
    "<DriverLicenceNumber>k__BackingField": "sample string 50",
    "<BrandingId>k__BackingField": 51
  },
  {
    "id": 1,
    "tag_id": "sample string 2",
    "site_code": "sample string 3",
    "type": {
      "id": 1,
      "name": "sample string 2"
    },
    "user_id": 4,
    "icon": "sample string 5",
    "name": "sample string 6",
    "first_name": "sample string 7",
    "last_name": "sample string 8",
    "address_1": "sample string 9",
    "address_2": "sample string 10",
    "address_3": "sample string 11",
    "address_town": "sample string 12",
    "postcode": "sample string 13",
    "phone": "14",
    "mobile": "15",
    "email": "sample string 16",
    "min_temp_threshold": 17.1,
    "max_temp_threshold": 18.1,
    "weekday_auth_start": "sample string 19",
    "weekday_auth_end": "sample string 20",
    "weekend_auth_start": "sample string 21",
    "weekend_auth_end": "sample string 22",
    "despatch_login_password": "sample string 23",
    "despatch_not_accepting_jobs": true,
    "despatch_sinbin_interval": 25,
    "despatch_sinbin_end_time": "2025-04-27T15:54:48.5874463+00:00",
    "despatch_accept_contract_jobs": true,
    "tel_temperature": 28.1,
    "gps_position": {
      "_latitude": {
        "_element": 120.32113697747289
      },
      "_longitude": {
        "_element": 120.32113697747289
      },
      "_foLat": {
        "_element": 49.0
      },
      "_foLong": {
        "_element": -2.0
      },
      "_af0": 6375585.7452000007,
      "_bf0": 6354209.61327432
    },
    "gps_time": "2025-04-27T15:54:48.5874463+00:00",
    "geo_street": "sample string 30",
    "geo_town": "sample string 31",
    "geo_country": "sample string 32",
    "geo_postcode": "sample string 33",
    "log": "sample string 34",
    "<Username>k__BackingField": "sample string 35",
    "<Password>k__BackingField": "sample string 36",
    "<TelTyrePressure>k__BackingField": 37.1,
    "<TelTyreStatus>k__BackingField": 38,
    "<TyreSensorVehicleLocation>k__BackingField": 39,
    "<TyreSensorPosition>k__BackingField": 40,
    "<AppType>k__BackingField": 41,
    "<DynamicsId>k__BackingField": "sample string 42",
    "<IsGreyFleet>k__BackingField": true,
    "<IsDriiveAcademy>k__BackingField": true,
    "<AssignProfiler>k__BackingField": true,
    "<hasValidUkDrivingLicence>k__BackingField": true,
    "<ArchivedDate>k__BackingField": "2025-04-27T15:54:48.5874463+00:00",
    "<LinkedAssetId>k__BackingField": 48,
    "<PayrollNumber>k__BackingField": "sample string 49",
    "<DriverLicenceNumber>k__BackingField": "sample string 50",
    "<BrandingId>k__BackingField": 51
  }
]

application/xml, text/xml

Sample:

<ArrayOfAsset xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Asset>
    <ID>1</ID>
    <TagID>sample string 2</TagID>
    <SiteCode>sample string 3</SiteCode>
    <UserID>4</UserID>
    <Type>
      <ID>1</ID>
      <Name>sample string 2</Name>
    </Type>
    <Icon>sample string 5</Icon>
    <Name>sample string 6</Name>
    <FirstName>sample string 7</FirstName>
    <LastName>sample string 8</LastName>
    <Address1>sample string 9</Address1>
    <Address2>sample string 10</Address2>
    <Address3>sample string 11</Address3>
    <Town>sample string 12</Town>
    <Postcode>sample string 13</Postcode>
    <Phone>14</Phone>
    <Mobile>15</Mobile>
    <Email>sample string 16</Email>
    <MinTempThreshold>17.1</MinTempThreshold>
    <MaxTempThreshold>18.1</MaxTempThreshold>
    <WeekdayAuthStart>sample string 19</WeekdayAuthStart>
    <WeekdayAuthEnd>sample string 20</WeekdayAuthEnd>
    <WeekendAuthStart>sample string 21</WeekendAuthStart>
    <WeekendAuthEnd>sample string 22</WeekendAuthEnd>
    <DespatchLoginPassword>sample string 23</DespatchLoginPassword>
    <DespatchNotAcceptingJobs>true</DespatchNotAcceptingJobs>
    <DespatchSinbinInterval>25</DespatchSinbinInterval>
    <DespatchSinbinEndTime>2025-04-27T15:54:48.5874463+00:00</DespatchSinbinEndTime>
    <DespatchAcceptContactJobs>true</DespatchAcceptContactJobs>
    <Temperature>28.1</Temperature>
    <GPSPosition>
      <Longitude>
        <Degrees>120.32113697747289</Degrees>
        <Radians>2.1</Radians>
      </Longitude>
      <Latitude>
        <Degrees>120.32113697747289</Degrees>
        <Radians>2.1</Radians>
      </Latitude>
    </GPSPosition>
    <GPSTime>2025-04-27T15:54:48.5874463+00:00</GPSTime>
    <GeoStreet>sample string 30</GeoStreet>
    <GeoTown>sample string 31</GeoTown>
    <GeoCountry>sample string 32</GeoCountry>
    <GeoPostcode>sample string 33</GeoPostcode>
    <Log>sample string 34</Log>
    <Username>sample string 35</Username>
    <Password>sample string 36</Password>
    <TelTyrePressure>37.1</TelTyrePressure>
    <TelTyreStatus>38</TelTyreStatus>
    <TyreSensorVehicleLocation>39</TyreSensorVehicleLocation>
    <TyreSensorPosition>40</TyreSensorPosition>
    <AppType>41</AppType>
    <DynamicsId>sample string 42</DynamicsId>
    <IsGreyFleet>true</IsGreyFleet>
    <IsDriiveAcademy>true</IsDriiveAcademy>
    <AssignProfiler>true</AssignProfiler>
    <hasValidUkDrivingLicence>true</hasValidUkDrivingLicence>
    <ArchivedDate>2025-04-27T15:54:48.5874463+00:00</ArchivedDate>
    <LinkedAssetId>48</LinkedAssetId>
    <PayrollNumber>sample string 49</PayrollNumber>
    <DriverLicenceNumber>sample string 50</DriverLicenceNumber>
    <BrandingId>51</BrandingId>
  </Asset>
  <Asset>
    <ID>1</ID>
    <TagID>sample string 2</TagID>
    <SiteCode>sample string 3</SiteCode>
    <UserID>4</UserID>
    <Type>
      <ID>1</ID>
      <Name>sample string 2</Name>
    </Type>
    <Icon>sample string 5</Icon>
    <Name>sample string 6</Name>
    <FirstName>sample string 7</FirstName>
    <LastName>sample string 8</LastName>
    <Address1>sample string 9</Address1>
    <Address2>sample string 10</Address2>
    <Address3>sample string 11</Address3>
    <Town>sample string 12</Town>
    <Postcode>sample string 13</Postcode>
    <Phone>14</Phone>
    <Mobile>15</Mobile>
    <Email>sample string 16</Email>
    <MinTempThreshold>17.1</MinTempThreshold>
    <MaxTempThreshold>18.1</MaxTempThreshold>
    <WeekdayAuthStart>sample string 19</WeekdayAuthStart>
    <WeekdayAuthEnd>sample string 20</WeekdayAuthEnd>
    <WeekendAuthStart>sample string 21</WeekendAuthStart>
    <WeekendAuthEnd>sample string 22</WeekendAuthEnd>
    <DespatchLoginPassword>sample string 23</DespatchLoginPassword>
    <DespatchNotAcceptingJobs>true</DespatchNotAcceptingJobs>
    <DespatchSinbinInterval>25</DespatchSinbinInterval>
    <DespatchSinbinEndTime>2025-04-27T15:54:48.5874463+00:00</DespatchSinbinEndTime>
    <DespatchAcceptContactJobs>true</DespatchAcceptContactJobs>
    <Temperature>28.1</Temperature>
    <GPSPosition>
      <Longitude>
        <Degrees>120.32113697747289</Degrees>
        <Radians>2.1</Radians>
      </Longitude>
      <Latitude>
        <Degrees>120.32113697747289</Degrees>
        <Radians>2.1</Radians>
      </Latitude>
    </GPSPosition>
    <GPSTime>2025-04-27T15:54:48.5874463+00:00</GPSTime>
    <GeoStreet>sample string 30</GeoStreet>
    <GeoTown>sample string 31</GeoTown>
    <GeoCountry>sample string 32</GeoCountry>
    <GeoPostcode>sample string 33</GeoPostcode>
    <Log>sample string 34</Log>
    <Username>sample string 35</Username>
    <Password>sample string 36</Password>
    <TelTyrePressure>37.1</TelTyrePressure>
    <TelTyreStatus>38</TelTyreStatus>
    <TyreSensorVehicleLocation>39</TyreSensorVehicleLocation>
    <TyreSensorPosition>40</TyreSensorPosition>
    <AppType>41</AppType>
    <DynamicsId>sample string 42</DynamicsId>
    <IsGreyFleet>true</IsGreyFleet>
    <IsDriiveAcademy>true</IsDriiveAcademy>
    <AssignProfiler>true</AssignProfiler>
    <hasValidUkDrivingLicence>true</hasValidUkDrivingLicence>
    <ArchivedDate>2025-04-27T15:54:48.5874463+00:00</ArchivedDate>
    <LinkedAssetId>48</LinkedAssetId>
    <PayrollNumber>sample string 49</PayrollNumber>
    <DriverLicenceNumber>sample string 50</DriverLicenceNumber>
    <BrandingId>51</BrandingId>
  </Asset>
</ArrayOfAsset>