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

Материал из WiKi - UserSide
(Normalize English API spelling to fiber and color)
(Fix Ukrainian API localization)
 
(не показаны 2 промежуточные версии этого же участника)
Строка 1: Строка 1:
[[API_fiber_EN|en]] | [[API_fiber|ru]]
'''en''' | [[API_fiber_UK|uk]] | [[API fiber|ru]]


Section '''[[API_EN|API]]''' ERP "UserSide"
Section '''[[API_EN|API]]''' ERP "UserSide"
Строка 14: Строка 14:
''Modified in: 3.15.23 (added cableline_type_id parameters)''
''Modified in: 3.15.23 (added cableline_type_id parameters)''


  Description: Adding a line
  Description: Add a cable line
  Obligatory parameters:
  Required parameters:
   object_a_id - ID of the initial object
   object_a_id - ID of the initial object
   object_b_id - ID of the final object (or house_b_id - ID of the final house or customer_b_id - ID of the final customer)
   object_b_id - ID of the final object (or house_b_id - ID of the final building or customer_b_id - ID of the final customer)
  Optional parameters:
  Optional parameters:
   building_date - Date of laying
   building_date - installation date
   building_length - building length
   building_length - construction length
   cableline_type_id - cable line type ID
   cableline_type_id - cable line type ID
   cabletype_id - cable type ID
   cabletype_id - cable type ID
Строка 27: Строка 27:
   customer_b_id - ID of the final customer
   customer_b_id - ID of the final customer
   fibers_count - number of fibers
   fibers_count - number of fibers
   house_b_id - ID of the final house
   house_b_id - ID of the final building
   is_planned - Flag - object is only planned
   is_planned - flag - object is only planned
   is_change_color_by_cabletype - Flag - Change fiber colors according to cable type properties
   is_change_color_by_cabletype - flag - change fiber colors according to cable type properties
   marking_a - Line marking on side A
   marking_a - line marking on side A
   marking_b - Line marking on side B
   marking_b - line marking on side B
   object_a_id - ID of the initial object
   object_a_id - ID of the initial object
   object_b_id - ID of final object
   object_b_id - ID of final object
Строка 38: Строка 38:
==== add_mark ====
==== add_mark ====
''Added in 3.13.35''
''Added in 3.13.35''
  Description: Adding a mark
  Description: Add a mark
  Obligatory parameters:
  Required parameters:
   fiber_id - line id
   fiber_id - line id
   mark_id - mark id
   mark_id - mark id
Строка 45: Строка 45:
==== add_route_object ====
==== add_route_object ====
''Added in 3.13.14''
''Added in 3.13.14''
  Description: Adds an object to a line route
  Description: Add an object to a cable line route
  Obligatory parameters:
  Required parameters:
   id - id of the line
   id - id of the line
   object_id - object id
   object_id - object id
Строка 54: Строка 54:
==== catalog_cables_add ====
==== catalog_cables_add ====
''Added in 3.17dev1''
''Added in 3.17dev1''
  Description: Adds an entry to the cables catalogue
  Description: Add an entry to the cable catalogue
  Obligatory parameters:
  Required parameters:
   cable_line_type_id - cable line type id
   cable_line_type_id - cable line type id
   brand - manufacturer name
   brand - manufacturer name
   name - cable brand
   name - cable brand
   core_count - number of conductors ''(fibers/core)''
   core_count - number of conductors ''(fibers/cores)''


==== catalog_cables_get ====
==== catalog_cables_get ====
Строка 73: Строка 73:
==== delete ====
==== delete ====
''Added in: 3.16dev8''
''Added in: 3.16dev8''
  Description: Deleting a cable line
  Description: Delete a cable line
  Obligatory parameters:
  Required parameters:
   id - object id
   id - object id


==== delete_mark ====
==== delete_mark ====
''Added in 3.13.35''
''Added in 3.13.35''
  Description: Removing a mark
  Description: Remove a mark
  Obligatory parameters:
  Required parameters:
   fiber_id - line id
   fiber_id - line id
   mark_id - mark id
   mark_id - mark id


