map

Get a specific room

Returns the room identified by roomId on the map identified by mapId.

get/homeappliances/{haId}/map/maps/{mapId}/rooms/{roomId}

Request

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

mapIdinteger required

The map identifier this room is part of

roomIdinteger required

The room's identifier

namestring

User defined name. As long as the user has not yet defined a name, this field is omitted.

floorTypestring

The room's floor type.

roomTypestring

The room type.

connectedRoomsinteger[]

List of room ids that are connected to this room and can be merged with this room.

Changes

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