Skip to content

timeman-status.md

Latest commit

 

History

History
379 lines (311 loc) · 10.5 KB

timeman-status.md

File metadata and controls

379 lines (311 loc) · 10.5 KB
Raw

Get information about the current workday timeman.status

{% note tip "" %}

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

{% endnote %}

Scope: timeman

Who can execute the method: any user

The method timeman.status retrieves information about the current workday.

Method parameters

#| || Name type | Description || || USER_ID integer | User identifier.

By default — the identifier of the current user || |#

Code examples

{% include Footnote on examples %}

{% list tabs %}

  • cURL (Webhook)

    curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"USER_ID":503}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/timeman.status

  • cURL (OAuth)

    curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"USER_ID":503,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/timeman.status

  • JS (TS)

    // This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type TimemanStatusResult = {
  STATUS: string
  TIME_START: ISODate | null
  TIME_FINISH: ISODate | null
  DURATION: string
  TIME_LEAKS: string
  ACTIVE: boolean
  IP_OPEN: string
  IP_CLOSE: string | null
  LAT_OPEN: number
  LON_OPEN: number
  LAT_CLOSE: number
  LON_CLOSE: number
  TZ_OFFSET: number
  TIME_FINISH_DEFAULT: ISODate | null
}

try {
  const response = await $b24.actions.v2.call.make<TimemanStatusResult>({
    method: 'timeman.status',
    params: {
      USER_ID: 503,
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Status:', result.STATUS, 'Started:', result.TIME_START)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

  • JS (UMD)

    <!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getTimemanStatus() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'timeman.status',
        params: {
          USER_ID: 503,
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Status:', result.STATUS, 'Started:', result.TIME_START)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getTimemanStatus)
</script>

  • Python

    from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.timeman.status(user_id=503).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Bitrix API error",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Bitrix SDK error: {error.message}")
except Exception as error:
    print(f"Unexpected error: {error}")

  • PHP

    try {
    $response = $b24Service
        ->core
        ->call(
            'timeman.status',
            [
                'USER_ID' => 503
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    if ($result->error()) {
        error_log($result->error());
        echo 'Error: ' . $result->error();
    } else {
        echo 'Info: ' . print_r($result->data(), true);
    }

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error calling timeman.status: ' . $e->getMessage();
}

  • BX24.js

    BX24.callMethod(
    'timeman.status',
    {
        'USER_ID' : 503
    },
    function(result) {
        if (result.error()) {
            console.error(result.error());
        } else {
            console.info(result.data());
        }
    }
);

  • PHP CRest

    require_once('crest.php');

$result = CRest::call(
    'timeman.status',
    [
        'USER_ID' => 503
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

  • Go

    // client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "timeman.status", b24.Params{
	"USER_ID": 503,
})
if err != nil {
	return fmt.Errorf("timeman.status: %w", err)
}

var item struct {
	Status    string `json:"STATUS"`
	TimeStart string `json:"TIME_START"`
	Duration  string `json:"DURATION"`
	TimeLeaks string `json:"TIME_LEAKS"`
	Active    bool   `json:"ACTIVE"`
	IPOpen    string `json:"IP_OPEN"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.Status, item.TimeStart)

{% endlist %}

Response handling

HTTP status: 200

{
    "result": {
        "STATUS": "EXPIRED",
        "TIME_START": "2025-03-27T08:00:01+02:00",
        "TIME_FINISH": null,
        "DURATION": "00:00:00",
        "TIME_LEAKS": "00:17:53",
        "ACTIVE": false,
        "IP_OPEN": "",
        "IP_CLOSE": "",
        "LAT_OPEN": 53.548841000000003,
        "LON_OPEN": 9.9872739999999993,
        "LAT_CLOSE": 0,
        "LON_CLOSE": 0,
        "TZ_OFFSET": 7200,
        "TIME_FINISH_DEFAULT": "2025-03-27T17:00:00+02:00"
    },
    "time": {
        "start": 1743057653.725821,
        "finish": 1743057654.0894129,
        "duration": 0.36359190940856934,
        "processing": 0.3278491497039795,
        "date_start": "2025-03-27T09:40:53+03:00",
        "date_finish": "2025-03-27T09:40:54+03:00",
        "operating_reset_at": 1743058253,
        "operating": 0.32782983779907227
    }
}

Returned data

#| || Name type | Description || || result object | Root element of the response.

Contains an object describing the workday || || STATUS string | Status of the current workday.

Possible values:

  • OPENED — opened
  • CLOSED — closed
  • PAUSED — paused
  • EXPIRED — expired, meaning opened before the start of the current calendar day and not closed || || TIME_START datetime | Date and time when the workday starts.

The time zone corresponds to the time zone at the start of the workday || || TIME_FINISH datetime | Date and time the workday ends.

Returns null for an unfinished workday || || DURATION string | Duration of the workday in the format HH:MM:SS.

Returns 00:00:00 for an unfinished workday || || TIME_LEAKS string | Total duration of breaks during the day in the format HH:MM:SS || || ACTIVE boolean | Confirmation of the workday.

A value of false means that the change to the workday is awaiting confirmation from the supervisor || || IP_OPEN string | IP address from which the workday started || || IP_CLOSE string | IP address from which the workday ended.

Returns null for an unfinished workday || || LAT_OPEN double | Geographical latitude of the point where the workday started || || LON_OPEN double | Geographical longitude of the point where the workday started || || LAT_CLOSE double | Geographical latitude of the point where the workday ended || || LON_CLOSE double | Geographical longitude of the point where the workday ended || || TZ_OFFSET integer | Time zone offset of the employee where the workday started.

The end time of the workday is adjusted to the time zone at the start of the day || || TIME_FINISH_DEFAULT datetime | Recommended value for the end of the day, which can be displayed to the user as a default value.

Displayed only for workdays with the status expired EXPIRED || || time time | Information about the time taken to process the request || |#

Error handling

HTTP status: 400

{
    "error":"",
    "error_description":"User not found"
}

{% include notitle error handling %}

Possible error codes

#| || Code | Description | Value || || TIMEMAN_TOOL_DISABLED | Working time management is disabled. | The time tracking tool is disabled || || empty string | User not found | User with the specified USER_ID not found || |#

Continue exploring