Merge pull request #2056 from EDI-N/Kolya_ua

Kolya ua
EDI-N · Jan 19, 2024 · 1a1ac93 · 1a1ac93
2 parents 0833e26 + 143203a
commit 1a1ac93
Show file tree

Hide file tree

Showing 9 changed files with 238 additions and 15 deletions.
diff --git a/docs/Certificate/EDIN_2_0/APIv2/API_Certificate_v2_list.rst b/docs/Certificate/EDIN_2_0/APIv2/API_Certificate_v2_list.rst
@@ -52,6 +52,8 @@
 +-----------+----------------------------+--------------------------------------------------------------------+
 | PUT       | ``/api/ecs/products``      | :doc:`/Certificate/EDIN_2_0/APIv2/Methods/CertificateProducts`     |
 +-----------+----------------------------+--------------------------------------------------------------------+
+| POST      | ``/api/ecs/certificates``  | :doc:`/Certificate/EDIN_2_0/APIv2/Methods/Certificates`            |
++-----------+----------------------------+--------------------------------------------------------------------+
 
 **Вкладення до сертифікатів:**
 
@@ -78,16 +80,17 @@
    Methods/CertificatePut
    Methods/CertificateGet
    Methods/CertificateDel
-   CertificateBodyDownload
-   ArchiveCertificate
-   ChangeCertificateAccess
-   CopyCertificate
-   SearchCertificates
-   CertificateProducts
-   CertificateBodyPost
-   CertificateBodyPut
-   CertificateBodyGet
-   CertificateBodyDel
+   Methods/CertificateBodyDownload
+   Methods/ArchiveCertificate
+   Methods/ChangeCertificateAccess
+   Methods/CopyCertificate
+   Methods/SearchCertificates
+   Methods/CertificateProducts
+   Methods/Certificates
+   Methods/CertificateBodyPost
+   Methods/CertificateBodyPut
+   Methods/CertificateBodyGet
+   Methods/CertificateBodyDel
 
 ---------------------------------
 

diff --git a/docs/Certificate/EDIN_2_0/APIv2/Methods/ArchiveCertificate.rst b/docs/Certificate/EDIN_2_0/APIv2/Methods/ArchiveCertificate.rst
@@ -4,10 +4,11 @@
 
 Для роботи з цим методом користувач повинен бути `авторизованим <https://wiki.edin.ua/uk/latest/integration_2_0/APIv2/Methods/Authorization.html>`__.
 
- .. note::
-   Архівувати можливо лише опубліковані сертифікати з обмеженим доступом!
+.. цей момент не зрозумів, у мене вийшло, що:
+  .. note::
+    Архівувати можливо лише опубліковані сертифікати з обмеженим доступом!
 
- .. hint::
+.. hint::
    Дія "архівувати" / "розархівувати" залежить від того, де перебуває сертифікат до виконання метода:
 
    * якщо сертифікат в **Архіві**, то виконається розархівування;

