API: Tour Execution Result

Return a list of tour execution results. This request is not supported for all customer and needs to be activated potentially.

Request

/api/v1/cleaning-executed-tour-result/list?from={fromDateTime}&to={toDateTime}

Parameter

Data

Attribut	Datentyp	Beschreibung
fromDateTime	ISO Date / Time	From  date
toDateTime	ISO Date / Time	To date

 

Answer

Data

Attribut	Datentyp	Beschreibung
cleaningDurationSeconds	Long	Duration in seconds between tour start / stop
durationBetweenCleaningSeconds	Long	Duration in seconds between last tour execution and this tour execution (potential travel time)
geoLocationMatch	String	See below
economicEntityId	Long	ID economic entity
mobileDeviceId	Long	ID mobile device id
cleaningTourStart	ISO Date / Time	Tour start date
cleaningTourEnd	ISO Date / Time	Tour end date
cleaningTourSessionId	String	Unique execution id
cleaningTourId	Long	ID Tour
cleaningAreasOpenCount	Integer	Open areas count
cleaningAreasPendingCount	Integer	Pending areas count
cleaningAreasDoneCount	Integer	Done areas count
cleaningCategoriesExecuted	String	Executed categories

 

Geo Location Match

NO_MATCH

More than 1 kilometer away from the economic entity during the tour execution.

PARTIAL

Partial more than 1 kilometer away from the economic entity during the tour execution.

MATCH

Less than 1 kilometer away from the economic entity during the tour execution.

NO_MOBILE_LOCATION

Geo location deactivated on movile device

Example answer

[{
"economicEntityId": 71,
"mobileDeviceId": 123,
"cleaningDurationSeconds": 4339,
"durationBetweenCleaningSeconds": 12863,
"geoLocationMatch": "PARTIAL",
"cleaningTourId": 321,
"cleaningTourSessionId": "fb32392f-af39-8076-b221-32d2eb4e182x",
"cleaningTourStart": "2023-08-01T07:09:26Z",
"cleaningTourEnd": "2023-08-01T08:21:45Z",
"cleaningAreasOpenCount": 0,
"cleaningAreasPendingCount": 0,
"cleaningAreasDoneCount": 7,
"cleaningCategoriesExecuted": "Weekly"
}]