GET v2/Assets/Area

Get all assets within a given area

Request Information

URI Parameters

None.

Body Parameters

The area model

Lhp.EquipmentIntelligence.WebApi.Client.Models.Area
NameDescriptionTypeAdditional information
Point

When defining a circular area, this is the center point

Lhp.EquipmentIntelligence.WebApi.Client.Models.Coordinate

None.

Radius

When defining a circular area, this is the radius in meters

decimal number

None.

Coordinates

A list of coordinates when defining a polygon area.

Collection of Lhp.EquipmentIntelligence.WebApi.Client.Models.Coordinate

None.

Request Formats

application/json, text/json

Sample:
{
  "Point": {
    "Latitude": 1.1,
    "Longitude": 2.1,
    "Timestamp": "2024-07-13T03:25:40.7402807+00:00"
  },
  "Radius": 1.1,
  "Coordinates": [
    {
      "Latitude": 1.1,
      "Longitude": 2.1,
      "Timestamp": "2024-07-13T03:25:40.7402807+00:00"
    },
    {
      "Latitude": 1.1,
      "Longitude": 2.1,
      "Timestamp": "2024-07-13T03:25:40.7402807+00:00"
    }
  ]
}

application/xml, text/xml

Sample:
<Area xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Point>
    <Latitude>1.1</Latitude>
    <Longitude>2.1</Longitude>
    <Timestamp>2024-07-13T03:25:40.7402807+00:00</Timestamp>
  </Point>
  <Radius>1.1</Radius>
  <Coordinates>
    <Coordinate>
      <Latitude>1.1</Latitude>
      <Longitude>2.1</Longitude>
      <Timestamp>2024-07-13T03:25:40.7402807+00:00</Timestamp>
    </Coordinate>
    <Coordinate>
      <Latitude>1.1</Latitude>
      <Longitude>2.1</Longitude>
      <Timestamp>2024-07-13T03:25:40.7402807+00:00</Timestamp>
    </Coordinate>
  </Coordinates>
</Area>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of Lhp.EquipmentIntelligence.WebApi.Client.Models.Asset
NameDescriptionTypeAdditional information
AssetId

The asset ID

integer

None.

TcuId

The TCU ID

integer

None.

OemEquipmentModelId

The OEM equipment model ID

integer

None.

OemEquipmentModelName

The OEM equipment model name

string

None.

CustomerAssetStatusId

The customer asset status ID

Lhp.EquipmentIntelligence.CustomerAssetStatuses

None.

Name

The asset Name

string

None.

Make

The asset make

string

None.

Model

The asset model

string

None.

Year

The asset year

string

None.

SerialNumber

The asset serial number

string

None.

Vin

The asset VIN

string

None.

UniqueExternalId

The asset's unique external identifier

string

None.

Location

The asset's last reported location

Lhp.EquipmentIntelligence.WebApi.Client.Models.Coordinate

None.

OwningCustomerId

ID of the Customer that currently owns this asset.

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "AssetId": 1,
    "TcuId": 1,
    "OemEquipmentModelId": 1,
    "OemEquipmentModelName": "sample string 2",
    "CustomerAssetStatusId": 0,
    "Name": "sample string 3",
    "Make": "sample string 4",
    "Model": "sample string 5",
    "Year": "sample string 6",
    "SerialNumber": "sample string 7",
    "Vin": "sample string 8",
    "UniqueExternalId": "sample string 9",
    "Location": {
      "Latitude": 1.1,
      "Longitude": 2.1,
      "Timestamp": "2024-07-13T03:25:40.7602833+00:00"
    },
    "OwningCustomerId": 1
  },
  {
    "AssetId": 1,
    "TcuId": 1,
    "OemEquipmentModelId": 1,
    "OemEquipmentModelName": "sample string 2",
    "CustomerAssetStatusId": 0,
    "Name": "sample string 3",
    "Make": "sample string 4",
    "Model": "sample string 5",
    "Year": "sample string 6",
    "SerialNumber": "sample string 7",
    "Vin": "sample string 8",
    "UniqueExternalId": "sample string 9",
    "Location": {
      "Latitude": 1.1,
      "Longitude": 2.1,
      "Timestamp": "2024-07-13T03:25:40.7602833+00:00"
    },
    "OwningCustomerId": 1
  }
]

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>
    <TcuId>1</TcuId>
    <OemEquipmentModelId>1</OemEquipmentModelId>
    <OemEquipmentModelName>sample string 2</OemEquipmentModelName>
    <CustomerAssetStatusId>None</CustomerAssetStatusId>
    <Name>sample string 3</Name>
    <Make>sample string 4</Make>
    <Model>sample string 5</Model>
    <Year>sample string 6</Year>
    <SerialNumber>sample string 7</SerialNumber>
    <Vin>sample string 8</Vin>
    <UniqueExternalId>sample string 9</UniqueExternalId>
    <Location>
      <Latitude>1.1</Latitude>
      <Longitude>2.1</Longitude>
      <Timestamp>2024-07-13T03:25:40.7602833+00:00</Timestamp>
    </Location>
    <OwningCustomerId>1</OwningCustomerId>
  </Asset>
  <Asset>
    <AssetId>1</AssetId>
    <TcuId>1</TcuId>
    <OemEquipmentModelId>1</OemEquipmentModelId>
    <OemEquipmentModelName>sample string 2</OemEquipmentModelName>
    <CustomerAssetStatusId>None</CustomerAssetStatusId>
    <Name>sample string 3</Name>
    <Make>sample string 4</Make>
    <Model>sample string 5</Model>
    <Year>sample string 6</Year>
    <SerialNumber>sample string 7</SerialNumber>
    <Vin>sample string 8</Vin>
    <UniqueExternalId>sample string 9</UniqueExternalId>
    <Location>
      <Latitude>1.1</Latitude>
      <Longitude>2.1</Longitude>
      <Timestamp>2024-07-13T03:25:40.7602833+00:00</Timestamp>
    </Location>
    <OwningCustomerId>1</OwningCustomerId>
  </Asset>
</ArrayOfAsset>