Документация BILLmanager 6

Графики работы (working_plan)

working_plan

Результат: список элементов

Графики работы отделов

Уровень доступа: admin

ПараметрЗначение
idId
name Наименование

Удалить

Функция: working_plan.delete

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции working_plan.

Результат: успешное выполнение операции или сообщение об ошибке

График работы

Функция: working_plan.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции working_plan)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции working_plan)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
name Наименование графика для отображения в списках
day_active Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Учитывать ли данный день недели в качестве рабочего дня
day_0_allday Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
day_0_begin 
day_0_end 
day_active Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Учитывать ли данный день недели в качестве рабочего дня
day_1_allday Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
day_1_begin 
day_1_end 
day_active Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Учитывать ли данный день недели в качестве рабочего дня
day_2_allday Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
day_2_begin 
day_2_end 
day_active Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Учитывать ли данный день недели в качестве рабочего дня
day_3_allday Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
day_3_begin 
day_3_end 
day_active Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Учитывать ли данный день недели в качестве рабочего дня
day_4_allday Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
day_4_begin 
day_4_end 
day_active Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Учитывать ли данный день недели в качестве рабочего дня
day_5_allday Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
day_5_begin 
day_5_end 
day_active Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Учитывать ли данный день недели в качестве рабочего дня
day_6_allday Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
day_6_begin 
day_6_end 

Выходные дни и корректировки рабочего времени

Функция: working_plan.day

Результат: список элементов

Уровень доступа: admin

  • id — Id
  • affected_date — Дата
  • description — Описание

Изменение настроек исключения

Функция: working_plan.day.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции working_plan).
    • elid — уникальный идентификатор (элемент id из функции working_plan.day)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции working_plan).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции working_plan).
    • elid — уникальный идентификатор (элемент id из функции working_plan.day)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
type Тип исключения из рабочего графика
day_begin Время начала рабочего дня
day_endВремя окончания рабочего дня
note Комментарий к исключению из рабочего графика

Копирование настроек исключения

Функция: working_plan.day.copy

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции working_plan).
    • elid — уникальный идентификатор (элемент id из функции working_plan.day)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции working_plan).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции working_plan).
    • elid — уникальный идентификатор (элемент id из функции working_plan.day)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
plan Скопировать из. Укажите график рабочего времени, из которого нужно скопировать исключения
first_day Начиная датой. Укажите дату, начиная с которой будут скопированы исключения
last_day Заканчивая датой. Укажите дату, заканчивая которой будут скопированы исключения

Создание

Функция: working_plan.day.create

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции working_plan).
    • elid — уникальный идентификатор (элемент id из функции working_plan.day)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции working_plan).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции working_plan).
    • elid — уникальный идентификатор (элемент id из функции working_plan.day)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
affected_date Дата или даты, для которых действует исключение. При указании диапазона дат можно использовать разделитель ' — ', например '2001-01-01 — 2001-01-31'. Каждое значение вводится с новой строки
type Тип исключения из рабочего графика
day_begin Время начала рабочего дня
day_end Время окончания рабочего дня
note Комментарий к исключению из рабочего графика

Удалить

Функция: working_plan.day.delete

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции working_plan.day.

Результат: успешное выполнение операции или сообщение об ошибке