==== edit ====
==== edit ====
  Description: Line editing
  Description: Edit a cable line
  Obligatory parameters:
  Required parameters:
   id - line id
   id - line id
  Optional parameters:
  Optional parameters:
   object_a_id - id of the start object
   object_a_id - id of the start object
   object_b_id - id of the final object  
   object_b_id - id of the final object  
   house_b_id - id of the final house
   house_b_id - id of the final building
   building_date - date of laying
   building_date - installation date
   building_length - building length
   building_length - construction length
   cabletype_id - cable type id
   cabletype_id - cable type id
   cable_line_type_id - cable line type id
   cable_line_type_id - cable line type id
Строка 99: Строка 99:
   custom_color - custom color for the line
   custom_color - custom color for the line
   fibers_count - number of fibers
   fibers_count - number of fibers
   house_b_id - ID of the final house
   house_b_id - ID of the final building
   is_planned - flag - object is only planned
   is_planned - flag - object is only planned
   is_change_color_by_cabletype - flag - Change fiber colors according to cable type properties
   is_change_color_by_cabletype - flag - change fiber colors according to cable type properties
   marking_a - line marking on A side
   marking_a - line marking on A side
   marking_b - line marking on side B
   marking_b - line marking on side B
Строка 111: Строка 111:
''Added in 3.12.94''
''Added in 3.12.94''
  Description: List of fibers
  Description: List of fibers
  Obligatory parameters:
  Required parameters:
   None
   None
  Optional parameters:
  Optional parameters:
Строка 119: Строка 119:
==== get_geo_length ====
==== get_geo_length ====
''Added in 3.13.14''
''Added in 3.13.14''
  Description: Calculation of line length according to geographical coordinates of endpoints ''(approximate calculation)''
  Description: Calculate line length by endpoint geographic coordinates ''(approximate calculation)''
  Obligatory parameters:
  Required parameters:
   id - line id
   id - line id


Строка 130: Строка 130:
''Modified in: 3.13.35 (added mark_id parameters)''
''Modified in: 3.13.35 (added mark_id parameters)''


  Description: List of lines
  Description: List of cable lines
  Obligatory parameters:
  Required parameters:
   None
   None
  Optional parameters:
  Optional parameters:
Строка 145: Строка 145:
==== remove_route_object ====
==== remove_route_object ====
''Added in 3.13.14''
''Added in 3.13.14''
  Description: Excludes objects on the line route
  Description: Remove objects from the cable line route
  Obligatory parameters:
  Required parameters:
   id - id of the line
   id - id of the line
  Optional parameters:
  Optional parameters:
Строка 153: Строка 153:
==== set_geo_route ====
==== set_geo_route ====
''Added in 3.13.45''
''Added in 3.13.45''
  Description: Set the geographical route of the line
  Description: Set the geographic route of the cable line
  Obligatory parameters:
  Required parameters:
   id - id of the line
   id - id of the line
   route - array of geographical points ''(lat,lon)'' of the line route in json format
   route - array of geographic points ''(lat,lon)'' of the cable line route in JSON format


==== set_pigtail_type ====
==== set_pigtail_type ====

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

en | uk | ru

Section API ERP "UserSide"

Purpose: Cable lines 

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

Subcategories

add

Modified in: 3.15.23 (added cableline_type_id parameters) 

Description: Add a cable line
Required parameters:
 object_a_id - ID of the initial object
 object_b_id - ID of the final object (or house_b_id - ID of the final building or customer_b_id - ID of the final customer)
Optional parameters:
 building_date - installation date
 building_length - construction length
 cableline_type_id - cable line type ID
 cabletype_id - cable type ID
 comment - Notes
 custom_color - Custom color for the line
 customer_b_id - ID of the final customer
 fibers_count - number of fibers
 house_b_id - ID of the final building
 is_planned - flag - object is only planned
 is_change_color_by_cabletype - flag - change fiber colors according to cable type properties
 marking_a - line marking on side A
 marking_b - line marking on side B
 object_a_id - ID of the initial object
 object_b_id - ID of final object
 optical_length - optical length

