Get Work Cycle List

ดึงรายชื่อรายการกะการทำงานทั้งหมดของบริษัท สำหรับใช้เป็นตัวเลือกกะใหม่ตอนแก้ไขตารางกะการทำงาน

ใช้ API นี้เพื่อดึงรายการกะการทำงานและรอบเวลาทั้งหมดที่ใช้งานอยู่ เพื่อนำไปเป็นตัวเลือก (Dropdown) ให้ผู้ใช้เลือกเปลี่ยนกะพนักงานผ่าน Save Work Cycle Grid — ค่า work_cycle_id ที่ได้จาก API นี้ให้นำไปใช้ต่อในการแก้ไขกะโดยตรง

Endpoint


GET /api/v1/open-apis/time-manage/get-work-cycle-list

สิทธิ์ที่ต้องการ: API Key ต้องมีสิทธิ์ ข้อมูลการยื่นเอกสาร (document:manage)

Request Parameters

ไม่มี parameters

Response Format

Success Response (HTTP 200)


{
  "code": 200,
  "message": "Success",
  "payload": [
    {
      "work_cycle_id": "202401083EAE7D1F9711",
      "work_cycle_code": "M1",
      "work_cycle_type_lv": "00",
      "cycle_for_parttime": "0",
      "work_start_time": "08:00",
      "work_end_time": "17:00",
      "break1_start_time": "12:00",
      "break1_end_time": "13:00",
      "break2_start_time": null,
      "break2_end_time": null,
      "work_hour": "00:00:00",
      "break_hour": "00:00:00",
      "work_cycle_addon_type": "00",
      "work_cycle_addon_type_for_employee": "daily",
      "work_cycle_value": "0.00",
      "work_cycle_auto": "0",
      "break_type": "01",
      "text_color": "#008CFF",
      "background_color": "#E6F4FA",
      "round_decimal": "N"
    }
  ]
}

Error Response - Unauthorized (HTTP 401)


{
  "statusCode": 401,
  "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
}

Response Fields

`payload[]`

Field	Type	Nullable	Description
`work_cycle_id`	string	No	รหัสอ้างอิงกะการทำงาน (ใช้ส่งกลับตอนแก้ไขกะ)
`work_cycle_code`	string	No	รหัสย่อกะการทำงาน (เช่น `"M1"`)
`work_cycle_type_lv`	string	No	รหัสประเภทกะการทำงาน
`cycle_for_parttime`	string	No	ระบุว่าเป็นกะสำหรับพนักงานพาร์ทไทม์หรือไม่
`work_start_time`	string	No	เวลาเริ่มเข้างานตามกะ (`HH:mm` เช่น `"08:00"`)
`work_end_time`	string	No	เวลาสิ้นสุดการทำงานตามกะ (`HH:mm` เช่น `"17:00"`)
`break1_start_time`	string	Yes	เวลาเริ่มพักช่วงที่ 1 (`HH:mm`)
`break1_end_time`	string	Yes	เวลาสิ้นสุดพักช่วงที่ 1 (`HH:mm`)
`break2_start_time`	string	Yes	เวลาเริ่มพักช่วงที่ 2 (`HH:mm`)
`break2_end_time`	string	Yes	เวลาสิ้นสุดพักช่วงที่ 2 (`HH:mm`)
`work_hour`	string	No	จำนวนชั่วโมงทำงานตามกะ (`HH:mm:ss`)
`break_hour`	string	No	จำนวนชั่วโมงพักตามกะ (`HH:mm:ss`)
`work_cycle_addon_type`	string	No	รหัสประเภทการคิดค่ากะเพิ่มเติม
`work_cycle_addon_type_for_employee`	string	No	หน่วยการคิดกะสำหรับพนักงาน (เช่น `"daily"`)
`work_cycle_value`	string	No	ค่าประกอบของกะ (ทศนิยม)
`work_cycle_auto`	string	No	ระบุว่าเป็นกะอัตโนมัติหรือไม่
`break_type`	string	No	รหัสประเภทการพักเบรก
`merge_1_`, `merge_2_`	string	Yes	ค่าคอนฟิกกะย่อยชุดที่ 1 และ 2 (เวลาเข้า-ออก, เวลาพัก, ประเภท/ค่าประกอบ) — เป็น `null` เมื่อไม่ได้ใช้งาน
`text_color`	string	No	สีตัวอักษรสำหรับแสดงกะบนตาราง (`#RRGGBB`)
`background_color`	string	No	สีพื้นหลังสำหรับแสดงกะบนตาราง (`#RRGGBB`)
`round_decimal`	string	No	การตั้งค่าการปัดเศษทศนิยมของกะ

Code Examples

cURL


curl -X GET "https://openapi.humansoft.co.th/api/v1/open-apis/time-manage/get-work-cycle-list" \
  -H "Ocp-Apim-Subscription-Key: YOUR_API_KEY"

JavaScript


const response = await fetch(
  'https://openapi.humansoft.co.th/api/v1/open-apis/time-manage/get-work-cycle-list',
  {
    method: 'GET',
    headers: {
      'Ocp-Apim-Subscription-Key': 'YOUR_API_KEY'
    }
  }
)
 
const data = await response.json()
console.log(data)

Python


import requests
 
url = "https://openapi.humansoft.co.th/api/v1/open-apis/time-manage/get-work-cycle-list"
headers = {
    "Ocp-Apim-Subscription-Key": "YOUR_API_KEY"
}
 
response = requests.get(url, headers=headers)
print(response.json())

PHP


<?php
$url = "https://openapi.humansoft.co.th/api/v1/open-apis/time-manage/get-work-cycle-list";
 
$headers = [
    "Ocp-Apim-Subscription-Key: YOUR_API_KEY"
];
 
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
 
$response = curl_exec($ch);
print_r(json_decode($response, true));
 
curl_close($ch);
?>

Business Rules

API นี้คืนเฉพาะกะการทำงานที่ตั้งค่าไว้และใช้งานอยู่ในบริษัทที่ผูกกับ API Key นั้นๆ
work_cycle_id ที่ได้จาก response นี้ ให้นำไปใช้ต่อในการแก้ไขกะโดยตรง — ห้ามสร้างค่าขึ้นเอง

Save Work Cycle Grid - นำรหัส work_cycle_id ที่ได้จาก API นี้ส่งกลับไปเพื่อขอเปลี่ยนกะ
Get Work Cycle Grid - ดึงตารางกะการทำงานของพนักงานแบบ Grid รายเดือน/สัปดาห์