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

Текущая версия от 09:38, 12 ноября 2026

en | uk | ru

Section API_EN of the "UserSide" ERP

Purpose: Custom sections/pages/links

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

Subcategories

link_add

Updated in: 3.21.69 (added is_frame parameter)

Updated in: 3.21.66 (added rights_employee_profiles parameter)

Added in: 3.20.23

Description: Create a new link
Required parameters:
 section - section where the link will be placed [header|dashboard|menu]
 name - name
 url - link
Optional parameters:
 rights_employee_profiles - IDs of employee profiles allowed to access this page (comma separated)
 sub_section - menu subsection where the link will be placed (for section=menu) [accountancy | inventories | employees | customers | tariffs | customer_messages | equipments | tasks | coverage | advertisements | memos | statistics | operators | settings | nodes | cable_lines | transport | chapter]
 is_blank - open the link in a new page
 is_frame - open the link in a frame

link_get

Added in: 3.20.23

Description: Retrieve the list of links
Required parameters:
 none
Optional parameters:
 section - section where the link is placed [header|dashboard|menu]

link_remove

Added in: 3.20.23

Description: Delete a link
Required parameters:
 id - object ID

page_add

Updated in: 3.21.66 (added rights_employee_profiles parameter)

Added in: 3.21.58

Description: Create a new page
Required parameters:
 section - location for the page [customer_card|device_card]
 name - page name
Optional parameters:
 rights_employee_profiles - IDs of employee profiles allowed to access this page (comma separated)
 sub_section - device types that display the page (for section=device_card) [switch|radio|olt|onu|other] (separate multiple values with commas)
 url - link
 is_blank - open the link in a new page
 is_frame - open the link in a frame
 body - page content

page_get

Added in: 3.21.58

Description: Get a list of pages
Required parameters:
 section - location of the pages [customer_card|device_card]

page_remove

Added in: 3.21.58

Description: Delete a page
Required parameters:
 id - object ID

@@ Строка 11: / Строка 11: @@
 ==== link_add ====
+''Updated in: 3.21.69 (added is_frame parameter)''
+''Updated in: 3.21.66 (added rights_employee_profiles parameter)''
 ''Added in: 3.20.23''
@@ Строка 20: / Строка 24: @@
    url - link
   Optional parameters:
+  rights_employee_profiles - IDs of employee profiles allowed to access this page ''(comma separated)''
    sub_section - menu subsection where the link will be placed ''(for section=menu)'' [accountancy | inventories | employees | customers | tariffs | customer_messages | equipments | tasks | coverage | advertisements | memos | statistics | operators | settings | nodes | cable_lines | transport | chapter]
    is_blank - open the link in a new page
+  is_frame - open the link in a frame
 ==== link_get ====
@@ Строка 42: / Строка 48: @@
 ==== page_add ====
+''Updated in: 3.21.66 (added rights_employee_profiles parameter)''
 ''Added in: 3.21.58''
@@ Строка 50: / Строка 58: @@
    name - page name
   Optional parameters:
+  rights_employee_profiles - IDs of employee profiles allowed to access this page ''(comma separated)''
    sub_section - device types that display the page ''(for section=device_card)'' [switch|radio|olt|onu|other] ''(separate multiple values with commas)''
    url - link