OXBOX Help

Schedule

Модуль представляет из себя расписание пользователей с возможностью создания или редактирования событий на период указанного рабочего времени.

Имеет следующую структуру:

{ type: "schedule", size: number, settings: { object: string, filters: {...}, }, components: { filters: Array<{...}>, buttons: Array<{...}> } }
  • object - объект, используемый для запроса на получение данных расписания, а так же, как часть ссылки при открытии создания или редактирования события.

  • filters - инициализационные значения для фильтров модуля.

В ответ на запрос данных расписания ожидается объект, представленный ниже:

{ schedule: { [key]: { [key]: { performer_title: string, performer_id: number, performer_href: string, initials?: {...}, schedule: Array<{ steps: Array<number>, status: "available" | "busy" | "empty", initials?: {...}, event?: { id: number, color: string, start_at: string, end_at: string, description: Array<string>, details: Array<{value: string, icon?: string}>, icons?: Array<string> } }> } } } steps_list: Array<string> }
  • schedule - данные по расписанию. Представляют из себя объект с вложенными объектами, имеющими динамический артикул, представляющий из себя заглавный столбец (столбец даты). Вложенный объект так же состоит из объектов с динамическими артикулами, формирующих вложенные столбцы (столбцы пользователей). Столбец пользователя имеет следующую структуру:

    • performer_title - заголовок столбца.

    • performer_id - идентификатор столбца. Необходим при создании события.

    • performer_href - ссылка для перехода при клике на заголовок столбца.

    • initials - объект дополнительных данных, отправляемых при запросе страницы создания или редактирования события. Действует на все клетки столбца.

    • schedule - Список расписания в виде ячеек. Ячейки представлены объектами с следующими свойствами:

      • steps - список чисел, используемый для того, чтобы обозначить спектр одного статуса расписания на данный период, т.е. представлен в виде массива из двух чисел - "от" и "до". Для синхронизации с "шагами" расписания необходимо указывать индексы значений из steps_list.

      • status - статус расписания на период. Имеет три значения:

        • empty - нет расписания.

        • available - время доступно для записи.

        • busy - время занято.

      • initials - объект дополнительных данных, отправляемых при запросе страницы создания или редактирования события. Действует индивидуально на данную клетку.

      • event - объект, присутствующий в ячейке только при статусе busy, отображает краткую информацию о событии. Состоит из следующих свойств:

        • id - идентификатор события. Используется, как часть инициализационных данных при открытии формы события.

        • color - цвет ячейки.

        • start_at - время начала события. Используется, как часть инициализационных данных при открытии формы события.

        • end_at - время окончания события. Используется, как часть инициализационных данных при открытии формы события.

        • description - список строк для вывода краткой информации по событию.

        • details - список строк да вывода более детальной информации, отображаемой при наведении на ячейку события. Имеется возможность указать иконки для строк.

        • icons - список названий иконок, отображаемых в качестве краткой альтернативы информации из description.

    • steps_list - список "шагов" расписания, представленных в виде строк.

15 мая 2025