Schedule
Comma-separated list of Station Codes.
Comma-separated list of Schedule IDs.
200 OK
Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.
Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.
Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.
Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.
Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.
GET /api/schedule HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Accept: */*
{
"isSuccess": true,
"results": [
{
"id": 1,
"stationCode": "text",
"stationName": "text",
"accountId": "text",
"plannedStartAt": "text",
"plannedStartAtTimestamp": 1,
"plannedEndAt": "text",
"plannedEndAtTimestamp": 1,
"workOrderReference": "text",
"plannedDuration": 1,
"plannedQuantity": 1,
"nonProductionReasonCode": "text",
"nonProductionReasonDescription": "text",
"skuCode": "text",
"skuName": "text",
"skuValue": 1,
"batchSize": 1,
"autoEndOnQuantityComplete": true,
"cycleTime": 1,
"unitsPerMinute": 1,
"unitsPerHour": 1,
"lineSpeedTarget": 1,
"effectiveCycleTime": 1,
"effectiveUnitsPerMinute": 1,
"effectiveUnitsPerHour": 1,
"effectiveLineSpeedTarget": 1,
"effectiveBatchSize": 1,
"effectiveMinimumCycleTime": 1,
"deletedAt": "text",
"actualStartAt": "text",
"actualStartAtTimestamp": 1,
"actualEndAt": "text",
"actualEndAtTimestamp": 1,
"quantityGood": 1,
"quantityBad": 1,
"skuGroupCode": "text",
"skuGroupName": "text",
"extendShift": true,
"downtimeDurationThresholdMultiplier": 1,
"isStarted": true,
"isEnded": true,
"allowScheduleCutShort": true,
"idealQuantity": 1,
"performanceModeFrom": "schedule",
"logs": [
"text"
],
"priorityAt": "text"
}
],
"range": {
"from": 1,
"to": 1,
"duration": 1,
"fromIso": "text",
"toIso": "text",
"durationFormatted": "text"
}
}^([a-zA-Z0-9-_]+)$^([a-zA-Z0-9.\\/-]+)$^([a-zA-Z0-9.\\/-]+)$200 OK
Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.
Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.
Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.
Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.
Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.
POST /api/schedule HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 661
{
"id": 1,
"stationCode": "text",
"plannedStartAt": "text",
"plannedEndAt": "text",
"plannedQuantity": null,
"skuCode": null,
"workOrderReference": null,
"nonProductionReasonCode": null,
"calculatedQuantity": 1,
"calculatedEndAt": "2025-09-15T22:34:09.185Z",
"predictedQuantity": 1,
"predictedEndAt": "2025-09-15T22:34:09.185Z",
"lastPredictedAt": "2025-09-15T22:34:09.185Z",
"deletedAt": "2025-09-15T22:34:09.185Z",
"actualStartAt": "text",
"actualEndAt": "text",
"skuGroupCode": null,
"cycleTime": null,
"extendShift": true,
"orderType": "quantity",
"unitsPerMinute": null,
"unitsPerHour": null,
"lineSpeedTarget": null,
"batchSize": null,
"priorityAt": null,
"autoEndOnQuantityComplete": null,
"skuName": "text"
}{
"isSuccess": true,
"result": {
"id": 1,
"stationCode": "text",
"plannedStartAt": "text",
"plannedEndAt": "text",
"plannedQuantity": 1,
"skuCode": "text",
"nonProductionReasonCode": "text",
"workOrderReference": "text",
"calculatedQuantity": 1,
"calculatedEndAt": "text",
"predictedQuantity": 1,
"predictedEndAt": "text",
"lastPredictedAt": "text",
"deletedAt": "text",
"accountId": "text",
"actualStartAt": "text",
"actualEndAt": "text",
"skuGroupCode": "text",
"cycleTime": 1,
"unitsPerMinute": 1,
"unitsPerHour": 1,
"lineSpeedTarget": 1,
"batchSize": 1,
"extendShift": true,
"priorityAt": "text",
"autoEndOnQuantityComplete": true,
"createdAt": "text",
"updatedAt": "text"
}
}Comma-separated list of Station Codes.
Comma-separated list of SKU Codes.
200 OK
Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.
Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.
Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.
Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.
Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.
GET /api/schedule/workorder HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Accept: */*
{
"isSuccess": true,
"result": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": [
{
"id": 1,
"stationCode": "text",
"stationName": "text",
"accountId": "text",
"plannedStartAt": "text",
"plannedStartAtTimestamp": 1,
"plannedEndAt": "text",
"plannedEndAtTimestamp": 1,
"workOrderReference": "text",
"plannedDuration": 1,
"plannedQuantity": 1,
"nonProductionReasonCode": "text",
"nonProductionReasonDescription": "text",
"skuCode": "text",
"skuName": "text",
"skuValue": 1,
"batchSize": 1,
"autoEndOnQuantityComplete": true,
"cycleTime": 1,
"unitsPerMinute": 1,
"unitsPerHour": 1,
"lineSpeedTarget": 1,
"effectiveCycleTime": 1,
"effectiveUnitsPerMinute": 1,
"effectiveUnitsPerHour": 1,
"effectiveLineSpeedTarget": 1,
"effectiveBatchSize": 1,
"effectiveMinimumCycleTime": 1,
"deletedAt": "text",
"actualStartAt": "text",
"actualStartAtTimestamp": 1,
"actualEndAt": "text",
"actualEndAtTimestamp": 1,
"quantityGood": 1,
"quantityBad": 1,
"skuGroupCode": "text",
"skuGroupName": "text",
"extendShift": true,
"downtimeDurationThresholdMultiplier": 1,
"isStarted": true,
"isEnded": true,
"allowScheduleCutShort": true,
"idealQuantity": 1,
"performanceModeFrom": "schedule",
"logs": [
"text"
],
"priorityAt": "text"
}
]
}
}
}200 OK
Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.
Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.
Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.
Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.
Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.
POST /api/schedule/{id}/cutshort HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Accept: */*
{
"isSuccess": true
}204 No Content
No content
Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.
Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.
Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.
Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.
Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.
DELETE /api/schedule/{id} HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Accept: */*
No content