Додавання (прив’язка) типу комплекта документів до довідника

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

Метод запиту

HTTP OPTIONS

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edin.ua/bdoc/package_dictionary

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові параметри, що передаються в тілі запиту (json)

packageId, dictionaryId

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

REQUEST

Опис json-параметрів запиту метода API (об’єкт Package2Dictionaries)

Таблиця 1 - Опис параметрів об’єкта Package2Dictionaries

Параметр

Формат

Опис

Об’єкт Package2Dictionaries

packageId

long

id комплекту

dictionaryId

long

id довідника

fillType

int

тип заповнення поля; «1 - заповнює ініціатор комплекта; 2 - одержувач; 3 - обидва»

required

int

ознака обов’язковості; «0 - Ні; 1 - Так»

dictionary

Dictionary

об’єкт; дані довідника

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт PackageType)

Таблиця 2 - Опис параметрів об’єкта PackageType

Параметр

Формат

Опис

Об’єкт PackageType

packageId

long

id комплекта

companyId

long

id компанії

name

String

назва типу комплекта

type

int

тип документа; ціле число (10); значення за замовчуванням «1», коментар: «1 - File based content; 2 - Structure based content»

code

String

код комплекта

packageChainId

long

незмінний ID комплекта на різних стадіях редагування

status

int

статус; «1 - Активний; 2 - Заблоковано; 3 - Черновик»

version

long

версія комплекту (кількість редакцій)

dateChanged

long

дата останньої зміни комплекта

autoHandle

int

ознака автооброботки комплекта; 0 - ні, 1 - так

document2packages

List<Document2Package>

масив об’єктів; зв’язок документа і комплекта

package2dictionaries

List<Package2Dictionaries_>

масив об’єктів; зв’язок комплекта і довідника

extraFields

List<Package2ExtraField_>

масив об’єктів; прив’язка додаткових полів до комплекту

company

Company

об’єкт; інформація про компанію

Таблиця 3 - Опис параметрів об’єкта Company

Параметр

Формат

Опис

Об’єкт Company

companyId

long

ID компанії

accountId

long

ID аккаунта

type

int

тип компанії (1 - юр. особа; 2 - фіз. особа)

name

String

назва компанії

legalName

String

юридична назва

inn

String

ідентифікаційний номер платника податків

code

String

свідоцтво платника ПДВ

phone

String

телефон

info

String

додаткова інформація

isApproved

int

ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП

isSignedOffer

int

ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так

isActive

int

статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так

ownershipType

String

форма власності

atCode

String

код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)

certNum

String

свідоцтво платника ПДВ

uuID

String

унікальний ідентифікатор компанії

bankAcc

BankAcc_

об’єкт; банківські реквізити

legalAddress

Address_

об’єкт; юридична адреса

actualAddress

Address_

об’єкт; фактична адреса

fizName

CompanyFizName_

об’єкт; ПІБ фіз. особи компанії

certificates

List<Certificate_>

масив об’єктів; сертифікати

dictionaries

List<Dictionary>

масив об’єктів; довідники

notifySettings

List<EmailNotifySettings_>

масив об’єктів; налаштування відправки повідомлень на пошту

Таблиця 4 - Опис параметрів об’єкта Document2Package

Параметр

Формат

Опис

Об’єкт Document2Package

packageId

long

id комплекта

documentId

long

id документа

needSign

int

необхідність підписання; «0 - Ні; 1 - Так»

signsCount

int

кількість підписів

ownerSignsCount

int

кількість підписів власника

needEncrypt

int

необхідність шифрування; «0 - Ні; 1 - Так»

required

int

обов’язковий документ: 0 - Ні; 1 - Так

isRecipientAttach

int

ознака, що вказує, що документ є «довкладенням» з боку одержувача; «0 - Ні; 1 - Так»

maxFilesCount

int

максимальна кількість вкладених файлів

document

Document

об’єкт; дані документа

Таблиця 5 - Опис параметрів об’єкта Package2Dictionaries

Параметр

Формат

Опис

Об’єкт Package2Dictionaries

packageId

long

id комплекту

dictionaryId

long

id довідника

fillType

int

тип заповнення поля; «1 - заповнює ініціатор комплекта; 2 - одержувач; 3 - обидва»

required

int

ознака обов’язковості; «0 - Ні; 1 - Так»

dictionary

Dictionary

об’єкт; дані довідника

Таблиця 3 - Опис параметрів об’єкта Dictionary

Параметр

Формат

Опис

Об’єкт Dictionary

dictionaryId

long

id довідника

companyId

long

id компании

name

String

назва довідника

code

String

код довідника

isActive

int

статус довідника; 1 - активний, 0 — заблокований

values

List<DictionaryValue>

масив об’єктів; значення довідника

Таблиця 4 - Опис параметрів об’єкта DictionaryValue

Параметр

Формат

Опис

Об’єкт DictionaryValue

valueId

long

id значення довідника

dictionaryId

long

id довідника

name

String

назва значення довідника

code

String

код значення довідника

parentCode

String

код «батьківського» значення довідника

isActive

int

статус значення довідника; 1 - активний, 0 - заблокований

Таблиця 5 - Опис параметрів об’єкта Document

Параметр

Формат

Опис

Об’єкт Document

documentId

long

id документа

companyId

long

id компанії

company

Company

об’єкт; інформація про компанію

name

String

назва документа

type

int

тип; «1 - Файл; 2 - Структура; 3 - Динамічна структура; 4 - Таблиця»

code

String

код документа

agreementProcId

long

id процесу узгодження

isActive

int

статус; «1 - Активний; 0 - Заблокований»

extraFields

List<ExtraField_>

масив об’єктів; додаткові поля документа

dictionary

Dictionary

об’єкт; дані довідника

structures

List<DocumentStructure_>

масив об’єктів; дані структурованого документа


Приклади

Приклад тіла запиту (json):

{
  "packageId": 1485,
  "dictionaryId": 443,
  "fillType": 3,
  "required": 0
}

Приклад тіла відповіді (json):

{
  "packageId": 1485,
  "companyId": 989,
  "name": "авыаыв123",
  "type": 1,
  "code": "323222",
  "packageChainId": 244,
  "status": 3,
  "version": 1,
  "dateChanged": 1557905884,
  "autoHandle": 0,
  "document2packages": [
    {
      "packageId": 1485,
      "documentId": 2391,
      "needSign": 0,
      "signsCount": 0,
      "ownerSignsCount": 0,
      "needEncrypt": 0,
      "required": 0,
      "isRecipientAttach": 0,
      "maxFilesCount": 3,
      "document": {
        "documentId": 2391,
        "companyId": 989,
        "name": "dsfdsfs",
        "type": 2,
        "code": "2322",
        "agreementProcId": 0,
        "isActive": 1,
        "extraFields": []
      }
    }
  ],
  "package2dictionaries": [
    {
      "packageId": 1485,
      "dictionaryId": 443,
      "fillType": 3,
      "required": 0,
      "dictionary": {
        "dictionaryId": 443,
        "companyId": 989,
        "name": "выфвф",
        "code": "32423",
        "isActive": 1,
        "values": [
          {
            "valueId": 759,
            "dictionaryId": 443,
            "name": "куцкуц",
            "code": "кцу",
            "isActive": 1
          }
        ]
      }
    }
  ],
  "extraFields": [],
  "company": {
    "companyId": 0,
    "accountId": 0,
    "type": 0,
    "name": "dwdsss",
    "code": "433",
    "isApproved": 0,
    "isSignedOffer": 0,
    "isActive": 0,
    "ownershipTypeId": 0,
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  }
}