Plant
Comma-separated list of Station 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/plant HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Accept: */*
{
"isSuccess": true,
"results": [
{
"code": "text",
"name": "text",
"timezone": "text",
"now": "text",
"stationGroups": [
{
"code": "text",
"name": "text",
"plantCode": "text",
"allowScheduleStationFlexibility": true,
"shiftPatternId": 1,
"allowQuickScheduleStart": true,
"createdAt": "text",
"updatedAt": "text"
}
],
"dayStartHour": 1
}
]
}Plant Code: The unique code for this plant.
^[a-z0-9\-]*$Plant Name: The display name for this plant.
Start Hour for Day: The normal time this plant starts for the day. When running 24 hours a day, this time will be considered the start and end when reporting by day.
Timezone: The timezone the plant operates in.
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/plant HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 63
{
"code": "text",
"name": "text",
"dayStartHour": 1,
"timezone": "UTC"
}{
"isSuccess": true,
"result": {
"code": "text",
"name": "text",
"timezone": "text",
"now": "text",
"stationGroups": [
{
"code": "text",
"name": "text",
"plantCode": "text",
"allowScheduleStationFlexibility": true,
"shiftPatternId": 1,
"allowQuickScheduleStart": true,
"createdAt": "text",
"updatedAt": "text"
}
],
"dayStartHour": 1
}
}Plant Code: The unique code for this plant.
^[a-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/plant/archive HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 20
{
"plantCode": "text"
}{
"isSuccess": true,
"result": {
"code": null
}
}