Push GPS Pin from Spark IoT

POST /spark

Body

GPS Pin to report

testMode boolean

Set true if you are testing integration, to avoid data pollution. Otherwise, this property can be omitted from request data.
utc_located_at string Required

UTC timestamp when GPS coordinates are calculated on device, in ISO 8601 datetime format. This can be formatted in Node/JavaScript with toISOString()
id_dev string Required

Spark IoT hardware unique device ID
gps_lat number(float) Required

GPS latitude
gps_long number(float) Required

GPS longitude
gps_speed number(float)

GPS speed (km/h)
gps_satellite integer

GPS satellites in view

Responses

200

Spark GPS Pin is reported
Hide response attributes Show response attributes object
- ok boolean
  
  True if the pin was successfully reported
- testMode boolean
  
  True if the pin was reported in test mode
- pin object
  
  Object containing the pin that was reported, including auto-generated attributes
  
  Hide pin attributes Show pin attributes object
  
  testMode boolean
  
  Set true if you are testing integration, to avoid data pollution. Otherwise, this property can be omitted from request data.
  
  utc_located_at string Required
  
  UTC timestamp when GPS coordinates are calculated on device, in ISO 8601 datetime format. This can be formatted in Node/JavaScript with toISOString()
  
  id_dev string Required
  
  Spark IoT hardware unique device ID
  
  gps_lat number(float) Required
  
  GPS latitude
  
  gps_long number(float) Required
  
  GPS longitude
  
  gps_speed number(float)
  
  GPS speed (km/h)
  
  gps_satellite integer
  
  GPS satellites in view
400

Client error
Hide response attribute Show response attribute object
- message string Required
  
  A human readable error message

POST /spark

curl \
 -X POST https://api.spotlumos.com/spark \
 -H "X-API-KEY: $API_KEY" \
 -d '{"testMode":true,"utc_located_at":"2023-01-25T02:00:00.000Z","id_dev":"B188","gps_lat":-33.872953,"gps_long":151.206948,"gps_speed":25.0,"gps_satellite":8}'

Request example

{
  "testMode": true,
  "utc_located_at": "2023-01-25T02:00:00.000Z",
  "id_dev": "B188",
  "gps_lat": -33.872953,
  "gps_long": 151.206948,
  "gps_speed": 25.0,
  "gps_satellite": 8
}

Request examples

{
  "testMode": true,
  "utc_located_at": "2023-01-25T02:00:00.000Z",
  "id_dev": "B188",
  "gps_lat": -33.872953,
  "gps_long": 151.206948,
  "gps_speed": 25.0,
  "gps_satellite": 8
}

Response examples (200)

{
  "ok": true,
  "testMode": true,
  "pin": {
    "testMode": true,
    "utc_located_at": "2023-01-25T02:00:00.000Z",
    "id_dev": "B188",
    "gps_lat": -33.872953,
    "gps_long": 151.206948,
    "gps_speed": 25.0,
    "gps_satellite": 8
  }
}

Response examples (200)

{
  "ok": true,
  "testMode": true,
  "pin": {
    "testMode": true,
    "utc_located_at": "2023-01-25T02:00:00.000Z",
    "id_dev": "B188",
    "gps_lat": -33.872953,
    "gps_long": 151.206948,
    "gps_speed": 25.0,
    "gps_satellite": 8
  }
}

Response examples (400)

{
  "message": "string"
}

Response examples (400)

{
  "message": "string"
}