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

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

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/store/packages
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Опціональні url-параметри: limit - ліміт вибірки (за умовчуванням 30; максимальне значення вибірки 50) offset - зміщення відносно верхньої межі вибірки (за умовчуванням 0)

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

REQUEST

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

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

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

Параметр	Формат	Опис
	Об’єкт ExtraField
fieldId	long	id поля
companyId	long	id компанії
name	String	назва поля
description	String	опис поля
dataType	int	формат поля; 1 - текст; 2 - число; 3 - дата; 4 - цифра
status	int	статус; 1 - Активно, 0 - Неактивно (Заблокировано)
value	String	значення поля

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

Параметр	Формат	Опис
	Об’єкт DictionaryValue
valueId	long	id значення довідника
dictionaryId	long	id довідника
name	String	назва значення довідника
code	String	код значення довідника
parentCode	String	код «батьківського» значення довідника
isActive	int	статус значення довідника; 1 - активний, 0 - заблокований

RESPONSE

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

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

Параметр	Формат	Опис
	Об’єкт Package
packageId	long	ID комплекту
senderCompanyId	long	ID компанії-відправника
recipientCompanyId	long	ID компанії-одержувача
ownerCompanyId	long	ID власника компанії
clientCompanyId	long	ID контрагента
ownerCompany	Company_	об’єкт; дані власника компанії
clientCompany	Company_	об’єкт; дані контрагента
senderCompany	Company_	об’єкт; дані компанії-відправника
recipientCompany	Company_	об’єкт; дані компанії-одержувача
contractId	long	ID сценарію документообігу
contract	Contract_	об’єкт; дані сценарію документообігу
packageTypeId	long	ID типу комплекту
packageTypeChainId	long	ID ланцюжка типу комплекту (використовується для пошуку пов’язаних версій комплекта)
dateCreated	long	дата створення
dateChanged	long	дата зміни
status	int	статус комплекту
archive	int	ознака архівації
packageNumber	String	номер комплекту
documents	List<DocumentStore_>	масив об’єктів; документи комплекту
package2Dictionaries	List<Package2Dictionaries_>	масив об’єктів; довідники комплекту
extraFields	List<Package2ExtraField_>	масив об’єктів; користувацькі поля, прив’язані до комплекту
contractDictionaries	List<Dictionary_>	масив об’єктів; список довідників, скопійованих з сценарію документообігу в момент створення комплекта
packageTags	List<Tag_>	масив об’єктів; список тегів, що прив’язані до комплекту
packageType	PackageType	об’єкт; настройки комплекту документів (комплекту)
isRead	int	ознака прочитання на WEB
isReadFromApi	int	ознака прочитання (завантаження) по API
isReadyForSend	int	індикатор «Готовий до відправлення»
packageDirection	int	напрямок комплекту; 1 - inbox, 2 - outbox, 3 - draft
signDateTerm	long	термін для підписання
packageUuid	UUID	унікальний ідентифікатор комплекта
packageBase	PackageBase_	об’єкт; дані комплекта підстави
packageId	long	ID комплекту
packageBasedId	long	ID комплекта підстави
packageBasedNumber	String	номер комплекта підстави

---

Приклади

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

{
  "folder": 1,
  "packageStatuses": [
    2,
    3,
    4,
    6,
    5,
    7,
    8
  ],
  "filterId": 0,
  "filterName": null
}

---

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

