метод REST scope: calendar

calendar.event.getbyid

Получить событие по id

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

Описание

Метод получает информацию о событии календаря по идентификатору.

Параметры

id integer обязательный

Идентификатор события.

Получить идентификатор можно методом calendar.event.get или calendar.event.get.nearest

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":324}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/calendar.event.getbyid

Ответ

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
    },
    "time": {
        "start": 1733406529.495513,
        "finish": 1733406529.744687,
        "duration": 0.2491741180419922,
        "processing": 0.0327458381652832,
        "date_start": "2024-12-05T13:48:49+00:00",
        "date_finish": "2024-12-05T13:48:49+00:00"
    }
}

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

HTTP-статус: 400

{
    "error": "",
    "error_description": "Не задан обязательный параметр \"id\" для метода \"calendar.event.getbyid\""
}
Код Описание Значение
Не задан обязательный параметр "id" для метода "calendar.event.getbyid" Не передан обязательный параметр id
Доступ запрещен Запрещен доступ к методу для внешних пользователей

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.