Fleet Telemetry (REST API)

Endpoint:

GET /equipment-telemetry/equipments

Params

Parameter	Type	Location	Required	Description
`page`	Integer	Query	No	Page number for pagination (default: 1)

Response

Success (200 OK)

{
   "data":[
      {
         "equipment":{
            "id":"8af142b3-a941-43b9-98b8-9ce01a1d44b5",
            "OEMName":"Caterpillar",
            "model":"320D2 GC",
            "serialNumber":"12345678",
            "invNumber":"INV-123456",
            "uniqueEquipmentId":"UEID-12345",
            "year":2018,
            "telemetry":{
               "location":{
                  "@datetime":"2024-02-27T11:43:20.000Z",
                  "Latitude":53.055524,
                  "Longitude":7.444976,
                  "Altitude":"4.1",
                  "Unit":"m"
               },
               "engineStatus":{
                  "@datetime":"2024-02-27T11:43:05.000Z",
                  "EngineNumber":"Number-1234",
                  "Running":false
               },
               "cumulativeOperatingHoursInfo":{
                  "@datetime":"2023-12-07T15:10:22.000Z",
                  "CumulativeOperatingHours":8198.016,
                  "Unit":"h"
               },
               "odometerInfo":{
                  "@datetime":"2024-02-27T11:43:05.000Z",
                  "Odometer":37.2,
                  "Unit":"km"
               }
            }
         }
      }
   ],
   "total":"integer"
}

Fields Description

id (string, nullable) - Equipment identifier
OEMName (string, nullable) - Original Equipment Manufacturer name
model (string, nullable) - Equipment model
serialNumber (string, nullable) - Serial number
invNumber (string, nullable) - Inventory number
uniqueEquipmentId (string, nullable) - Unique equipment identifier
year (integer, nullable) - Manufacturing year

Examples

curl -X GET "https://integration-api.ram.syniotec.com/master-data/v1/equipment-telemetry/equipments?page=1" \
  -H "Authorization: Bearer your-token"

{
  "data": [
    {
      "equipment": {
        "id": "equipment-123",
        "OEMName": "Caterpillar",
        "model": "CAT 320",
        "serialNumber": "CAT123456",
        "invNumber": "INV-001",
        "uniqueEquipmentId": "EQ-789",
        "year": 2020,
        "telemetry": {
          "location": {
            "latitude": 48.8566,
            "longitude": 2.3522,
            "timestamp": "2024-01-15T10:30:00Z"
          },
          "engineStatus": {
            "engineOn": true,
            "timestamp": "2024-01-15T10:30:00Z"
          },
          "cumulativeOperatingHours": {
            "hours": 1250.5
          },
          "odometerInfo": {
            "distance": 45000
          }
        }
      }
    }
  ],
  "total": 10
}

Error Responses

{
  "message": "string"
}

message - Human-readable error message

How It Works

This endpoint combines data from multiple sources:

Fleet Snapshot API - Retrieves real-time equipment state from the telematics system
Core Equipment Database - Matches equipment by serial number (beacon ID)
Telemetry Data Merging - Combines equipment metadata with live telemetry data

The result is a comprehensive fleet overview with both static equipment information and dynamic telemetry data.

Notes

Maximum timeout: 29 seconds
Pagination is supported via the page query parameter
Empty pages return { "data": [], "total": 1 }
All telemetry data is fetched in real-time from external services
The endpoint automatically handles equipment deduplication by serial number