Получить список будущих событий calendar.event.get.nearest

Scope: calendar

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

Метод получает список ближайших будущих событий календаря за заданное число дней.

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

Примеры кодаПримеры кода

Как использовать примеры в документации

1. Получить события текущего пользователя за следующие 10 дней.

   cURL (Webhook)

   cURL (OAuth)

   BX24.js

   Python

   PHP

   Go

   curl -X POST \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d '{"type":"user","ownerId":2,"days":10,"forCurrentUser":true,"maxEventsCount":100,"detailUrl":"/company/personal/user/#user_id#/calendar/"}' \
   https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/calendar.event.get.nearest
   

   curl -X POST \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d '{"type":"user","ownerId":2,"days":10,"forCurrentUser":true,"maxEventsCount":100,"detailUrl":"/company/personal/user/#user_id#/calendar/","auth":"**put_access_token_here**"}' \
   https://**put_your_bitrix24_address**/rest/calendar.event.get.nearest
   

   BX24.callMethod(
       'calendar.event.get.nearest',
       {
           type: 'user',
           ownerId: 2,
           days: 10,
           forCurrentUser: true,
           maxEventsCount: 100,
           detailUrl: '/company/personal/user/#user_id#/calendar/'
       }
   );
   

   from b24pysdk.errors import BitrixAPIError, BitrixSDKException
   
   try:
       bitrix_response = client.calendar.event.get.nearest(
           type="user",
           owner_id=2,
           days=10,
           for_current_user=True,
           max_events_count=100,
           detail_url="/company/personal/user/#user_id#/calendar/",
       ).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}")
   

   require_once('crest.php');
   
   $result = CRest::call(
       'calendar.event.get.nearest',
       [
           'type' => 'user',
           'ownerId' => 2,
           'days' => 10,
           'forCurrentUser' => true,
           'maxEventsCount' => 100,
           'detailUrl' => '/company/personal/user/#user_id#/calendar/'
       ]
   );
   
   echo '<PRE>';
   print_r($result);
   echo '</PRE>';
   

   // client и ctx уже созданы — см. раздел «SDK для Go»
   res, err := client.Core().Call(ctx, "calendar.event.get.nearest", b24.Params{
   	"type":           "user",
   	"ownerId":        2,
   	"days":           10,
   	"forCurrentUser": true,
   	"maxEventsCount": 100,
   	"detailUrl":      "/company/personal/user/#user_id#/calendar/",
   })
   if err != nil {
   	return fmt.Errorf("calendar.event.get.nearest: %w", err)
   }
   
   // Ответ приходит как json.RawMessage — разберите его
   // в структуру под форму ответа, показанную ниже на этой странице.
   fmt.Printf("%s\n", res.Result)
   

2. Получить события календаря компании.

   cURL (Webhook)

   cURL (OAuth)

   BX24.js

   Python

   PHP

   Go

   curl -X POST \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d '{"type":"company_calendar","ownerId":0,"forCurrentUser":false}' \
   https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/calendar.event.get.nearest
   

   curl -X POST \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d '{"type":"company_calendar","ownerId":0,"forCurrentUser":false,"auth":"**put_access_token_here**"}' \
   https://**put_your_bitrix24_address**/rest/calendar.event.get.nearest
   

   BX24.callMethod(
       'calendar.event.get.nearest',
       {
           type: 'company_calendar',
           ownerId: 0,
           forCurrentUser: false
       }
   );
   

   from b24pysdk.errors import BitrixAPIError, BitrixSDKException
   
   try:
       bitrix_response = client.calendar.event.get.nearest(
           type="company_calendar",
           owner_id=0,
           for_current_user=False,
       ).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}")
   

   require_once('crest.php');
   
   $result = CRest::call(
       'calendar.event.get.nearest',
       [
           'type' => 'company_calendar',
           'ownerId' => 0,
           'forCurrentUser' => false
       ]
   );
   
   echo '<PRE>';
   print_r($result);
   echo '</PRE>';
   

   // client и ctx уже созданы — см. раздел «SDK для Go»
   res, err := client.Core().Call(ctx, "calendar.event.get.nearest", b24.Params{
   	"type":           "company_calendar",
   "ownerId":        0,
   	"forCurrentUser": false,
   }, b24.WithIdempotent())
   if err != nil {
   return fmt.Errorf("calendar.event.get.nearest: %w", err)
   }
   
   // Ответ приходит как json.RawMessage — разберите его
   // в структуру под форму ответа, показанную ниже на этой странице.
   fmt.Printf("%s\n", res.Result)
   

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

HTTP-статус: 200

