map

Get all maps of a cleaning robot

Returns all maps known to the cleaning robot with their basic information.

Maps with isSaved set to false are temporary maps which are not yet fully saved on the home appliance and might get overwritten at any time.

get/homeappliances/{haId}/map/maps

Request

  • Base URL: https://api.home-connect.com/api
  • URL: https://api.home-connect.com/api/homeappliances/{haId}/map/maps
  • Auth: OAuth 2 (authorization code, authorization URL https://api.home-connect.com/security/oauth/authorize, token URL https://api.home-connect.com/security/oauth/token, scopes: CleaningRobot-Map)

Response

List of maps

mapIdinteger required

The map's identifier

namestring required

User defined name

isSavedboolean

If false, marks a map as 'temporary' map that is not yet fully saved and might get overwritten at any time.

Example response

[
  {
    "mapId": 1,
    "name": "Ground floor",
    "isSaved": true,
    "baseStations": [
      {
        "x": 120,
        "y": -35,
        "angleX": 90
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.