QUINCE API. Одиниці виміру

Список методів

Метод	Опис
`/api/v2/unit/list`	Отримання списку одиниць виміру
`/api/v2/unit/add`	Створення одиниць виміру
`/api/v2/unit/update`	Оновлення одиниць виміру
`/api/v2/unit/markasdelete`	Видалення або архівування одиниці виміру
`/api/v2/unit/restore`	Відновлення одиниці виміру з архіву

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

Назва методу: /api/v2/unit/list

Повертає список одиниць виміру. Для навігації використовується номер сторінки page. Якщо page не передати, буде використана перша сторінка. Якщо Limit не передати, за замовчуванням повертається до 100 елементів.

Параметри запиту

Поле	Опис
`filter`	Об’єкт з фільтрами. Необов’язковий.
`filter.Id`	Ідентифікатор одиниці виміру.
`filter.Search`	Пошук за `Name`, `FullName`, `Memo` або `Id`.
`filter.Archive`	Ознака архівності. `false` повертає активні елементи, `true` - архівні.
`filter.MobileApp`	Якщо `true`, API повертає збільшений ліміт елементів для мобільного сценарію.
`page`	Номер сторінки. Необов’язковий.

Поля відповіді

Поле	Опис
`Id`	Ідентифікатор одиниці виміру.
`Name`	Коротка назва.
`FullName`	Повна назва.
`Memo`	Коментар.
`Void`	Ознака архівності.

Приклад запиту

{
  "filter": {
    "Search": "шт",
    "Archive": false
  },
  "page": 1
}

Приклад відповіді

{
  "success": true,
  "data": [
    {
      "Id": 1,
      "Name": "шт",
      "FullName": "Штука",
      "Memo": null,
      "Void": false
    }
  ]
}

Створення та оновлення одиниць виміру

Назва методу створення: /api/v2/unit/add

Назва методу оновлення: /api/v2/unit/update

Методи додають або оновлюють одиниці виміру пакетами до 100 елементів. Для /api/v2/unit/add поле Name обов’язкове, а переданий Id ігнорується. Для /api/v2/unit/update поле Id обов’язкове. Якщо переданий Id не знайдено, API повертає success: false і список проблемних Id.

Параметри запиту

Поле	Опис
`array`	Масив одиниць виміру. Обов’язковий.
`array[].Id`	Ідентифікатор одиниці виміру. Обов’язковий для `/api/v2/unit/update`.
`array[].Name`	Коротка назва. Обов’язкова.
`array[].FullName`	Повна назва. Якщо не передати під час створення, використовується `Name`.
`array[].Memo`	Коментар.

Формат відповіді

Поле	Опис
`success`	`true` або `false`.
`data`	Масив ідентифікаторів створених або оновлених одиниць виміру.
`error`	Текст помилки, якщо `success = false`.

Видалення, архівування та відновлення одиниць виміру

Одиниці виміру входять до довідників з уніфікованим контрактом видалення й відновлення (/api/v2/unit/markasdelete і /api/v2/unit/restore). Повний опис формату запиту, відповіді та кодів відмов - у розділі Видалення, архівування та відновлення довідників.