Merge pull request #14 from EDI-N/Kolya

Kolya
EDI-N · Oct 11, 2021 · 279e701 · 279e701
2 parents 4daf22c + 60e9b17
commit 279e701
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 0 deletions.
diff --git a/docs/API_DOCflow/API_DOCflow_list.rst b/docs/API_DOCflow/API_DOCflow_list.rst
@@ -56,6 +56,7 @@
    Methods/PostPackages
    Methods/PostPackageSend
    Methods/PostPackageStatus
+   Methods/MarkAsReadFromApi
 
 .. toctree::
    :caption: Сценарій документообігу

diff --git a/docs/API_DOCflow/Methods/MarkAsReadFromApi.rst b/docs/API_DOCflow/Methods/MarkAsReadFromApi.rst
@@ -0,0 +1,46 @@
+#############################################################
+**Відмітити комплект документів (пекет), як "прочитаний"**
+#############################################################
+
+Для роботи з цим методом користувач повинен бути `авторизованим <https://wiki-df.edin.ua/uk/latest/API_DOCflow/Methods/Authorization.html>`__ .
+
++--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
+|                       **Метод запиту**                       |                                              **HTTP OPTIONS**                                              |
++==============================================================+============================================================================================================+
+| **Content-Type**                                             | application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)                                 |
++--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
+| **URL запиту**                                               | **https://doc.edin.ua/bdoc/store/package/read_from_api**?package_id=2385                                   |
++--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
+| **Параметри, що передаються в URL (разом з адресою методу)** | В рядку заголовка (Header) "Set-Cookie" обов'язково передається **SID** - токен, отриманий при авторизації |
+|                                                              |                                                                                                            |
+|                                                              | **Обов'язкові url-параметри:**                                                                             |
+|                                                              |                                                                                                            |
+|                                                              | **package_id** - ID комплекта документів (пекета)                                                          |
++--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
+
+.. tip:: Метод зручно використовувати для організованої роботи (фільтрації) отриманих комплектів документів.
+
+**JSON-параметри в тілі HTTP запиту/відповіді**
+*******************************************************************
+
+``REQUEST``
+
+В цьому методі json-тіло **запиту** відсутнє (інші дані передавати не потрібно).
+
+``RESPONSE``
+
+У **відповідь** передається код сервера 200 (ok)
+
+--------------
+
+**Приклади**
+*****************
+
+**При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)**
+
+--------------
+
+У **відповідь** передається код сервера 200 (ok)
+
+
+