map

Get the cleaning status of a map

Returns the cleaning status, e.g. the path which has already been cleaned, of the map identified by mapId.

get/homeappliances/{haId}/map/maps/{mapId}/cleaningStatus

Request

  • Base URL: https://api.home-connect.com/api
  • URL: https://api.home-connect.com/api/homeappliances/{haId}/map/maps/{mapId}/cleaningStatus
  • 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

Cleaning status of the requested map

mapIdinteger required

The map identifier this cleaning information refers to.

cleaningPathCompressedZstdstring

Based on cleaningPath, this is the zstd [RFC8878] compressed and base64url [RFC4648] encoded version.

Changes

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