timeman.status
This method returns information about current workday.
Parameters
Parameter | Description |
---|---|
USER_ID | User ID. Optional, by default, current user settings are returned. |
Response field
Field | Value | Description | Note |
---|---|---|---|
STATUS | string | Current workday status. | Value variations:
| TIME_START | datetime | Date/time of workday start. | Hour zone corresponds to the hour zone when workday starts |
TIME_FINISH | datetime | Date/time of workday finish | For unclosed workday, null is returned |
DURATION | HH:MM:SS | Workday duration | For unclosed workday, 00:00:00 is returned. |
TIME_LEAKS | HH:MM:SS | Summary duration for the break for a day. | |
ACTIVE | true|false | Workday confirmation | 'False' value signifies that the modification of workday awaits of manager's confirmation. |
IP_OPEN | string | IP-address, from which the workday was opened | |
IP_CLOSE | string | IP-address, from which the workday was closed | For unclosed workday, null is returned |
LAT_OPEN | double | Geographic latitude of point where workday was started | |
LON_OPEN | double | Geographic longitude of the point where workday was started | |
LAT_CLOSE | double | Geographic latitude of point where workday was closed | |
LON_CLOSE | double | Geographic longitude of the point where workday was closed | |
TZ_OFFSET | int | Time zone offset for user | Implies time zone where workday was started. When closing the workday, the closing time is recorded with an offset to the time zone, when the day was started. |
TIME_FINISH_DEFAULT | datetime | Time when the workday is closed by default | Displays only for workdays with EXPIRED status. It is a "Recommended" value for closing a workday, which can be shown to a user as the default value. |
If user never opened a workday, an abbreviated response will be returned, containing only STATUS field with CLOSED value.
Call example:
https://portal.bitrix24.com/rest/timeman.status/?auth=xxxxxx&user_id=1
Response example:
{ "result": { "STATUS": "PAUSED", "TIME_START": "2017-04-21T02:33:44+02:00", "TIME_FINISH": "2017-04-21T15:11:26+02:00", "DURATION": "00:00:00", "TIME_LEAKS": "00:00:00", "ACTIVE": false, "IP_OPEN": "192.168.0.1", "IP_CLOSE": "192.168.0.100", "LAT_OPEN": 55.33, "LON_OPEN": 20.5, "LAT_CLOSE": 0, "LON_CLOSE": 0, "TZ_OFFSET": 7200 } }
© «Bitrix24», 2001-2024