Програми лояльності

Список програм лояльності

Отримати список програм лояльності

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

Параметри

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

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

[
  {
    "id_program": 1,
    "program_text": "Loyalty program JSON must be here.",
    "state": 1,
    "active": true
  }
]

Додати програму лояльності

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

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

Параметри

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

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

• Content-Type: application/json

Тіло запиту:

{
  "id_program": 1,
  "program_text": "Loyalty program JSON must be here.",
  "state": 1,
  "active": true
}

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

{
  "id_program": 1,
  "program_text": "Loyalty program JSON must be here.",
  "state": 1,
  "active": true
}

Схема:

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

Кількість програм лояльності

Отримати кількість програм лояльності

GET /api/loyaltyPrograms/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/loyaltyPrograms/current

Отримання програми лояльності, в якій поле state = 1 (поточна програма)

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

{
  "id_program": 1,
  "program_text": "Loyalty program JSON must be here.",
  "state": 1,
  "active": true
}

Схема:

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

Програма лояльності

Отримати дані про програму лояльності

GET /api/loyaltyPrograms/{id_program}/{?unprotect_keys,with}

Параметри

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

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

{
  "id_program": 1,
  "program_text": "Loyalty program JSON must be here.",
  "state": 1,
  "active": true
}

Схема:

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

Змінити дані про програму лояльності

PUT /api/loyaltyPrograms/{id_program}/{?unprotect_keys,with}

Параметри

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

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

• Content-Type: application/json

Тіло запиту:

{
  "id_program": 1,
  "program_text": "Loyalty program JSON must be here.",
  "state": 1,
  "active": true
}

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

{
  "id_program": 1,
  "program_text": "Loyalty program JSON must be here.",
  "state": 1,
  "active": true
}

Схема:

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

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

DELETE /api/loyaltyPrograms/{id_program}/{?unprotect_keys,with}

Параметри

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

Відповідь 204