Station Group

get

Authorizations

X-API-KEYstringRequired

Query parameters

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

/station-group

GET /api/station-group HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "isSuccess": true,
  "results": [
    {
      "code": "text",
      "name": "text",
      "plantCode": "text",
      "accountId": "text",
      "allowScheduleStationFlexibility": true,
      "shiftPatternId": 1,
      "allowQuickScheduleStart": true,
      "createdAt": "text",
      "updatedAt": "text",
      "plantTimezone": "text",
      "stations": [
        {
          "accountId": "text",
          "code": "text",
          "name": "text",
          "groupCode": "text",
          "shiftPatternId": null,
          "moduleVisibility": [
            "utilisation"
          ],
          "minimumCycleTime": null,
          "speedScale": null,
          "speedOffset": null,
          "speedToProductionRatio": null,
          "electricalPowerNominalKw": null,
          "idleCostPerMinute": null,
          "downtimeDetectionMode": "utilisation",
          "utilisationDowntimeThreshold": 1,
          "slowDurationThreshold": null,
          "forceAllShiftTimeAsPlannedProduction": true,
          "productiveStatusMode": "productive_signal",
          "electricalUsageStoppedThresholdKw": null,
          "lineSpeedStoppedThreshold": null,
          "productiveHoldOnTime": null,
          "allowInterruptionMode": false,
          "allowManualProduction": false,
          "allowQuickScheduleStart": false,
          "allowScheduleCutShort": false,
          "currentOperatorInitials": null,
          "statusCode": null,
          "statusCodeUpdatedAt": null,
          "cycleTime": null,
          "unitsPerMinute": null,
          "unitsPerHour": null,
          "lineSpeedTarget": null,
          "createdAt": null,
          "updatedAt": null,
          "archivedAt": null
        }
      ],
      "shifts": [
        {
          "id": 1,
          "name": "text",
          "startHour": 1,
          "duration": 1,
          "accountId": "text",
          "shiftPatternId": 1,
          "weekDay": "text"
        }
      ]
    }
  ]
}

post

Authorizations

X-API-KEYstringRequired

Body

codestring · min: 1 · max: 32RequiredPattern: ^([a-zA-Z0-9-_]+)$

namestring · min: 1 · max: 32Required

plantCodestring · min: 3 · max: 55Required

Plant Code: The unique code for this plant.

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

allowScheduleStationFlexibilitybooleanOptionalDefault: false

shiftPatternIdintegerRequired

allowQuickScheduleStartbooleanOptional

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

/station-group

POST /api/station-group HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 138

{
  "code": "text",
  "name": "text",
  "plantCode": "text",
  "allowScheduleStationFlexibility": false,
  "shiftPatternId": 1,
  "allowQuickScheduleStart": true
}

{
  "isSuccess": true,
  "results": [
    {
      "code": "text",
      "name": "text",
      "plantCode": "text",
      "accountId": "text",
      "allowScheduleStationFlexibility": true,
      "shiftPatternId": 1,
      "allowQuickScheduleStart": true,
      "createdAt": "text",
      "updatedAt": "text"
    }
  ]
}

get

Authorizations

X-API-KEYstringRequired

Path parameters

codestring · min: 1 · max: 32RequiredPattern: ^([a-zA-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

get

/station-group/{code}

GET /api/station-group/{code} HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "isSuccess": true,
  "result": {
    "code": "text",
    "name": "text",
    "plantCode": "text",
    "accountId": "text",
    "allowScheduleStationFlexibility": true,
    "shiftPatternId": 1,
    "allowQuickScheduleStart": true,
    "createdAt": "text",
    "updatedAt": "text",
    "plantTimezone": "text",
    "stations": [
      {
        "accountId": "text",
        "code": "text",
        "name": "text",
        "groupCode": "text",
        "shiftPatternId": null,
        "moduleVisibility": [
          "utilisation"
        ],
        "minimumCycleTime": null,
        "speedScale": null,
        "speedOffset": null,
        "speedToProductionRatio": null,
        "electricalPowerNominalKw": null,
        "idleCostPerMinute": null,
        "downtimeDetectionMode": "utilisation",
        "utilisationDowntimeThreshold": 1,
        "slowDurationThreshold": null,
        "forceAllShiftTimeAsPlannedProduction": true,
        "productiveStatusMode": "productive_signal",
        "electricalUsageStoppedThresholdKw": null,
        "lineSpeedStoppedThreshold": null,
        "productiveHoldOnTime": null,
        "allowInterruptionMode": false,
        "allowManualProduction": false,
        "allowQuickScheduleStart": false,
        "allowScheduleCutShort": false,
        "currentOperatorInitials": null,
        "statusCode": null,
        "statusCodeUpdatedAt": null,
        "cycleTime": null,
        "unitsPerMinute": null,
        "unitsPerHour": null,
        "lineSpeedTarget": null,
        "createdAt": null,
        "updatedAt": null,
        "archivedAt": null
      }
    ],
    "shifts": [
      {
        "id": 1,
        "name": "text",
        "startHour": 1,
        "duration": 1,
        "accountId": "text",
        "shiftPatternId": 1,
        "weekDay": "text"
      }
    ]
  }
}

delete

Authorizations

X-API-KEYstringRequired

Path parameters

codestring · min: 1 · max: 32RequiredPattern: ^([a-zA-Z0-9-_]+)$

Responses

204

204 No Content

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

delete

/station-group/{code}

DELETE /api/station-group/{code} HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Accept: */*

No content

PreviousStation NextStation Window

Last updated 4 months ago