Calendar: Overview of Methods
The calendar helps users plan meetings, tasks, and events. Calendars can be managed using a group of methods calendar.section.*.
Calendar events are scheduled activities or meetings. A group of methods calendar.event.* is used to create, modify, retrieve, or delete events.
Quick navigation: all methods and events
User documentation: Bitrix24 calendar
Calendar Connection with Other Objects
User. The calendar is linked to a user by the calendar owner's ID ownerId for the calendar type user. The user ID can be obtained using the method user.get.
Group. The calendar is linked to a group by the calendar owner's ID ownerId for the calendar type group. The ID can be obtained by creating a new group or by getting the list of groups.
User Documentation
Calendar Settings
In the main calendar settings, the company's working hours, weekends, and holidays are specified. The settings can be retrieved using the method calendar.settings.get.
In user settings, an employee can specify personal preferences, such as time zone or week number display. User settings can be retrieved using the method calendar.user.settings.get and set using the method calendar.user.settings.set.
User Documentation
Resource Booking
In Bitrix24, resource booking is done through a custom CRM field of type resourcebooking. Such a field can be created in the lead and deal forms.
Resource availability can be tracked in the CRM Calendar. Technically, a resource is a section of the calendar, and booking is a calendar event.
The management of resources is handled by a group of methods calendar.resource.*.
User Documentation
Widgets
An application can be embedded into the calendar. In the list of calendar view types, there is a place for embedding CALENDAR_GRIDVIEW, where you can add your item.
Typical use-cases and scenarios
Overview of Methods and Events
Scope:
calendarWho can execute the method: any user
Main
|
Method |
Description |
|
Add a new calendar |
|
|
Update a calendar |
|
|
Get a list of calendars |
|
|
Delete a calendar |
|
|
Get main calendar settings |
|
|
Get user calendar settings |
|
|
Set user calendar settings |
|
Event |
Triggered |
|
When a calendar or resource section is added |
|
|
When a calendar or resource section is modified |
|
|
When a calendar or resource section is deleted |
Calendar Events
|
Method |
Description |
|
Add an event |
|
|
Update an event |
|
|
Get an event by |
|
|
Get a list of calendar events |
|
|
Get a list of upcoming events |
|
|
Delete an event |
|
|
Get the current user's participation status in an event |
|
|
Set the participation status in an event for the current user |
|
|
Get the availability of users from the list |
|
Event |
Triggered |
|
When an event is added |
|
|
When an event is modified |
|
|
When an event is deleted |
Resource Booking
|
Method |
Description |
|
Add a resource |
|
|
Update a resource |
|
|
Get a list of resources |
|
|
Get resource bookings by filter |
|
|
Delete a resource |