map

Get a specific zone

Returns the zone identified by zoneId on the map identified by mapId.

get/homeappliances/{haId}/map/maps/{mapId}/zones/{zoneId}

Request

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

Details of the requested zone

mapIdinteger required

The map identifier this zone is part of

zoneIdinteger required

The zone's identifier

zoneType'Service.Map.ZoneType.NoGoBarrier' | 'Service.Map.ZoneType.NoMopBarrier' | 'Service.Map.ZoneType.NoGoZone' | 'Service.Map.ZoneType.NoMopZone' required

Type of the zone.

  • Service.Map.ZoneType.NoGoBarrier: Virtual barrier, which prohibits the robot to pass.
  • Service.Map.ZoneType.NoMopBarrier: Virtual barrier which can only be passed when no mopping is active.
  • Service.Map.ZoneType.NoGoZone: Area where the robot should not clean.
  • Service.Map.ZoneType.NoMopZone: Area where the robot shall not mop.

Changes

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