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

Материал из WiKi - UserSide
Перейти к навигации Перейти к поиску
(Подкатегории)
Строка 36: Строка 36:
 
   uzelcode - ID узла связи/муфты/опоры/колодца
 
   uzelcode - ID узла связи/муфты/опоры/колодца
 
   work_amount - объем работ
 
   work_amount - объем работ
 +
 +
==== add_inventory_to_operation ====
 +
''Добавлено в: 3.13.38''
 +
 +
Описание: Добавление ТМЦ в операцию
 +
 +
Обязательные параметры:
 +
  operation_id - id операции
 +
  inventory_id - id ТМЦ ''(оно должно находится на счёте-источнике операции)''
 +
Необязательные параметры:
 +
  amount - количество ТМЦ ''(если более 1 единицы в ТМЦ)''
  
 
==== change_date_work ====
 
==== change_date_work ====

Версия 13:32, 10 августа 2019

Раздел API ERP "UserSide"

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

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

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

add

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

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

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

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

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

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

Необязательные параметры:
 apart - номер квартиры
 author_operator_id - ID оператора-автора задания
 citycode - ID населенного пункта. Если не указан, то берётся из данных по дому housecode
 division_id - ID подразделения (допускается несколько значений через запятую)
 dopf_N - значение дополнительного поля для поля ID N
 fio - ФИО клиента (имеется в виду, что "клиент" еще не является абонентом)
 housecode - ID дома. Если не указан, то берётся из данных по абоненту - usercode, либо из данных по узлу связи - uzelcode
 opis - заметки к заданию
 parent_task_id - ID родительского задания
 unit_id - ID исполнителя (допускается несколько значений через запятую)
 usercode - ID абонента
 uzelcode - ID узла связи/муфты/опоры/колодца
 work_amount - объем работ

add_inventory_to_operation

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

Описание: Добавление ТМЦ в операцию

Обязательные параметры:
 operation_id - id операции
 inventory_id - id ТМЦ (оно должно находится на счёте-источнике операции)
Необязательные параметры:
 amount - количество ТМЦ (если более 1 единицы в ТМЦ)

change_date_work

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

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

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

change_state

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

Обязательные параметры:
 id - id задания
 state_id - id состояния задания
Необязательные параметры:
 operator_id - id оператора, от имени которого изменять состояние

check_verify_code

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

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

comment_add

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

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

Обязательные параметры:
 id - ID задания
 comment - текст
Необязательные параметры:
 operator_id - id оператора, от имени которого комментарий

division_add

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

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

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

division_delete

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

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

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

edit

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

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

Обязательные параметры:
 id - id задания
Необязательные параметры:
 body - текст задания (описательная часть)

get_catalog_type

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

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

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

get_catalog_state

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

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

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

get_comment

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

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

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

get_list

Доработано в: 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)

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

Необязательные параметры (условия выборки):
 author_id - ID оператора - автора задания (можно через запятую)
 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 - дата выполнения задания (до)
 division_id - ID подразделения (можно через запятую)
 house_id - ID дома работ
 staff_id - ID исполнителя (можно через запятую)
 state_id - ID статуса заданий (можно через запятую)
 type_id - ID типа заданий (можно через запятую)
 watcher_id - ID оператора - наблюдателя за заданием (можно через запятую)
 order_by - поле для сортировки (возможные варианты: customer_id, date_add, date_change, date_do, date_finish, house_id, state_id, type_id)
 limit - лимит выборки записей
 offset - смещение выборки

get_related_task_id

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

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

set_rate

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

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

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

show

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

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

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

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

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

staff_add

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

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

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

staff_delete

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

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

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