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

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

Метод запиту

HTTP GET

Content-Type

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

URL запиту

https://doc.edi-n.com/bdoc/agreement_groups?search_pattern=%D1%84%D0%B8%D0%BD&company_id=1313&limit=30

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

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

Опціональні url-параметри:(пошук та фільтри):

company_id - ID компанії (вибірка за компанією)

search_pattern - пошук за назвою групи

limit - ліміт вибірки (за замовчанням=30)

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

REQUEST

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

RESPONSE

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

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

Параметр

Формат

Опис

Об’єкт AgreementGroup

users

ArrayList<User_>

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

groupID

long

ID групи узгодження

companyID

long

ID компанії

company

Company_

об’єкт; дані компанії

groupName

String

назва групи узгодження

comment

String

коментар

Приклади

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


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

[
  {
    "users": [],
    "groupId": 301,
    "companyId": 1313,
    "company": {
      "companyId": 0,
      "accountId": 0,
      "type": 0,
      "name": "ФОП Гаврилюк Татьяна",
      "code": "3189823647",
      "isApproved": 0,
      "isSignedOffer": 0,
      "isActive": 0,
      "certificates": [],
      "dictionaries": [],
      "notifySettings": []
    },
    "groupName": "Юридический отдел "
  },
  {
    "users": [],
    "groupId": 293,
    "companyId": 1313,
    "company": {
      "companyId": 0,
      "accountId": 0,
      "type": 0,
      "name": "ФОП Гаврилюк Татьяна",
      "code": "3189823647",
      "isApproved": 0,
      "isSignedOffer": 0,
      "isActive": 0,
      "certificates": [],
      "dictionaries": [],
      "notifySettings": []
    },
    "groupName": "Бухгалтерия"
  }
]