Go to OI Website Request Access to Demo Site

Shift

PreviousSchedule NextSku Group

get

Authorizations

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

GET /api/shift-pattern HTTP/1.1
Host: qa.eu-west-2-2.busroot.opind.co
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "isSuccess": true,
  "results": [
    {
      "accountId": "text",
      "title": "text",
      "id": 1,
      "createdAt": "text",
      "updatedAt": "text",
      "code": "text",
      "duration": 1,
      "startHour": 1,
      "endHour": 1,
      "shifts": [
        {
          "shiftId": 1,
          "startHour": 1,
          "duration": 1,
          "shiftName": "text",
          "shiftPatternId": 1,
          "weekDay": "text"
        }
      ]
    }
  ]
}

get

Authorizations

Responses

200

200 OK

text/csv

Responsestring

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

GET /api/shift-pattern/csv HTTP/1.1
Host: qa.eu-west-2-2.busroot.opind.co
X-API-KEY: YOUR_API_KEY
Accept: */*

text

delete

Authorizations

Path parameters

idintegerRequired

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

DELETE /api/shift-pattern/{id} HTTP/1.1
Host: qa.eu-west-2-2.busroot.opind.co
X-API-KEY: YOUR_API_KEY
Accept: */*

No content

post

Authorizations

Body

shiftPatternIdintegerOptional

titlestring · min: 1Required

deleteShiftsinteger[]Optional

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

POST /api/shift HTTP/1.1
Host: qa.eu-west-2-2.busroot.opind.co
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 151

{
  "shiftPatternId": 1,
  "title": "text",
  "shifts": [
    {
      "id": 1,
      "name": "text",
      "startHour": 1,
      "duration": 1,
      "shiftPatternId": 1,
      "weekDay": "text"
    }
  ],
  "deleteShifts": [
    1
  ]
}

{
  "isSuccess": true,
  "result": {
    "shifts": [
      {
        "shiftId": 1,
        "startHour": 1,
        "duration": 1,
        "shiftName": "text",
        "shiftPatternId": 1,
        "weekDay": "text"
      }
    ],
    "shiftPatternId": 1
  }
}