Space Move

This API can used by devices if they need to relocate within the Customer's heirarchy.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Use the hub_url received in the registration response as your base URL.

📘

This API requires the device to authenticate, see Device Authentication.

Request Data

NameTypeDescription
targetstringfollow_parent or unsorted

The following target parameters are supported:

  • follow_parent Valid only for child devices with a Parent Device. This call will move the device to the same Space the parent is in.
  • unsortedWill move the device to a special "Unsorted" space in the root tree of a Customer.

This API can only be called for Claimed devices.

Return Data

The Space the device is after the move.

{
  "location": {
    "coordinates": {
      "lat": 51.165691,
      "lng": 10.451526
    },
    "utc_offset": 60,
    "name": "Germany"
  },
  "temperature_units": "celsius",
  "maintenance": false,
  "name": "Interactive Class",
  "local_time": "2022-03-17T10:55:28+01:00",
  "device_id": "fbe103c8-..."
}

KeySubkeySubkeyTypeDescriptionModel API Version
locationobjectNULL if not set1.0.1+
coordinatesobject1.0.1+
latfloatLatitude1.0.1+
longfloatLongitude1.0.1+
utc_offsetnumberOffset in minutes from UTC1.0.1+
namestringLocation's name1.0.1+
1.0.1+
temperature_unitsstringTemperature units for the space1.0.1+
maintenancebooleanIndicates whether the space is in maintenance mode1.0.1+
namestringSpace name1.0.1+
local_timedateLocal time of the space1.0.1+
device_idstringDevice ID1.0.7+
Path Params
string
required
Body Params
string
required
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json