Створення / редагування ярлика фільтра

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

Важливо

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

Метод запиту

HTTP POST

Content-Type

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

URL запиту

https://doc.edi-n.com/bdoc/filter

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

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

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

filterName; periodType; dateFrom; dateTo;

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

REQUEST

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

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):

{
  "folder": 1,
  "packageStatuses": [
    2,
    3,
    4,
    6,
    5,
    7,
    8
  ],
  "dateFrom": 0,
  "dateTo": 0,
  "senderCompaniesIds": [],
  "recipientCompaniesIds": [],
  "packageChainIds": [],
  "periodType": 1,
  "filterName": "альбус",
  "packageTagIds": []
}

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

{
  "filterId": 129,
  "filterName": "альбус",
  "ownerCompaniesIds": [],
  "clientCompaniesIds": [],
  "senderCompaniesIds": [],
  "recipientCompaniesIds": [],
  "dateFrom": 0,
  "dateTo": 0,
  "packageTypesIds": [],
  "packageChainIds": [],
  "contractIds": [],
  "packageStatuses": [
    2,
    3,
    4,
    6,
    5,
    7,
    8
  ],
  "packageTagIds": [],
  "folder": 1,
  "periodType": 1,
  "dateShift": 0
}