Групи торгових точок

Список груп торгових точок

Отримати список груп торгових точок

GET /api/groupOutlets{?active,with,order,filters,ids_list,offset,limit,unprotect_keys}

Параметри

Параметр	Тип	Обов’язковий	Опис
active	string	ні	Якщо параметр дорівнює “true”, то повертаються лише активні записи.
with	string	ні	Список імен пов’язаних ресурсів через кому без пробілів. Зв’язки: owner, child, outlets
order	string	ні	Список полів сортування через кому без пробілів
ids_list	string	ні	Список значень ключового поля записів, які потрібно повернути. Зазначається через кому без пробілу
filters	string	ні	Текстові фільтри у форматі: field_name:: |field_name1::
offset	integer	ні	Повертати дані, починаючи з указаного номера запису
limit	integer	ні	Повертати вказану кількість записів

Відповідь 200 (application/json)

[
  {
    "id_group_outlet": 2,
    "name_group": "Outlets group",
    "id_owner_group": 1,
    "active": true
  }
]

Додати групу торгових точок

POST /api/groupOutlets{?active,with,order,filters,ids_list,offset,limit,unprotect_keys}

• Атрибут id_group_outlet у JSON запиту ігнорується, якщо не вказано параметр unprotect_keys=true.

Параметри

Параметр	Тип	Обов’язковий	Опис
unprotect_keys	string	ні	Якщо параметр існує і дорівнює “true”, в операціях створення/редагування значення ключового поля не ігноруються

Заголовки запиту:

• Content-Type: application/json

Тіло запиту:

{
  "id_group_outlet": 2,
  "name_group": "Outlets group",
  "id_owner_group": 1,
  "active": true
}

Відповідь 201 (application/json)

{
  "id_group_outlet": 2,
  "name_group": "Outlets group",
  "id_owner_group": 1,
  "active": true
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_group_outlet": {
      "type": "number"
    },
    "name_group": {
      "type": "string"
    },
    "id_owner_group": {
      "type": "number"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id_group_outlet",
    "name_group",
    "active"
  ]
}

Кількість груп торгових точок

Отримати кількість груп торгових точок

GET /api/groupOutlets/count{?filters,ids_list,active}

Параметри

Параметр	Тип	Обов’язковий	Опис
ids_list	string	ні	Список значень ключового поля записів, які потрібно повернути. Зазначається через кому без пробілу
filters	string	ні	Текстові фільтри у форматі: field_name:: |field_name1::
active	string	ні	Якщо параметр дорівнює “true”, то враховуються лише активні записи.

Відповідь 200 (application/json)

{
  "count": 10
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "count": {
      "type": "number"
    }
  },
  "required": [
    "count"
  ]
}

Група торгових точок

Отримати дані про групу торгових точок

GET /api/groupOutlets/{id_group_outlet}/{?unprotect_keys,with}

Параметри

Параметр	Тип	Обов’язковий	Опис
id_group_outlet	integer	так	Код групи торгових точок
with	string	ні	Список імен пов’язаних ресурсів через кому без пробілів. Зв’язки: owner, child, outlets

Відповідь 200 (application/json)

{
  "id_group_outlet": 2,
  "name_group": "Outlets group",
  "id_owner_group": 1,
  "active": true
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_group_outlet": {
      "type": "number"
    },
    "name_group": {
      "type": "string"
    },
    "id_owner_group": {
      "type": "number"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id_group_outlet",
    "name_group",
    "active"
  ]
}

Змінити дані про групу торгових точок

PUT /api/groupOutlets/{id_group_outlet}/{?unprotect_keys,with}

Параметри

Параметр	Тип	Обов’язковий	Опис
id_group_outlet	integer	так	Код групи торгових точок
unprotect_keys	string	ні	Якщо параметр існує і дорівнює “true”, в операціях створення/редагування значення ключового поля не ігноруються

Заголовки запиту:

• Content-Type: application/json

Тіло запиту:

{
  "id_group_outlet": 2,
  "name_group": "Outlets group",
  "id_owner_group": 1,
  "active": true
}

Відповідь 200 (application/json)

{
  "id_group_outlet": 2,
  "name_group": "Outlets group",
  "id_owner_group": 1,
  "active": true
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_group_outlet": {
      "type": "number"
    },
    "name_group": {
      "type": "string"
    },
    "id_owner_group": {
      "type": "number"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id_group_outlet",
    "name_group",
    "active"
  ]
}

Деактивувати дані про групу торгових точок

DELETE /api/groupOutlets/{id_group_outlet}/{?unprotect_keys,with}

Параметри

Параметр	Тип	Обов’язковий	Опис
id_group_outlet	integer	так	Код групи торгових точок

Відповідь 204