API: Tour Trend

This request delivers a list with all cleaning tours done within a specified period of time. 

Request

/api/v1/cleaning-tour/trend/list?from=2021-06-01T00:00:00Z&to=2021-06-07T00:00:00Z

Parameter

Attribut	Data type	Description
from	ISO Date / Time	Start date and time for query
to	ISO Date / Time	End date and time for query

Answer

Data

Attribut	Data type	Description
id	Long	ID of tour entry
tourName	String	Tour name
startDate	ISO Date / Time	Date and time of tour start
endDate	ISO Date / Time	Data and time of tour end
openCleaningAreas	Integer	Areas not done within this tour (still red)
pendingCleaningAreas	Integer	Areas marked as not clean within this tour (marked blue)
doneCleaningAreas	Integer	Areas done (marked green)
doneCleaningAreasCalculatedDuration	Long	The estimated time needed to clean the areas effectively done in this tour in seconds.

Example of an answer from the API

[{
"id": 345
"tourName": "Tour 4",
"startDate": "2019-05-10 04:04:50"
"endDate":: "2019-05-10 06:59:59",
"openCleaningAreas": 3,
"pendingCleaningAreas": 1,
"doneCleaningAreas": 29,
"doneCleaningAreasCalculatedDuration": 15188
}]