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

Текущая версия от 13:56, 23 августа 2023

Раздел API ERP "UserSide"

Назначение: Ключи

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

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

add

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

Описание: Добавление
Обязательные параметры:
 нет (но должно быть указано либо name либо building_id либо и то и другое)
Обязательные параметры:
 name - "Название" ключа
 building_id - ID здания
 comment - Заметки

get_list

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

Описание: Ключи
Обязательные параметры:
 нет
Дополнительные параметры:
 id - ID ключа (можно через запятую)
 staff_id - ID сотрудника, на котором учитываются ключи (можно через запятую)

@@ Строка 1: / Строка 1: @@
+[[API_key_EN|en]] | [[API_key|ru]]
 Раздел '''[[API]]''' ERP "UserSide"
-Назначение: ВОЛС
+Назначение: Ключи
   Дополнительные параметры:
@@ Строка 8: / Строка 10: @@
 == Подкатегории ==
-==== get_list ====
+==== add ====
-  Описание: Список ВОЛС
+''Добавлено в: 3.18beta1''
+  Описание: Добавление
   Обязательные параметры:
-   нет
+   нет ''(но должно быть указано либо name либо building_id либо и то и другое)''
- Дополнительные параметры:
-  object_id - ID конкретной ВОЛС
- Дополнительно возвращаемые данные:
-  array(
-   [Data] => Данные об объектах
-  )
-==== add ====
- Описание: Добавление ВОЛС
   Обязательные параметры:
-   object_a_id - ID начального объекта
+   name - "Название" ключа
-  object_b_id - ID конечного объекта (либо house_b_id - ID конечного дома)
+   building_id - ID здания
- Дополнительные параметры:
-  building_date - Дата прокладки
-  building_length - строительная длина
-   cabletype_id - ID типа кабеля
    comment - Заметки
-  custom_color - Собственный цвет для ВОЛС
-  fibers_count - количество ОВ
-  is_planned - Флаг - объект только запланирован
-  is_change_color_by_cabletype - Флаг - Изменить цвета ОВ согласно свойств типа кабеля
-  marking_a - Маркировка ВОЛС на стороне А
-  marking_b - Маркировка ВОЛС на стороне Б
-  object_a_id - ID начального объекта
-  object_b_id - ID конечного объекта
-  optical_length - оптическая длина
- Дополнительно возвращаемые данные:
-  array(
-   [id] => ID добавленной ВОЛС в случае успеха
-  )
-==== edit ====
+==== get_list ====
-  Описание: Редактирование ВОЛС
+''Добавлено в: 3.12.71''
+  Описание: Ключи
   Обязательные параметры:
-   id - ID ВОЛС
+   нет
-  Необязательные параметры:
+  Дополнительные параметры:
-   object_a_id - ID начального объекта
+   id - ID ключа ''(можно через запятую)''
-  object_b_id - ID конечного объекта
+   staff_id - ID сотрудника, на котором учитываются ключи ''(можно через запятую)''
-   house_b_id - ID конечного дома
-  building_date - Дата прокладки
-  building_length - строительная длина
-  cabletype_id - ID типа кабеля
-  comment - Заметки
-  custom_color - Собственный цвет для ВОЛС
-  fibers_count - количество ОВ
-  is_planned - Флаг - объект только запланирован
-  is_change_color_by_cabletype - Флаг - Изменить цвета ОВ согласно свойств типа кабеля
-  marking_a - Маркировка ВОЛС на стороне А
-  marking_b - Маркировка ВОЛС на стороне Б
-  object_a_id - ID начального объекта
-  object_b_id - ID конечного объекта
-  optical_length - оптическая длина