Отримання типу комплекта документів по контракту

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

Важливо

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

Метод запиту

HTTP GET

Content-Type

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

URL запиту

https://doc.edi-n.com/bdoc/extra/contract/package_type?contract_id=111&package_id=58

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

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

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

contract_id - ID контракту

package_id - ID комплекту документів

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

REQUEST

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

RESPONSE

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

Таблиця 1 - Опис параметрів об’єкта 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_

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


Приклади

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


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

[
  {
    "packageId": 1459,
    "companyId": 989,
    "name": "авыаыв",
    "type": 1,
    "code": "323222",
    "packageChainId": 242,
    "status": 1,
    "version": 3,
    "dateChanged": 1557488853,
    "autoHandle": 0,
    "document2packages": [],
    "package2dictionaries": [],
    "extraFields": []
  },
  {
    "packageId": 1457,
    "companyId": 989,
    "name": "авыаыв",
    "type": 1,
    "code": "323222",
    "packageChainId": 242,
    "status": 2,
    "version": 2,
    "dateChanged": 1557488632,
    "autoHandle": 0,
    "document2packages": [],
    "package2dictionaries": [],
    "extraFields": []
  },
  {
    "packageId": 1455,
    "companyId": 989,
    "name": "авыаыв",
    "type": 1,
    "code": "323222",
    "packageChainId": 242,
    "status": 2,
    "version": 1,
    "dateChanged": 1557488538,
    "autoHandle": 0,
    "document2packages": [],
    "package2dictionaries": [],
    "extraFields": []
  }
]