API task: различия между версиями

Материал из WiKi - UserSide
 
(не показаны 53 промежуточные версии 2 участников)
Строка 1: Строка 1:
[[API_task_EN|en]] | [[API_task|ru]]
Раздел '''[[API]]''' ERP "UserSide"
Раздел '''[[API]]''' ERP "UserSide"


Строка 9: Строка 11:


==== add ====
==== add ====
''Доработано в: 3.12beta31 (добавлен параметр author_operator_id)''
''Доработано в: 3.19.30 (добавлен параметр is_high_priority)''
 
''Доработано в: 3.18.43 (добавлен параметр device_id)''
 
''Доработано в: 3.18.29 (добавлен параметр deadline_hour)''
 
''Доработано в: 3.17dev1 (исключены параметры usercode, uzelcode и добавлены параметры customer_id, node_id)''
 
''Доработано в: 3.16dev2 (исключены параметры unit_id, author_operator_id и добавлены параметры employee_id, author_employee_id)''
 
''Доработано в: 3.12.84 (добавлен параметр parent_task_id)''
 
''Доработано в: 3.12.38 (добавлены параметры unit_id, division_id)''


''Доработано в: 3.12.26 (добавлен параметр work_amount)''
''Доработано в: 3.12.26 (добавлен параметр work_amount)''


''Доработано в: 3.12.38 (добавлены параметры unit_id, division_id)''
''Доработано в: 3.12beta31 (добавлен параметр author_operator_id)''


''Доработано в: 3.12.84 (добавлен параметр parent_task_id)''
  Описание: Создание задания
  Описание: Создание задания
   
   
Строка 25: Строка 38:
   apart - номер квартиры
   apart - номер квартиры
   address_id - ''(для версии 3.13 и позже)'' id адресной единицы
   address_id - ''(для версии 3.13 и позже)'' id адресной единицы
   author_operator_id - ID оператора-автора задания
  author_employee_id - ID сотрудника-автора задания
   author_operator_id - ID оператора-автора задания ''(до версии 3.16dev2)''
   citycode - ''(для версии 3.12 и ранее)'' id населенного пункта. Если не указан, то берётся из данных по дому housecode
   citycode - ''(для версии 3.12 и ранее)'' id населенного пункта. Если не указан, то берётся из данных по дому housecode
  customer_id - ''(для версии 3.17 и позже)'' ID абонента
  deadline_hour - время на выполнение задания ''(с даты принятия. В часах)''
  device_id - ID оборудования
   division_id - ID подразделения ''(допускается несколько значений через запятую)''
   division_id - ID подразделения ''(допускается несколько значений через запятую)''
   dopf_N - значение дополнительного поля для поля ID N
   dopf_N - значение дополнительного поля для поля ID N
  employee_id - ID исполнителя ''(допускается несколько значений через запятую)''
   fio - ФИО клиента ''(имеется в виду, что "клиент" еще не является абонентом)''
   fio - ФИО клиента ''(имеется в виду, что "клиент" еще не является абонентом)''
   housecode - ''(для версии 3.12 и ранее)'' id здания. Если не указан, то берётся из данных по абоненту - usercode, либо из данных по узлу связи - uzelcode
   housecode - ''(для версии 3.12 и ранее)'' id здания. Если не указан, то берётся из данных по абоненту - customer_id, либо из данных по сооружению связи - node_id
  is_high_priority - флаг - высокий приоритет
  node_id - ''(для версии 3.17 и позже)'' ID сооружения связи
   opis - заметки к заданию
   opis - заметки к заданию
   parent_task_id - ID родительского задания
   parent_task_id - ID родительского задания
   unit_id - ID исполнителя ''(допускается несколько значений через запятую)''
   unit_id - ID исполнителя ''(допускается несколько значений через запятую) (до версии 3.16dev2)''
   usercode - ID абонента
   usercode - ''(для версии 3.16 и ранее)'' ID абонента
   uzelcode - ID узла связи/муфты/опоры/колодца
   uzelcode - ''(для версии 3.16 и ранее)'' ID сооружения связи
   work_amount - объем работ
   work_amount - объем работ


Строка 46: Строка 66:
   task_id - id задания
   task_id - id задания
   customer_id - id абонента
   customer_id - id абонента
==== add_device_to_task ====
''Добавлено в: 3.19beta1''
Описание: Добавление оборудования к заданию
Обязательные параметры:
  task_id - id задания
  device_id - id оборудования
==== add_owner_to_task ====
''Добавлено в: 3.19.19''
Описание: Добавление собственника к заданию
Обязательные параметры:
  task_id - id задания
  owner_id - id собственника


==== change_date_work ====
==== change_date_work ====
''Доработано в: 3.16dev2 (исключен параметр operator_id, добавлен параметр employee_id)''
''Добавлено в: 3.12.83''
''Добавлено в: 3.12.83''


