GET api/S1Units/Search?searchPhrase={searchPhrase}&count={count}

DEPRECATED - use ~/Search/Units endpoint. Returns S1 units matching the specified searchphrase, including units in child groups. This search is slow, but returns a lot of information. Limit: This request can only be made 3 times per minute.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
searchPhrase

must be at least 1 character

string

Required

count

(optional)Maximum number of results to return (default 25)

integer32

Default value is 25

Body Parameters

None.

Response Information

Resource Description

DEPRECATED - use ~/Search/Units endpoint. Returns S1 units matching the specified searchphrase, including units in child groups. This search is slow, but returns a lot of information. Limit: This request can only be made 3 times per minute.

Collection of S1UnitModel
NameDescriptionTypeAdditional information
SerialNumber

Read Only

string

Required

UnitName

string

String length: inclusive between 1 and 50

IntervalSeconds

Wakeup interval.

integer32

Null values possible.

Range: inclusive between 1800 and 86400

UnitConfiguredIntervalSeconds

Read Only. Wakeup interval currently configured in the unit. May differ from Wakeup interval if a configuration is pending. Can be used to determine when a unit configuration is scheduled to take place.

integer32

Null values possible.

Range: inclusive between 1800 and 172800

RFIDBeaconOn

boolean

Null values possible.

FirstReportHour

Hour of first report in UTC

byte

Null values possible.

Range: inclusive between 0 and 23

FirstGPSHour

Hour of first GPS fix in UTC

byte

Null values possible.

Range: inclusive between 0 and 23

GPSIntervalSeconds

GPS fix interval.

integer32

Null values possible.

Range: inclusive between 1800 and 86400

ConfigurationPending

Read Only. Indicates if unit has pending configuration changes, not yet submitted to the device

boolean

Null values possible.

UnitTypeId

Read Only.

integer32

Null values possible.

UnitTypeName

Read Only. Unit type (ie. T7, T9, etc.)

string

None.

ReferenceId

string

None.

Closed

Unit is closed

boolean

None.

RequestedClosed

The unit has been requested closed

boolean

None.

Suspended

The unit has been suspended by Trusted A/S because of non-payment. All access to data has been revoked until any outstanding issues have been resolved.

boolean

Null values possible.

FirmwareVersion

Unit firmware version

decimal number

None.

DeliveryDate

Delivery date (if available)

date

Null values possible.

BatteryInstalledDate

date

Null values possible.

RFIDBeaconOnSeconds

Number of seconds with RFID beacon turned on

integer32

None.

UserGroupId

integer32

Null values possible.

UserGroupName

string

None.

ReplacedBySerialnumber

Unit is replaced by this serialnumber, if any

string

None.

ReplacingSerialnumber

Unit is replacing this serialnumber, if any

string

None.

S1CInputSettings

S1C Input settings (only available for S1C units)

S1CInputSettings

None.

CurrentSubscription

Read Only. The current subscription (Trusted Basic, Trusted Vision, Trusted Premium, Trusted S1).

string

None.

CurrentSubscriptionStartDate

Read Only. Start date of current subscription (if available).

date

Null values possible.

CurrentSubscriptionEndDate

Read Only. End date of current subscription (if available).

date

Null values possible.

TAASCommitmentStartDate

Read Only. Start date of current Trusted as-a-service commitment (if applicable).

date

Null values possible.

TAASCommitmentEndDate

Read Only. End date of current Trusted as-a-service commitment (if applicable).

date

Null values possible.

Response Formats

application/json, text/json

