API cable route EN: различия между версиями
Нет описания правки |
|||
(не показана 1 промежуточная версия этого же участника) | |||
Строка 2: | Строка 2: | ||
Section '''[[API_EN|API]]''' ERP "UserSide" | Section '''[[API_EN|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: Adding a cable route | |||
Obligatory 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: Adds a cable channel | |||
Obligatory 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 | |||
Obligatory parameters: | |||
None | |||
Optional parameters: | |||
id - id of objects ''(can be comma separated)'' | |||
==== get_duct ==== | |||
''Added in: 3.13.7'' | |||
Description: List of cable channels | |||
Obligatory parameters: | |||
None | |||
Optional parameters: | |||
id - id of objects ''(can be comma separated)'' | |||
cable_route_id - id of cable route ''(can be comma separated)'' |
Текущая версия от 14:53, 28 июля 2023
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: Adding a cable route Obligatory 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: Adds a cable channel Obligatory 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 Obligatory parameters: None Optional parameters: id - id of objects (can be comma separated)
get_duct
Added in: 3.13.7
Description: List of cable channels Obligatory parameters: None Optional parameters: id - id of objects (can be comma separated) cable_route_id - id of cable route (can be comma separated)