Merge pull request #2055 from EDI-N/Kolya_ua

api_CertificateV2

docs/Certificate/EDIN_2_0/APIv2/API_Certificate_v2_list.rst

@@ -29,17 +29,44 @@
 Робота з сертифікатами
 =============================================================
 
-+-----------+--------------------------+------------------------------------------------------------+
-| **Метод** |      **URL запиту**      |                          **Опис**                          |
-+===========+==========================+============================================================+
-| POST      | ``/api/ecs/certificate`` | :doc:`/Certificate/EDIN_2_0/APIv2/Methods/CertificatePost` |
-+-----------+--------------------------+------------------------------------------------------------+
-| PUT       | ``/api/ecs/certificate`` | :doc:`/Certificate/EDIN_2_0/APIv2/Methods/CertificatePut`  |
-+-----------+--------------------------+------------------------------------------------------------+
-| GET       | ``/api/ecs/certificate`` | :doc:`/Certificate/EDIN_2_0/APIv2/Methods/CertificateGet`  |
-+-----------+--------------------------+------------------------------------------------------------+
-| DELETE    | ``/api/ecs/certificate`` | :doc:`/Certificate/EDIN_2_0/APIv2/Methods/CertificateDel`  |
-+-----------+--------------------------+------------------------------------------------------------+
++-----------+----------------------------+--------------------------------------------------------------------+
+| **Метод** |       **URL запиту**       |                              **Опис**                              |
++===========+============================+====================================================================+
+| POST      | ``/api/ecs/certificate``   | :doc:`/Certificate/EDIN_2_0/APIv2/Methods/CertificatePost`         |
++-----------+----------------------------+--------------------------------------------------------------------+
+| PUT       | ``/api/ecs/certificate``   | :doc:`/Certificate/EDIN_2_0/APIv2/Methods/CertificatePut`          |
++-----------+----------------------------+--------------------------------------------------------------------+
+| GET       | ``/api/ecs/certificate``   | :doc:`/Certificate/EDIN_2_0/APIv2/Methods/CertificateGet`          |
++-----------+----------------------------+--------------------------------------------------------------------+
+| DELETE    | ``/api/ecs/certificate``   | :doc:`/Certificate/EDIN_2_0/APIv2/Methods/CertificateDel`          |
++-----------+----------------------------+--------------------------------------------------------------------+
+| GET       | ``/api/ecs/body/download`` | :doc:`/Certificate/EDIN_2_0/APIv2/Methods/CertificateBodyDownload` |
++-----------+----------------------------+--------------------------------------------------------------------+
+| PUT       | ``/api/ecs/archive``       | :doc:`/Certificate/EDIN_2_0/APIv2/Methods/ArchiveCertificate`      |
++-----------+----------------------------+--------------------------------------------------------------------+
+| PUT       | ``/api/ecs/access``        | :doc:`/Certificate/EDIN_2_0/APIv2/Methods/ChangeCertificateAccess` |
++-----------+----------------------------+--------------------------------------------------------------------+
+| PUT       | ``/api/ecs/copy``          | :doc:`/Certificate/EDIN_2_0/APIv2/Methods/CopyCertificate`         |
++-----------+----------------------------+--------------------------------------------------------------------+
+| POST      | ``/api/ecs/search``        | :doc:`/Certificate/EDIN_2_0/APIv2/Methods/SearchCertificates`      |
++-----------+----------------------------+--------------------------------------------------------------------+
+| PUT       | ``/api/ecs/products``      | :doc:`/Certificate/EDIN_2_0/APIv2/Methods/CertificateProducts`     |
++-----------+----------------------------+--------------------------------------------------------------------+
+
+**Вкладення до сертифікатів:**
+
++-----------+-------------------+----------------------------------------------------------------+
+| **Метод** |  **URL запиту**   |                            **Опис**                            |
++===========+===================+================================================================+
+| POST      | ``/api/ecs/body`` | :doc:`/Certificate/EDIN_2_0/APIv2/Methods/CertificateBodyPost` |
++-----------+-------------------+----------------------------------------------------------------+
+| PUT       | ``/api/ecs/body`` | :doc:`/Certificate/EDIN_2_0/APIv2/Methods/CertificateBodyPut`  |
++-----------+-------------------+----------------------------------------------------------------+
+| GET       | ``/api/ecs/body`` | :doc:`/Certificate/EDIN_2_0/APIv2/Methods/CertificateBodyGet`  |
++-----------+-------------------+----------------------------------------------------------------+
+| DELETE    | ``/api/ecs/body`` | :doc:`/Certificate/EDIN_2_0/APIv2/Methods/CertificateBodyDel`  |
++-----------+-------------------+----------------------------------------------------------------+
+
 
 .. beauty list
 
