Plant

get

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Query parameters

stationcodesstringOptional

Comma-separated list of Station Codes.

plantcodestring · min: 1Optional

Responses

200

200 OK

application/json

400

Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.

application/json

401

Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.

application/json

403

Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.

application/json

409

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.

application/json

500

Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.

application/json

get

/plant

HTTPcURLJavaScriptPython

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
    }
  ]
}

post

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Body

application/json

codestring · min: 3 · max: 55Required

Plant Code: The unique code for this plant.

Pattern: ^[a-z0-9\-]*$

namestring · min: 3 · max: 55Required

Plant Name: The display name for this plant.

dayStartHournumber · max: 24Optional

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.

timezonestring · enumOptional

Timezone: The timezone the plant operates in.

Possible values:

Responses

200

200 OK

application/json

400

Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.

application/json

401

Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.

application/json

403

Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.

application/json

409

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.

application/json

500

Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.

application/json

post

/plant

HTTPcURLJavaScriptPython

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
  }
}

post

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Body

application/json

plantCodestring · min: 3 · max: 55Required

Plant Code: The unique code for this plant.

Pattern: ^[a-z0-9\-]*$

Responses

200

200 OK

application/json

400

Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.

application/json

401

Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.

application/json

403

Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.

application/json

409

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.

application/json

500

Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.

application/json

post

/plant/archive

HTTPcURLJavaScriptPython

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
  }
}