Дисконтні картки

Список дисконтних карток

Отримати список дисконтних карток

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

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

Параметри

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

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

[
  {
    "id_discount_card": 1,
    "id_client": 1,
    "bar_code": "4052557303215",
    "phone_number": "5555555555",
    "id_price_level": 1,
    "id_dcard_type": 1,
    "active": true
  }
]

Додати дисконтну картку

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

Додавання дисконтної картки.

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

Параметри

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

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

• Content-Type: application/json

Тіло запиту:

{
  "id_discount_card": 1,
  "id_client": 1,
  "bar_code": "4052557303215",
  "phone_number": "5555555555",
  "id_price_level": 1,
  "id_dcard_type": 1,
  "active": true
}

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

{
  "id_discount_card": 1,
  "id_client": 1,
  "bar_code": "4052557303215",
  "phone_number": "5555555555",
  "id_price_level": 1,
  "id_dcard_type": 1,
  "active": true
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_discount_card": {
      "type": "number"
    },
    "id_client": {
      "type": "number"
    },
    "bar_code": {
      "type": "string"
    },
    "phone_number": {
      "type": "string"
    },
    "id_price_level": {
      "type": "number"
    },
    "id_dcard_type": {
      "type": "number"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id_discount_card",
    "id_client",
    "bar_code",
    "phone_number",
    "active"
  ]
}

Кількість дисконтних карток

Отримати кількість дисконтних карток

GET /api/discountCards/count{?id_client,filters,ids_list,active}

Повертає кількість записів

Параметри

Параметр	Тип	Обов’язковий	Опис
id_client	integer	ні	Код клієнта
filters	string	ні	Текстові фільтри у форматі: field_name:: |field_name1::
ids_list	string	ні	Список значень ключового поля записів, які потрібно повернути. Зазначається через кому без пробілу
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/discountCards/{id_discount_card}/{?unprotect_keys,with}

Отримання даних про дисконтну картку

Параметри

Параметр	Тип	Обов’язковий	Опис
id_discount_card	integer	так	Код дисконтної картки
with	string	ні	Список імен пов’язаних ресурсів через кому без пробілів. Зв’язки: priceLevel, discountCardType, client

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

{
  "id_discount_card": 1,
  "id_client": 1,
  "bar_code": "4052557303215",
  "phone_number": "5555555555",
  "id_price_level": 1,
  "id_dcard_type": 1,
  "active": true
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_discount_card": {
      "type": "number"
    },
    "id_client": {
      "type": "number"
    },
    "bar_code": {
      "type": "string"
    },
    "phone_number": {
      "type": "string"
    },
    "id_price_level": {
      "type": "number"
    },
    "id_dcard_type": {
      "type": "number"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id_discount_card",
    "id_client",
    "bar_code",
    "phone_number",
    "active"
  ]
}

Змінити дані про дисконтну картку

PUT /api/discountCards/{id_discount_card}/{?unprotect_keys,with}

Зміна даних про дисконтну картку за кодом

Параметри

Параметр	Тип	Обов’язковий	Опис
id_discount_card	integer	так	Код дисконтної картки
unprotect_keys	string	ні	Якщо параметр існує і дорівнює “true”, в операціях створення/редагування значення ключового поля не ігноруються
with	string	ні	Список імен пов’язаних ресурсів через кому без пробілів. Зв’язки: priceLevel, discountCardType, client

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

• Content-Type: application/json

Тіло запиту:

{
  "id_discount_card": 1,
  "id_client": 1,
  "bar_code": "4052557303215",
  "phone_number": "5555555555",
  "id_price_level": 1,
  "id_dcard_type": 1,
  "active": true
}

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

{
  "id_discount_card": 1,
  "id_client": 1,
  "bar_code": "4052557303215",
  "phone_number": "5555555555",
  "id_price_level": 1,
  "id_dcard_type": 1,
  "active": true
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_discount_card": {
      "type": "number"
    },
    "id_client": {
      "type": "number"
    },
    "bar_code": {
      "type": "string"
    },
    "phone_number": {
      "type": "string"
    },
    "id_price_level": {
      "type": "number"
    },
    "id_dcard_type": {
      "type": "number"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id_discount_card",
    "id_client",
    "bar_code",
    "phone_number",
    "active"
  ]
}

Деактивувати дані про дисконтну картку

DELETE /api/discountCards/{id_discount_card}/{?unprotect_keys,with}

Деактивація даних про дисконтну картку

Параметри

Параметр	Тип	Обов’язковий	Опис
id_discount_card	integer	так	Код дисконтної картки

Відповідь 204