@@ -51,6 +78,16 @@
    Methods/CertificatePut
    Methods/CertificateGet
    Methods/CertificateDel
+   CertificateBodyDownload
+   ArchiveCertificate
+   ChangeCertificateAccess
+   CopyCertificate
+   SearchCertificates
+   CertificateProducts
+   CertificateBodyPost
+   CertificateBodyPut
+   CertificateBodyGet
+   CertificateBodyDel
 
 ---------------------------------
 

docs/Certificate/EDIN_2_0/APIv2/Methods/ArchiveCertificate.csv

@@ -0,0 +1,8 @@
+**URL**       ,
+Метод запиту  , PUT                                          
+URL запиту    ,**/api/ecs/archive?gln=9864232613879&uuid=3ff444f4-7594-4a43-a151-90e14ee92b0c**
+URL параметри ,"**gln** (обов'язково) String - GLN власної Компанії;
+
+**uuid** (обов'язково) UUID - унікальний ідентифікатор сертифіката"
+**Headers**   ,
+Authorization ,"**SID** - токен, отриманий при `авторизації <https://wiki.edin.ua/uk/latest/integration_2_0/APIv2/Methods/Authorization.html>`__"

docs/Certificate/EDIN_2_0/APIv2/Methods/ArchiveCertificate.rst

@@ -0,0 +1,23 @@
+#########################################################################################################
+**Архівувати / розархівувати сертифікат**
+#########################################################################################################
+
+Для роботи з цим методом користувач повинен бути `авторизованим <https://wiki.edin.ua/uk/latest/integration_2_0/APIv2/Methods/Authorization.html>`__.
+
+ .. note::
+   Архівувати можливо лише опубліковані сертифікати з обмеженим доступом!
+
+ .. hint::
+   Дія "архівувати" / "розархівувати" залежить від того, де перебуває сертифікат до виконання метода:
+
+   * якщо сертифікат в **Архіві**, то виконається розархівування;
+   * якщо сертифікат в **Опублікованих**, то виконається архівування.
+
+.. csv-table:: 
+  :file: ArchiveCertificate.csv
+  :widths:  10, 41
+  :stub-columns: 0
+
+**RESPONSE**
+
+Код сервера 200 (ok).

docs/Certificate/EDIN_2_0/APIv2/Methods/CertificateBodyDel.csv

@@ -0,0 +1,12 @@
+**URL**       ,
+Метод запиту  , DELETE                                        
+URL запиту    ,**/api/ecs/body?gln=9864232613879&uuid=3ff444f4-7594-4a43-a151-90e14ee92b0c&body_type=1**
+URL параметри ,"**gln** (обов'язково) String - GLN власної Компанії;
+
+**uuid** (обов'язково) UUID - унікальний ідентифікатор сертифіката
+
+**body_type** (обов'язково) int - тип тіла:
+
+* 1 - вкладення до сертифіката"
+**Headers**   ,
+Authorization ,"**SID** - токен, отриманий при `авторизації <https://wiki.edin.ua/uk/latest/integration_2_0/APIv2/Methods/Authorization.html>`__"

docs/Certificate/EDIN_2_0/APIv2/Methods/CertificateBodyDel.rst

@@ -0,0 +1,16 @@
+#########################################################################################################
+**Видалити всі вкладення сертифіката**
+#########################################################################################################
+
+Для роботи з цим методом користувач повинен бути `авторизованим <https://wiki.edin.ua/uk/latest/integration_2_0/APIv2/Methods/Authorization.html>`__.
+
+.. csv-table:: 
+  :file: CertificateBodyDel.csv
+  :widths:  10, 41
+  :stub-columns: 0
+
+**RESPONSE**
+
+Код сервера 200 (ok).
+
+

docs/Certificate/EDIN_2_0/APIv2/Methods/CertificateBodyDownload.csv

@@ -0,0 +1,13 @@
+**URL**       ,
+Метод запиту  , GET                                          
+URL запиту    ,**/api/ecs/body/download?gln=9864232613879&uuid=3ff444f4-7594-4a43-a151-90e14ee92b0c&body_type=1**
+URL параметри ,"**gln** (обов'язково) String - GLN власної Компанії;
+
+**uuid** (обов'язково) UUID - унікальний ідентифікатор сертифіката
+
+**body_type** (обов'язково) int - тип тіла:
+
+* 1 - вкладення до сертифіката"
+**Headers**   ,
+Authorization ,"**SID** - токен, отриманий при `авторизації <https://wiki.edin.ua/uk/latest/integration_2_0/APIv2/Methods/Authorization.html>`__"
+Content-Type  , application/pdf

docs/Certificate/EDIN_2_0/APIv2/Methods/CertificateBodyDownload.rst

@@ -0,0 +1,16 @@
+#########################################################################################################
+**Отримати вкладення до сертифіката в PDF**
+#########################################################################################################
+
+Для роботи з цим методом користувач повинен бути `авторизованим <https://wiki.edin.ua/uk/latest/integration_2_0/APIv2/Methods/Authorization.html>`__.
+
+.. csv-table:: 
+  :file: CertificateBodyDownload.csv
+  :widths:  10, 41
+  :stub-columns: 0
+
+**RESPONSE**
+
+У тілі **відповіді** передається pdf файл з вкладеннями.
+
+

docs/Certificate/EDIN_2_0/APIv2/Methods/CertificateBodyGet.csv

@@ -0,0 +1,12 @@
+**URL**       ,
+Метод запиту  , GET                                          
+URL запиту    ,**/api/ecs/body?gln=9864232613879&uuid=3ff444f4-7594-4a43-a151-90e14ee92b0c&body_type=1**
+URL параметри ,"**gln** (обов'язково) String - GLN власної Компанії;
+
+**uuid** (обов'язково) UUID - унікальний ідентифікатор сертифіката
+
+**body_type** (обов'язково) int - тип тіла:
+
+* 1 - вкладення до сертифіката"
+**Headers**   ,
+Authorization ,"**SID** - токен, отриманий при `авторизації <https://wiki.edin.ua/uk/latest/integration_2_0/APIv2/Methods/Authorization.html>`__"

docs/Certificate/EDIN_2_0/APIv2/Methods/CertificateBodyGet.rst

@@ -0,0 +1,16 @@
+#########################################################################################################
+**Отримати контент вкладення до сертифіката**
+#########################################################################################################
+
+Для роботи з цим методом користувач повинен бути `авторизованим <https://wiki.edin.ua/uk/latest/integration_2_0/APIv2/Methods/Authorization.html>`__.
+
+.. csv-table:: 
+  :file: CertificateBodyGet.csv
+  :widths:  10, 41
+  :stub-columns: 0
+
+**RESPONSE**
+
+У тілі **відповіді** передається контент сформованого pdf файлу з вкладеннями у вигляді base64 рядка.
+
+

docs/Certificate/EDIN_2_0/APIv2/Methods/CertificateBodyPost.csv

@@ -0,0 +1,15 @@
+**URL**       ,
+Метод запиту  , POST                                          
+URL запиту    ,**/api/ecs/body?gln=9864232613879&uuid=3ff444f4-7594-4a43-a151-90e14ee92b0c&body_type=1**
+URL параметри ,"**gln** (обов'язково) String - GLN власної Компанії;
+
+**uuid** (обов'язково) UUID - унікальний ідентифікатор сертифіката
+
+**body_type** (обов'язково) int - тип тіла:
+
+* 1 - вкладення до сертифіката"
+**Headers**   ,
+Authorization ,"**SID** - токен, отриманий при `авторизації <https://wiki.edin.ua/uk/latest/integration_2_0/APIv2/Methods/Authorization.html>`__"
+Content-Type  , `multipart/form-data <https://tools.ietf.org/html/rfc7578>`__
+**REQUEST**   ,
+Form-data     ,"В тілі запиту передаються файли вкладень в форматі PDF, JPG, JPEG, PNG, TIFF. Всі файли, що передаються будуть автоматично об'єднані в один PDF файл."

docs/Certificate/EDIN_2_0/APIv2/Methods/CertificateBodyPost.rst

@@ -0,0 +1,37 @@
+#########################################################################################################
+**Створити вкладення до сертифіката**
+#########################################################################################################
+
+Для роботи з цим методом користувач повинен бути `авторизованим <https://wiki.edin.ua/uk/latest/integration_2_0/APIv2/Methods/Authorization.html>`__.
+
+.. note::
+   Максимальний розмір файлу для завантаження - 7,5 МБ
+
+.. csv-table:: 
+  :file: CertificateBodyPost.csv
+  :widths:  10, 41
+  :stub-columns: 0
+
+Приклад запиту:
+
+.. code:: json
+
+    -----------------------------28001198861666343170695798896
+    Content-Disposition: form-data; name="files[]"; filename="istockphoto-1154370446-612x612.png"
+    Content-Type: image/png
+
+    (data)
+
+    -----------------------------28001198861666343170695798896
+    Content-Disposition: form-data; name="files[]"; filename="photo-1518020382113-a7e8fc38eac9.jpeg"
+    Content-Type: image/jpeg
+
+    (data)
+
+    -----------------------------28001198861666343170695798896--
+
+**RESPONSE**
+
+У тілі **відповіді** передається контент сформованого pdf файлу з вкладеннями у вигляді base64 рядка.
+
+

docs/Certificate/EDIN_2_0/APIv2/Methods/CertificateBodyPut.csv

@@ -0,0 +1,15 @@
+**URL**       ,
+Метод запиту  , POST                                          
+URL запиту    ,**/api/ecs/body?gln=9864232613879&uuid=3ff444f4-7594-4a43-a151-90e14ee92b0c&body_type=1**
+URL параметри ,"**gln** (обов'язково) String - GLN власної Компанії;
+
+**uuid** (обов'язково) UUID - унікальний ідентифікатор сертифіката
+
+**body_type** (обов'язково) int - тип тіла:
+
+* 1 - вкладення до сертифіката"
+**Headers**   ,
+Authorization ,"**SID** - токен, отриманий при `авторизації <https://wiki.edin.ua/uk/latest/integration_2_0/APIv2/Methods/Authorization.html>`__"
+Content-Type  , `multipart/form-data <https://tools.ietf.org/html/rfc7578>`__
+**REQUEST**   ,
+Form-data     ,"В тілі запиту передаються файли вкладень в форматі PDF, JPG, JPEG, PNG, TIFF. Всі файли, що передаються будуть автоматично об'єднані в один PDF файл."

docs/Certificate/EDIN_2_0/APIv2/Methods/CertificateBodyPut.rst

@@ -0,0 +1,37 @@
+#########################################################################################################
+**Додати нові вкладення до сертифіката**
+#########################################################################################################
+
+Для роботи з цим методом користувач повинен бути `авторизованим <https://wiki.edin.ua/uk/latest/integration_2_0/APIv2/Methods/Authorization.html>`__.
+
+.. note::
+   Максимальний розмір файлу для завантаження - 7,5 МБ
+
+.. csv-table:: 
+  :file: CertificateBodyPut.csv
+  :widths:  10, 41
+  :stub-columns: 0
+
+Приклад запиту:
+
+.. code:: json
+
+    -----------------------------28001198861666343170695798896
+    Content-Disposition: form-data; name="files[]"; filename="istockphoto-1154370446-612x612.png"
+    Content-Type: image/png
+
+    (data)
+
+    -----------------------------28001198861666343170695798896
+    Content-Disposition: form-data; name="files[]"; filename="photo-1518020382113-a7e8fc38eac9.jpeg"
+    Content-Type: image/jpeg
+
+    (data)
+
+    -----------------------------28001198861666343170695798896--
+
+**RESPONSE**
+
+У тілі **відповіді** передається контент сформованого pdf файлу з вкладеннями у вигляді base64 рядка.
+
+

docs/Certificate/EDIN_2_0/APIv2/Methods/CertificatePost.csv

@@ -7,4 +7,3 @@ Authorization ,"**SID** - токен, отриманий при `авториз
 Content-Type  , *application/json*
 **REQUEST**   ,
 JSON Body     ,"В тілі запиту (json) передається об'єкт з `даними сертифіката <https://wiki.edin.ua/uk/latest/Certificate/EDIN_2_0/APIv2/Methods/EveryBody/CertificatePostRequest.html>`__."
-

docs/Certificate/EDIN_2_0/APIv2/Methods/CertificateProducts.csv

@@ -0,0 +1,11 @@
+**URL**       ,
+Метод запиту  , PUT                                          
+URL запиту    ,**/api/ecs/products?gln=9864232613879&uuid=3ff444f4-7594-4a43-a151-90e14ee92b0c**
+URL параметри ,"**gln** (обов'язково) String - GLN власної Компанії;
+
+**uuid** (обов'язково) UUID - унікальний ідентифікатор сертифіката"
+**Headers**   ,
+Authorization ,"**SID** - токен, отриманий при `авторизації <https://wiki.edin.ua/uk/latest/integration_2_0/APIv2/Methods/Authorization.html>`__"
+Content-Type  , *application/json*
+**REQUEST**   ,
+JSON Body     ,"В тілі запиту методу передаються `дані товарів <https://wiki.edin.ua/uk/latest/Certificate/EDIN_2_0/APIv2/Methods/EveryBody/CertificateProductsRequest.html>`__, що прив'язуються до сертифіката (масив об’єктів XCertificateProduct)."

docs/Certificate/EDIN_2_0/APIv2/Methods/CertificateProducts.rst

@@ -0,0 +1,17 @@
+#########################################################################################################
+**Додати (пов'язати) товари до сертифіката**
+#########################################################################################################
+
+Для роботи з цим методом користувач повинен бути `авторизованим <https://wiki.edin.ua/uk/latest/integration_2_0/APIv2/Methods/Authorization.html>`__.
+
+.. note::
+   Якщо продукт уже прив'язаний до сертифіката і в тілі передано його ідентифікатор (XCertificateProduct.id), то дані товару будуть оновлені, в іншому випадку буде створено новий товар.
+
+.. csv-table:: 
+  :file: CertificateProducts.csv
+  :widths:  10, 41
+  :stub-columns: 0
+
+**RESPONSE**
+
+Код сервера 200 (ok).