calendar-accessibility-get.md

Получить занятость пользователей из списка calendar.accessibility.get

Scope: calendar

Кто может выполнять метод: любой пользователь

Метод получает занятость пользователей из списка.

Параметры метода

{% include Сноска об обязательных параметрах %}

#| || Название тип | Описание || || users* array | Массив идентификаторов пользователей || || from* date | Дата начала периода для определения занятости в формате ГГГГ-ММ-ДД.

Например, 2024-06-20 || || to* date | Дата окончания периода для определения занятости в формате ГГГГ-ММ-ДД.

Например, 2024-12-20 || |#

Примеры кода

{% include Сноска о примерах %}

{% list tabs %}

• cURL (Webhook)

  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_webbhook_here**/calendar.accessibility.get

• cURL (OAuth)

  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

• JS

  BX24.callMethod(
      'calendar.accessibility.get',
      {
          from: '2024-06-20',
          to: '2024-12-20',
          users: [1, 2, 34]
      }
  );

• PHP

  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>';

{% endlist %}

Обработка ответа

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 | Результат содержит объект.

Ключ объекта — это идентификатор пользователя из запроса.

Значение — массив объектов, каждый из которых описывает событие, в котором занят пользователь в указанный период || |#

Объект события {#event}

#| || Название тип | Описание || || ID string | Идентификатор события || || NAME string | Название события || || DATE_FROM datetime | Дата и время начала события || || DATE_TO datetime | Дата и время окончания события || || DATE_FROM_TS_UTC string | Дата и время начала события в UTC в формате timestamp || || DATE_TO_TS_UTC string | Дата и время окончания события в UTC в формате timestamp || || ~USER_OFFSET_FROM integer | Смещение времени начала события относительно UTC в секундах || || ~USER_OFFSET_TO integer | Смещение времени окончания события относительно UTC в секундах || || DT_SKIP_TIME integer | Флаг отображающий что событие длится целый день. Возможные значения:

• Y — целый день

• N — не целый день || || TZ_FROM integer | Таймзона даты начала события || || TZ_TO integer | Таймзона даты окончания события || || ACCESSIBILITY integer | Доступность участников события. Возможные значения:

• busy — занят

• absent — отсутствую

• quest — под вопросом

• free — свободен || || IMPORTANCE string | Важность события. Возможные значения:

• high — высокая

• normal — средняя

• low— низкая || || EVENT_TYPE string | Некоторые события содержат информацию о способе создания.

Событие может быть создано через:

• #shared# — слоты календаря
• #shared_crm# — слоты CRM
• #collab# — коллабу
• #shared_collab# — слоты коллабы || |#

Обработка ошибок

HTTP-статус: 400

{
    "error": "",
    "error_description": "Не задан обязательный параметр "from" для метода "calendar.accessibility.get""
}

{% include notitle обработка ошибок %}

Возможные коды ошибок

#| || Код | Сообщение об ошибке | Описание || || Пустая строка | Не задан обязательный параметр "from" для метода "calendar.accessibility.get" | Не передан обязательный параметр from || || Пустая строка | Не задан обязательный параметр "to" для метода "calendar.accessibility.get" | Не передан обязательный параметр to || || Пустая строка | Не задан обязательный параметр "users" для метода "calendar.accessibility.get" | Не передан обязательный параметр users || || Пустая строка | Доступ запрещен | Запрещен доступ к методу для внешних пользователей || |#

{% include системные ошибки %}

Продолжите изучение

• {#T}