{
    "result": [
        {
            "ID": "1265",
            "PARENT_ID": "1265",
            "DELETED": "N",
            "CAL_TYPE": "user",
            "OWNER_ID": "1",
            "NAME": "Event Name",
            "DATE_FROM": "12/11/2024 05:59:00 pm",
            "DATE_TO": "12/11/2024 06:59:00 pm",
            "ORIGINAL_DATE_FROM": null,
            "TZ_FROM": "Europe/Riga",
            "TZ_TO": "Europe/Riga",
            "TZ_OFFSET_FROM": "7200",
            "TZ_OFFSET_TO": "7200",
            "DATE_FROM_TS_UTC": "1733932740",
            "DATE_TO_TS_UTC": "1733936340",
            "DT_SKIP_TIME": "N",
            "DT_LENGTH": 3600,
            "EVENT_TYPE": null,
            "CREATED_BY": "1",
            "DATE_CREATE": "12/05/2024 01:48:41 pm",
            "TIMESTAMP_X": "12/05/2024 01:48:41 pm",
            "DESCRIPTION": "Description for event",
            "PRIVATE_EVENT": "",
            "ACCESSIBILITY": "free",
            "IMPORTANCE": "normal",
            "IS_MEETING": true,
            "MEETING_STATUS": "H",
            "MEETING_HOST": "1",
            "MEETING": {
                "HOST_NAME": "User Name",
                "NOTIFY": false,
                "REINVITE": false,
                "ALLOW_INVITE": false,
                "HIDE_GUESTS": false,
                "MEETING_CREATOR": 1,
                "LANGUAGE_ID": "ru",
                "MAIL_FROM": ""
            },
            "LOCATION": "test location",
            "REMIND": [
                {
                    "type": "min",
                    "count": 50
                }
            ],
            "COLOR": "#9dcf00",
            "RRULE": {
                "FREQ": "WEEKLY",
                "BYDAY": {
                    "MO": "MO",
                    "WE": "WE"
                },
                "INTERVAL": 1,
                "UNTIL": "12/24/2024",
                "~UNTIL": "12/24/2024",
                "UNTIL_TS": 1734998400
            },
            "EXDATE": "11/28/2024;12/05/2024;12/12/2024;12/19/2024;12/26/2024",
            "DAV_XML_ID": "20241211T155900Z-534185204b362e9be7e261e92ccd9078@b24evo.lan",
            "G_EVENT_ID": "",
            "DAV_EXCH_LABEL": "",
            "CAL_DAV_LABEL": "",
            "VERSION": "1",
            "ATTENDEES_CODES": [
                "U1"
            ],
            "RECURRENCE_ID": 1272,
            "RELATIONS": {
                "ORIGINAL_RECURSION_ID": 1271,
                "COMMENT_XML_ID": "EVENT_1271_12/23/2024"
            },
            "SECTION_ID": "4",
            "SYNC_STATUS": null,
            "UF_CRM_CAL_EVENT": [
                "CO_1",
                "L_5"
            ],
            "UF_WEBDAV_CAL_EVENT": false,
            "SECTION_DAV_XML_ID": null,
            "DATE_FROM_FORMATTED": "Wed Dec 11 2024 17:59:00",
            "DATE_TO_FORMATTED": "Wed Dec 11 2024 18:59:00",
            "SECT_ID": "4",
            "ATTENDEE_LIST": [
                {
                    "id": 1,
                    "entryId": "1265",
                    "status": "H"
                }
            ],
            "COLLAB_ID": null,
            "~RRULE_DESCRIPTION": "каждую неделю по: Пн, Ср, от 12/11/2024 до 12/24/2024",
            "attendeesEntityList": [
                {
                    "entityId": "user",
                    "id": 1
                }
            ],
            "~DESCRIPTION": "Description for event",
            "~USER_OFFSET_FROM": 7200,
            "~USER_OFFSET_TO": 7200
        },
        {
            "ID": "1221",
            ...
        }
    ],
    "time": {
        "start": 1733411636.753706,
        "finish": 1733411637.040975,
        "duration": 0.28726911544799805,
        "processing": 0.05995798110961914,
        "date_start": "2024-12-05T15:13:56+00:00",
        "date_finish": "2024-12-05T15:13:57+00:00"
    }
}

Возвращаемые данныеВозвращаемые данные

Объект MEETINGОбъект MEETING

Объект REMINDОбъект REMIND

Объект RRULEОбъект RRULE

Объект RELATIONSОбъект RELATIONS

Объекты ATTENDEE_LISTОбъекты ATTENDEE_LIST

Объект attendeesEntityListОбъект attendeesEntityList

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

HTTP-статус: 400

{
  "error": "",
  "error_description": "Доступ запрещен"
}

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

Статусы и коды системных ошибокСтатусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.