Snapshot - Single-Element

Endpoint Description

The single-element snapshot provides the same data as the Fleet Snapshot Endpoint, but is limited to a single piece of equipment. This piece of equipment is identified by the inclusion of a PIN or VIN as parameters in the URL. The single-element snapshot endpoint uses the common schema.

Request Information

URI

Authorize GEThttps://api20.takeuchi-us.com/Telematics/Fleet/Equipment/{identifier}

URI Parameters

Name Description Type Additional Information
identifier The PIN or VIN that uniquely identifies an asset. string Required

Header Parameters

Key Value Description Requirements
Authorization Bearer *Token generated from Connect endpoints. Authorization is required to access this endpoint. Required
Accept */* | application/xml | application/json By default responses will be "application/xml". Optional

Body Parameters

None (Empty)

Response Information

Resource Description

Response will be defined by ISO/TS, and can either be XML or JSON format.

Fleet

Name Description Type Additional Information
Links Links are used to describe the meta data about call. Each link contains a relationship (rel) and a hyperlink (href). Collection of FleetLinks Single-Element snapshot may not contain links.
Equipment Equipment(s) are earth-moving machinery, which can be identified by the PIN or VIN in the equipment header. Contains data points related to the equipment(s). Collection of FleetEquipment Single-Element snapshots will contain a single element.
version Declaration Version specifies the version of the XML standard to which the XML document conforms. string
snapshotTime The snapshot time is the date and time at which the snapshot of the fleet was created. string Date and Time are expressed as: YYYY-MM-DDThh:mm:ssZ

Response Formats

<Fleet xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="sample string 1" xmlns="http://www.jcmanet.or.jp/english2017/ISO/15143/-3/20190501">
  <Links>
    <rel>sample string 1</rel>
    <href>sample string 2</href>
  </Links>
  <Links>
    <rel>sample string 1</rel>
    <href>sample string 2</href>
  </Links>
  <Equipment>
    <EquipmentHeader>
      <UnitInstallDateTime>0001-01-01T00:00:00Z</UnitInstallDateTime>
      <OEMName>sample string 2</OEMName>
      <Model>sample string 3</Model>
      <EquipmentID>sample string 4</EquipmentID>
      <SerialNumber>sample string 5</SerialNumber>
      <PIN>sample string 6</PIN>
    </EquipmentHeader>
    <Location datetime="0001-01-01T00:00:00Z">
      <Latitude>1</Latitude>
      <Longitude>2</Longitude>
      <Altitude>3</Altitude>
      <AltitudeUnits>sample string 4</AltitudeUnits>
    </Location>
    <CumulativeOperatingHours>
      <Hour>1</Hour>
      <datetime>0001-01-01T00:00:00Z</datetime>
    </CumulativeOperatingHours>
    <DEFRemaining datetime="0001-01-01T00:00:00Z">
      <Percent>1</Percent>
      <DEFTankCapacityUnits>sample string 2</DEFTankCapacityUnits>
      <DEFTankCapacity>3</DEFTankCapacity>
    </DEFRemaining>
    <EngineStatus datetime="0001-01-01T00:00:00Z">
      <EngineNumber>sample string 1</EngineNumber>
      <Running>true</Running>
    </EngineStatus>
    <FuelUsed datetime="0001-01-01T00:00:00Z">
      <FuelUnits>sample string 1</FuelUnits>
      <FuelConsumed>2</FuelConsumed>
    </FuelUsed>
    <FuelRemaining datetime="0001-01-01T00:00:00Z">
      <Percent>1</Percent>
      <FuelTankCapacityUnits>sample string 2</FuelTankCapacityUnits>
      <FuelTankCapacity>3</FuelTankCapacity>
    </FuelRemaining>
  </Equipment>
  <Equipment>
    <EquipmentHeader>
      <UnitInstallDateTime>0001-01-01T00:00:00Z</UnitInstallDateTime>
      <OEMName>sample string 2</OEMName>
      <Model>sample string 3</Model>
      <EquipmentID>sample string 4</EquipmentID>
      <SerialNumber>sample string 5</SerialNumber>
      <PIN>sample string 6</PIN>
    </EquipmentHeader>
    <Location datetime="0001-01-01T00:00:00Z">
      <Latitude>1</Latitude>
      <Longitude>2</Longitude>
      <Altitude>3</Altitude>
      <AltitudeUnits>sample string 4</AltitudeUnits>
    </Location>
    <CumulativeOperatingHours>
      <Hour>1</Hour>
      <datetime>0001-01-01T00:00:00Z</datetime>
    </CumulativeOperatingHours>
    <DEFRemaining datetime="0001-01-01T00:00:00Z">
      <Percent>1</Percent>
      <DEFTankCapacityUnits>sample string 2</DEFTankCapacityUnits>
      <DEFTankCapacity>3</DEFTankCapacity>
    </DEFRemaining>
    <EngineStatus datetime="0001-01-01T00:00:00Z">
      <EngineNumber>sample string 1</EngineNumber>
      <Running>true</Running>
    </EngineStatus>
    <FuelUsed datetime="0001-01-01T00:00:00Z">
      <FuelUnits>sample string 1</FuelUnits>
      <FuelConsumed>2</FuelConsumed>
    </FuelUsed>
    <FuelRemaining datetime="0001-01-01T00:00:00Z">
      <Percent>1</Percent>
      <FuelTankCapacityUnits>sample string 2</FuelTankCapacityUnits>
      <FuelTankCapacity>3</FuelTankCapacity>
    </FuelRemaining>
  </Equipment>
</Fleet>
Return