Get Shift Details

Developing

GET/api/v1/shifts

Request

Query Params

CompanyName

string

optional

The name of the company (null for get all shifts in tenant)

Example:

empeo dev test

Code

string

optional

Shift code

Example:

IVE

ShiftName

string

optional

Shift name

Example:

สำนักงาน

TakeRow

integer

required

Total number of record to be retrieved (Default 50)

Example:

SkipRow

integer

required

Start index of the record to be skipped

Example:

Header Params

Authorization

string

optional

Authorization credential utilized in API requests

Example:

Ocp-Apim-Subscription-Key

string

optional

Api subscription key get from the OpenAPI integration setting page

Example:

Request samples

Responses

Success(200)

HTTP Code: 200

Content Type : JSONapplication/json

statusCode

integer

required

Response status code

message

string

required

Response message

totals

integer

required

Total number of data returned

data

array [object {14}]

required

Data object

shiftName

string

required

Shift name

shiftName_EN

string

required

Shift name (In English)

code

string

required

Shift code

colorCode

string | null

required

Shift color code

description

string

required

Shift Description

isAllSite

boolean

required

Indicates whether the shift can apply to all companies

isNightShift

boolean

required

Indicates whether the shift takes place during the night hours. (e.g. 10 PM to 6 AM)

isDoubleShift

boolean

required

Indicates whether the shift is allow employee to work more than 1 shift per day

minuteFlexible

integer

required

Amount of time (in minutes) of flexibility allowed for the start and end times of the work period

minuteOfLate

integer

required

Amount of time (in minutes) before count as late

minuteOfAbsence

integer

required

Amount of time (in minutes) before count as absence

allowance

integer

required

Shift allowance

holidayAllowance

boolean

required

Shift holiday allowance

shiftDetails

array [object {8}]

required

Shift details

{
  "statusCode": 200,
  "message": "OK",
  "totals": 3,
  "data": [
    {
      "shiftName": "วันหยุด",
      "shiftName_EN": "Day Off",
      "code": "OFF",
      "colorCode": null,
      "description": "กำหนดให้เป็นวันหยุดพนักงาน",
      "isAllSite": true,
      "isNightShift": false,
      "isDoubleShift": false,
      "minuteFlexible": 0,
      "minuteOfLate": 0,
      "minuteOfAbsence": 30,
      "allowance": 0,
      "holidayAllowance": false,
      "shiftDetails": []
    },
    {
      "shiftName": "Normal workday",
      "shiftName_EN": "Normal workday",
      "code": "IVE",
      "colorCode": "#AB47BC",
      "description": "",
      "isAllSite": false,
      "isNightShift": false,
      "isDoubleShift": false,
      "minuteFlexible": 15,
      "minuteOfLate": 0,
      "minuteOfAbsence": 30,
      "allowance": 0,
      "holidayAllowance": false,
      "shiftDetails": [
        {
          "dayOfWeek": 1,
          "weekOfMonth": 1,
          "startTime": "08:30:00",
          "endTime": "17:30:00",
          "breakStartTime": "12:00:00",
          "breakEndTime": "13:00:00",
          "otStartTime": "17:30:00",
          "otEndTime": "08:30:00"
        },
        {
          "dayOfWeek": 2,
          "weekOfMonth": 1,
          "startTime": "08:30:00",
          "endTime": "17:30:00",
          "breakStartTime": "12:00:00",
          "breakEndTime": "13:00:00",
          "otStartTime": "17:30:00",
          "otEndTime": "08:30:00"
        },
        {
          "dayOfWeek": 3,
          "weekOfMonth": 1,
          "startTime": "08:30:00",
          "endTime": "17:30:00",
          "breakStartTime": "12:00:00",
          "breakEndTime": "13:00:00",
          "otStartTime": "17:30:00",
          "otEndTime": "08:30:00"
        },
        {
          "dayOfWeek": 4,
          "weekOfMonth": 1,
          "startTime": "08:30:00",
          "endTime": "17:30:00",
          "breakStartTime": "12:00:00",
          "breakEndTime": "13:00:00",
          "otStartTime": "17:30:00",
          "otEndTime": "08:30:00"
        },
        {
          "dayOfWeek": 5,
          "weekOfMonth": 1,
          "startTime": "08:30:00",
          "endTime": "17:30:00",
          "breakStartTime": "12:00:00",
          "breakEndTime": "13:00:00",
          "otStartTime": "17:30:00",
          "otEndTime": "08:30:00"
        }
      ]
    },
    {
      "shiftName": "Evening Shift",
      "shiftName_EN": "Evening Shift",
      "code": "EV001",
      "colorCode": "#485CC7",
      "description": "",
      "isAllSite": false,
      "isNightShift": true,
      "isDoubleShift": false,
      "minuteFlexible": 0,
      "minuteOfLate": 0,
      "minuteOfAbsence": 30,
      "allowance": 0,
      "holidayAllowance": false,
      "shiftDetails": [
        {
          "dayOfWeek": 1,
          "weekOfMonth": 1,
          "startTime": "17:30:00",
          "endTime": "00:30:00",
          "breakStartTime": "22:00:00",
          "breakEndTime": "23:00:00",
          "otStartTime": "00:30:00",
          "otEndTime": "17:30:00"
        },
        {
          "dayOfWeek": 2,
          "weekOfMonth": 1,
          "startTime": "17:30:00",
          "endTime": "00:30:00",
          "breakStartTime": "22:00:00",
          "breakEndTime": "23:00:00",
          "otStartTime": "00:30:00",
          "otEndTime": "17:30:00"
        },
        {
          "dayOfWeek": 3,
          "weekOfMonth": 1,
          "startTime": "17:30:00",
          "endTime": "00:30:00",
          "breakStartTime": "22:00:00",
          "breakEndTime": "23:00:00",
          "otStartTime": "00:30:00",
          "otEndTime": "17:30:00"
        },
        {
          "dayOfWeek": 4,
          "weekOfMonth": 1,
          "startTime": "17:30:00",
          "endTime": "00:30:00",
          "breakStartTime": "22:00:00",
          "breakEndTime": "23:00:00",
          "otStartTime": "00:30:00",
          "otEndTime": "17:30:00"
        },
        {
          "dayOfWeek": 5,
          "weekOfMonth": 1,
          "startTime": "17:30:00",
          "endTime": "00:30:00",
          "breakStartTime": "22:00:00",
          "breakEndTime": "23:00:00",
          "otStartTime": "00:30:00",
          "otEndTime": "17:30:00"
        },
        {
          "dayOfWeek": 6,
          "weekOfMonth": 1,
          "startTime": "17:30:00",
          "endTime": "00:30:00",
          "breakStartTime": "22:00:00",
          "breakEndTime": "23:00:00",
          "otStartTime": "00:30:00",
          "otEndTime": "17:30:00"
        },
        {
          "dayOfWeek": 0,
          "weekOfMonth": 1,
          "startTime": "17:30:00",
          "endTime": "00:30:00",
          "breakStartTime": "22:00:00",
          "breakEndTime": "23:00:00",
          "otStartTime": "00:30:00",
          "otEndTime": "17:30:00"
        }
      ]
    }
  ]
}

Last modified: 2 months ago