{"id":12627,"date":"2024-06-25T14:08:24","date_gmt":"2024-06-25T11:08:24","guid":{"rendered":"https:\/\/availo.app\/?post_type=documents&p=12627"},"modified":"2024-06-25T14:08:27","modified_gmt":"2024-06-25T11:08:27","slug":"get-working-report-all-employee","status":"publish","type":"documents","link":"https:\/\/availo.app\/en\/documents\/%d9%85%d8%b3%d8%aa%d9%86%d8%af%d8%a7%d8%aa-api\/get-working-report-all-employee\/","title":{"rendered":"Get Working Report All Employee"},"content":{"rendered":"\n

<\/p>\n\n\n\n

<\/p>\n\n\n\n

Link: <\/strong>{Base_Url}\/api\/ExternalReports\/GetWorkingReportAllEmployee<\/p>\n\n\n\n

Method Type: <\/strong>POST<\/p>\n\n\n\n

Content Type: <\/strong>Application\/Json<\/p>\n\n\n\n

Description<\/strong>: <\/strong>Return all transactions sessions of All employees during a period of dates.<\/p>\n\n\n\n

<\/p>\n\n\n\n

Request object:<\/em><\/strong><\/p>\n\n\n\n

Field<\/td>Required<\/td>Type<\/td>Description<\/td><\/tr>
Data.  FromDate<\/td>
Yes<\/td>

Date<\/td>
The start date ofperiod<\/td><\/tr>
Data.  ToDate<\/td>Yes<\/td>Date<\/td>The end date of period<\/td><\/tr>







Data.DisplayType<\/td>







Yes<\/td>







int<\/td>
The expected values are
means that you need to return the first getting in and the last getting out for each employee per day.means that you need to return all employeessessions (getting in and getting out) in the day<\/td><\/tr>

Data.TimeZoneOffset<\/td>

Yes<\/td>

int<\/td>
KSA (-180)UAE (-240)Jordan (-120)<\/td><\/tr>
PageNumber<\/td>Yes<\/td>int<\/td>The current Page number
**If the value is 0 the response will include all list<\/td><\/tr>

PageSize<\/td>

Yes<\/td>

int<\/td>
The number of rows perpage<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

<\/p>\n\n\n\n

Sample Request:<\/strong><\/p>\n\n\n\n

\"Graphical<\/p>\n\n\n\n


<\/strong><\/p>\n\n\n\n

<\/p>\n\n\n\n

Response object:<\/strong><\/p>\n\n\n\n

Field<\/td>Required<\/td>type<\/td>Description<\/td><\/tr>

Data<\/td>

Yes<\/td>

List of objects
**find the table below<\/td>

List of all employees with their movements<\/td><\/tr>

Status<\/td>

Yes<\/td>

bool<\/td>

if the request is a success or not<\/td><\/tr>

message<\/td>

No<\/td>

string<\/td>

The error message that returns from request<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Field<\/td>type<\/td>Description<\/td><\/tr>


Status<\/td>

string<\/td>
Status of the transactions. Values:
“Completed” (Check-in and checkout)”Absence”, (No Check-in and No checkout)”Un completed”, (Check-in without checkout)”Automatic check out\u201d (Check-in with auto checkout)”Leave” (Has an approved leave)”Vacation\u201d (Has an approved vacation)”Weekly Holiday””Yearly Holiday””Public Holiday”<\/td><\/tr>

totalPlanWorkHourDuringInterval<\/td>


Hours: Minutes<\/td>

The number of hours an employee’s work plan requires<\/td><\/tr>

totalHoursWorkDuringInterval<\/td>

Hours: Minutes<\/td>

 The number of working hours for an employee ona given day<\/td><\/tr>

totalCheckInLateHoursDuringInterval<\/td>

Hours: Minutes<\/td>

 Total number of hours an employee is checked-in late on a given day (depending on their work plan\u2019s start hour)<\/td><\/tr>


totalCheckOutLateHoursDuringInterval<\/td>


Hours: Minutes<\/td>

Total number of hours an employee is checked-out early on a given day (depending on their work plan\u2019s finish hour)<\/td><\/tr>

sessionTotalCheckInLateHours<\/td>

Hours: Minutes<\/td>

The number of hours an employee is checked-in late on a given day in current session (depending on their work plan\u2019s start hour)
<\/td><\/tr>

sessionTotalCheckOutLateHours<\/td>


Hours: Minutes<\/td>

The number of hours an employee checked-out early on a given day in current session (depending on their work plan\u2019s finish hour)
<\/td><\/tr>


sessionTotalShortesHours<\/td>


Hours: Minutes<\/td>

 <\/em><\/strong>Total number of shortages working hours of employee (depending on their work plan working hours)
<\/td><\/tr>


sessionTotalOverTimeHours<\/td>


Hours: Minutes<\/td>

The number of overtime hours on a given day (depending on their work plan\u2019s working hours)<\/td><\/tr>


sessionTotalOverTimeExtraHours<\/td>


Hours: Minutes<\/td>

The number of extra overtime hours on a given day (depending on their work plan\u2019s working hours)<\/td><\/tr>


sessionTotalHolidayOverTimeHours<\/td>


Hours: Minutes<\/td>

The number of hours an employee work on holidays (depending on their work plans holidays)<\/td><\/tr>


firstShiftStartTime<\/td>


Hours: Minutes<\/td>

 Employee work plan start time (first shift) <\/td><\/tr>


firstShiftEndTime<\/td>


Hours: Minutes<\/td>


 Employee work plan finish time (first shift)<\/td><\/tr>

secShiftStartTime<\/td>


Hours: Minutes<\/td>


 Employee work plan start time (second shift)** if the plan has two work shifts<\/td><\/tr>


secShiftEndTime<\/td>


Hours: Minutes<\/td>


 Employee work plan finish time (second shift)** if the plan has two work shifts<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

<\/p>\n\n\n\n

Sample Response:<\/strong><\/p>\n\n\n\n

\"Graphical<\/strong><\/p>\n\n\n\n

\"Graphical<\/figure>\n\n\n\n

\"Graphical
<\/strong>
\u00a0\u00a0<\/p>\n\n\n\n

{\r\n  \"data\": {\r\n    \"list\": [\r\n      {\r\n        \"jobNumber\": \"0\",\r\n        \"userName\": \"h.shqeer@t2.sa\",\r\n        \"fullName\": \"heba\",\r\n        \"totalPlanWorkHourDuringInterval\": \"00:00\",\r\n        \"totalHoursWorkDuringInterval\": \"00:01\",\r\n        \"totalCheckInLateHoursDuringInterval\": \"00:00\",\r\n        \"totalCheckOutLateHoursDuringInterval\": \"00:00\",\r\n        \"workReportTransactions\": {\r\n          \"list\": [\r\n            {\r\n              \"selectedDate\": \"2020-11-22T00:00:00\",\r\n              \"status\": \"Completed\",\r\n              \"workingHours\": \"-\",\r\n              \"checkInDate\": \"17:56\",\r\n              \"checkInAccessGateNameAr\": \"heba\",\r\n              \"checkInAccessGateNameEn\": \"gps\",\r\n              \"checkOutDate\": \"17:57\",\r\n              \"checkOutAccessGateNameAr\": \"heba\",\r\n              \"checkOutAccessGateNameEn\": \"gps\",\r\n              \"actualWorkingHours\": \"00:01\",\r\n              \"sessionTotalCheckInLateHours\": \"00:00\",\r\n              \"sessionTotalCheckOutLateHours\": \"00:00\",\r\n              \"sessionTotalShortesHours\": \"00:00\",\r\n              \"sessionTotalOverTimeHours\": \"00:00\",\r\n              \"sessionTotalOverTimeExtraHours\": \"00:00\",\r\n              \"sessionTotalHolidayOverTimeHours\": \"00:00\"\r\n            }\r\n          ],\r\n          \"totalCount\": 2\r\n        }\r\n      }\r\n    ],\r\n    \"totalCount\": 3\r\n  },\r\n  \"status\": true,\r\n  \"message\": \"\"\r\n}\r\n\r\n<\/code><\/pre>\n","protected":false},"excerpt":{"rendered":"

Link: {Base_Url}\/api\/ExternalReports\/GetWorkingReportAllEmployee Method Type: POST Content Type: Application\/Json Description: Return all transactions sessions of All employees during a period of dates. Request object: Field Required Type Description Data.  FromDate Yes Date The start date ofperiod Data.  ToDate Yes Date The end date of period Data.DisplayType Yes int The expected values aremeans that you need to […]<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":12458,"menu_order":0,"template":"","aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/availo.app\/en\/wp-json\/wp\/v2\/documents\/12627"}],"collection":[{"href":"https:\/\/availo.app\/en\/wp-json\/wp\/v2\/documents"}],"about":[{"href":"https:\/\/availo.app\/en\/wp-json\/wp\/v2\/types\/documents"}],"author":[{"embeddable":true,"href":"https:\/\/availo.app\/en\/wp-json\/wp\/v2\/users\/2"}],"version-history":[{"count":0,"href":"https:\/\/availo.app\/en\/wp-json\/wp\/v2\/documents\/12627\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/availo.app\/en\/wp-json\/wp\/v2\/documents\/12458"}],"wp:attachment":[{"href":"https:\/\/availo.app\/en\/wp-json\/wp\/v2\/media?parent=12627"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}