Reference Map ID Option

Key

ConsumerProducts.CleaningRobot.Option.ReferenceMapId

Description

This option defines the used reference map.

Data type

Enumeration

Possible values

  • Temporary map
    Key: ConsumerProducts.CleaningRobot.EnumType.AvailableMaps.TempMap
  • User-defined map 1
    Key: ConsumerProducts.CleaningRobot.EnumType.AvailableMaps.Map1
  • User-defined map 2
    Key: ConsumerProducts.CleaningRobot.EnumType.AvailableMaps.Map2
  • User-defined map 3
    Key: ConsumerProducts.CleaningRobot.EnumType.AvailableMaps.Map3
  • User-defined map 4
    Key: ConsumerProducts.CleaningRobot.EnumType.AvailableMaps.Map4
  • User-defined map 5
    Key: ConsumerProducts.CleaningRobot.EnumType.AvailableMaps.Map5

Availability

Please note that most of our appliances dynamically update the API over the available options upon selection of the program. Therefore, the simplest and safest implementation would be to first select a program without any option and then query the available options of this program and for example dynamically present them on UI.

  Programs
CleanAll CleanMap GoHome
Values
TempMap
Map1
Map2
Map3
Map4
Map5

 

Example

GET /api/homeappliances/{haid}/programs/active/options/ConsumerProducts.CleaningRobot.Option.ReferenceMapId


{
    "data":{
        "key":"ConsumerProducts.CleaningRobot.Option.ReferenceMapId",
        "value": "ConsumerProducts.CleaningRobot.EnumType.AvailableMaps.Map1"
    }
}