/
PostTag.rst
70 lines (50 loc) · 4 KB
/
PostTag.rst
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
#############################################################
**Створення / редагування тегів**
#############################################################
Для роботи з цим методом користувач повинен бути `авторизованим <https://wiki.edi-n.com/uk/latest/API_DOCflow/Methods/Authorization.html>`__ .
+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| **Метод запиту** | **HTTP POST** |
+==============================================================+============================================================================================================+
| **Content-Type** | text/json; charset=UTF-8 (тіло запиту/відповіді в json форматі в тілі HTTP запиту) |
+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| **URL запиту** | https://doc.edi-n.com/bdoc/tag |
+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| **Параметри, що передаються в URL (разом з адресою методу)** | В рядку заголовка (Header) "Set-Cookie" обов'язково передається **SID** - токен, отриманий при авторизації |
+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
.. important::
Редагування тегу відбувається аналогічним запитом за допомогою перезапису даних, обов'язково при цьому вказувати **tagId**!
**JSON-параметри в тілі HTTP запиту/відповіді**
***********************************************************
``REQUEST``
Таблиця 1 - Опис json-параметрів **запиту** метода API
+----------+--------------------+--------+---------------------------------------------------------+
| Параметр | Mandatory/Optional | Формат | Опис |
+==========+====================+========+=========================================================+
| name | M | String | назва тегу |
+----------+--------------------+--------+---------------------------------------------------------+
| code | О | long | унікальний код, якщо не передано створиться автоматично |
+----------+--------------------+--------+---------------------------------------------------------+
``RESPONSE``
У **відповідь** передаються дані тегу (объект **Tag**).
Таблиця 2 - Опис параметрів об'єкта **Tag**
.. csv-table::
:file: for_csv/Tag.csv
:widths: 1, 12, 41
:header-rows: 1
:stub-columns: 0
**Приклади**
*********************************
Приклад тіла **запиту** в json форматі
.. code:: ruby
{
"code": "6418c44baec34df7bc17a66a1989fa1a",
"name": "Альбатрос"
}
--------------
Приклад тіла **відповіді** в json форматі
.. code:: ruby
{
"tagId": 409,
"name": "Альбатрос",
"code": "6418c44baec34df7bc17a66a1989fa1a"
}