Skip to content

Latest commit

 

History

History
209 lines (187 loc) · 63 KB

GetCertByID.rst

File metadata and controls

209 lines (187 loc) · 63 KB
Raw

Отримання атрибутів конкретного сертифіката по ID

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту HTTP GET
Content-Type application/json (тіло HTTP запиту/відповіді в json форматі)
URL запиту https://edo.edi-n.com/Api/V1/GetCertUA/GetCertByID
Параметри, що передаються в URL (разом з адресою методу) -//-

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

Таблиця 1 - Опис json-параметрів запиту

Параметр Mandatory/Optional Формат Опис
varToken​ M String Токен, отриманий при авторизації
signInfo M number ID конкретного сертификату

RESPONSE

Таблиця 2 - Опис json-параметрів відповіді метода API

Параметр Mandatory/Optional Формат Опис
​*cert_data​* {...} об'єкт; інформація про сертифікат
cert_cat​ [{...}] масив об'єктів; категорії, вказані власником
cert_files​ [{...}] масив об'єктів; файли та скан-копії, прикріплені до сертифіката
​varMessage​ String Повідомлення сервера
​intCode​ int код відповіді сервера
​intCertID​ int ID сертификата
​varCreatedDate​ YYYY-MM-DD HH:MM:SS дата сертифіката
​varNumber​ String номер сертифіката
​varOriginalNum​ String оригінальний номер сертифіката (в тому вигляді, в якому його передав користувач)
​varSystemNum​ String внутрішній номер сертифіката (використовується для пошуку/відображення)
​intType​ int тип сертифіката; 1 - Сертифікат відповідності / визнання; 2 - Свідоцтво якості; 3 - Декларація імпортера; 4 - Висновок СЕС; 5 - Декларація виробника; 6 - Карантинний сертифікат; 7 - Акт фітосанітарного контролю; 8 - Фітосанітарний сертифікат; 9 - Висновок фітосанітарної експертизи; 10 - Протокол лабораторних випробувань; 11 - Експертний висновок; 13 - Сертифікат типу; 14 - Сертифікат аналізу; 15 - Дозвіл на випуск / реалізацію; 16 - Висновок Держлікслужби
​intSubType​ int вид сертифіката; 1 - період дії, 2 - номер партії
​intOwnerGlnID​ int GLN користувача-власника сертифіката
​intSupplierGlnID​ int GLN користувача-постачальника сертифіката
​intAccessType​ int права перегляду; 0 - не вибрано; 1 - доступний усім; 2 - обмежений доступ
​varLotNumber​ String (50) артикул виробника
​varDate​ YYYY-MM-DD HH:MM:SS дата видачі сертифіката
​varText​ text коментарі / найменування товару (якщо а полі є значення, то завантажуване (імпорт) значення дописується через кому)
​varStartDate​ YYYY-MM-DD HH:MM:SS дата старту сертифіката
​varEndDate​ YYYY-MM-DD HH:MM:SS дата закінчення сертифіката
​varPartNumber​ String (100) номер партії
​intDssCertID​ int номер dss сертифіката
​intDssCertStat​ int статус сертифіката
​intDssCertDate​ int дата звірки з dss
​isMadePDF​ загальний ідентифікатор статусу прикріплених скан-копій файлів; відображає статус сертифіката відносно загального pdf файлу, що мыстить файли сертифыката (основний та додатковий); 0 - файли не прикріплені до сертифіката користувачем; 1 - файли в черзі на конвертацію в загальний PDF без ЕПЦ; 2 - загальний PDF в процесі створення без ЕЦП; 3 - загальний PDF створений без ЕЦП; 4 - загальний PDF в черзі на створення PDF c візуалізацією ЕЦП; 5 - загальний PDF c візуалізацією ЕЦП в процесі створення; 6 - загальний PDF c візуалізацією ЕЦП створений; 7 - помилка при створенні загального PDF без ЕПЦ; 8 - помилка при створенні загального PDF з візуалізацією ЕПЦ
​varReviewDate​ YYYY-MM-DD HH:MM:SS дата/час ревізії сертифіката (останні зміни)
​varSubTypeName​ String назва виду сертифіката
​varAccessTypeName​ String назва прав перегляду
​varTypeName​ String назва типу сертифіката
​varDssCertStat​ String назва статусу сертифіката
​intCertCatID​ int id категорії, присвоєної власником
​varCertCatName​ String назва категорії, присвоєної власником
​intFileID​ int id файлу сертифіката
​intType​ int тип файлу
​varFileName​ String назва файлу сертифіката з розширенням
​intSignStatus​ int статус підписання; 0 - ні, 1 - так
​varHashLink​ String хеш посилання файлу

