timeclock.timeclocks

Returns a list of all Time Clocks.

SUPPORTED METHODS:

GET

ParametersTypeDescription
token (required)Valid token
start_date (accepted)dateStart date
end_date (accepted)dateEnd date
schedule (accepted)integerSchedule id
employee_id (accepted)integerEmployee id
status (accepted)enum (approved, unapproved)
page (accepted)integerPage number
per_page (accepted)integerNumber per page
order_by (accepted)enum (id, end_timestamp)
direction (accepted)enum (asc, desc)asc: ascending
desc: descending

DOCUMENTATION

GET
Returns a list of schedules.
Level 5 is required

--

Example Request:

{
   "module":"timeclock.timeclocks",
   "method":"GET",
   "request":{
         "start_date":"11/14/2013",
         "end_date":"11/14/2013"
   }
}

Example Response:

{
   "status":1,
   "data":[{
        "store": "18769",
        "in_terminal": "0",
        "break_time": "21",
        "approved_time": "0",
        "out_gps": "{\"latitude\":\"\",\"longitude\":\"\",\"supported\":0}",
        "in_picture": null,
        "out_picture_url": "",
        "out_hour": "18",
        "out_terminal": "-98",
        "length": {
            "total_hours": "0.02",
            "hours": 0,
            "mins": 1
        },
        "in_gps": "{\"latitude\":\"\",\"longitude\":\"\",\"supported\":0}",
        "out_day": "1660",
        "out_timestamp": "1384427970",
        "in_picture_url": "",
        "remote_site": null,
        "schedule": {
            "name": "Kids",
            "id": "153311"
        },
        "in_hour": "18",
        "events": [
            {
                "clock_time": "3952824",
                "type": "3",
                "data": {"notes": "shift notes"},
                "timestamp": "2013-11-14 04:18:13",
                "id": "11741"
            },
            {
                "clock_time": "3952824",
                "type": "6",
                "data": {"position": "153311"},
                "timestamp": "2013-11-14 04:18:24",
                "id": "11742"
            },
            {
                "clock_time": "3952824",
                "type": "1",
                "data": null,
                "timestamp": "2013-11-14 04:18:45",
                "id": "11743"
            },
            {
                "clock_time": "3952824",
                "type": "2",
                "data": {"breakin": "11743"},
                "timestamp": "2013-11-14 04:19:06",
                "id": "11744"
            }
        ],
        "in_timestamp": "1384427881",
        "in_location": "devtest2",
        "shift": null,
        "screenshots": null,
        "in_day": "1660",
        "status": "0",
        "approved_by": "0",
        "end_timestamp": "2013-11-14 04:19:30",
        "id": "3952824",
        "out_time": {
            "day": "Nov 14, 2013",
            "timestamp": "2013-11-14 04:19:30",
            "time": "4:19am"
        },
        "approved_notes": "",
        "out_picture": "",
        "created": "0",
        "out_location": "devtest2",
        "in_time": {
            "day": "Nov 14, 2013",
            "timestamp": "2013-11-14 04:18:01",
            "time": "4:18am"
        },
        "notes": "shift notes",
        "employee": {
            "name": "Lisa",
            "id": "258265"
        },
        "start_timestamp": "2013-11-14 04:18:01",
        "current_length": {
            "total_hours": "0.03",
            "hours": 0,
            "mins": 2
        }
    }],
   "token":"xxxxxxx"
}