Строка 56: Строка 96:
   value - дата
   value - дата
  Необязательные параметры:
  Необязательные параметры:
   operator_id - id оператора-инициатора ''(для фиксации в историю по заданию)''
  employee_id - id сотрудника-инициатора ''(для фиксации в историю по заданию)''
   operator_id - id оператора-инициатора ''(для фиксации в историю по заданию) (до версии 3.16dev2)''


==== change_state ====
==== change_state ====
''Доработано в: 3.16dev2 (исключен параметр operator_id, добавлен параметр employee_id)''
  Описание: Изменения состояния (статуса) задания
  Описание: Изменения состояния (статуса) задания
   
   
Строка 65: Строка 108:
   state_id - id состояния задания
   state_id - id состояния задания
  Необязательные параметры:
  Необязательные параметры:
   operator_id - id оператора, от имени которого изменять состояние
  employee_id - id сотрудника, от имени которого изменять состояние
   operator_id - id оператора, от имени которого изменять состояние ''(до версии 3.16dev2)''


==== check_verify_code ====
==== check_verify_code ====
Строка 73: Строка 117:
   id - ID задания
   id - ID задания
   verify_code - код подтверждения
   verify_code - код подтверждения
==== checklist_item_check ====
''Добавлено в: 3.17dev1''
Описание: Отметка пункта чек-листа в задании
Обязательные параметры:
  id - id пункта чек-листа
  task_id - id задания
  employee_id - id сотрудника, от имени которого помечается пункт
==== checklist_item_uncheck ====
''Добавлено в: 3.17dev1''
Описание: Снятие отметки с пункта чек-листа в задании
Обязательные параметры:
  id - id пункта чек-листа
  task_id - id задания


==== comment_add ====
==== comment_add ====
''Доработано в: 3.17dev1 (добавлен параметр dateadd)''
''Доработано в: 3.16.19 (добавлен параметр reply_comment_id)''
''Доработано в: 3.16dev2 (исключен параметр operator_id, добавлен параметр employee_id)''
''Доработано в: 3.12.89 (добавлен параметр author_operator_id)''
''Доработано в: 3.12.89 (добавлен параметр author_operator_id)''


Строка 83: Строка 152:
   comment - текст
   comment - текст
  Необязательные параметры:
  Необязательные параметры:
   operator_id - id оператора, от имени которого комментарий
  dateadd - дата-время комментария
  employee_id - id сотрудника, от имени которого комментарий
   operator_id - id оператора, от имени которого комментарий ''(до версии 3.16dev2)''
  reply_comment_id - id комментария, на который отвечаем
 
==== comment_edit ====
 
''Добавлено в: 3.18beta1''
 
Описание: Изменение комментария
Обязательные параметры:
  id - ID комментария
  task_id - ID задания
  body - текст


==== delete ====
==== delete ====
Строка 94: Строка 177:


==== division_add ====
==== division_add ====
''Доработано в: 3.16dev2 (исключен параметр operator_id, добавлен параметр employee_id)''
''Добавлено в: 3.13.36''
''Добавлено в: 3.13.36''


Строка 102: Строка 187:
   division_id - id подразделения
   division_id - id подразделения
  Необязательные параметры:
  Необязательные параметры:
   operator_id - id оператора-инициатора ''(для фиксации в историю по заданию)''
  employee_id - id сотрудника-инициатора ''(для фиксации в историю по заданию)''
   operator_id - id оператора-инициатора ''(для фиксации в историю по заданию) (до версии 3.16dev2)''


==== division_delete ====
==== division_delete ====
''Доработано в: 3.16dev2 (исключен параметр operator_id, добавлен параметр employee_id)''
''Добавлено в: 3.13.36''
''Добавлено в: 3.13.36''


Строка 113: Строка 201:
   division_id - id подразделения
   division_id - id подразделения
  Необязательные параметры:
  Необязательные параметры:
   operator_id - id оператора-инициатора ''(для фиксации в историю по заданию)''
  employee_id - id сотрудника-инициатора ''(для фиксации в историю по заданию)''
   operator_id - id оператора-инициатора ''(для фиксации в историю по заданию) (до версии 3.16dev2)''


==== edit ====
==== edit ====
''Доработано в: 3.19.30 (добавлен параметр is_high_priority)''
''Доработано в: 3.19.15 (добавлен параметр job_time_hour)''
''Доработано в: 3.19.12 (добавлен параметр apartment)''
''Доработано в: 3.18.30 (добавлен параметр deadline_hour)''
''Доработано в: 3.18beta1 (добавлен параметр address_id)''
''Доработано в: 3.16dev3 (добавлен параметр type_id)''
''Доработано в: 3.15.12 (добавлен параметр parent_task_id)''
''Доработано в: 3.15.12 (добавлен параметр parent_task_id)''


