API: Cleaning activities

This query delivers a list with all cleaning activities done in a specific period of time

Request

/api/v1/cleaning-area/cleaning/list?
                        from=2021-06-01T00:00:00Z&
                        to=2021-06-07T00:00:00Z&
                        withCleaningCategories=true&
                        withCleaningPerformanceTypes=true

Parameter

Attribut	Data type	Description
from	ISO Date / Time	Start date and time for query
to	ISO Date / Time	End data and time for query
withCleaningCategories	Boolean	Option to include categories
withCleaningPerformanceTypes	Boolean	Option to include cleaning activities

Antwort

Daten

Attribut	Data type	Description
id	Long	ID of cleaning performance
buildingId	Long	Building ID
buildingName	String	Building name
floorId	Long	Floor ID
floorName	String	Floor name
cleaningAreaId	Long	Area (room) ID
cleaningAreaName	String	Area (room) name
closed	ISO Date / Time	Date and time when the cleaning was marked as done
eventThreshold	Integer	IoT event limit on cleaning
eventsCounted	Integer	Sum of all the events recorded on this cleaning. If this amount exceeds the limit then the cleaning was triggered by events.
cleaningTourId	Long	ID of the cleaning tour which did the cleaning
cleaningTourName	String	Name of the cleaning tour which did the cleaning
cleaningSchedule	String	Abbreviation of the cleaning frequency according to the SLA. Here you'll find a list with the frequencies of all the cleaning performances included in the cleaning done.
calculatedDuration	Double	Estimated time needed to do the cleaning.
cleaningCategories	CleaningCategory	List with the categories of the cleaning tasks done.
cleaningSelf	Boolean	The cleaning performances done by the cleaners additional to their normal tours are marked with a "True".

 

CleaningCategory

Attribut	Data type	Description
id	Long	Category ID
name	String	Name of Category
cleaningPerformanceTypes	CleaningPerformanceType	List with all the cleaning performance done from this category.

 

CleaningPerformanceType

Attribut	Data type	Description
id	Long	ID of cleaning category
name	String	Name of cleaning category of which the cleaning performance is part of

 

Beispiel Antwort

[{
  "id": 231234,
  "buildingId": 32,
  "buildingName": "Building 1",
  "floorId": 56,
  "floorName": "Floor 3",
  "cleaningAreaId": 78,
  "cleaningAreaName": "123.034"
  "closed":: "2019-05-10 06:59:59",
  "eventThreshold": 200,
  "eventsCounted": 50,
  "cleaningTourId": 543
  "cleaningTourName": "Tour 12,
  "cleaningSchedule": "@1xw",
  "calculatedDuration": 120,
  "cleaningSelf": false
  "cleaningCategories": [{
    "id": 234,
    "name": "surface"
    cleaningPerformanceTypes: [{
      id: 155,
      name: "clean whaever"
    }]
  ]} 
}]