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

Материал из WiKi - UserSide
(Новая страница: «en | ru Section '''API''' ERP "UserSide"»)
 
Нет описания правки
 
Строка 2: Строка 2:


Section '''[[API_EN|API]]''' ERP "UserSide"
Section '''[[API_EN|API]]''' ERP "UserSide"
Purpose: Action with object owners
Additional parameters:
action - request subcategory ''(possible value: see below)''
== Subcategories ==
==== add ====
''Modified in: 3.16.1 (added parameters address, ceo_name, phone, agreement_number, agreement_date, requisites, comment, cost)''
''Added in: 3.13.26''
Description: Addition
Obligatory parameters:
  name - name
Optional parameters:
  address - text address
  ceo_name - full name of manager
  phone - telephone
  agreement_number - agreement number
  agreement_date - date of agreement
  requisites - text requisites
  comment - notes
  cost - amount of payment to the owner
==== bind_building ====
''Added in: 3.13.15''
Description: Specifies the owner for the building
Obligatory parameters:
  owner_id - owner id
  building_id - building id
==== bind_fiber ====
''Added in: 3.13.35''
Description: Specifies the owner for the FOCL
Obligatory parameters:
  owner_id - owner id
  fibre_id - id of FOCL
==== bind_node ====
''Added in: 3.13.35''
Description: Specifies the owner for the infrastructure object
Obligatory parameters:
  owner_id - owner id
  node_id - id of infrastructure object
==== delete ====
''Added in: 3.13.26''
Description: Delete object
Obligatory parameters:
  id - id of the object
==== edit ====
''Modified in: 3.16.1 (added parameters address, ceo_name, phone, agreement_number, agreement_date, requisites, comment, cost)''
''Added in: 3.13.26''
Description: Edit object
Obligatory parameters:
  id - id of the object
Optional parameters:
  name - name
  address - text address
  ceo_name - manager's full name
  phone - telephone
  agreement_number - agreement number
  agreement_date - date of agreement
  requisites - text requisites
  comment - notes
  cost - amount of payment to the owner
==== get ====
''Added in: 3.12.10''
Description: List of objects
Optional parameters:
  id - list of object id ''(can be comma separated)''
==== unbind_building ====
''Added in: 3.13.15''
Description: Exclude the owner of a building
Obligatory parameters:
  owner_id - owner id
  building_id - building id
==== unbind_fiber ====
''Added in: 3.13.35''
Description: Unbind ownership of a FOCL
Obligatory parameters:
  fibre_id - id of the FOCL
==== unbind_node ====
''Added in: 3.13.35''
Description: Exclusion of the owner of the infrastructure object
Obligatory parameters:
  node_id - id of the infrastructure object

Текущая версия от 16:11, 28 августа 2023

en | ru

Section API ERP "UserSide"

Purpose: Action with object owners

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

Subcategories

add

Modified in: 3.16.1 (added parameters address, ceo_name, phone, agreement_number, agreement_date, requisites, comment, cost)

Added in: 3.13.26

Description: Addition 
Obligatory parameters:
 name - name
Optional parameters:
 address - text address
 ceo_name - full name of manager
 phone - telephone
 agreement_number - agreement number
 agreement_date - date of agreement
 requisites - text requisites
 comment - notes
 cost - amount of payment to the owner

bind_building

Added in: 3.13.15

Description: Specifies the owner for the building
Obligatory parameters:
 owner_id - owner id
 building_id - building id

bind_fiber

Added in: 3.13.35

Description: Specifies the owner for the FOCL
Obligatory parameters:
 owner_id - owner id
 fibre_id - id of FOCL

bind_node

Added in: 3.13.35

Description: Specifies the owner for the infrastructure object
Obligatory parameters:
 owner_id - owner id
 node_id - id of infrastructure object

delete

Added in: 3.13.26

Description: Delete object
Obligatory parameters:
 id - id of the object

edit

Modified in: 3.16.1 (added parameters address, ceo_name, phone, agreement_number, agreement_date, requisites, comment, cost)

Added in: 3.13.26

Description: Edit object
Obligatory parameters:
 id - id of the object
Optional parameters:
 name - name
 address - text address
 ceo_name - manager's full name
 phone - telephone
 agreement_number - agreement number
 agreement_date - date of agreement
 requisites - text requisites
 comment - notes
 cost - amount of payment to the owner

get

Added in: 3.12.10

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

unbind_building

Added in: 3.13.15

Description: Exclude the owner of a building
Obligatory parameters:
 owner_id - owner id
 building_id - building id

unbind_fiber

Added in: 3.13.35

Description: Unbind ownership of a FOCL
Obligatory parameters:
 fibre_id - id of the FOCL

unbind_node

Added in: 3.13.35

Description: Exclusion of the owner of the infrastructure object
Obligatory parameters:
 node_id - id of the infrastructure object