add_mark

Added in 3.13.35 

Description: Add a mark
Required parameters:
 fiber_id - line id
 mark_id - mark id

add_route_object

Added in 3.13.14 

Description: Add an object to a cable line route
Required parameters:
 id - id of the line
 object_id - object id
Optional parameters:
 reserve - cable reserve (in meters)

catalog_cables_add

Added in 3.17dev1 

Description: Add an entry to the cable catalogue
Required parameters:
 cable_line_type_id - cable line type id
 brand - manufacturer name
 name - cable brand
 core_count - number of conductors (fibers/cores)

catalog_cables_get

Added in 3.15.12 

Description: Catalogue of cables
Optional parameters:
 cable_line_type_id - id of cable line type

catalog_types_get

Added in 3.15.12 

Description: Catalogue of cable line types

delete

Added in: 3.16dev8 

Description: Delete a cable line
Required parameters:
 id - object id

delete_mark

Added in 3.13.35 

Description: Remove a mark
Required parameters:
 fiber_id - line id
 mark_id - mark id

edit

Description: Edit a cable line
Required parameters:
 id - line id
Optional parameters:
 object_a_id - id of the start object
 object_b_id - id of the final object 
 house_b_id - id of the final building
 building_date - installation date
 building_length - construction length
 cabletype_id - cable type id
 cable_line_type_id - cable line type id
 comment - notes
 custom_color - custom color for the line
 fibers_count - number of fibers
 house_b_id - ID of the final building
 is_planned - flag - object is only planned
 is_change_color_by_cabletype - flag - change fiber colors according to cable type properties
 marking_a - line marking on A side
 marking_b - line marking on side B
 optical_length - optical length

get_fiber

Modified in: 3.14beta5 (added fiber_id parameters)

Added in 3.12.94 

Description: List of fibers
Required parameters:
 None
Optional parameters:
 fiber_id - cable line id (can be comma separated)
 id - fiber id (can be comma separated)

get_geo_length

Added in 3.13.14 

Description: Calculate line length by endpoint geographic coordinates (approximate calculation)
Required parameters:
 id - line id

get_list

Modified in: 3.16.19 (added cable_line_type_id parameters)

Modified in: 3.13.45 (added node_id parameters)

Modified in: 3.13.35 (added mark_id parameters) 

Description: List of cable lines
Required parameters:
 None
Optional parameters:
 cable_line_type_id - id of cable line type
 mark_id - mark id
 node_id - id of placement object (can be comma separated)
 object_id - id of the specific line

map_color_get

Added in 3.16dev8 

Description: Cable colors on the map

remove_route_object

Added in 3.13.14 

Description: Remove objects from the cable line route
Required parameters:
 id - id of the line
Optional parameters:
 object_id - object id

set_geo_route

Added in 3.13.45 

Description: Set the geographic route of the cable line
Required parameters:
 id - id of the line
 route - array of geographic points (lat,lon) of the cable line route in JSON format

set_pigtail_type

Added in 3.19.35 

Description: Set the pigtail type for a line fiber/conductor
Required parameters:
 id - line id
 side - line side [1|2]
 number - fiber/conductor number
 pigtail_type - pigtail type

pigtail_type variants: 

 1001 - SC UPC
 1002 - LC UPC
 1003 - FC UPC
 1004 - ST UPC
 1005 - E2000 UPC
 1011 - SC APC
 1012 - LC APC
 1013 - FC APC
 1014 - ST APC
 1015 - E2000 APC
 10010 - SC UPC Female
 10011 - SC APC Female
 1100 - no pigtail
 5000 - failed
Источник — https://wiki.userside.eu/index.php?title=API_fiber_EN&oldid=21527