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

Материал из WiKi - UserSide
Нет описания правки
(Fix Ukrainian API localization)
 
(не показаны 2 промежуточные версии этого же участника)
Строка 1: Строка 1:
[[API_cable_route_EN|en]] | [[API_cable_route|ru]]
'''en''' | [[API_cable_route_UK|uk]] | [[API cable_route|ru]]


Section '''[[API_EN|API]]''' ERP "UserSide"
Section '''[[API_EN|API]]''' ERP "UserSide"
Строка 19: Строка 19:
==== add_route ====
==== add_route ====
''Added in: 3.13.7''
''Added in: 3.13.7''
  Description: Adding a cable route
  Description: Add a cable route
  Obligatory parameters:
  Required parameters:
   object_first_type - type of the initial object
   object_first_type - type of the initial object
   object_first_id - id of the initial object
   object_first_id - id of the initial object
Строка 33: Строка 33:
==== add_duct ====
==== add_duct ====
''Added in: 3.13.7''
''Added in: 3.13.7''
  Description: Adds a cable channel
  Description: Add a cable channel
  Obligatory parameters:
  Required parameters:
   cable_route_id - id of the cable route
   cable_route_id - id of the cable route
  Optional parameters:
  Optional parameters:
Строка 45: Строка 45:
''Added in: 3.13.7''
''Added in: 3.13.7''
  Description: List of cable routes
  Description: List of cable routes
  Obligatory parameters:
  Required parameters:
   None
   None
  Optional parameters:
  Optional parameters:
Строка 53: Строка 53:
''Added in: 3.13.7''
''Added in: 3.13.7''
  Description: List of cable channels
  Description: List of cable channels
  Obligatory parameters:
  Required parameters:
   None
   None
  Optional parameters:
  Optional parameters:
   id - id of objects ''(can be comma separated)''
   id - id of objects ''(can be comma separated)''
   cable_route_id - id of cable route ''(can be comma separated)''
   cable_route_id - id of cable route ''(can be comma separated)''

Текущая версия от 11:37, 10 мая 2026

en | uk | ru

Section API ERP "UserSide"

Purpose: Cable routes and ducts

Additional parameters:
action - request subcategory (possible value: see below)

ID types of initial and final objects of the trace:

1 - user
17 - manhole (before version 3.17)
18 - pole (before version 3.17)
19 - building
22 - communication installation

Subcategories

add_route

Added in: 3.13.7

Description: Add a cable route
Required parameters:
 object_first_type - type of the initial object
 object_first_id - id of the initial object
 object_second_type - end object type
 object_second_id - id of the final object
Additional parameters:
 name - name
 comment - note
 length - length
 date_install - date of actual installation

add_duct

Added in: 3.13.7

Description: Add a cable channel
Required parameters:
 cable_route_id - id of the cable route
Optional parameters:
 number - number
 comment - note
 diameter - diameter
 date_install - date of actual installation

get_route

Added in: 3.13.7

Description: List of cable routes
Required parameters:
 None
Optional parameters:
 id - id of objects (can be comma separated)

get_duct

Added in: 3.13.7

Description: List of cable channels
Required parameters:
 None
Optional parameters:
 id - id of objects (can be comma separated)
 cable_route_id - id of cable route (can be comma separated)