iotoms Docs

List day cycles

GET
/api/v1/ops/day-cycles

Returns day cycles within an inclusive from/to date range, optionally filtered by status. Both dates default to today when omitted.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

from?string

Start date, YYYY-MM-DD.

Formatdate
to?string

End date, YYYY-MM-DD.

Formatdate
status?string

Optional: OPEN or CLOSED to return only day cycles in that state.

Value in"OPEN""CLOSED"

Header Parameters

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request worked, ERROR when it did not.

message*string

Short human-readable message describing the result, for logs or display; do not parse it.

data?array<>|

Day cycles whose business date falls in the requested range. Not paginated.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/ops/day-cycles'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "dayCycleId": "bbed7a30-80be-4ccf-810d-a33c370a67d1",      "businessDate": "2019-08-24",      "status": "OPEN",      "startedAt": "2019-08-24T14:15:22Z",      "closedAt": "2019-08-24T14:15:22Z",      "vehicleLabel": "string",      "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",      "vehicleType": "VAN",      "openingCash": 0,      "closingCash": 0,      "startOdometerKm": 0,      "endOdometerKm": 0,      "coveragePercent": 0,      "totalStores": 0,      "visitedStores": 0    }  ]}