Sample:
[
  {
    "SerialNumber": "sample string 1",
    "UnitName": "sample string 2",
    "IntervalSeconds": 1,
    "UnitConfiguredIntervalSeconds": 1,
    "RFIDBeaconOn": true,
    "FirstReportHour": 64,
    "FirstGPSHour": 64,
    "GPSIntervalSeconds": 1,
    "ConfigurationPending": true,
    "UnitTypeId": 1,
    "UnitTypeName": "sample string 3",
    "ReferenceId": "sample string 4",
    "Closed": true,
    "RequestedClosed": true,
    "Suspended": true,
    "FirmwareVersion": 7.1,
    "DeliveryDate": "2024-11-21T09:58:13.5647226+00:00",
    "BatteryInstalledDate": "2024-11-21T09:58:13.5647226+00:00",
    "RFIDBeaconOnSeconds": 8,
    "UserGroupId": 1,
    "UserGroupName": "sample string 9",
    "ReplacedBySerialnumber": "sample string 10",
    "ReplacingSerialnumber": "sample string 11",
    "S1CInputSettings": {
      "ReadIntervalMinutes": 1,
      "Input0": {
        "Low": 1,
        "High": 2,
        "GPSTrigger": true,
        "ReportTrigger": true
      },
      "Input1": {
        "Low": 1,
        "High": 2,
        "GPSTrigger": true,
        "ReportTrigger": true
      },
      "Input2": {
        "Low": 1,
        "High": 2,
        "GPSTrigger": true,
        "ReportTrigger": true
      },
      "Input3": {
        "Low": 1,
        "High": 2,
        "GPSTrigger": true,
        "ReportTrigger": true
      },
      "Load0": {
        "Low": 1,
        "High": 2,
        "GPSTrigger": true,
        "ReportTrigger": true
      },
      "Load1": {
        "Low": 1,
        "High": 2,
        "GPSTrigger": true,
        "ReportTrigger": true
      },
      "Load0b": {
        "Low": 1,
        "High": 2,
        "GPSTrigger": true,
        "ReportTrigger": true
      },
      "Load1b": {
        "Low": 1,
        "High": 2,
        "GPSTrigger": true,
        "ReportTrigger": true
      }
    },
    "CurrentSubscription": "sample string 12",
    "CurrentSubscriptionStartDate": "2024-11-21T09:58:13.5647226+00:00",
    "CurrentSubscriptionEndDate": "2024-11-21T09:58:13.5647226+00:00",
    "TAASCommitmentStartDate": "2024-11-21T09:58:13.5647226+00:00",
    "TAASCommitmentEndDate": "2024-11-21T09:58:13.5647226+00:00"
  },
  {
    "SerialNumber": "sample string 1",
    "UnitName": "sample string 2",
    "IntervalSeconds": 1,
    "UnitConfiguredIntervalSeconds": 1,
    "RFIDBeaconOn": true,
    "FirstReportHour": 64,
    "FirstGPSHour": 64,
    "GPSIntervalSeconds": 1,
    "ConfigurationPending": true,
    "UnitTypeId": 1,
    "UnitTypeName": "sample string 3",
    "ReferenceId": "sample string 4",
    "Closed": true,
    "RequestedClosed": true,
    "Suspended": true,
    "FirmwareVersion": 7.1,
    "DeliveryDate": "2024-11-21T09:58:13.5647226+00:00",
    "BatteryInstalledDate": "2024-11-21T09:58:13.5647226+00:00",
    "RFIDBeaconOnSeconds": 8,
    "UserGroupId": 1,
    "UserGroupName": "sample string 9",
    "ReplacedBySerialnumber": "sample string 10",
    "ReplacingSerialnumber": "sample string 11",
    "S1CInputSettings": {
      "ReadIntervalMinutes": 1,
      "Input0": {
        "Low": 1,
        "High": 2,
        "GPSTrigger": true,
        "ReportTrigger": true
      },
      "Input1": {
        "Low": 1,
        "High": 2,
        "GPSTrigger": true,
        "ReportTrigger": true
      },
      "Input2": {
        "Low": 1,
        "High": 2,
        "GPSTrigger": true,
        "ReportTrigger": true
      },
      "Input3": {
        "Low": 1,
        "High": 2,
        "GPSTrigger": true,
        "ReportTrigger": true
      },
      "Load0": {
        "Low": 1,
        "High": 2,
        "GPSTrigger": true,
        "ReportTrigger": true
      },
      "Load1": {
        "Low": 1,
        "High": 2,
        "GPSTrigger": true,
        "ReportTrigger": true
      },
      "Load0b": {
        "Low": 1,
        "High": 2,
        "GPSTrigger": true,
        "ReportTrigger": true
      },
      "Load1b": {
        "Low": 1,
        "High": 2,
        "GPSTrigger": true,
        "ReportTrigger": true
      }
    },
    "CurrentSubscription": "sample string 12",
    "CurrentSubscriptionStartDate": "2024-11-21T09:58:13.5647226+00:00",
    "CurrentSubscriptionEndDate": "2024-11-21T09:58:13.5647226+00:00",
    "TAASCommitmentStartDate": "2024-11-21T09:58:13.5647226+00:00",
    "TAASCommitmentEndDate": "2024-11-21T09:58:13.5647226+00:00"
  }
]

