Рекламні повідомлення для чеків

Список рекламних повідомлень для чеків

Отримати список рекламних повідомлень для чеків

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

Параметри

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

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

[
  {
    "id_ads": 1,
    "id_workplace": 1,
    "ads_text": "This is ads text example",
    "is_unique": false,
    "use_count": 0,
    "active": true
  }
]

Додати рекламне повідомлення для чеків

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

• Атрибут unprotect_keys=true і значення id_ads у тілі запиту вказувати обовʼязково. Значення ключа id_ads автоматично не генерується при створенні запису.

Параметри

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

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

• Content-Type: application/json

Тіло запиту:

{
  "id_ads": 1,
  "id_workplace": 1,
  "ads_text": "This is ads text example",
  "is_unique": false,
  "use_count": 0,
  "active": true
}

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

{
  "id_ads": 1,
  "id_workplace": 1,
  "ads_text": "This is ads text example",
  "is_unique": false,
  "use_count": 0,
  "active": true
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_ads": {
      "type": "number"
    },
    "id_workplace": {
      "type": "number"
    },
    "ads_text": {
      "type": "string"
    },
    "is_unique": {
      "type": "boolean"
    },
    "use_count": {
      "type": "number"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id_ads",
    "id_workplace",
    "active"
  ]
}

Кількість рекламних повідомлень для чеків

Отримати кількість рекламних повідомлень для чеків

GET /api/AdsMessages/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/AdsMessages/{id_ads}/{?unprotect_keys,with}

Параметри

Параметр	Тип	Обов’язковий	Опис
id_ads	integer	так	Ідентифікатор рекламного повідомлення
with	string	ні	Список імен повʼязаних ресурсів через кому без пробілів. Звʼязки: workplace

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

{
  "id_ads": 1,
  "id_workplace": 1,
  "ads_text": "This is ads text example",
  "is_unique": false,
  "use_count": 0,
  "active": true
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_ads": {
      "type": "number"
    },
    "id_workplace": {
      "type": "number"
    },
    "ads_text": {
      "type": "string"
    },
    "is_unique": {
      "type": "boolean"
    },
    "use_count": {
      "type": "number"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id_ads",
    "id_workplace",
    "active"
  ]
}

Змінити дані про рекламне повідомлення

PUT /api/AdsMessages/{id_ads}/{?unprotect_keys,with}

Параметри

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

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

• Content-Type: application/json

Тіло запиту:

{
  "id_ads": 1,
  "id_workplace": 1,
  "ads_text": "This is ads text example",
  "is_unique": false,
  "use_count": 0,
  "active": true
}

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

{
  "id_ads": 1,
  "id_workplace": 1,
  "ads_text": "This is ads text example",
  "is_unique": false,
  "use_count": 0,
  "active": true
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_ads": {
      "type": "number"
    },
    "id_workplace": {
      "type": "number"
    },
    "ads_text": {
      "type": "string"
    },
    "is_unique": {
      "type": "boolean"
    },
    "use_count": {
      "type": "number"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id_ads",
    "id_workplace",
    "active"
  ]
}

Деактивувати дані про рекламне повідомлення

DELETE /api/AdsMessages/{id_ads}/{?unprotect_keys,with}

Параметри

Параметр	Тип	Обов’язковий	Опис
id_ads	integer	так	Ідентифікатор рекламного повідомлення

Відповідь 204