diff --git a/docs/Certificate/EDIN_2_0/APIv2/Methods/Certificates.csv b/docs/Certificate/EDIN_2_0/APIv2/Methods/Certificates.csv
@@ -0,0 +1,9 @@
+**URL**       ,
+Метод запиту  , POST                                          
+URL запиту    ,**/api/ecs/certificates?gln=9864232613879**
+URL параметри ,"**gln** (обов'язково) String - GLN власної Компанії"
+**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**   ,
+JSON Body     ,"В тілі запиту передається zip-файл, що містить файли-вкладення (в форматі PDF, JPG, JPEG, PNG, TIFF) та заповнений xls/xlsx шаблон з зазначеними назвами файлів-вкладень."
diff --git a/docs/Certificate/EDIN_2_0/APIv2/Methods/Certificates.rst b/docs/Certificate/EDIN_2_0/APIv2/Methods/Certificates.rst
@@ -0,0 +1,16 @@
+#########################################################################################################
+**Масово завантажити сертифікати**
+#########################################################################################################
+
+Для роботи з цим методом користувач повинен бути `авторизованим <https://wiki.edin.ua/uk/latest/integration_2_0/APIv2/Methods/Authorization.html>`__.
+
+.. csv-table:: 
+  :file: Certificates.csv
+  :widths:  10, 41
+  :stub-columns: 0
+
+:download:`Приклад передаваємого zip<Certificates.zip>`
+
+**RESPONSE**
+
+В тілі **відповіді** передаються `дані завантажених сертифікатів <https://wiki.edin.ua/uk/latest/Certificate/EDIN_2_0/APIv2/Methods/EveryBody/XCertificateList.html>`__ (масив об'єктів XCertificate).
diff --git a/docs/Certificate/EDIN_2_0/APIv2/Methods/Certificates.zip b/docs/Certificate/EDIN_2_0/APIv2/Methods/Certificates.zip
diff --git a/docs/Certificate/EDIN_2_0/APIv2/Methods/EveryBody/CertificateGetResponse.rst b/docs/Certificate/EDIN_2_0/APIv2/Methods/EveryBody/CertificateGetResponse.rst
@@ -162,6 +162,30 @@
   :header-rows: 1
   :stub-columns: 0
 
+Таблиця 7 - Опис параметрів об'єкта **AccessType**
+
+.. csv-table:: 
+  :file: for_csv/AccessType.csv
+  :widths:  20, 20
+  :header-rows: 1
+  :stub-columns: 0
+
+Таблиця 8 - Опис параметрів об'єкта **Level**
+
+.. csv-table:: 
+  :file: for_csv/Level.csv
+  :widths:  20, 20
+  :header-rows: 1
+  :stub-columns: 0
+
+Таблиця 9 - Опис параметрів об'єкта **XCertificateProduct**
+
+.. csv-table:: 
+  :file: for_csv/XCertificateProduct.csv
+  :widths:  1, 5, 12, 41
+  :header-rows: 1
+  :stub-columns: 0
+
 -------------------------
 
 .. [#] Під визначенням колонки **Тип поля** мається на увазі скорочене позначення:

diff --git a/docs/Certificate/EDIN_2_0/APIv2/Methods/EveryBody/SearchCertificatesResponse.rst b/docs/Certificate/EDIN_2_0/APIv2/Methods/EveryBody/SearchCertificatesResponse.rst
@@ -119,7 +119,7 @@
 
 .. csv-table:: 
   :file: for_csv/SearchCertificatesResponse.csv
-  :widths:  10, 5, 41
+  :widths:  10, 20, 41
   :header-rows: 1
   :stub-columns: 0
 
@@ -163,6 +163,30 @@
   :header-rows: 1
   :stub-columns: 0
 
+Таблиця 7 - Опис параметрів об'єкта **AccessType**
+
+.. csv-table:: 
+  :file: for_csv/AccessType.csv
+  :widths:  20, 20
+  :header-rows: 1
+  :stub-columns: 0
+
+Таблиця 8 - Опис параметрів об'єкта **Level**
+
+.. csv-table:: 
+  :file: for_csv/Level.csv
+  :widths:  20, 20
+  :header-rows: 1
+  :stub-columns: 0
+
+Таблиця 9 - Опис параметрів об'єкта **XCertificateProduct**
+
+.. csv-table:: 
+  :file: for_csv/XCertificateProduct.csv
+  :widths:  1, 5, 12, 41
+  :header-rows: 1
+  :stub-columns: 0
+
 -------------------------
 
 .. [#] Під визначенням колонки **Тип поля** мається на увазі скорочене позначення:

diff --git a/docs/Certificate/EDIN_2_0/APIv2/Methods/EveryBody/XCertificateList.rst b/docs/Certificate/EDIN_2_0/APIv2/Methods/EveryBody/XCertificateList.rst
@@ -0,0 +1,137 @@
+############################################################################################################################
+**Дані про сертифікати (масив об'єктів XCertificate)**
+############################################################################################################################
+
+**JSON:**
+
+.. code:: json
+
+    [
+        {
+            "id": 185,
+            "uuid": "87612047-82ba-43d2-a03e-5c7cc7f904f9",
+            "number": "UA1.12345678-20",
+            "createDate": 1689800400,
+            "updateDate": 0,
+            "issueDate": 0,
+            "type": {
+                "id": 2,
+                "type": 0
+            },
+            "view": {
+                "id": 2
+            },
+            "access": [],
+            "startDate": 1693515600,
+            "endDate": 0,
+            "isSigned": false,
+            "accessType": {
+                "code": 0,
+                "description": "Неопубликований"
+            },
+            "creator": 0,
+            "info": "Комментар 2",
+            "bodies": {
+                "1": []
+            },
+            "characteristics": {
+                "Issuer Article": "2341111",
+                "VMD Number": "123123123"
+            },
+            "parents": [],
+            "products": [
+                {
+                    "id": 0,
+                    "certificateId": 0,
+                    "name": "Молоко 15%",
+                    "barcode": "4820000000000",
+                    "article": "321",
+                    "buyerCode": "123",
+                    "uktved": 0
+                },
+                {
+                    "id": 0,
+                    "certificateId": 0,
+                    "name": "Молоко 10%",
+                    "barcode": "4820000000001",
+                    "article": "521",
+                    "buyerCode": "125",
+                    "uktved": 0
+                },
+                {
+                    "id": 0,
+                    "certificateId": 0,
+                    "name": "Молоко 5%",
+                    "barcode": "4820000000002",
+                    "article": "321221",
+                    "buyerCode": "122123",
+                    "uktved": 0
+                }
+            ],
+            "productsQty": 0,
+            "autoArchive": false
+        }
+    ]
+
+Таблиця 1 - Опис параметрів об'єкта **XCertificate**
+
+.. csv-table:: 
+  :file: for_csv/XCertificate.csv
+  :widths:  1, 5, 12, 41
+  :header-rows: 1
+  :stub-columns: 0
+
+Таблиця 2 - Опис параметрів об'єкта **XCertificateType**
+
+.. csv-table:: 
+  :file: for_csv/XCertificateType.csv
+  :widths:  1, 5, 12, 41
+  :header-rows: 1
+  :stub-columns: 0
+
+Таблиця 3 - Опис параметрів об'єкта **XCertificateView**
+
+.. csv-table:: 
+  :file: for_csv/XCertificateView.csv
+  :widths:  1, 5, 12, 41
+  :header-rows: 1
+  :stub-columns: 0
+
+Таблиця 4 - Опис **characteristics**
+
+.. csv-table:: 
+  :file: for_csv/characteristics.csv
+  :widths:  1, 5, 12, 41
+  :header-rows: 1
+  :stub-columns: 0
+
+Таблиця 5 - Опис параметрів об'єкта **AccessType**
+
+.. csv-table:: 
+  :file: for_csv/AccessType.csv
+  :widths:  20, 20
+  :header-rows: 1
+  :stub-columns: 0
+
+Таблиця 6 - Опис параметрів об'єкта **Level**
+
+.. csv-table:: 
+  :file: for_csv/Level.csv
+  :widths:  20, 20
+  :header-rows: 1
+  :stub-columns: 0
+
+Таблиця 7 - Опис параметрів об'єкта **XCertificateProduct**
+
+.. csv-table:: 
+  :file: for_csv/XCertificateProduct.csv
+  :widths:  1, 5, 12, 41
+  :header-rows: 1
+  :stub-columns: 0
+
+-------------------------
+
+.. [#] Під визначенням колонки **Тип поля** мається на увазі скорочене позначення:
+
+   * M (mandatory) — обов'язкові до заповнення поля;
+   * O (optional) — необов'язкові (опціональні) до заповнення поля.
diff --git a/docs/Certificate/EDIN_2_0/APIv2/Methods/EveryBody/for_csv/XQueryCertificates.csv b/docs/Certificate/EDIN_2_0/APIv2/Methods/EveryBody/for_csv/XQueryCertificates.csv
@@ -1,6 +1,15 @@
 Параметр,Тип [1]_,Формат,Опис
 .. _XQueryCertificates:,,Об'єкт **XQueryCertificates**,
-queryType,O,"enum (MY, PRIVATE, PUBLIC, DRAFT, ARCHIVE, LIMITED_ACCESS, PUBLIC_ACCESS, PRIVATE_ACCESS)",розділ сертифікатів
+queryType,O,"enum (MY, PRIVATE, PUBLIC, DRAFT, ARCHIVE, LIMITED_ACCESS, PUBLIC_ACCESS, PRIVATE_ACCESS)","розділ сертифікатів
+
+* MY - Мої сертифікати (відображаються всі Ваші сертифікати);
+* PRIVATE - Доступні мені
+* PUBLIC - Сертифікати
+* DRAFT - Чернетки
+* ARCHIVE - Архів
+* LIMITED_ACCESS - Обмежений доступ
+* PUBLIC_ACCESS - Публічний доступ (Ви власник)
+* PRIVATE_ACCESS - Обмежений доступ (Ви власник)"
 companyId,O,long,ідентифікатор компанії
 **products**,O,List<XQueryProduct_>,масив об'єктів; дані товарів
 number,O,String,номер сертифіката