API fiber EN
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