API: Orders

Return a list of orders

Request

/api/v1/cleaning-order/list?from={fromDateTime}&to={toDateTime}

Parameter

Data

Attribut	Datentyp	Beschreibung
fromDateTime	ISO Date / Time	Date start
toDateTime	ISO Date / Time	Date end

 

Response

Data

Attribut	Datentyp	Beschreibung
id	Long	ID of the order
cleaningAreaIds	String	List of all cleaning area ids
cleaningAreaNames	String	List of all cleaning area names
type	String	Type
status	String	Status
priority	Integer	Priority
creationDate	ISO Date / Time	Creation date
creatorUserName	String	Creating user
cancelUserName	String	Canceling user name
closedDate	ISO Date / Time	Close date
message	String	Message
imageUrl	Url	Image URL
cleaningPerformanceTypeIds	String	List of all activity type ids
cleaningPerformanceTypeNames	String	List of all activity names
cleaningTourIds	String	List of all cleaning tour ids
cleaningTourNames	String	List of all tour names
feedbacks	String	List of all feedbacks
timeLogged	Long	Logged seconds by stopwatch function
secondsNeededToClean	Double	Estimated cleaning duration (if set)

Example answer

[{
"id": 7308,
"cleaningAreaIds": "31991",
"cleaningAreaNames": "0.304",
"type": "CLEANING_PERFORMANCE_TYPES",
"status": "DONE",
"priority": 100,
"creationDate": "2024-01-24T09:29:08Z",
"creatorUserName": "hans.muser",
"cancelUserName": null,
"closedDate": "2024-01-24T09:32:21Z",
"message": null,
"imageUrl": null,
"cleaningPerformanceTypeIds": "2009744",
"cleaningPerformanceTypeNames": "Verbrauchsmaterial (On Demand)",
"cleaningTourIds": "1282",
"cleaningTourNames": "Revier 4",
"feedbacks": null,
"timeLogged": null,
"secondsNeededToClean": null
}]