API node EN

en | uk | ru

Section API ERP "UserSide"

Purpose: Infrastructure facilities (communication nodes, splice closures, poles, manholes)

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

IDs of infrastructure object types:

0 - communication node (up to 3.14.21)
1 - splice closure
2 - pole
3 - manhole
4 - communication node (from 3.14.21)

Subcategories

add

Modified in: 3.16.22 (added level_id parameter)

Modified in: 3.16dev9 (added level parameter)

Description: Add an infrastructure facility
Required parameters:
 type - Type of object
Optional parameters:
 city_id - ID of the locality where the object is located
 custom_icon_id - ID of custom icon on the map
 comment - notes
 date_add - date added
 entrance - entrance number
 house_id - ID of the building where the object is located
 inventory_number - inventory number of the object
 is_planned - flag - object is only planned
 level - floor number
 level_id - floor/level ID (from building structure)
 location - object location (text)
 node_parent_id - ID of parent object
 number - object number
 owner_id - owner ID
 map_id - map ID (for version 3.12 and earlier)
 coordinates - coordinates in text form separated by commas (example: 47.839628,35.140553)

add_mark

Description: Add a mark
Required parameters:
 node_id - object id
 mark_id - mark id

change_custom_icon

Description: Change custom icon on the map
Required parameters:
 id - object id
 custom_icon_id - icon id

delete

Added in: 3.16dev8

Description: Delete an infrastructure facility
Required parameters:
 id - object id

delete_mark

Description: Remove a mark
Required parameters:
 node_id - object id
 mark_id - mark id

edit

Modified in: 3.16.22 (added level_id parameter)

Modified in: 3.16dev9 (added level parameter)

Description: Edit an infrastructure facility
Required parameters:
 id - object ID
Optional parameters:
 city_id - ID of the locality where the object is located
 custom_icon_id - ID of custom icon on the map
 comment - notes
 coordinates - coordinates in text form with comma (example: 47.839628,35.140553)
 date_add - date added
 entrance - entrance number
 house_id - ID of the house where the object is located
 inventory_number - inventory number of the object
 is_planned - flag - object is only planned
 level - floor number
 level_id - floor/level ID (from the building structure)
 location - object location (text)
 node_parent_id - ID of parent object
 number - object number
 owner_id - owner ID

get

Modified in: 3.17beta1 (added entrance_number parameter)

Modified in: 3.13.35 (added mark_id parameter)

Modified at: 3.13.14 (added parent_id parameter)

Modified in: 3.13alpha1 (added address_id parameter, removed city_id, street_id, house_id parameters)

Modified in: 3.12.74 (added city_id, street_id, house_id parameters)

Description: List of infrastructure facilities
Required parameters:
 None
Optional parameters:
 address_id - address unit id (can be comma separated) (since version 3.13)
 city_id - id of the settlement (can be comma separated) (before version 3.13)
 entrance_number - entrance number
 house_id - building id (can be comma separated) (before version 3.13)
 id - object id (can be comma separated)
 mark_id - mark id
 object_type - object type
 parent_id - id of parent object (can be comma separated)
 street_id - street id (can be comma separated) (before version 3.13)

get_icon_list

Description: List of custom icons for objects
Optional parameters:
 id - list of object IDs (can be comma separated)

get_id

Modified in: 3.14.46 (added type_id parameter)

Modified in: 3.12.72 (added possible comment value, added is_entry parameter)

Modified in: 3.12.71 (added possible value of additional_dataX)

Description: Get object ID from input data
Required parameters:
 data_type - type of data we are checking (possible values: comment, number, additional_dataX (instead of X - id of additional field))
 data_value - value
Optional parameters:
 is_entry - flag - whether to check for a match in part of string occurrence
 type_id - object type

get_id_by_coord

Added in: 3.12beta30

Description: Get ID of the nearest object by specified coordinates
Required parameters:
 lat - latitude
 lon - longitude
Optional parameters:
 type - type of object
 range - radius in metres within which to display objects

get_redevelopment_scheme

Added in: 3.16dev3

Description: List of redevelopment schemes for an infrastructure facility
Required parameters:
 id - infrastructure facility id

get_scheme

Added in: 3.15.15

Description: Get a commutation scheme
Required parameters:
 id - infrastructure facility id

get_type_list

Added in: 3.16dev3

Description: Get the list of infrastructure facility types

get_relation_customers

Added in: 3.19.45

Description: Retrieve information about dependent customers
Required parameters:
 id - infrastructure facility id