Приклади

Приклад тіла запиту в json форматі:

{
  "​ varToken​ ": "​ 8q0hu05o59vmmrpo4t5slfedj2​ ",
  "​ certID​ ": "​ 1234​ "
}

Приклад тіла відповіді в json форматі:

{
  "​cert_data​ ": {
    "​intCertID​ ": "​ 1493​ ",
    "​varCreatedDate​ ": "​ 2017-06-02 11:37:59​ ",
    "​varNumber​ ": "​ 1233​ ",
    "​varOriginalNum​ ": "​ 1233​ ",
    "​varSystemNum​ ": "​ 1233​ ",
    "​intType​ ": "​ 8 ​ ",
    "​intSubType​ ": "​ 1 ​ ",
    "​intOwnerGlnID​ ": "​ 133061​ ",
    "​intSupplierGlnID​ ": "​ 133061​ ",
    "​intAccessType​ ": "​ 2 ​ ",
    "​varLotNumber​ ": "",
    "​varDate​ ": "​ 2017-06-03 00:00:00​ ",
    "​varText​ ": "",
    "​varStartDate​ ": "​ 2017-06-01 00:00:00​ ",
    "​varEndDate​ ": "​ 2017-06-30 00:00:00​ ",
    "​varPartNumber​ ": "",
    "​intDssCertID​ ": "​ 123​ ",
    "​intDssCertStat​ ": "​ 1 ​ ",
    "​intDssCertDate​ ": "​ 2017-06-02 12:24:35​ ",
    "​isMadePDF​ ": "​ 6 ​ ",
    "​varReviewDate​ ": "​ 2017-06-02 11:37:59​ ",
    "​varSubTypeName​ ": "​ Период действия​ ",
    "​varAccessTypeName​ ": "​ Ограниченный доступ​ ",
    "​varTypeName​ ": "​ фітосанітарний сертифікат​ ",
    "​varDssCertStat​ ": "​ Данные корректны​ "
  },
  "​cert_cat​ ": [
    {
      "​intCertCatID​ ": "​ 7 ​ ",
      "​varCertCatName​ ": "​ Фрукты​"
    },
    {
      "​intCertCatID​ ": "​ 1 ​ ",
      "​varCertCatName​ ": "​ Зефир​"
    }
  ],
  "​cert_files​ ": [
    {
      "​intFileID​ ": "​ 2823​ ",
      "​intType​ ": "​ 0 ​ ",
      "​varFileName​ ": "​ mozilla.pdf​ ",
      "​intSignStatus​ ": "​ 0 ​ ",
      "​varHashLink​ ": "​ 38c95fcb3faec5f40267478abedd0338​ "
    },
    {
      "​intFileID​ ": "​ 2825​ ",
      "​intType​ ": "​ 2 ​ ",
      "​varFileName​ ": "​ 1233.pdf​ ",
      "​intSignStatus​ ": "​ 1 ​ ",
      "​varHashLink​ ": "​ 93607fa75358206fae30566ec99f8136​ "
    },
    {
      "​intFileID​ ": "​ 2827​ ",
      "​intType​ ": "​ 3 ​ ",
      "​varFileName​ ": "​ 1233_signed.pdf​ ",
      "​intSignStatus​ ": "​ 0 ​ ",
      "​varHashLink​ ": "​ f1eb7e602719270db93cc071bc63f77b​ "
    }
  ],
  "​varMessage​ ": "​ Success!​ ",
  "​intCode​ ": 200
}

Attention

Відповідь за запитом по сертифікату, що недоступний для поточного GLN:

{
  "varMessage": "no data found",
  "intCode": 404
}