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

Материал из WiKi - UserSide
(Новая страница: «en | ru Section '''API''' ERP "UserSide"»)
 
(Fix Ukrainian API localization)
 
(не показано 5 промежуточных версий 2 участников)
Строка 1: Строка 1:
[[API_map_EN|en]] | [[API_map|ru]]
'''en''' | [[API_map_UK|uk]] | [[API map|ru]]


Section '''[[API_EN|API]]''' ERP "UserSide"
Section '''[[API_EN|API]]''' ERP "UserSide"
Purpose: Coverage map management
Optional parameters:
action - request subcategory ''(possible value: see below)''
== Subcategories ==
==== add_label ====
''Added in: 3.19beta1''
Description: Add labelling
Required parameters:
  lat - latitude
  lon - longitude
  text - text of inscription
==== add_poly ====
''Added in: 3.18beta1''
Description: Add polygon
Required parameters:
  coord - coordinates ''(comma separated)''
  name - name
Optional parameters:
  color - HTML color of the polygon
==== check_entry_point_in_polygon ====
''Added in: 3.14.69''
Description: List of polygons that include a point
Required parameters:
  lat - latitude of the point
  lon - longitude of the point
==== edit_label ====
''Added in: 3.19beta1''
Description: Edit label
Required parameters:
  id - id of the object
Optional parameters:
  lat - latitude
  lon - longitude
  text - text of the inscription
==== edit_poly ====
''Added in: 3.19beta1''
Description: Edit polygon
Required parameters:
  id - id of the object
Optional parameters:
  coord - coordinates ''(comma separated)''
  name - name
  color - HTML color of the polygon
==== get ====
''Added in: 3.12.10''
Description: List of objects
Optional parameters:
  id - list of object IDs ''(comma separated)''
==== get_poly ====
''Added in: 3.12.80''
Description: List of polygons
Optional parameters:
  id - list of object IDs ''(comma separated)''
==== map_object_facilities_inside ====
''Added in: 3.19.4''
Description: Retrieve the list of objects located inside an object on the map ''(for example inside a polygon)''
Required parameters:
  id - object id
==== map_object_mark_add ====
''Added in: 3.19.3''
Description: Add a mark to an object on the map
Required parameters:
  id - object id
  mark_id - mark id
==== map_object_mark_delete ====
''Added in: 3.19.3''
Description: Delete a mark from an object on the map
Required parameters:
  id - object id
  mark_id - mark id

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

en | uk | ru

Section API ERP "UserSide"

Purpose: Coverage map management

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

Subcategories

add_label

Added in: 3.19beta1

Description: Add labelling
Required parameters:
 lat - latitude
 lon - longitude
 text - text of inscription

add_poly

Added in: 3.18beta1

Description: Add polygon
Required parameters:
 coord - coordinates (comma separated)
 name - name
Optional parameters:
 color - HTML color of the polygon

check_entry_point_in_polygon

Added in: 3.14.69

Description: List of polygons that include a point
Required parameters:
 lat - latitude of the point
 lon - longitude of the point

edit_label

Added in: 3.19beta1

Description: Edit label
Required parameters:
 id - id of the object
Optional parameters:
 lat - latitude
 lon - longitude
 text - text of the inscription

edit_poly

Added in: 3.19beta1

Description: Edit polygon
Required parameters:
 id - id of the object
Optional parameters:
 coord - coordinates (comma separated)
 name - name
 color - HTML color of the polygon

get

Added in: 3.12.10

Description: List of objects
Optional parameters:
 id - list of object IDs (comma separated)

get_poly

Added in: 3.12.80

Description: List of polygons
Optional parameters:
 id - list of object IDs (comma separated)

map_object_facilities_inside

Added in: 3.19.4

Description: Retrieve the list of objects located inside an object on the map (for example inside a polygon)
Required parameters:
 id - object id

map_object_mark_add

Added in: 3.19.3

Description: Add a mark to an object on the map
Required parameters:
 id - object id
 mark_id - mark id

map_object_mark_delete

Added in: 3.19.3

Description: Delete a mark from an object on the map
Required parameters:
 id - object id
 mark_id - mark id