метод REST
scope: calendar
calendar.accessibility.get
Получить занятость пользователей из списка
Описание
Метод получает занятость пользователей из списка.
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"from":"2024-06-20","to":"2024-12-20","users":[1,2,34]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/calendar.accessibility.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"from":"2024-06-20","to":"2024-12-20","users":[1,2,34],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/calendar.accessibility.get
// 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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type CalendarEventItem = {
ID: string
NAME: string
DATE_FROM: string
DATE_TO: string
DATE_FROM_TS_UTC: string
DATE_TO_TS_UTC: string
'~USER_OFFSET_FROM': number
'~USER_OFFSET_TO': number
DT_SKIP_TIME: 'Y' | 'N'
TZ_FROM: string
TZ_TO: string
ACCESSIBILITY: 'busy' | 'absent' | 'quest' | 'free'
IMPORTANCE: 'high' | 'normal' | 'low'
EVENT_TYPE: string
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type AccessibilityGetResult = Record<string, CalendarEventItem[]>
try {
const response = await $b24.actions.v2.call.make<AccessibilityGetResult>({
method: 'calendar.accessibility.get',
params: {
from: '2024-06-20',
to: '2024-12-20',
users: [1, 2, 34],
},
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
for (const [userId, events] of Object.entries(result)) {
console.info(`User ${userId}:`, events.map(e => `${e.NAME} (${e.ACCESSIBILITY})`))
}
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- 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 getAccessibility() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'calendar.accessibility.get',
params: {
from: '2024-06-20',
to: '2024-12-20',
users: [1, 2, 34],
},
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
for (const [userId, events] of Object.entries(result)) {
console.info(`User ${userId}:`, events.map(e => `${e.NAME} (${e.ACCESSIBILITY})`))
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getAccessibility)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.calendar.accessibility.get(
users=[
1,
2,
34,
],
from_date="2024-06-20",
to="2024-12-20",
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'calendar.accessibility.get',
[
'from' => '2024-06-20',
'to' => '2024-12-20',
'users' => [1, 2, 34]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting calendar accessibility: ' . $e->getMessage();
}
BX24.callMethod(
'calendar.accessibility.get',
{
from: '2024-06-20',
to: '2024-12-20',
users: [1, 2, 34]
}
);
require_once('crest.php');
$result = CRest::call(
'calendar.accessibility.get',
[
'from' => '2024-06-20',
'to' => '2024-12-20',
'users' => [1, 2, 34]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "calendar.accessibility.get", b24.Params{
"from": "2024-06-20",
"to": "2024-12-20",
"users": []int{1, 2, 34},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("calendar.accessibility.get: %w", err)
}
// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)
Ответ
HTTP-статус: 200
{
"result": {
"1": [
{
"ID": "1213",
"NAME": "Event name",
"DATE_FROM": "02.12.2024 11:00:00",
"DATE_TO": "02.12.2024 12:00:00",
"DATE_FROM_TS_UTC": "1733158800",
"DATE_TO_TS_UTC": "1733162400",
"~USER_OFFSET_FROM": -21600,
"~USER_OFFSET_TO": -21600,
"DT_SKIP_TIME": "N",
"TZ_FROM": "America/Managua",
"TZ_TO": "America/Managua",
"ACCESSIBILITY": "busy",
"IMPORTANCE": "normal",
"EVENT_TYPE": "#collab#"
},
{
"ID": "1216",
...
}
],
"2": [
{
"ID": 1,
...
},
{
"ID": 2,
...
}
],
"34": []
}
}
Возвращаемые данные
result
object
Результат содержит объект.
Ключ объекта — это идентификатор пользователя из запроса.
Значение — массив объектов, каждый из которых описывает событие, в котором занят пользователь в указанный период
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Не задан обязательный параметр \"from\" для метода \"calendar.accessibility.get\""
}
| Код | Описание | Значение |
|---|---|---|
| — | Не задан обязательный параметр "from" для метода "calendar.accessibility.get" | Не передан обязательный параметр from |
| — | Не задан обязательный параметр "to" для метода "calendar.accessibility.get" | Не передан обязательный параметр to |
| — | Не задан обязательный параметр "users" для метода "calendar.accessibility.get" | Не передан обязательный параметр users |
| — | Доступ запрещен | Запрещен доступ к методу для внешних пользователей |

