API: Liste der Reinigungsdruchführungen

Liefert eine Liste sämtlicher Reinigungsdurchführungen im angegebenen Zeitraum.

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	Datentyp	Beschreibung
from	ISO Date / Time	Von Datum der Abfrage
to	ISO Date / Time	Bis Datum der Abfrage
withCleaningCategories	Boolean	Inklusive Reinigungskategorien
withCleaningPerformanceTypes	Boolean	Inklusive Reinigungsleistungen

 

Antwort

Daten

Attribut	Datentyp	Beschreibung
id	Long	ID der Reinigungsdurchführung
buildingId	Long	ID des Gebäude
buildingName	String	Name des Gebäudes
floorId	Long	ID des Stockwerks
floorName	String	Name des Stockwerks
cleaningAreaId	Long	ID der Fläche
cleaningAreaName	String	Name der Fläche
closed	ISO Date / Time	Durchführungszeitpunkt
eventThreshold	Integer	Schwellwert für die sensorbasierte Reinigungsauslösung
eventsCounted	Integer	Summe der Events. Falls dieser Wert höher als der Schwellwert ist, bedeutet dies eine Auslösung durch die Events.
cleaningTourId	Long	ID der Reinigungstour
cleaningTourName	String	Name der Reinigungstour
cleaningSchedule	String	Kurzform der Ausführungsfrequenz.  Hier handelt es sich um eine Auflistung sämtlicher Frequenzen welche in diesem Reinigungspaket enthalten sind.
calculatedDuration	Double	Berechnete Zeit für diese Reinigung
cleaningCategories	CleaningCategory	Auflistung der ausgeführten Reinigungskategorien
cleaningSelf	Boolean	'True' wenn die Reinigung von der Reinigungskraft selbst ausgelöst wurde

 

CleaningCategory

Attribut	Datentyp	Beschreibung
id	Long	ID der Reinigungskategorie
name	String	Name der Reinigungskategorie
cleaningPerformanceTypes	CleaningPerformanceType	Liste der ausgeführten Reinigungsleistungen dieser Kategorie

 

CleaningPerformanceType

Attribut	Datentyp	Beschreibung
id	Long	ID der Reinigungsleistung
name	String	Name der Reinigungskategorie

 

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"
    }]
  ]} 
}]