GET v2/TcuSubscriptions

Get all TCUs subscriptions by the user's customer account. Returns only Active and Idle by default.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Statuses

Limits subscriptions to the supplied statuses

Collection of Lhp.EquipmentIntelligence.CustomerTcuSubscriptionStatuses

None.

ExpirationDays

Limits subscriptions to those expiring within the supplied number of days

integer

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Lhp.EquipmentIntelligence.WebApi.Models.V2.TcuSubscription.TcuSubscription
NameDescriptionTypeAdditional information
Name

The subscription name

string

None.

StartsOn

If not idle, the date on which the subcription started (formatted yyyy-MM-dd)

string

None.

ExpiresOn

The date on which the subscription expires (formatted yyyy-MM-dd)

string

None.

Status

The current status of the subscription

Lhp.EquipmentIntelligence.CustomerTcuSubscriptionStatuses

None.

TcuType

The TCU type name

string

None.

TcuImei

The TCU IMEI

string

None.

TcuLastReportedOn

The date/time the TCU last reported

date

None.

AssetName

The name of the asset on which the TCU is installed

string

None.

AssetVin

The VIN of the asset on which the TCU is installed

string

None.

AssetSerialNumber

The Serial Number of the asset on which the TCU is installed

string

None.

AssetOwner

The current owner of the asset on which the TCU is installed

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Name": "sample string 1",
    "StartsOn": "sample string 2",
    "ExpiresOn": "sample string 3",
    "Status": "None",
    "TcuType": "sample string 4",
    "TcuImei": "sample string 5",
    "TcuLastReportedOn": "2024-07-12T03:13:06.3084954+00:00",
    "AssetName": "sample string 6",
    "AssetVin": "sample string 7",
    "AssetSerialNumber": "sample string 8",
    "AssetOwner": "sample string 9"
  },
  {
    "Name": "sample string 1",
    "StartsOn": "sample string 2",
    "ExpiresOn": "sample string 3",
    "Status": "None",
    "TcuType": "sample string 4",
    "TcuImei": "sample string 5",
    "TcuLastReportedOn": "2024-07-12T03:13:06.3084954+00:00",
    "AssetName": "sample string 6",
    "AssetVin": "sample string 7",
    "AssetSerialNumber": "sample string 8",
    "AssetOwner": "sample string 9"
  }
]

application/xml, text/xml

Sample:
<ArrayOfTcuSubscription xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <TcuSubscription>
    <Name>sample string 1</Name>
    <StartsOn>sample string 2</StartsOn>
    <ExpiresOn>sample string 3</ExpiresOn>
    <Status>None</Status>
    <TcuType>sample string 4</TcuType>
    <TcuImei>sample string 5</TcuImei>
    <TcuLastReportedOn>2024-07-12T03:13:06.3084954+00:00</TcuLastReportedOn>
    <AssetName>sample string 6</AssetName>
    <AssetVin>sample string 7</AssetVin>
    <AssetSerialNumber>sample string 8</AssetSerialNumber>
    <AssetOwner>sample string 9</AssetOwner>
  </TcuSubscription>
  <TcuSubscription>
    <Name>sample string 1</Name>
    <StartsOn>sample string 2</StartsOn>
    <ExpiresOn>sample string 3</ExpiresOn>
    <Status>None</Status>
    <TcuType>sample string 4</TcuType>
    <TcuImei>sample string 5</TcuImei>
    <TcuLastReportedOn>2024-07-12T03:13:06.3084954+00:00</TcuLastReportedOn>
    <AssetName>sample string 6</AssetName>
    <AssetVin>sample string 7</AssetVin>
    <AssetSerialNumber>sample string 8</AssetSerialNumber>
    <AssetOwner>sample string 9</AssetOwner>
  </TcuSubscription>
</ArrayOfTcuSubscription>