Why aren't these parameters shown in Swagger?
The current Swagger documentation does not list all query parameters available on the orders endpoint. The parameters below are fully supported and are essential for retrieving only the orders relevant to your integration.
What query parameters are available?
| Parameter | Type | Comment |
|---|---|---|
| LastChanged | DateTime2022-11-29T12:59:33.092022-11-29
|
Returns orders changed after the specified date/time. Standard web date format supporting milliseconds. The time part can be omitted. |
| ExternalId | String | Returns the order matching your system's order ID (IdBackoffice). |
| Status | Int All = 0 Active = 1 Completed = 2 |
"Completed" corresponds to "Historical" in the Handyman Office UI. |
| IncludeSignatures | Boolean | Includes signature image binaries in the response. |
| InstallationId | String | Returns all orders connected to the specified equipment or installation site. |
| PageSize | Integer | Paging support — number of records to return. |
| StartIndex | Integer | Paging support — number of records to skip. Use together with PageSize for subsequent page reads. |
What is an example request?
Get the first 3 orders changed after a specific date:
localhost:8080/api/orders?LastChanged=2022-06-03T10:57:07.09&PageSize=3