Documentation

timeman.status

This method returns information about current workday.

Parameters

ParameterDescription
USER_IDUser ID. Optional, by default, current user settings are returned.

Response field

tr>
Field ValueDescriptionNote
STATUSstringCurrent workday status.Value variations:
  • OPENED - workday is ongoing
  • CLOSED - workday is closed
  • PAUSED - workday is paused
  • EXPIRED - workday has expired (was opened prior to start of current calendar day and was not closed)
TIME_STARTdatetimeDate/time of workday start.Hour zone corresponds to the hour zone when workday starts
TIME_FINISHdatetimeDate/time of workday finishFor unclosed workday, null is returned
DURATIONHH:MM:SSWorkday durationFor unclosed workday, 00:00:00 is returned.
TIME_LEAKSHH:MM:SSSummary duration for the break for a day.
ACTIVEtrue|falseWorkday confirmation'False' value signifies that the modification of workday awaits of manager's confirmation.
IP_OPENstringIP-address, from which the workday was opened
IP_CLOSEstringIP-address, from which the workday was closedFor unclosed workday, null is returned
LAT_OPENdoubleGeographic latitude of point where workday was started
LON_OPENdoubleGeographic longitude of the point where workday was started
LAT_CLOSEdoubleGeographic latitude of point where workday was closed
LON_CLOSEdoubleGeographic longitude of the point where workday was closed
TZ_OFFSETintTime zone offset for userImplies 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_DEFAULTdatetimeTime when the workday is closed by defaultDisplays 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