Додавання (прив’язка) тега до сценарію документообігу

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

Метод запиту

HTTPS PUT

Content-Type

application/json, text/plain (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)

URL запиту

https://doc.edin.ua/bdoc/contract_tag?contract_id=2445&tag_id=409

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

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

Обов’язкові url-параметри:

contract_id - ID сценарію документообігу

tag_id - ID тегу

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

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передаються дані сценарію документообігу (об’єкт Contract).

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

Параметр

Формат

Опис

Об’єкт Contract

contractId

long

ID сценарію документообігу

number

String

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

contractName

String

назва сценарію документообігу

date

long

дата документа у форматі UNIX TimeStamp

ownerCompany

Company_

об’єкт; інформація про компанію відправника (власника)

clientCompany

Company_

об’єкт; інформація про компанію одержувача (клієнта)

description

String

опис / додаткова інформація

expiredDate

long

дійсний до (дата у форматі UNIX TimeStamp)

sentDate

long

дата відправки у форматі UNIX TimeStamp

status

int

статус; 0 - Чернетка; 1 - Новий; 2 - Прийнято; 3 - Відхилено; 4 - Розірвано; 5 - Чекає підписання; значення за замовчуванням = «0»

paymentStatus

int

ознака, що визначає платника за транзакцію; 0 - Відправник (клієнт), 1 - Одержувач (власник); значення за замовчуванням = «0»;

isSpecialConditions

int

ознака використання спеціальних умов обслуговування

isAllClientSenderPackages

int

відмітка «всі комплекти» для вхідних; 0 - немає, 1 — так

isAllOwnerSenderPackages

int

відмітка «всі комплекти» для вихідних; 0 - немає, 1 — так

specialConditions

SpecialConditions_

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

dictionaries

List<Dictionary_>

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

tags

List<Tag_>

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

ownerPackages

List<PackageType_>

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

clientPackages

List<PackageType_>

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

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)


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

{
  "contractId": 2445,
  "number": "1",
  "contractName": "Акт выполненных работ ",
  "date": 1574380800,
  "ownerCompany": {
    "companyId": 1317,
    "accountId": 427,
    "type": 2,
    "name": "ФОП Иванов Иван",
    "code": "3258963012",
    "isApproved": 0,
    "isSignedOffer": 1,
    "isActive": 1,
    "ownershipType": "ФОП",
    "uuid": "4e8ad4c1-b6b7-477d-a439-8544f6ad9c2b",
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  },
  "clientCompany": {
    "companyId": 1313,
    "accountId": 423,
    "type": 2,
    "name": "ФОП Гаврилюк Татьяна",
    "code": "3189823647",
    "isApproved": 0,
    "isSignedOffer": 1,
    "isActive": 1,
    "ownershipType": "ТОВ",
    "uuid": "7f38f6c6-4f1e-4361-9837-cdfa64fa3e0f",
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  },
  "expiredDate": 1606003200,
  "sentDate": 1574416366,
  "status": 2,
  "paymentStatus": 0,
  "isSpecialConditions": 0,
  "isAllClientSenderPackages": 1,
  "isAllOwnerSenderPackages": 0,
  "dictionaries": [],
  "tags": [
    {
      "tagId": 409,
      "name": "Альбатрос",
      "code": "6418c44baec34df7bc17a66a1989fa1a"
    }
  ],
  "ownerPackages": [],
  "clientPackages": []
}