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

Материал из WiKi - UserSide
Нет описания правки
(Sync English API page with Russian API documentation)
Строка 29: Строка 29:
   name - name
   name - name
  Optional parameters:
  Optional parameters:
   colour - HTML colour of the polygon
   color - HTML color of the polygon


==== check_entry_point_in_polygon ====
==== check_entry_point_in_polygon ====
Строка 60: Строка 60:
   coord - coordinates ''(comma separated)''
   coord - coordinates ''(comma separated)''
   name - name
   name - name
   colour - HTML colour of the polygon
   color - HTML color of the polygon


==== get ====
==== get ====
Строка 73: Строка 73:
  Optional parameters:
  Optional parameters:
   id - list of object IDs ''(comma separated)''
   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

Версия от 19:22, 9 мая 2026

en | ru

Section API ERP "UserSide"

Purpose: Action with coverage maps

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

Subcategories

add_label

Added in: 3.19beta1

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

add_poly

Added in: 3.18beta1

Description: Add polygon
Obligatory 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
Obligatory parameters:
 lat - latitude of the point
 lon - longitude of the point

edit_label

Added in: 3.19beta1

Description: Edit label
Obligatory 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
Obligatory 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