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

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

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

GET /api/discountCardTypes{?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_dcard_type": 1,
    "name": "Card type one",
    "active": true
  }
]

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

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

Додавання типу дисконтних карток.

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

Параметри

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

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

• Content-Type: application/json

Тіло запиту:

{
  "id_dcard_type": 1,
  "name": "Card type one",
  "active": true
}

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

{
  "id_dcard_type": 1,
  "name": "Card type one",
  "active": true
}

Схема:

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

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

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

GET /api/discountCardTypes/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/discountCardTypes/{id_dcard_type}/{?unprotect_keys}

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

Параметри

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

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

{
  "id_dcard_type": 1,
  "name": "Card type one",
  "active": true
}

Схема:

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

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

PUT /api/discountCardTypes/{id_dcard_type}/{?unprotect_keys}

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

Параметри

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

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

• Content-Type: application/json

Тіло запиту:

{
  "id_dcard_type": 1,
  "name": "Card type one",
  "active": true
}

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

{
  "id_dcard_type": 1,
  "name": "Card type one",
  "active": true
}

Схема:

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

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

DELETE /api/discountCardTypes/{id_dcard_type}/{?unprotect_keys}

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

Параметри

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

Відповідь 204