1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-11-29 22:27:42 +02:00
Files
OpenIntegrations/docs/en/md/Bitrix24/Calendars-management/Get-calendar-settings-structure.mdx
Vitaly the Alpaca (bot) 2ec373a899 Main build (Jenkins)
2025-04-06 17:14:16 +03:00

109 lines
2.7 KiB
Plaintext
Vendored

---
sidebar_position: 8
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Get calendar settings structure
Gets the structure of the default calendar settings
`Function GetCalendarSettingsStructure(Val URL, Val Token = "") Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| URL | --url | String | ✔ | URL of webhook or a Bitrix24 domain, when token used |
| Token | --token | String | ✖ | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [calendar.settings.get](https://apidocs.bitrix24.ru/api-reference/calendar/calendar-settings-get.html)
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/h0m...";
Result = OPI_Bitrix24.GetCalendarSettingsStructure(URL);
URL = "b24-ar17wx.bitrix24.by";
Token = "f85df267006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetCalendarSettingsStructure(URL, Token);
```
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
oint bitrix24 GetCalendarSettingsStructure \
--url "b24-ar17wx.bitrix24.by" \
--token "***"
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
oint bitrix24 GetCalendarSettingsStructure ^
--url "b24-ar17wx.bitrix24.by" ^
--token "***"
```
</TabItem>
</Tabs>
```json title="Result"
{
"result": {
"work_time_start": "9",
"work_time_end": "19",
"year_holidays": "1.01,2.01,7.01,23.02,8.03,1.05,9.05,12.06,4.11",
"year_workdays": "31.12",
"week_holidays": [
"SA",
"SU"
],
"week_start": "MO",
"user_name_template": "#NAME# #LAST_NAME#",
"sync_by_push": "",
"user_show_login": "1",
"path_to_user": "/company/personal/user/#user_id#/",
"path_to_user_calendar": "/company/personal/user/#user_id#/calendar/",
"path_to_group": "/workgroups/group/#group_id#/",
"path_to_group_calendar": "/workgroups/group/#group_id#/calendar/",
"path_to_vr": "",
"path_to_rm": "",
"rm_iblock_type": "",
"rm_iblock_id": "",
"dep_manager_sub": "1",
"denied_superpose_types": [],
"pathes_for_sites": "",
"pathes": [],
"forum_id": "1",
"rm_for_sites": "1",
"path_to_type_company_calendar": "/calendar/",
"path_to_type_events": "",
"path_to_type_location": ""
},
"time": {
"start": 1739051130.47399,
"finish": 1739051130.50146,
"duration": 0.0274679660797119,
"processing": 0.0031890869140625,
"date_start": "2025-02-09T00:45:30+03:00",
"date_finish": "2025-02-09T00:45:30+03:00",
"operating_reset_at": 1739051730,
"operating": 0
}
}
```