Gofive OpenAPI
empeoVenioeTaxGo
empeoVenioeTaxGo
  1. Master
  • Authentication API
    • Authorization
      POST
  • Employee
    • Get Employee
      GET
    • Update Employee
      PUT
    • Get List Employees
      GET
    • Get Employees List
      GET
    • Get Mastertypes List
      GET
    • Get Name Prefixes
      GET
    • Get Document Types
      GET
    • Update Employee
      POST
    • Add Employee Attachment
      POST
    • Update Employee Address
      POST
    • Update Employee Family
      POST
    • Update Employee Information
      POST
    • Update Employee Shifts
      POST
    • Update Employee Contact
      POST
    • Update Employee Education
      POST
    • Update Employee Experience
      POST
    • Update Employee CustomField
      POST
    • Delete Employee
      POST
    • Get Employee Shifts
      GET
    • Get Employee Role
      GET
    • Get Employee Movement Lists
      GET
  • Leave
    • Get Employee Documents
  • Master
    • Get Organizations
      GET
    • Get CustomField
      GET
    • Get Holiday
      GET
    • Get MasterSetup
      GET
    • Get Shift Details
      GET
  • Payroll
    • Create Loan
    • Get Loan (Draft)
    • Get Cost Center
    • Get Financial Transactions
    • Update Financial Transactions
  • Attendance
    • Get Time Attendance
    • Get Time Attendances Lite
  • Welfare
    • Get Shuttle Buses
    • Get Passengers
  • Time
    • Workin
    • Get Employee WorkIn Site
    • Get Timestamps
    • Get TimeStamp Attachments
    • Get Workin Sites
    • Get IOMO Logs
    • Add Timestamps
  • AppMan
    • Update status criminal checker
    • Send Email Notification when completed
  • Asset
    • Get Asset list
    • Update Asset
    • Get Employee Assets
  • Recruitment
    • Get Candidate
  1. Master

Get Shift Details

Developing
GET
https://api.gofive.co.th/empeo/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:
10
SkipRow
integer 
required
Start index of the record to be skipped
Example:
0
Header Params
Authorization
string 
optional
Authorization credential utilized in API requests
Example:
{{token}}
Ocp-Apim-Subscription-Key
string 
optional
Api subscription key get from the OpenAPI integration setting page
Example:
{{subscription_key}}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.gofive.co.th/empeo/api/v1/shifts?CompanyName=empeo dev test&Code=IVE&ShiftName=สำนักงาน&TakeRow=10&SkipRow=0' \
--header 'Authorization: ' \
--header 'Ocp-Apim-Subscription-Key: '

Responses

🟢200Success
application/json
Body
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
Example
{
  "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"
        }
      ]
    }
  ]
}
🟠401User authentication required V2.
Modified at 2024-11-26 07:39:06
Previous
Get MasterSetup
Next
Create Loan
Built with