map

Get a specific cleaning summary

Returns the summary of the cleaning run identified by counter.

get/homeappliances/{haId}/map/cleaningSummary/{counter}

Request

  • Base URL: https://api.home-connect.com/api
  • URL: https://api.home-connect.com/api/homeappliances/{haId}/map/cleaningSummary/{counter}
  • 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 cleaning summary

counterinteger required

Incremental counter that uniquely identifies each cleaning run summary

Example response

{
  "map": {
    "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.