[
  {
    "packageId": 6913,
    "senderCompanyId": 6,
    "recipientCompanyId": 4,
    "senderCompany": {
      "companyId": 6,
      "accountId": 10,
      "type": 0,
      "name": "ФІЗИЧНА ОСОБА",
      "legalName": "Ромашка",
      "inn": "0987654321",
      "code": "12345678",
      "isApproved": 0,
      "isSignedOffer": 0,
      "isActive": 0,
      "uuid": "22345200-abe8-4f60-90c8-0d43c5f6c0f6",
      "certificates": [],
      "dictionaries": [],
      "notifySettings": []
    },
    "recipientCompany": {
      "companyId": 4,
      "accountId": 8,
      "type": 0,
      "name": "Царь Царей",
      "legalName": "ПрАТ \"Літак\"",
      "inn": "123456789043",
      "code": "34554355",
      "isApproved": 0,
      "isSignedOffer": 0,
      "isActive": 0,
      "uuid": "a903de62-5b34-43c9-b73a-fb2b8ee4efc1",
      "certificates": [],
      "dictionaries": [],
      "notifySettings": []
    },
    "contract": {
      "contractId": 6,
      "number": "1",
      "contractName": "Сотрудник",
      "date": 1531872000,
      "description": "ав",
      "expiredDate": 1563408000,
      "sentDate": 0,
      "status": 2,
      "paymentStatus": 1,
      "isSpecialConditions": 0,
      "isAllClientSenderPackages": 0,
      "isAllOwnerSenderPackages": 0,
      "dictionaries": [],
      "ownerPackages": [],
      "clientPackages": []
    },
    "packageTypeId": 2139,
    "packageTypeChainId": 285,
    "dateCreated": 1573051584,
    "dateChanged": 1573052586,
    "status": 2,
    "archive": 0,
    "packageNumber": "1573051558",
    "documents": [],
    "package2Dictionaries": [],
    "extraFields": [],
    "contractDictionaries": [],
    "packageType": {
      "packageId": 2139,
      "companyId": 4,
      "name": "Создал что бы удалить",
      "type": 1,
      "code": "80be4146ea4b4ca9a808ce6e8ae98a98",
      "packageChainId": 285,
      "status": 1,
      "version": 0,
      "dateChanged": 1573051420,
      "autoHandle": 0,
      "document2packages": [],
      "package2dictionaries": [],
      "extraFields": []
    },
    "isRead": 1,
    "isReadFromApi": 0,
    "isReadyForSend": 0,
    "packageDirection": 1,
    "signDateTerm": 0,
    "packageUuid": "4eb586a0-50e3-4455-97bf-c049c656af22",
    "isWithAgreement": 0
  },
  {
    "packageId": 6263,
    "senderCompanyId": 6,
    "recipientCompanyId": 4,
    "senderCompany": {
      "companyId": 6,
      "accountId": 10,
      "type": 0,
      "name": "ФІЗИЧНА ОСОБА",
      "legalName": "Ромашка",
      "inn": "0987654321",
      "code": "12345678",
      "isApproved": 0,
      "isSignedOffer": 0,
      "isActive": 0,
      "uuid": "22345200-abe8-4f60-90c8-0d43c5f6c0f6",
      "certificates": [],
      "dictionaries": [],
      "notifySettings": []
    },
    "recipientCompany": {
      "companyId": 4,
      "accountId": 8,
      "type": 0,
      "name": "Царь Царей",
      "legalName": "ПрАТ \"Літак\"",
      "inn": "123456789043",
      "code": "34554355",
      "isApproved": 0,
      "isSignedOffer": 0,
      "isActive": 0,
      "uuid": "a903de62-5b34-43c9-b73a-fb2b8ee4efc1",
      "certificates": [],
      "dictionaries": [],
      "notifySettings": []
    },
    "contract": {
      "contractId": 6,
      "number": "1",
      "contractName": "Сотрудник",
      "date": 1531872000,
      "description": "ав",
      "expiredDate": 1563408000,
      "sentDate": 0,
      "status": 2,
      "paymentStatus": 1,
      "isSpecialConditions": 0,
      "isAllClientSenderPackages": 0,
      "isAllOwnerSenderPackages": 0,
      "dictionaries": [],
      "ownerPackages": [],
      "clientPackages": []
    },
    "packageTypeId": 1945,
    "packageTypeChainId": 285,
    "dateCreated": 1568620619,
    "dateChanged": 1568620619,
    "status": 2,
    "archive": 0,
    "packageNumber": "1568620497",
    "documents": [],
    "package2Dictionaries": [],
    "extraFields": [],
    "contractDictionaries": [],
    "packageType": {
      "packageId": 1945,
      "companyId": 4,
      "name": "Создал что бы удалить",
      "type": 1,
      "code": "80be4146ea4b4ca9a808ce6e8ae98a98",
      "packageChainId": 285,
      "status": 2,
      "version": 0,
      "dateChanged": 1568620428,
      "autoHandle": 0,
      "document2packages": [],
      "package2dictionaries": [],
      "extraFields": []
    },
    "isRead": 1,
    "isReadFromApi": 0,
    "isReadyForSend": 0,
    "packageDirection": 1,
    "signDateTerm": 0,
    "packageUuid": "b5800b95-e181-474c-adb3-50f8593f322c",
    "isWithAgreement": 1
  }
]