Строка 124: Строка 226:
   id - id задания
   id - id задания
  Необязательные параметры:
  Необязательные параметры:
  address_id - id адресной единицы
  apartment - номер квартиры
   body - текст задания ''(описательная часть)''
   body - текст задания ''(описательная часть)''
  deadline_hour - время на выполнение задания ''(с даты принятия. В часах)''
  is_high_priority - флаг - высокий приоритет
  job_time_hour - время на выполнение задания ''(с даты начала работ. В часах)''
   parent_task_id - id родительского задания
   parent_task_id - id родительского задания
  type_id - id типа задания
==== employee_add ====
''Добавлено в: 3.16dev2''
Описание: Добавление исполнителя
Обязательные параметры:
  id - id задания
  employee_id - id исполнителя
Необязательные параметры:
  author_employee_id - id сотрудника-инициатора ''(для фиксации в историю по заданию)''
==== employee_delete ====
''Добавлено в: 3.16dev2''
Описание: Исключение исполнителя
Обязательные параметры:
  id - id задания
  employee_id - id исполнителя
Необязательные параметры:
  author_employee_id - id сотрудника-инициатора ''(для фиксации в историю по заданию)''


==== get_allow_staff ====
==== get_allow_staff ====
Строка 140: Строка 268:
  Необязательные параметры:
  Необязательные параметры:
   id - id типа заданий ''(можно через запятую)''
   id - id типа заданий ''(можно через запятую)''
==== get_catalog_type_group ====
''Добавлено в: 3.16dev3''
Описание: Группы типов заданий


==== get_catalog_state ====
==== get_catalog_state ====
''Доработано в: 3.19.1 (добавлен параметр type_id)''
''Добавлено в: 3.12.22''
''Добавлено в: 3.12.22''
  Описание: Классификатор состояний заданий
  Описание: Классификатор состояний заданий
   
   
  Необязательные параметры:
  Необязательные параметры:
  type_id - id типа задания
   state_id - id состояния ''(можно через запятую)''
   state_id - id состояния ''(можно через запятую)''


==== get_comment ====
==== get_comment ====
''Доработано в: 3.16dev2 (исключен параметр operator_id, добавлен параметр employee_id)''
''Доработано в: 3.14.67 (добавлен параметр id)''
''Доработано в: 3.14.67 (добавлен параметр id)''


Строка 158: Строка 296:
  Описание: Комментарии
  Описание: Комментарии
   
   
  Необязательные параметры (но должен быть хотя-бы один):
  Необязательные параметры ''(но должен быть хотя-бы один)'':
   id - id комментария (можно через запятую)
   id - id комментария ''(можно через запятую)''
   task_id - id заданий (можно через запятую)
   task_id - id заданий ''(можно через запятую)''
   date_add_from - дата добавления комментария (с)
   date_add_from - дата добавления комментария ''(с)''
   date_add_to - дата добавления комментария (до)
   date_add_to - дата добавления комментария ''(до)''
   operator_id - id оператора - автора комментария
  employee_id - id сотрудника-автора комментария
   operator_id - id оператора-автора комментария ''(до версии 3.16dev2)''


==== get_list ====
==== get_list ====
''Доработано в: 3.18.43 (добавлен параметр device_id)''
''Доработано в: 3.18.40 (добавлен параметр apart)''
''Доработано в: 3.18.30 (добавлены параметры change_operation_type, change_employee_id)''
''Доработано в: 3.18beta1 (добавлен параметр address_id)''
''Доработано в: 3.16dev3 (добавлены параметры task_position, task_position_radius, из параметра order_by исключены возможные значения customer_id и house_id)''
''Доработано в: 3.16dev2 (исключены параметры closer_operator_id, staff_id, author_id, watcher_id добавлены параметры closer_employee_id, employee_id, author_employee_id, watcher_employee_id)''
''Доработано в: 3.15.23 (добавлен параметр is_expired)''
''Доработано в: 3.15.23 (добавлен параметр is_expired)''


Строка 194: Строка 346:
   
   
  Необязательные параметры (условия выборки):
  Необязательные параметры (условия выборки):
   author_id - ID оператора - автора задания ''(можно через запятую)''
  address_id - ID адресного объекта ''(можно через запятую)''
   closer_operator_id - ID оператора, который закрыл ''(выполнил)'' задание''(можно через запятую)''
  apart - номер квартиры/помещения
   author_id - ID оператора - автора задания ''(можно через запятую) (до версии 3.16dev2)''
  author_employee_id - ID сотрудника - автора задания ''(можно через запятую)''
  change_employee_id - ID сотрудника - автора изменений по заданию
  change_operation_type - тип действий по изменению задания ''(возможные значения: add_comment, change_state)''
  closer_employee_id - ID сотрудника, который закрыл ''(выполнил)'' задание ''(можно через запятую)''
   closer_operator_id - ID оператора, который закрыл ''(выполнил)'' задание ''(можно через запятую) (до версии 3.16dev2)''
   customer_id - ID абонента ''(можно через запятую)''
   customer_id - ID абонента ''(можно через запятую)''
   date_add_from - дата создания задания (с)
   date_add_from - дата создания задания (с)
