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

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

הקדמה

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

URL

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

פרמטרים

פרמטר	תיאור	סוג	דוגמה
u	שם משתמש	מחרוזת	test
p	סיסמה	מחרוזת	123456

תגובה

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

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

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

פרמטר	תיאור	סוג
empname	שם העובד	מחרוזת
nickname	כינוי	מחרוזת (או null)
role	תפקידים	מערך של אובייקטים
role_name	שם התפקיד	מחרוזת
role_id	מזהה התפקיד	מספר
CellPhone	טלפון סלולרי	מחרוזת
Email	דוא"ל	מחרוזת
birthdate	תאריך לידה	מחרוזת (או null)
dworkStart	תאריך תחילת עבודה	מחרוזת (או null)
dworkEnd	תאריך סיום עבודה	מחרוזת (או null)
DeptName	שם המחלקה	מחרוזת
EmpNo	מספר עובד	מחרוזת
status	סטטוס	1 פעיל או 0 כבוי
DeptCode	קוד מחלקה	מחרוזת
UserTypeDesc	סוג משתמש	מחרוזת

דוגמה לבקשה

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

http

 

GET /index.php/api/getEmp?u=test&p=123456 HTTP/1.1 Host: 412.co.il

or

demo url: https://412.co.il/index.php/api/getEmp?u=test&p=123456


דוגמה לתשובה

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

json

 

{ "status": true, "msg": [ { "empname": "admin 1", "nickname": null, "role": [ { "role_name": "driver", "role_id": 1440 }, { "role_name": "waiter", "role_id": 1442 }, { "role_name": "assistant", "role_id": 1444 }, { "role_name": "food", "role_id": 1445 } ], "CellPhone": "", "Email": "", "birthdate": null, "dworkStart": null, "dworkEnd": null, "DeptName": "Dept1", "EmpNo": "1222" } ] }

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

json

 

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

הערות נוספות

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

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