application/xml, text/xml

Sample:
<ArrayOfS1UnitModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Models">
  <S1UnitModel>
    <BatteryInstalledDate>2024-11-21T09:58:13.5647226+00:00</BatteryInstalledDate>
    <Closed>true</Closed>
    <ConfigurationPending>true</ConfigurationPending>
    <CurrentSubscription>sample string 12</CurrentSubscription>
    <CurrentSubscriptionEndDate>2024-11-21T09:58:13.5647226+00:00</CurrentSubscriptionEndDate>
    <CurrentSubscriptionStartDate>2024-11-21T09:58:13.5647226+00:00</CurrentSubscriptionStartDate>
    <DeliveryDate>2024-11-21T09:58:13.5647226+00:00</DeliveryDate>
    <FirmwareVersion>7.1</FirmwareVersion>
    <FirstGPSHour>64</FirstGPSHour>
    <FirstReportHour>64</FirstReportHour>
    <GPSIntervalSeconds>1</GPSIntervalSeconds>
    <IntervalSeconds>1</IntervalSeconds>
    <RFIDBeaconOn>true</RFIDBeaconOn>
    <RFIDBeaconOnSeconds>8</RFIDBeaconOnSeconds>
    <ReferenceId>sample string 4</ReferenceId>
    <ReplacedBySerialnumber>sample string 10</ReplacedBySerialnumber>
    <ReplacingSerialnumber>sample string 11</ReplacingSerialnumber>
    <RequestedClosed>true</RequestedClosed>
    <S1CInputSettings>
      <Input0>
        <GPSTrigger>true</GPSTrigger>
        <High>2</High>
        <Low>1</Low>
        <ReportTrigger>true</ReportTrigger>
      </Input0>
      <Input1>
        <GPSTrigger>true</GPSTrigger>
        <High>2</High>
        <Low>1</Low>
        <ReportTrigger>true</ReportTrigger>
      </Input1>
      <Input2>
        <GPSTrigger>true</GPSTrigger>
        <High>2</High>
        <Low>1</Low>
        <ReportTrigger>true</ReportTrigger>
      </Input2>
      <Input3>
        <GPSTrigger>true</GPSTrigger>
        <High>2</High>
        <Low>1</Low>
        <ReportTrigger>true</ReportTrigger>
      </Input3>
      <Load0>
        <GPSTrigger>true</GPSTrigger>
        <High>2</High>
        <Low>1</Low>
        <ReportTrigger>true</ReportTrigger>
      </Load0>
      <Load0b>
        <GPSTrigger>true</GPSTrigger>
        <High>2</High>
        <Low>1</Low>
        <ReportTrigger>true</ReportTrigger>
      </Load0b>
      <Load1>
        <GPSTrigger>true</GPSTrigger>
        <High>2</High>
        <Low>1</Low>
        <ReportTrigger>true</ReportTrigger>
      </Load1>
      <Load1b>
        <GPSTrigger>true</GPSTrigger>
        <High>2</High>
        <Low>1</Low>
        <ReportTrigger>true</ReportTrigger>
      </Load1b>
      <ReadIntervalMinutes>1</ReadIntervalMinutes>
    </S1CInputSettings>
    <SerialNumber>sample string 1</SerialNumber>
    <Suspended>true</Suspended>
    <TAASCommitmentEndDate>2024-11-21T09:58:13.5647226+00:00</TAASCommitmentEndDate>
    <TAASCommitmentStartDate>2024-11-21T09:58:13.5647226+00:00</TAASCommitmentStartDate>
    <UnitConfiguredIntervalSeconds>1</UnitConfiguredIntervalSeconds>
    <UnitName>sample string 2</UnitName>
    <UnitTypeId>1</UnitTypeId>
    <UnitTypeName>sample string 3</UnitTypeName>
    <UserGroupId>1</UserGroupId>
    <UserGroupName>sample string 9</UserGroupName>
  </S1UnitModel>
  <S1UnitModel>
    <BatteryInstalledDate>2024-11-21T09:58:13.5647226+00:00</BatteryInstalledDate>
    <Closed>true</Closed>
    <ConfigurationPending>true</ConfigurationPending>
    <CurrentSubscription>sample string 12</CurrentSubscription>
    <CurrentSubscriptionEndDate>2024-11-21T09:58:13.5647226+00:00</CurrentSubscriptionEndDate>
    <CurrentSubscriptionStartDate>2024-11-21T09:58:13.5647226+00:00</CurrentSubscriptionStartDate>
    <DeliveryDate>2024-11-21T09:58:13.5647226+00:00</DeliveryDate>
    <FirmwareVersion>7.1</FirmwareVersion>
    <FirstGPSHour>64</FirstGPSHour>
    <FirstReportHour>64</FirstReportHour>
    <GPSIntervalSeconds>1</GPSIntervalSeconds>
    <IntervalSeconds>1</IntervalSeconds>
    <RFIDBeaconOn>true</RFIDBeaconOn>
    <RFIDBeaconOnSeconds>8</RFIDBeaconOnSeconds>
    <ReferenceId>sample string 4</ReferenceId>
    <ReplacedBySerialnumber>sample string 10</ReplacedBySerialnumber>
    <ReplacingSerialnumber>sample string 11</ReplacingSerialnumber>
    <RequestedClosed>true</RequestedClosed>
    <S1CInputSettings>
      <Input0>
        <GPSTrigger>true</GPSTrigger>
        <High>2</High>
        <Low>1</Low>
        <ReportTrigger>true</ReportTrigger>
      </Input0>
      <Input1>
        <GPSTrigger>true</GPSTrigger>
        <High>2</High>
        <Low>1</Low>
        <ReportTrigger>true</ReportTrigger>
      </Input1>
      <Input2>
        <GPSTrigger>true</GPSTrigger>
        <High>2</High>
        <Low>1</Low>
        <ReportTrigger>true</ReportTrigger>
      </Input2>
      <Input3>
        <GPSTrigger>true</GPSTrigger>
        <High>2</High>
        <Low>1</Low>
        <ReportTrigger>true</ReportTrigger>
      </Input3>
      <Load0>
        <GPSTrigger>true</GPSTrigger>
        <High>2</High>
        <Low>1</Low>
        <ReportTrigger>true</ReportTrigger>
      </Load0>
      <Load0b>
        <GPSTrigger>true</GPSTrigger>
        <High>2</High>
        <Low>1</Low>
        <ReportTrigger>true</ReportTrigger>
      </Load0b>
      <Load1>
        <GPSTrigger>true</GPSTrigger>
        <High>2</High>
        <Low>1</Low>
        <ReportTrigger>true</ReportTrigger>
      </Load1>
      <Load1b>
        <GPSTrigger>true</GPSTrigger>
        <High>2</High>
        <Low>1</Low>
        <ReportTrigger>true</ReportTrigger>
      </Load1b>
      <ReadIntervalMinutes>1</ReadIntervalMinutes>
    </S1CInputSettings>
    <SerialNumber>sample string 1</SerialNumber>
    <Suspended>true</Suspended>
    <TAASCommitmentEndDate>2024-11-21T09:58:13.5647226+00:00</TAASCommitmentEndDate>
    <TAASCommitmentStartDate>2024-11-21T09:58:13.5647226+00:00</TAASCommitmentStartDate>
    <UnitConfiguredIntervalSeconds>1</UnitConfiguredIntervalSeconds>
    <UnitName>sample string 2</UnitName>
    <UnitTypeId>1</UnitTypeId>
    <UnitTypeName>sample string 3</UnitTypeName>
    <UserGroupId>1</UserGroupId>
    <UserGroupName>sample string 9</UserGroupName>
  </S1UnitModel>
</ArrayOfS1UnitModel>