Отримання списку всіх ярликів фільтрів

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

Важливо

Вибір дії (створення або редагування). В разі якщо в тілі запиту (json) присутній filterId, то запис з зазначеним filterId підлягає редагуванню.

Метод запиту

HTTPS GET

Content-Type

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

URL запиту

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

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

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

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

REQUEST

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

RESPONSE

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

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

Параметр

Формат

Опис

Об’єкт PackageFilter

filterId

long

ID фильтру

filterName

long

назва ярлика-фільтру

packageId

long

ID комплекта (пакета)

ownerCompaniesIds

List<ownerCompaniesIds>

масив об’єктів; список ID компаній власника

clientCompaniesIds

List<clientCompaniesIds>

масив об’єктів; список ID компаній контрагента

senderCompaniesIds

List<senderCompaniesIds>

масив об’єктів; список ID компаній відправника

recipientCompaniesIds

**List<recipientCompaniesIds>*

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

dateFrom

long

дата початку вибірки при пошуку комплекту (unix timestamp)

dateTo

long

дата закынчення вибірки при пошуку комплекту (unix timestamp)

packageNumber

String

номер комплекту

packageTypesIds

List<packageTypesIds>

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

packageChainIds

List<packageChainIds>

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

contractIds

List<contractIds>

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

packageStatuses

List<packageStatuses>

масив; по статусах комплектів документів де «1» - чернетка; «2» - відправлений; «3» — прийнятий; «4» - запит на уточнення; «5» - відхилений; «6» - оброблений; «7» - відмова; «8» — додано документ;

packageTagIds

List<packageTagIds>

масив  ID тегів

folder

int

папка; 1 — inbox; 2 — outbox; 3 — draft;

isReadFromApi

int

ознака прочитання (завантаження) по API

isRead

int

ознака прочитання на WEB

periodType

int

період; 1 — currentMonth; 2 — previousMonth; 3 — currentDate; 4 fixedPeriod;

dateShift

int

N днів в формі «Поточна дата мінус N-днів» (якщо periodType = 3)

fileName

String

пошук по імені файлу документа

packageDictionaryValue

DictionaryValue_

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

extraField

ExtraField_

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


Приклади

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


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

[
  {
    "filterId": 305,
    "filterName": "альбус",
    "ownerCompaniesIds": [],
    "clientCompaniesIds": [],
    "senderCompaniesIds": [],
    "recipientCompaniesIds": [
      1319
    ],
    "dateFrom": 1575151200,
    "dateTo": 1576533600,
    "packageTypesIds": [],
    "packageChainIds": [
      330
    ],
    "contractIds": [],
    "packageStatuses": [
      2,
      3,
      4,
      6,
      5,
      7,
      8
    ],
    "packageTagIds": [
      409
    ],
    "folder": 1,
    "periodType": 1,
    "dateShift": 0,
    "packageDictionaryValue": {
      "valueId": 1431,
      "dictionaryId": 715,
      "name": "Направление 5",
      "code": "1b35ec2b56d24ae29951010bd2a4f279",
      "isActive": 1,
      "childs": []
    },
    "extraField": {
      "fieldId": 265,
      "companyId": 0,
      "name": "Сумма ",
      "dataType": 0,
      "status": 0,
      "value": "5"
    }
  },
  {
    "filterId": 303,
    "filterName": "альба",
    "ownerCompaniesIds": [],
    "clientCompaniesIds": [],
    "senderCompaniesIds": [],
    "recipientCompaniesIds": [],
    "dateFrom": 1574719200,
    "dateTo": 1576533600,
    "packageTypesIds": [],
    "packageChainIds": [],
    "contractIds": [],
    "packageStatuses": [
      2,
      3,
      4,
      6,
      5,
      7,
      8
    ],
    "packageTagIds": [],
    "folder": 1,
    "periodType": 3,
    "dateShift": 20
  },
  {
    "filterId": 301,
    "filterName": "альбатрос",
    "ownerCompaniesIds": [],
    "clientCompaniesIds": [],
    "senderCompaniesIds": [],
    "recipientCompaniesIds": [],
    "dateFrom": 1575158400,
    "dateTo": 1576540800,
    "packageTypesIds": [],
    "packageChainIds": [],
    "contractIds": [],
    "packageStatuses": [
      2,
      3,
      4,
      6,
      5,
      7,
      8
    ],
    "packageTagIds": [
      295
    ],
    "folder": 1,
    "periodType": 4,
    "dateShift": 0
  }
]