Строка 205: Строка 363:
   date_finish_from - дата выполнения задания (с)
   date_finish_from - дата выполнения задания (с)
   date_finish_to - дата выполнения задания (до)
   date_finish_to - дата выполнения задания (до)
  device_id - ID оборудования ''(можно через запятую)''
   division_id - ID подразделения ''(можно через запятую)''
   division_id - ID подразделения ''(можно через запятую)''
   division_id_with_staff - ID подразделения ''(в т.ч. с заданиями сотрудников этого подразделения) (можно через запятую)''
   division_id_with_staff - ID подразделения ''(в т.ч. с заданиями сотрудников этого подразделения) (можно через запятую)''
  employee_id - ID исполнителя ''(можно через запятую, используйте -1 для получения заданий без исполнителей)''
   house_id - ID дома работ
   house_id - ID дома работ
   is_expired - флаг - выводить только просроченные задания
   is_expired - флаг - выводить только просроченные задания
   node_id - ID объекта размещения
   node_id - ID объекта размещения
   staff_id - ID исполнителя ''(можно через запятую, используйте -1 для получения заданий без исполнителей)''
   staff_id - ID исполнителя ''(можно через запятую, используйте -1 для получения заданий без исполнителей) (до версии 3.16dev2)''
   state_id - ID статуса заданий ''(можно через запятую)''
   state_id - ID статуса заданий ''(можно через запятую)''
  task_position - координаты задания ''(там где это возможно. В формате lat,lng. Напр: 40.245218,52.333384)''
  task_position_radius - радиус от task_position ''(в метрах)''
   type_id - ID типа заданий ''(можно через запятую)''
   type_id - ID типа заданий ''(можно через запятую)''
   watcher_id - ID оператора - наблюдателя за заданием ''(можно через запятую)''
   watcher_id - ID оператора-наблюдателя за заданием ''(можно через запятую) (до версии 3.16dev2)''
   order_by - поле для сортировки ''(возможные варианты: customer_id, date_add, date_change, date_do, date_finish, house_id, state_id, type_id)''
  watcher_employee_id - ID сотрудника-наблюдателя за заданием ''(можно через запятую)''
   order_by - поле для сортировки ''(возможные варианты: date_add, date_change, date_do, date_finish, state_id, type_id)''
   limit - лимит выборки записей
   limit - лимит выборки записей
   offset - смещение выборки
   offset - смещение выборки
Строка 228: Строка 391:


  Описание: Получение списка типовых комментариев
  Описание: Получение списка типовых комментариев
==== mark_add ====
''Добавлено в: 3.19.24''
Описание: Добавление метки на задание
Обязательные параметры:
  task_id - id задания
  mark_id - id метки
==== mark_delete ====
''Добавлено в: 3.19.24''
Описание: Удаление метки с задания
Обязательные параметры:
  task_id - id задания
  mark_id - id метки
==== overview_task ====
''Добавлено в: 3.19.7''
Описание: Фиксация факта просмотра задания сотрудником
Обязательные параметры:
  task_id - id задания
  employee_id - id сотрудника


==== remove_customer_from_task ====
==== remove_customer_from_task ====
Строка 237: Строка 423:
   task_id - id задания
   task_id - id задания
   customer_id - id абонента
   customer_id - id абонента
==== remove_owner_from_task ====
''Добавлено в: 3.19.19''
Описание: Исключение собственника с задания
Обязательные параметры:
  task_id - id задания
  owner_id - id собственника


==== set_rate ====
==== set_rate ====
Строка 247: Строка 442:


==== show ====
==== show ====
''Доработано в: 3.16dev2 (исключен параметр operator_id, добавлен параметр employee_id)''
''Доработано в: 3.13.29 (в параметре id можно подавать список через запятую)''
''Доработано в: 3.13.29 (в параметре id можно подавать список через запятую)''


Строка 258: Строка 455:
   id - id задания ''(можно через запятую)''
   id - id задания ''(можно через запятую)''
  Необязательные параметры:
  Необязательные параметры:
   operator_id - id оператора, который просматривает это задание ''(для фиксации в историю по заданию)''
   employee_id - id сотрудника, который просматривает это задание ''(для фиксации в историю по заданию)''
   is_without_comments - флаг - не выводить комментарии в информации по заданию
   is_without_comments - флаг - не выводить комментарии в информации по заданию
  operator_id - id оператора, который просматривает это задание ''(для фиксации в историю по заданию) (до версии 3.16dev2)''
