מדריך API: קבלת נתוני יומיים

הקדמה

שירות זה מאפשר לקבל נתוני יומיים על עובדים במערכת עבור טווח תאריכים מסוים, באמצעות קריאה לנקודת הקצה המתוארת להלן.

URL

https://412.co.il/index.php/api/getDaily

פרמטרים

פרמטר	תיאור	סוג	דוגמה
`u`	שם משתמש	מחרוזת	`test`
`p`	סיסמה	מחרוזת	`123456`
`from`	תאריך התחלה	מחרוזת (פורמט: YYYY-MM-DD)	`2023-07-01`
`to`	תאריך סיום	מחרוזת (פורמט: YYYY-MM-DD)	`2023-08-01`

תגובה

התשובה משרת ה-API תהיה בפורמט JSON וכוללת את המידע הבא:

פרמטר	תיאור	סוג
`status`	מצב ההצלחה של הפעולה	בוליאני (`true`/`false`)
`msg`	נתונים יומיים או הודעת שגיאה	מערך של אובייקטים (במקרה של הצלחה) או מחרוזת (במקרה של כישלון)

מבנה הנתונים במשתנה msg (במקרה של הצלחה)

פרמטר	תיאור	סוג
`Note`	הערות	מחרוזת
`role_name`	שם התפקיד	מחרוזת
`editedRecord`	האם הרשומה נערכה	מספר
`attach`	קובץ מצורף	מחרוזת או `null`
`date`	תאריך בפורמט תצוגה	מחרוזת
`greg`	תאריך גרגוריאני	מחרוזת (פורמט: YYYY-MM-DD)
`HourType`	סוג השעה	0 - דיווח עבודה 1 - חצי יום מחלה 2 - חצי יום חופשה 3 - חצי יום מילואים 4 - מילואים 5 - חופשה 6 - מחלה 7 - מיוחד/אחר
`HourRecordID`	מזהה רשומת השעה	מספר
`txtgps1`	קואורדינטות GPS 1	מחרוזת או `null`
`txtgps2`	קואורדינטות GPS 2	מחרוזת או `null`
`custom_day`	יום מותאם אישית	מחרוזת
`Flng`	קו אורך התחלה	מחרוזת
`Flat`	קו רוחב התחלה	מחרוזת
`Tolng`	קו אורך סיום	מחרוזת
`Tolat`	קו רוחב סיום	מחרוזת
`Device_from`	מכשיר התחלה	מחרוזת או `null`
`Device_to`	מכשיר סיום	מחרוזת או `null`
`EmpID`	מזהה עובד	מספר
`DeptName`	שם המחלקה	מחרוזת
`empUId`	מזהה ייחודי של העובד	מחרוזת
`EmpFirstName`	שם פרטי של העובד	מחרוזת
`EmpLastName`	שם משפחה של העובד	מחרוזת
`pict`	תמונה	מחרוזת
`EmpNo`	מספר עובד	מחרוזת
`hfrom`	שעת התחלה	מחרוזת (פורמט: HH )
`covid_status`	מצב קורונה	מחרוזת
`hto`	שעת סיום	מחרוזת (פורמט: HH )
`record_value`	ערך הרשומה	מספר
`shifts`	משמרות	מערך של אובייקטים

דוגמה לבקשה

בקשת GET לדוגמה:

http

GET /index.php/api/getDaily?u=test&p=123456&from=2023-07-01&to=2023-08-01 HTTP/1.1 Host: 412.co.il

example
deme url: https://412.co.il/index.php/api/getDaily?u=test&p=123456&from=2023-07-01&to=2023-08-01

דוגמה לתשובה

במקרה של הצלחה:

json

{
  "status": true,
  "msg": [
    {
      "Note": "",
      "role_name": "",
      "editedRecord": 1,
      "attach": null,
      "date": "01/06/2023",
      "greg": "2023-06-01",
      "HourType": 0,
      "HourRecordID": 243613,
      "txtgps1": null,
      "txtgps2": null,
      "custom_day": "אבל",
      "Flng": ".0000000000",
      "Flat": ".0000000000",
      "Tolng": ".0000000000",
      "Tolat": ".0000000000",
      "Device_from": null,
      "Device_to": null,
      "EmpID": 1729232,
      "DeptName": "מחלקה2'כללי",
      "empUId": "EBA40BE2-03FC-4790-AEFA-36F399603091",
      "EmpFirstName": "ישראל",
      "EmpLastName": "ישראלי",
      "pict": "",
      "EmpNo": "123123123",
      "hfrom": "08:00",
      "covid_status": "",
      "hto": "16:00",
      "record_value": 8,
      "shifts": []
    }
  ]
}

במקרה של כישלון:

json

{
  "status": false,
  "msg": "Invalid username or password"
}

הערות נוספות

יש לוודא ששם המשתמש והסיסמה נכונים כדי לקבל גישה לנתונים.
ניתן להשתמש בכלי בדיקה כמו Postman או דפדפן כדי לבדוק את קריאת ה-API.

מקווה שמדריך זה יעזור לך לעבוד עם ה-API בהצלחה!

מאמרים קשורים

מדריך API: הוספת מיקום מותר לדיווח

api לקבלת רשימת עובדים

API להוספת משמרת פתוחה

API לקבלת דוח נוכחות יומי