Get Shift Details - Gofive OpenAPI

ดึงรายการกะการทำงาน

ดึงกะการทำงานที่ตั้งไว้ใน tenant พร้อมรายละเอียดเวลาเข้า-ออกรายวัน ใช้หา Code และ ShiftRefId
ก่อนกำหนดกะให้พนักงาน คืนเฉพาะกะที่เปิดใช้งานอยู่

ควรส่ง companyName เสมอ — ถ้าไม่ส่ง ระบบจะไม่ได้แปลว่า "ทุกบริษัท" แต่จะเลือกบริษัทใน tenant มา
หนึ่งบริษัทแบบไม่กำหนดแน่นอน แล้วคืนกะของบริษัทนั้นบวกกับกะที่ใช้ได้ทุกสาขา (IsAllSite = true)
ผลลัพธ์จึงอาจไม่ใช่บริษัทที่ต้องการ

companyName, code และ shiftName ค้นแบบ contains (shiftName ค้นทั้งชื่อไทยและอังกฤษ)
ผลลัพธ์เรียงตามชื่อกะจากมากไปน้อย ไม่ส่ง takeRow = 50 รายการแรก

ShiftDetails มีหนึ่งรายการต่อหนึ่งวันในรอบของกะ — DayOfWeek 1 = อาทิตย์ ถึง 7 = เสาร์
และ WeekOfMonth ใช้กับกะที่หมุนเวียนรายสัปดาห์ (0 = ทุกสัปดาห์)

ต้องมีสิทธิ์ Open API โมดูล Shift ระดับ Read

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

สำเร็จ — Data คือกะที่ตรงตัวกรอง พร้อม ShiftDetails ของแต่ละกะ

Bodyapplication/json

Example

{
    "StatusCode": 200,
    "Message": "OK",
    "Totals": 1,
    "Data": [
        {
            "ShiftRefId": 3301,
            "ShiftName": "กะเช้าตัวอย่าง",
            "ShiftName_EN": "Sample Morning Shift",
            "Code": "A01",
            "ColorCode": "#4CAF50",
            "Description": "กะทำงานปกติ จันทร์-ศุกร์",
            "IsAllSite": false,
            "IsNightShift": false,
            "IsDoubleShift": false,
            "MinuteFlexible": 15,
            "MinuteOfLate": 30,
            "MinuteOfAbsence": 240,
            "Allowance": 0,
            "HolidayAllowance": false,
            "ShiftDetails": [
                {
                    "DayOfWeek": 2,
                    "WeekOfMonth": 0,
                    "StartTime": "08:00:00",
                    "EndTime": "17:00:00",
                    "BreakStartTime": "12:00:00",
                    "BreakEndTime": "13:00:00",
                    "OTStartTime": "17:30:00",
                    "OTEndTime": "20:00:00"
                },
                {
                    "DayOfWeek": 3,
                    "WeekOfMonth": 0,
                    "StartTime": "08:00:00",
                    "EndTime": "17:00:00",
                    "BreakStartTime": "12:00:00",
                    "BreakEndTime": "13:00:00",
                    "OTStartTime": "17:30:00",
                    "OTEndTime": "20:00:00"
                }
            ]
        }
    ]
}

🟢204No Content

🟠401Unauthorized

🟠403Forbidden

🟠429

🔴500Server Error