==== (*) staff_add ====
''Исключено в: 3.16dev2 (используйте API->task->[[API task#employee_add|employee_add]])''


==== staff_add ====
''Добавлено в: 3.12.83''
''Добавлено в: 3.12.83''


Строка 272: Строка 472:
   operator_id - id оператора-инициатора ''(для фиксации в историю по заданию)''
   operator_id - id оператора-инициатора ''(для фиксации в историю по заданию)''


==== staff_delete ====
==== (*) staff_delete ====
''Исключено в: 3.16dev2 (используйте API->task->[[API task#employee_delete|employee_delete]])''
 
''Добавлено в: 3.12.83''
''Добавлено в: 3.12.83''


Строка 284: Строка 486:


==== watcher_add ====
==== watcher_add ====
''Доработано в: 3.16dev2 (исключены параметры staff_id, operator_id, добавлены параметры employee_id, author_employee_id)''
''Добавлено в: 3.14.21''
''Добавлено в: 3.14.21''


Строка 290: Строка 494:
  Обязательные параметры:
  Обязательные параметры:
   id - id задания
   id - id задания
   staff_id - id наблюдателя
  employee_id - id наблюдателя
   staff_id - id наблюдателя ''(до версии 3.16dev2)''
  Необязательные параметры:
  Необязательные параметры:
   operator_id - id оператора-инициатора ''(для фиксации в историю по заданию)''
  author_employee_id - id сотрудника-инициатора ''(для фиксации в историю по заданию)''
   operator_id - id оператора-инициатора ''(для фиксации в историю по заданию) (до версии 3.16dev2)''


==== watcher_delete ====
==== watcher_delete ====
''Доработано в: 3.16dev2 (исключены параметры staff_id, operator_id, добавлены параметры employee_id, author_employee_id)''
''Добавлено в: 3.14.21''
''Добавлено в: 3.14.21''


Строка 301: Строка 509:
  Обязательные параметры:
  Обязательные параметры:
   id - id задания
   id - id задания
   staff_id - id наблюдателя
  employee_id - id наблюдателя
   staff_id - id наблюдателя ''(до версии 3.16dev2)''
  Необязательные параметры:
  Необязательные параметры:
   operator_id - id оператора-инициатора ''(для фиксации в историю по заданию)''
  author_employee_id - id сотрудника-инициатора ''(для фиксации в историю по заданию)''
   operator_id - id оператора-инициатора ''(для фиксации в историю по заданию) (до версии 3.16dev2)''

Текущая версия от 19:43, 3 ноября 2024

en | ru

Раздел API ERP "UserSide"

Назначение: Работа с заданиями 

Дополнительные параметры:
action - подкатегория запроса (возможное значение: см.ниже)

Подкатегории

add

Доработано в: 3.19.30 (добавлен параметр is_high_priority)

Доработано в: 3.18.43 (добавлен параметр device_id)

Доработано в: 3.18.29 (добавлен параметр deadline_hour)

Доработано в: 3.17dev1 (исключены параметры usercode, uzelcode и добавлены параметры customer_id, node_id)

Доработано в: 3.16dev2 (исключены параметры unit_id, author_operator_id и добавлены параметры employee_id, author_employee_id)

Доработано в: 3.12.84 (добавлен параметр parent_task_id)

Доработано в: 3.12.38 (добавлены параметры unit_id, division_id)

Доработано в: 3.12.26 (добавлен параметр work_amount)

Доработано в: 3.12beta31 (добавлен параметр author_operator_id) 

Описание: Создание задания

Обязательные параметры:
 work_datedo - дата на которую назначено выполнение задания
 work_typer - ID ТИПА задания

Необязательные параметры:
 apart - номер квартиры
 address_id - (для версии 3.13 и позже) id адресной единицы
 author_employee_id - ID сотрудника-автора задания
 author_operator_id - ID оператора-автора задания (до версии 3.16dev2)
 citycode - (для версии 3.12 и ранее) id населенного пункта. Если не указан, то берётся из данных по дому housecode
 customer_id - (для версии 3.17 и позже) ID абонента
 deadline_hour - время на выполнение задания (с даты принятия. В часах)
 device_id - ID оборудования
 division_id - ID подразделения (допускается несколько значений через запятую)
 dopf_N - значение дополнительного поля для поля ID N
 employee_id - ID исполнителя (допускается несколько значений через запятую)
 fio - ФИО клиента (имеется в виду, что "клиент" еще не является абонентом)
 housecode - (для версии 3.12 и ранее) id здания. Если не указан, то берётся из данных по абоненту - customer_id, либо из данных по сооружению связи - node_id
 is_high_priority - флаг - высокий приоритет
 node_id - (для версии 3.17 и позже) ID сооружения связи
 opis - заметки к заданию
 parent_task_id - ID родительского задания
 unit_id - ID исполнителя (допускается несколько значений через запятую) (до версии 3.16dev2)
 usercode - (для версии 3.16 и ранее) ID абонента
 uzelcode - (для версии 3.16 и ранее) ID сооружения связи
 work_amount - объем работ

add_customer_to_task

Добавлено в: 3.13.70 

Описание: Добавление абонента к заданию

Обязательные параметры:
 task_id - id задания
 customer_id - id абонента

add_device_to_task

Добавлено в: 3.19beta1 

Описание: Добавление оборудования к заданию

Обязательные параметры:
 task_id - id задания
 device_id - id оборудования

add_owner_to_task

Добавлено в: 3.19.19 

Описание: Добавление собственника к заданию

Обязательные параметры:
 task_id - id задания
 owner_id - id собственника

change_date_work

Доработано в: 3.16dev2 (исключен параметр operator_id, добавлен параметр employee_id)

Добавлено в: 3.12.83 

Описание: Изменение даты и времени выполнения задания (дата, на которую назначены работы)

Обязательные параметры:
 id - id задания
 value - дата
Необязательные параметры:
 employee_id - id сотрудника-инициатора (для фиксации в историю по заданию)
 operator_id - id оператора-инициатора (для фиксации в историю по заданию) (до версии 3.16dev2)

change_state

Доработано в: 3.16dev2 (исключен параметр operator_id, добавлен параметр employee_id) 

Описание: Изменения состояния (статуса) задания

Обязательные параметры:
 id - id задания
 state_id - id состояния задания
Необязательные параметры:
 employee_id - id сотрудника, от имени которого изменять состояние
 operator_id - id оператора, от имени которого изменять состояние (до версии 3.16dev2)

check_verify_code

Описание: Проверка кода подтверждения для выполнения заявки

Обязательные параметры:
 id - ID задания
 verify_code - код подтверждения

checklist_item_check

Добавлено в: 3.17dev1 

Описание: Отметка пункта чек-листа в задании

Обязательные параметры:
 id - id пункта чек-листа
 task_id - id задания
 employee_id - id сотрудника, от имени которого помечается пункт

checklist_item_uncheck

Добавлено в: 3.17dev1 

Описание: Снятие отметки с пункта чек-листа в задании

Обязательные параметры:
 id - id пункта чек-листа
 task_id - id задания

comment_add

Доработано в: 3.17dev1 (добавлен параметр dateadd)

Доработано в: 3.16.19 (добавлен параметр reply_comment_id)

Доработано в: 3.16dev2 (исключен параметр operator_id, добавлен параметр employee_id)

Доработано в: 3.12.89 (добавлен параметр author_operator_id) 

Описание: Добавление комментария

Обязательные параметры:
 id - ID задания
 comment - текст
Необязательные параметры:
 dateadd - дата-время комментария
 employee_id - id сотрудника, от имени которого комментарий
 operator_id - id оператора, от имени которого комментарий (до версии 3.16dev2)
 reply_comment_id - id комментария, на который отвечаем

comment_edit

Добавлено в: 3.18beta1 

Описание: Изменение комментария

Обязательные параметры:
 id - ID комментария
 task_id - ID задания
 body - текст

delete

Добавлено в: 3.14.35 

Описание: Удаление задания

Обязательные параметры:
 id - id задания

division_add

Доработано в: 3.16dev2 (исключен параметр operator_id, добавлен параметр employee_id)

Добавлено в: 3.13.36 

Описание: Добавление подразделения

Обязательные параметры:
 id - id задания
 division_id - id подразделения
Необязательные параметры:
 employee_id - id сотрудника-инициатора (для фиксации в историю по заданию)
 operator_id - id оператора-инициатора (для фиксации в историю по заданию) (до версии 3.16dev2)

division_delete

Доработано в: 3.16dev2 (исключен параметр operator_id, добавлен параметр employee_id)

Добавлено в: 3.13.36 

Описание: Исключение подразделения

Обязательные параметры:
 id - id задания
 division_id - id подразделения
Необязательные параметры:
 employee_id - id сотрудника-инициатора (для фиксации в историю по заданию)
 operator_id - id оператора-инициатора (для фиксации в историю по заданию) (до версии 3.16dev2)

edit

Доработано в: 3.19.30 (добавлен параметр is_high_priority)

Доработано в: 3.19.15 (добавлен параметр job_time_hour)

Доработано в: 3.19.12 (добавлен параметр apartment)

Доработано в: 3.18.30 (добавлен параметр deadline_hour)

Доработано в: 3.18beta1 (добавлен параметр address_id)

Доработано в: 3.16dev3 (добавлен параметр type_id)

Доработано в: 3.15.12 (добавлен параметр parent_task_id)

Добавлено в: 3.13.18 

Описание: Изменение задания

Обязательные параметры:
 id - id задания
Необязательные параметры:
 address_id - id адресной единицы
 apartment - номер квартиры
 body - текст задания (описательная часть)
 deadline_hour - время на выполнение задания (с даты принятия. В часах)
 is_high_priority - флаг - высокий приоритет
 job_time_hour - время на выполнение задания (с даты начала работ. В часах)
 parent_task_id - id родительского задания
 type_id - id типа задания

employee_add

Добавлено в: 3.16dev2 

Описание: Добавление исполнителя

Обязательные параметры:
 id - id задания
 employee_id - id исполнителя
Необязательные параметры:
 author_employee_id - id сотрудника-инициатора (для фиксации в историю по заданию)

employee_delete

Добавлено в: 3.16dev2 

Описание: Исключение исполнителя

Обязательные параметры:
 id - id задания
 employee_id - id исполнителя
Необязательные параметры:
 author_employee_id - id сотрудника-инициатора (для фиксации в историю по заданию)

get_allow_staff

Добавлено в: 3.15.23 

Описание: Список исполнителей и подразделений, которые доступны для назначение на задание (согласно настроек)

Обязательные параметры:
 id - id задания

get_catalog_type

Добавлено в: 3.12.22 

Описание: Типы заданий

Необязательные параметры:
 id - id типа заданий (можно через запятую)

get_catalog_type_group

Добавлено в: 3.16dev3 

Описание: Группы типов заданий

get_catalog_state

Доработано в: 3.19.1 (добавлен параметр type_id)

Добавлено в: 3.12.22 

Описание: Классификатор состояний заданий

Необязательные параметры:
 type_id - id типа задания
 state_id - id состояния (можно через запятую)

get_comment

Доработано в: 3.16dev2 (исключен параметр operator_id, добавлен параметр employee_id)

Доработано в: 3.14.67 (добавлен параметр id)

Доработано в: 3.14.53 (добавлен параметр operator_id)

Доработано в: 3.13.50 (добавлены параметры date_add_from и date_add_to)

Добавлено в: 3.12.75 

Описание: Комментарии

Необязательные параметры (но должен быть хотя-бы один):
 id - id комментария (можно через запятую)
 task_id - id заданий (можно через запятую)
 date_add_from - дата добавления комментария (с)
 date_add_to - дата добавления комментария (до)
 employee_id - id сотрудника-автора комментария
 operator_id - id оператора-автора комментария (до версии 3.16dev2)

get_list

Доработано в: 3.18.43 (добавлен параметр device_id)

Доработано в: 3.18.40 (добавлен параметр apart)

Доработано в: 3.18.30 (добавлены параметры change_operation_type, change_employee_id)

Доработано в: 3.18beta1 (добавлен параметр address_id)

Доработано в: 3.16dev3 (добавлены параметры task_position, task_position_radius, из параметра order_by исключены возможные значения customer_id и house_id)

Доработано в: 3.16dev2 (исключены параметры closer_operator_id, staff_id, author_id, watcher_id добавлены параметры closer_employee_id, employee_id, author_employee_id, watcher_employee_id)

Доработано в: 3.15.23 (добавлен параметр is_expired)

Доработано в: 3.14.71 (добавлен параметр node_id)

Доработано в: 3.14.62 (добавлен параметр closer_operator_id)

Доработано в: 3.14.56 (добавлен параметр division_id_with_staff)

Доработано в: 3.14.41 (в параметр staff_id добавлено возможное значение -1)

Доработано в: 3.13.29 (добавлены параметры date_change_from, date_change_to)

Доработано в: 3.13.28 (в параметр order_by добавлен вариант date_change)

Доработано в: 3.12.91 (добавлен параметр watcher_id)

Доработано в: 3.12.83 (добавлен параметр author_id)

Доработано в: 3.12.78 (добавлены параметры order_by, limit, offset)

Доработано в: 3.12.62 (добавлен параметр customer_id)

Доработано в: 3.12.24 (добавлены параметры date_do_from, date_do_to)

Доработано в: 3.12beta29 (добавлен параметр house_id) 

Описание: Список заданий (идентификаторы)

Необязательные параметры (условия выборки):
 address_id - ID адресного объекта (можно через запятую)
 apart - номер квартиры/помещения
 author_id - ID оператора - автора задания (можно через запятую) (до версии 3.16dev2)
 author_employee_id - ID сотрудника - автора задания (можно через запятую)
 change_employee_id - ID сотрудника - автора изменений по заданию
 change_operation_type - тип действий по изменению задания (возможные значения: add_comment, change_state)
 closer_employee_id - ID сотрудника, который закрыл (выполнил) задание (можно через запятую)
 closer_operator_id - ID оператора, который закрыл (выполнил) задание (можно через запятую) (до версии 3.16dev2)
 customer_id - ID абонента (можно через запятую)
 date_add_from - дата создания задания (с)
 date_add_to - дата создания задания (до)
 date_change_from - дата обновления задания (с)
 date_change_to - дата обновления задания (до)
 date_do_from - дата на которую назначено выполнение задания (с)
 date_do_to - дата на которую назначено выполнение задания (до)
 date_finish_from - дата выполнения задания (с)
 date_finish_to - дата выполнения задания (до)
 device_id - ID оборудования (можно через запятую)
 division_id - ID подразделения (можно через запятую)
 division_id_with_staff - ID подразделения (в т.ч. с заданиями сотрудников этого подразделения) (можно через запятую)
 employee_id - ID исполнителя (можно через запятую, используйте -1 для получения заданий без исполнителей)
 house_id - ID дома работ
 is_expired - флаг - выводить только просроченные задания
 node_id - ID объекта размещения
 staff_id - ID исполнителя (можно через запятую, используйте -1 для получения заданий без исполнителей) (до версии 3.16dev2)
 state_id - ID статуса заданий (можно через запятую)
 task_position - координаты задания (там где это возможно. В формате lat,lng. Напр: 40.245218,52.333384)
 task_position_radius - радиус от task_position (в метрах)
 type_id - ID типа заданий (можно через запятую)
 watcher_id - ID оператора-наблюдателя за заданием (можно через запятую) (до версии 3.16dev2)
 watcher_employee_id - ID сотрудника-наблюдателя за заданием (можно через запятую)
 order_by - поле для сортировки (возможные варианты: date_add, date_change, date_do, date_finish, state_id, type_id)
 limit - лимит выборки записей
 offset - смещение выборки

get_related_task_id

Описание: Список связанных заданий с текущим заданием (идентификаторы)

Обязательные параметры:
 id - ID задания

get_typical_comments

Добавлено в: 3.14.70 

Описание: Получение списка типовых комментариев

mark_add

Добавлено в: 3.19.24 

Описание: Добавление метки на задание
Обязательные параметры:
 task_id - id задания
 mark_id - id метки

mark_delete

Добавлено в: 3.19.24 

Описание: Удаление метки с задания
Обязательные параметры:
 task_id - id задания
 mark_id - id метки

overview_task

Добавлено в: 3.19.7 

Описание: Фиксация факта просмотра задания сотрудником

Обязательные параметры:
 task_id - id задания
 employee_id - id сотрудника

remove_customer_from_task

Добавлено в: 3.15.23 

Описание: Исключение абонента с задания

Обязательные параметры:
 task_id - id задания
 customer_id - id абонента

remove_owner_from_task

Добавлено в: 3.19.19 

Описание: Исключение собственника с задания

Обязательные параметры:
 task_id - id задания
 owner_id - id собственника

set_rate

Добавлено в: 3.12.63 

Описание: Указание индивидуального тарифа (для сотрудников) по заданию

Обязательные параметры:
 task_id - ID задания
 rate - тариф

show

Доработано в: 3.16dev2 (исключен параметр operator_id, добавлен параметр employee_id)

Доработано в: 3.13.29 (в параметре id можно подавать список через запятую)

Доработано в: 3.13.25 (добавлен параметр is_without_comments)

Доработано в: 3.12.64 (добавлен параметр operator_id) 

Описание: Информация о задании

Обязательные параметры:
 id - id задания (можно через запятую)
Необязательные параметры:
 employee_id - id сотрудника, который просматривает это задание (для фиксации в историю по заданию)
 is_without_comments - флаг - не выводить комментарии в информации по заданию
 operator_id - id оператора, который просматривает это задание (для фиксации в историю по заданию) (до версии 3.16dev2)

(*) staff_add

Исключено в: 3.16dev2 (используйте API->task->employee_add)

Добавлено в: 3.12.83 

Описание: Добавление исполнителя

Обязательные параметры:
 id - id задания
 staff_id - id исполнителя
Необязательные параметры:
 operator_id - id оператора-инициатора (для фиксации в историю по заданию)

(*) staff_delete

Исключено в: 3.16dev2 (используйте API->task->employee_delete)

Добавлено в: 3.12.83 

Описание: Исключение исполнителя

Обязательные параметры:
 id - id задания
 staff_id - id исполнителя
Необязательные параметры:
 operator_id - id оператора-инициатора (для фиксации в историю по заданию)

watcher_add

Доработано в: 3.16dev2 (исключены параметры staff_id, operator_id, добавлены параметры employee_id, author_employee_id)

Добавлено в: 3.14.21 

Описание: Добавление наблюдателя

Обязательные параметры:
 id - id задания
 employee_id - id наблюдателя
 staff_id - id наблюдателя (до версии 3.16dev2)
Необязательные параметры:
 author_employee_id - id сотрудника-инициатора (для фиксации в историю по заданию)
 operator_id - id оператора-инициатора (для фиксации в историю по заданию) (до версии 3.16dev2)

watcher_delete

Доработано в: 3.16dev2 (исключены параметры staff_id, operator_id, добавлены параметры employee_id, author_employee_id)

Добавлено в: 3.14.21 

Описание: Исключение наблюдателя

Обязательные параметры:
 id - id задания
 employee_id - id наблюдателя
 staff_id - id наблюдателя (до версии 3.16dev2)
Необязательные параметры:
 author_employee_id - id сотрудника-инициатора (для фиксации в историю по заданию)
 operator_id - id оператора-инициатора (для фиксации в историю по заданию) (до версии 3.16dev2)
Источник — https://wiki.userside.eu/index.php?title=API_task&oldid=19994