ProBonus API: Справочники [База знаний ГК Карбис]

Эта страница только для чтения. Вы можете посмотреть её исходный текст, но не можете его изменить. Сообщите администратору, если считаете, что это неправильно.
====== ProBonus API: Справочники ======

Группы счетов, составные скидки, типы идентификаторов, рестораны, теги и группы тегов, товарные купоны.

Общие правила (адрес, авторизация, форматы, коды ошибок) — на странице [[external:pro_bonus:10_probonus_api:20_reference|ProBonus API. Справочник методов]].

===== Список методов =====

^ Метод ^ Адрес ^ Назначение ^
| ''POST'' | ''/api/v0/account_groups/delete'' | [[#удаление_элемента_справочника_группы_счетов_по_заданному_id|Удаление элемента справочника "Группы счетов" по заданному id]] |
| ''GET'' | ''/api/v0/account_groups/get'' | [[#чтение_элемента_справочника_группы_счетов_по_заданному_id|Чтение элемента справочника "Группы счетов" по заданному id]] |
| ''POST'' | ''/api/v0/account_groups/insert'' | [[#добавление_нового_элемента_справочника_группы_счетов|Добавление нового элемента справочника "Группы счетов"]] |
| ''GET'' | ''/api/v0/account_groups/list'' | [[#чтение_списка_элементов_справочника_группы_счетов|Чтение списка элементов справочника "Группы счетов"]] |
| ''POST'' | ''/api/v0/account_groups/update'' | [[#обновление_элемента_справочника_группы_счетов_по_заданному_id|Обновление элемента справочника "Группы счетов" по заданному id]] |
| ''POST'' | ''/api/v0/discounts/delete'' | [[#удаление_элемента_справочника_составные_скидкибонусы_по_заданному_id|Удаление элемента справочника "Составные скидки/бонусы" по заданному id]] |
| ''GET'' | ''/api/v0/discounts/get'' | [[#чтение_элемента_справочника_составные_скидкибонусы_по_заданному_id|Чтение элемента справочника "Составные скидки/бонусы" по заданному id]] |
| ''POST'' | ''/api/v0/discounts/insert'' | [[#добавление_нового_элемента_справочника_составные_скидкибонусы|Добавление нового элемента справочника "Составные скидки/бонусы"]] |
| ''GET'' | ''/api/v0/discounts/list'' | [[#чтение_списка_элементов_справочника_составные_скидкибонусы|Чтение списка элементов справочника "Составные скидки/бонусы"]] |
| ''POST'' | ''/api/v0/discounts/update'' | [[#обновление_параметров_элемента_справочника_составные_скидкибонусы_по_заданному_id|Обновление параметров элемента справочника "Составные скидки/бонусы" по заданному id]] |
| ''POST'' | ''/api/v0/identifier_types/delete'' | [[#удаление_элемента_спрвавочника_типы_идентификаторов_по_заданному_id|Удаление элемента спрвавочника "Типы идентификаторов" по заданному id]] |
| ''GET'' | ''/api/v0/identifier_types/get'' | [[#чтение_элемента_справочника_типы_идентификаторов_по_заданному_id|Чтение элемента справочника "Типы идентификаторов" по заданному id]] |
| ''POST'' | ''/api/v0/identifier_types/insert'' | [[#добавление_нового_элемента_справочника_типы_идентификаторов|Добавление нового элемента справочника "Типы идентификаторов"]] |
| ''GET'' | ''/api/v0/identifier_types/list'' | [[#чтение_списка_элементов_справочника_типы_идентификаторов|Чтение списка элементов справочника "Типы Идентификаторов"]] |
| ''POST'' | ''/api/v0/identifier_types/update'' | [[#обновлене_элемента_справочника_типы_идентификаторов_по_заданному_id|Обновлене элемента справочника "Типы идентификаторов" по заданному id]] |
| ''POST'' | ''/api/v0/restaurants/delete'' | [[#удаление_элемента_справочника_рестораны_по_заданному_id|Удаление элемента справочника "Рестораны" по заданному id]] |
| ''GET'' | ''/api/v0/restaurants/get'' | [[#чтение_элемента_справочника_рестораны_по_заданному_id|Чтение элемента справочника "Рестораны" по заданному id]] |
| ''POST'' | ''/api/v0/restaurants/insert'' | [[#добавление_нового_элемента_справочника_рестораны|Добавление нового элемента справочника "Рестораны"]] |
| ''GET'' | ''/api/v0/restaurants/list'' | [[#чтение_списка_элементов_справочника_рестораны|Чтение списка элементов справочника "Рестораны"]] |
| ''GET'' | ''/api/v0/restaurants/list_last_visited_by_account_id'' | [[#рестораны_которые_недавно_посещал_гость|Рестораны, которые недавно посещал гость]] |
| ''POST'' | ''/api/v0/restaurants/restore'' | [[#востановление_элемента_справочника_рестораны_по_заданному_id|Востановление элемента справочника "Рестораны" по заданному id]] |
| ''POST'' | ''/api/v0/restaurants/update'' | [[#обновление_элемента_справочника_рестораны_по_заданному_id|Обновление элемента справочника "Рестораны" по заданному id]] |
| ''POST'' | ''/api/v0/tags/delete'' | [[#удаление_элемента_справочника_теги_гостей_по_заданному_id|Удаление элемента справочника "Теги гостей" по заданному id]] |
| ''GET'' | ''/api/v0/tags/get'' | [[#чтение_элемента_справочника_теги_гостей_по_заданному_id|Чтение элемента справочника "Теги гостей" по заданному id]] |
| ''POST'' | ''/api/v0/tags/groups/delete'' | [[#удаление_элемента_справочника_группы_тегов_по_заданному_id|Удаление элемента справочника "Группы тегов" по заданному id]] |
| ''GET'' | ''/api/v0/tags/groups/get'' | [[#чтение_элемента_справочника_группы_тегов_по_заданному_id|Чтение элемента справочника "Группы тегов" по заданному id]] |
| ''POST'' | ''/api/v0/tags/groups/insert'' | [[#добавление_элемента_справочника_группы_тегов|Добавление элемента справочника "Группы тегов"]] |
| ''GET'' | ''/api/v0/tags/groups/list'' | [[#чтение_списка_элементов_справочника_группы_тегов|Чтение списка элементов справочника "Группы тегов"]] |
| ''POST'' | ''/api/v0/tags/groups/restore'' | [[#восстановление_удаленного_элемента_справочника_группы_тегов_по_заданному_id|Восстановление удаленного элемента справочника "Группы тегов" по заданному id]] |
| ''POST'' | ''/api/v0/tags/groups/update'' | [[#обновление_элемента_справочника_группы_тегов|Обновление элемента справочника "Группы тегов"]] |
| ''POST'' | ''/api/v0/tags/insert'' | [[#добавление_элемента_справочника_теги_гостей|Добавление элемента справочника "Теги гостей"]] |
| ''GET'' | ''/api/v0/tags/list'' | [[#чтение_списка_элементов_справочника_теги_гостей|Чтение списка элементов справочника "Теги гостей"]] |
| ''POST'' | ''/api/v0/tags/restore'' | [[#восстановление_удаленного_элемента_справочника_теги_гостей_по_заданному_id|Восстановление удаленного элемента справочника "Теги гостей" по заданному id]] |
| ''POST'' | ''/api/v0/tags/update'' | [[#обновление_элемента_справочника_теги_гостей|Обновление элемента справочника "Теги гостей"]] |
| ''GET'' | ''/api/v0/coupons_dish/get'' | [[#чтение_элемента_справочника_товарные_купоны_по_указанному_id|Чтение элемента справочника "Товарные купоны" по указанному id]] |
| ''POST'' | ''/api/v0/coupons_dish/insert'' | [[#добавление_элемента_справочника_товарные_купоны_по_указанному_id|Добавление элемента справочника "Товарные купоны" по указанному id]] |
| ''GET'' | ''/api/v0/coupons_dish/list'' | [[#чтение_списка_элементов_справочника_товарные_купоны|Чтение списка элементов справочника "Товарные купоны"]] |
| ''POST'' | ''/api/v0/coupons_dish/update'' | [[#обновление_элемента_справочника_товарные_купоны_по_указанному_id|Обновление элемента справочника "Товарные купоны" по указанному id]] |

===== Группы счетов =====

==== Удаление элемента справочника "Группы счетов" по заданному id ====
**''POST /api/v0/account_groups/delete''**\\
Авторизация: требуется

**Параметры запроса:**

^ Параметр ^ Где ^ Тип ^ Обяз. ^ Описание ^
| ''id'' | строка запроса | integer | да | Идентификатор объекта |

**Ответ 200:** JSON (структура в схеме не описана).

Дополнительные коды ответа: ''401'' — Unauthorized.

==== Чтение элемента справочника "Группы счетов" по заданному id ====
**''GET /api/v0/account_groups/get''**\\
Авторизация: требуется

**Параметры запроса:**

^ Параметр ^ Где ^ Тип ^ Обяз. ^ Описание ^
| ''id'' | строка запроса | integer | да | Идентификатор объекта |

**Ответ 200** — объект ''AccountGroupDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''id'' | integer | да | Идентификатор группы |
| ''name'' | string(100) | да | Наименование группы |
| ''template'' | [[#accounttemplatedto|AccountTemplateDto]] |  | Шаблон |

Дополнительные коды ответа: ''401'' — Unauthorized.

==== Добавление нового элемента справочника "Группы счетов" ====
**''POST /api/v0/account_groups/insert''**\\
Авторизация: требуется

**Тело запроса** — объект ''AccountGroupInsDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(100) | да | Наименование |
| ''template'' | [[#accounttemplatebasedto|AccountTemplateBaseDto]] |  | Шаблон |

**Ответ 200** — объект ''AccountGroupDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''id'' | integer | да | Идентификатор группы |
| ''name'' | string(100) | да | Наименование группы |
| ''template'' | [[#accounttemplatedto|AccountTemplateDto]] |  | Шаблон |

Дополнительные коды ответа: ''401'' — Unauthorized.

==== Чтение списка элементов справочника "Группы счетов" ====
**''GET /api/v0/account_groups/list''**\\
Авторизация: требуется

**Ответ 200** — массив объектов ''AccountGroupListItemDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''id'' | integer | да | Идентификатор группы |
| ''name'' | string(100) | да | Наименование группы |
| ''haveTemplate'' | boolean | да |  |

Дополнительные коды ответа: ''401'' — Unauthorized.

==== Обновление элемента справочника "Группы счетов" по заданному id ====
**''POST /api/v0/account_groups/update''**\\
Авторизация: требуется

**Тело запроса** — объект ''AccountGroupUpdDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(100) | да | Наименование |
| ''template'' | [[#accounttemplatebasedto|AccountTemplateBaseDto]] |  | Шаблон |
| ''id'' | integer |  | Идентификатор |

**Ответ 200** — объект ''AccountGroupDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''id'' | integer | да | Идентификатор группы |
| ''name'' | string(100) | да | Наименование группы |
| ''template'' | [[#accounttemplatedto|AccountTemplateDto]] |  | Шаблон |

Дополнительные коды ответа: ''401'' — Unauthorized.

===== Составные скидки/бонусы =====

==== Удаление элемента справочника "Составные скидки/бонусы" по заданному id ====
**''POST /api/v0/discounts/delete''**\\
Авторизация: требуется

**Параметры запроса:**

^ Параметр ^ Где ^ Тип ^ Обяз. ^ Описание ^
| ''id'' | строка запроса | integer |  | Идентификатор объекта |

**Ответ 200** — объект ''DiscountDto (discount)'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(50) | да | Наименование |
| ''limitPeriodInDays'' | integer |  | Период накопления суммы потрат, дней (''NULL'' — за всё время) |
| ''discountLevels'' | массив [[#discountleveldto|DiscountLevelDto]] | да | Уровни составной скидки |
| ''id'' | integer | да | Идентификатор |

==== Чтение элемента справочника "Составные скидки/бонусы" по заданному id ====
**''GET /api/v0/discounts/get''**\\
Авторизация: требуется

**Параметры запроса:**

^ Параметр ^ Где ^ Тип ^ Обяз. ^ Описание ^
| ''id'' | строка запроса | integer |  | Идентификатор объекта |

**Ответ 200** — объект ''DiscountDto (discount)'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(50) | да | Наименование |
| ''limitPeriodInDays'' | integer |  | Период накопления суммы потрат, дней (''NULL'' — за всё время) |
| ''discountLevels'' | массив [[#discountleveldto|DiscountLevelDto]] | да | Уровни составной скидки |
| ''id'' | integer | да | Идентификатор |

==== Добавление нового элемента справочника "Составные скидки/бонусы" ====
**''POST /api/v0/discounts/insert''**\\
Авторизация: требуется

**Тело запроса** — объект ''DiscountBaseDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(50) | да | Наименование |
| ''limitPeriodInDays'' | integer |  | Период накопления суммы потрат, дней (''NULL'' — за всё время) |
| ''discountLevels'' | массив [[#discountleveldto|DiscountLevelDto]] | да | Уровни составной скидки |

**Ответ 200** — объект ''DiscountDto (discount)'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(50) | да | Наименование |
| ''limitPeriodInDays'' | integer |  | Период накопления суммы потрат, дней (''NULL'' — за всё время) |
| ''discountLevels'' | массив [[#discountleveldto|DiscountLevelDto]] | да | Уровни составной скидки |
| ''id'' | integer | да | Идентификатор |

==== Чтение списка элементов справочника "Составные скидки/бонусы" ====
**''GET /api/v0/discounts/list''**\\
Авторизация: требуется

**Ответ 200** — массив объектов ''DiscountDto (discount)'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(50) | да | Наименование |
| ''limitPeriodInDays'' | integer |  | Период накопления суммы потрат, дней (''NULL'' — за всё время) |
| ''discountLevels'' | массив [[#discountleveldto|DiscountLevelDto]] | да | Уровни составной скидки |
| ''id'' | integer | да | Идентификатор |

==== Обновление параметров элемента справочника "Составные скидки/бонусы" по заданному id ====
**''POST /api/v0/discounts/update''**\\
Авторизация: требуется

**Тело запроса** — объект ''DiscountDto (discount)'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(50) | да | Наименование |
| ''limitPeriodInDays'' | integer |  | Период накопления суммы потрат, дней (''NULL'' — за всё время) |
| ''discountLevels'' | массив [[#discountleveldto|DiscountLevelDto]] | да | Уровни составной скидки |
| ''id'' | integer | да | Идентификатор |

**Ответ 200** — объект ''DiscountDto (discount)'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(50) | да | Наименование |
| ''limitPeriodInDays'' | integer |  | Период накопления суммы потрат, дней (''NULL'' — за всё время) |
| ''discountLevels'' | массив [[#discountleveldto|DiscountLevelDto]] | да | Уровни составной скидки |
| ''id'' | integer | да | Идентификатор |

===== Типы идентификаторов =====

==== Удаление элемента спрвавочника "Типы идентификаторов" по заданному id ====
**''POST /api/v0/identifier_types/delete''**\\
Авторизация: требуется

**Параметры запроса:**

^ Параметр ^ Где ^ Тип ^ Обяз. ^ Описание ^
| ''id'' | строка запроса | integer | да | Идентификатор объекта |

**Ответ 200:** JSON (структура в схеме не описана).

==== Чтение элемента справочника "Типы идентификаторов" по заданному id ====
**''GET /api/v0/identifier_types/get''**\\
Авторизация: требуется

**Параметры запроса:**

^ Параметр ^ Где ^ Тип ^ Обяз. ^ Описание ^
| ''id'' | строка запроса | integer |  | Идентификатор объекта |

**Ответ 200** — объект ''IdentifierTypeDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(100) | да | Наименование типа |
| ''id'' | integer | да | Идентификатор типа |
| ''system'' | boolean |  | Системный тип (нельзя удалить); по умолчанию ''false'' |
| ''systemType'' | string |  | Код системного типа (см. описание таблицы) |
| ''temporary'' | boolean |  | Временный идентификатор (имеет срок действия); по умолчанию ''false'' |
| ''frontVisible'' | boolean |  | Отображать в веб-интерфейсе; по умолчанию ''true'' |
| ''frontEditable'' | boolean |  | Разрешено редактировать в веб-интерфейсе; по умолчанию ''true'' |

==== Добавление нового элемента справочника "Типы идентификаторов" ====
**''POST /api/v0/identifier_types/insert''**\\
Авторизация: требуется

**Тело запроса** — объект ''IdentifierTypeBaseDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(100) | да | Наименование типа |

**Ответ 200** — объект ''IdentifierTypeUpdate'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(100) | да | Наименование типа |
| ''id'' | integer | да | Идентификатор типа |

==== Чтение списка элементов справочника "Типы Идентификаторов" ====
**''GET /api/v0/identifier_types/list''**\\
Авторизация: требуется

**Ответ 200** — массив объектов ''IdentifierTypeDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(100) | да | Наименование типа |
| ''id'' | integer | да | Идентификатор типа |
| ''system'' | boolean |  | Системный тип (нельзя удалить); по умолчанию ''false'' |
| ''systemType'' | string |  | Код системного типа (см. описание таблицы) |
| ''temporary'' | boolean |  | Временный идентификатор (имеет срок действия); по умолчанию ''false'' |
| ''frontVisible'' | boolean |  | Отображать в веб-интерфейсе; по умолчанию ''true'' |
| ''frontEditable'' | boolean |  | Разрешено редактировать в веб-интерфейсе; по умолчанию ''true'' |

==== Обновлене элемента справочника "Типы идентификаторов" по заданному id ====
**''POST /api/v0/identifier_types/update''**\\
Авторизация: требуется

**Тело запроса** — объект ''IdentifierTypeUpdate'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(100) | да | Наименование типа |
| ''id'' | integer | да | Идентификатор типа |

**Ответ 200** — объект ''IdentifierTypeUpdate'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(100) | да | Наименование типа |
| ''id'' | integer | да | Идентификатор типа |

===== Рестораны =====

==== Удаление элемента справочника "Рестораны" по заданному id ====
**''POST /api/v0/restaurants/delete''**\\
Авторизация: требуется

**Параметры запроса:**

^ Параметр ^ Где ^ Тип ^ Обяз. ^ Описание ^
| ''id'' | строка запроса | integer | да | Идентификатор объекта |

**Ответ 200:** JSON (структура в схеме не описана).

==== Чтение элемента справочника "Рестораны" по заданному id ====
**''GET /api/v0/restaurants/get''**\\
Авторизация: требуется

**Параметры запроса:**

^ Параметр ^ Где ^ Тип ^ Обяз. ^ Описание ^
| ''id'' | строка запроса | integer | да | Идентификатор объекта |

**Ответ 200** — объект ''RestaurantDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(100) | да | Наименование |
| ''code'' | string | да | код ресторана 9 цифр |
| ''isDeleted'' | boolean |  | Признак удаления; по умолчанию ''false'' |
| ''id'' | integer | да | Идентификатор ресторана |

==== Добавление нового элемента справочника "Рестораны" ====
**''POST /api/v0/restaurants/insert''**\\
Авторизация: требуется

**Тело запроса** — объект ''RestaurantBaseDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(100) | да | Наименование |
| ''code'' | string | да | код ресторана 9 цифр |
| ''isDeleted'' | boolean |  | Признак удаления; по умолчанию ''false'' |

**Ответ 200** — объект ''RestaurantDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(100) | да | Наименование |
| ''code'' | string | да | код ресторана 9 цифр |
| ''isDeleted'' | boolean |  | Признак удаления; по умолчанию ''false'' |
| ''id'' | integer | да | Идентификатор ресторана |

==== Чтение списка элементов справочника "Рестораны" ====
**''GET /api/v0/restaurants/list''**\\
Авторизация: требуется

**Параметры запроса:**

^ Параметр ^ Где ^ Тип ^ Обяз. ^ Описание ^
| ''show_deleted'' | строка запроса | boolean |  | Показывать удалённые элементы |

**Ответ 200** — массив объектов ''RestaurantListItemDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(100) | да | Наименование |
| ''code'' | string | да | код ресторана 9 цифр |
| ''isDeleted'' | boolean |  | Признак удаления; по умолчанию ''false'' |
| ''id'' | integer | да | Идентификатор ресторана |
| ''licSlot'' | integer |  |  |

==== Рестораны, которые недавно посещал гость ====
**''GET /api/v0/restaurants/list_last_visited_by_account_id''**\\
Авторизация: требуется

**Параметры запроса:**

^ Параметр ^ Где ^ Тип ^ Обяз. ^ Описание ^
| ''account_id'' | строка запроса | integer | да | Идентификатор счёта |
| ''limit'' | строка запроса | integer |  | Максимальное количество записей в ответе; по умолчанию ''3'' |

**Ответ 200** — массив объектов ''RestaurantDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(100) | да | Наименование |
| ''code'' | string | да | код ресторана 9 цифр |
| ''isDeleted'' | boolean |  | Признак удаления; по умолчанию ''false'' |
| ''id'' | integer | да | Идентификатор ресторана |

==== Востановление элемента справочника "Рестораны" по заданному id ====
**''POST /api/v0/restaurants/restore''**\\
Авторизация: требуется

**Параметры запроса:**

^ Параметр ^ Где ^ Тип ^ Обяз. ^ Описание ^
| ''id'' | строка запроса | integer | да | Идентификатор объекта |

**Ответ 200:** JSON (структура в схеме не описана).

==== Обновление элемента справочника "Рестораны" по заданному id ====
**''POST /api/v0/restaurants/update''**\\
Авторизация: требуется

**Тело запроса** — объект ''RestaurantDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(100) | да | Наименование |
| ''code'' | string | да | код ресторана 9 цифр |
| ''isDeleted'' | boolean |  | Признак удаления; по умолчанию ''false'' |
| ''id'' | integer | да | Идентификатор ресторана |

**Ответ 200** — объект ''RestaurantDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(100) | да | Наименование |
| ''code'' | string | да | код ресторана 9 цифр |
| ''isDeleted'' | boolean |  | Признак удаления; по умолчанию ''false'' |
| ''id'' | integer | да | Идентификатор ресторана |

===== Теги и группы тегов =====

==== Удаление элемента справочника "Теги гостей" по заданному id ====
**''POST /api/v0/tags/delete''**\\
Авторизация: требуется

**Параметры запроса:**

^ Параметр ^ Где ^ Тип ^ Обяз. ^ Описание ^
| ''id'' | строка запроса | integer |  | Идентификатор объекта |

**Ответ 200:** JSON (структура в схеме не описана).

==== Чтение элемента справочника "Теги гостей" по заданному id ====
**''GET /api/v0/tags/get''**\\
Авторизация: требуется

**Параметры запроса:**

^ Параметр ^ Где ^ Тип ^ Обяз. ^ Описание ^
| ''id'' | строка запроса | integer |  | Идентификатор объекта |

**Ответ 200** — объект ''TagDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(100) | да | Наименование тега |
| ''isDeleted'' | boolean |  | Признак удаления; по умолчанию ''false'' |
| ''groupId'' | integer | да | ID группы тега |
| ''id'' | integer | да | Идентификатор тега |

==== Удаление элемента справочника "Группы тегов" по заданному id ====
**''POST /api/v0/tags/groups/delete''**\\
Авторизация: требуется

**Параметры запроса:**

^ Параметр ^ Где ^ Тип ^ Обяз. ^ Описание ^
| ''id'' | строка запроса | integer |  | Идентификатор объекта |

**Ответ 200:** JSON (структура в схеме не описана).

==== Чтение элемента справочника "Группы тегов" по заданному id ====
**''GET /api/v0/tags/groups/get''**\\
Авторизация: требуется

**Параметры запроса:**

^ Параметр ^ Где ^ Тип ^ Обяз. ^ Описание ^
| ''id'' | строка запроса | integer |  | Идентификатор объекта |

**Ответ 200** — объект ''TagGroupDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(100) | да | Наименование |
| ''isDeleted'' | boolean |  | Признак удаления; по умолчанию ''false'' |
| ''id'' | integer | да | Идентификатор группы тегов |
| ''usageCount'' | integer |  | Количество использований; по умолчанию ''0'' |

==== Добавление элемента справочника "Группы тегов" ====
**''POST /api/v0/tags/groups/insert''**\\
Авторизация: требуется

**Тело запроса** — объект ''TagGroupBaseDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(100) | да | Наименование |
| ''isDeleted'' | boolean |  | Признак удаления; по умолчанию ''false'' |

**Ответ 200** — объект ''TagGroupDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(100) | да | Наименование |
| ''isDeleted'' | boolean |  | Признак удаления; по умолчанию ''false'' |
| ''id'' | integer | да | Идентификатор группы тегов |
| ''usageCount'' | integer |  | Количество использований; по умолчанию ''0'' |

==== Чтение списка элементов справочника "Группы тегов" ====
**''GET /api/v0/tags/groups/list''**\\
Авторизация: требуется

**Параметры запроса:**

^ Параметр ^ Где ^ Тип ^ Обяз. ^ Описание ^
| ''show_deleted'' | строка запроса | boolean |  | Показывать удалённые элементы |

**Ответ 200** — массив объектов ''TagGroupListItemDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(100) | да | Наименование |
| ''isDeleted'' | boolean |  | Признак удаления; по умолчанию ''false'' |
| ''id'' | integer | да | Идентификатор группы тегов |
| ''usageCount'' | integer |  | Количество использований; по умолчанию ''0'' |
| ''tagsCount'' | integer |  | по умолчанию ''0'' |

==== Восстановление удаленного элемента справочника "Группы тегов" по заданному id ====
**''POST /api/v0/tags/groups/restore''**\\
Авторизация: требуется

**Параметры запроса:**

^ Параметр ^ Где ^ Тип ^ Обяз. ^ Описание ^
| ''id'' | строка запроса | integer |  | Идентификатор объекта |

**Ответ 200:** JSON (структура в схеме не описана).

==== Обновление элемента справочника "Группы тегов" ====
**''POST /api/v0/tags/groups/update''**\\
Авторизация: требуется

**Тело запроса** — объект ''TagGroupDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(100) | да | Наименование |
| ''isDeleted'' | boolean |  | Признак удаления; по умолчанию ''false'' |
| ''id'' | integer | да | Идентификатор группы тегов |
| ''usageCount'' | integer |  | Количество использований; по умолчанию ''0'' |

**Ответ 200** — объект ''TagGroupDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(100) | да | Наименование |
| ''isDeleted'' | boolean |  | Признак удаления; по умолчанию ''false'' |
| ''id'' | integer | да | Идентификатор группы тегов |
| ''usageCount'' | integer |  | Количество использований; по умолчанию ''0'' |

==== Добавление элемента справочника "Теги гостей" ====
**''POST /api/v0/tags/insert''**\\
Авторизация: требуется

**Тело запроса** — объект ''TagBaseDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(100) | да | Наименование тега |
| ''isDeleted'' | boolean |  | Признак удаления; по умолчанию ''false'' |
| ''groupId'' | integer | да | ID группы тега |

**Ответ 200** — объект ''TagDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(100) | да | Наименование тега |
| ''isDeleted'' | boolean |  | Признак удаления; по умолчанию ''false'' |
| ''groupId'' | integer | да | ID группы тега |
| ''id'' | integer | да | Идентификатор тега |

==== Чтение списка элементов справочника "Теги гостей" ====
**''GET /api/v0/tags/list''**\\
Авторизация: требуется

**Параметры запроса:**

^ Параметр ^ Где ^ Тип ^ Обяз. ^ Описание ^
| ''show_deleted'' | строка запроса | boolean |  | Показывать удалённые элементы |

**Ответ 200** — массив объектов ''TagListItemDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(100) | да | Наименование тега |
| ''isDeleted'' | boolean |  | Признак удаления; по умолчанию ''false'' |
| ''groupId'' | integer | да | ID группы тега |
| ''id'' | integer | да | Идентификатор тега |
| ''usageCount'' | integer |  | Количество использований; по умолчанию ''0'' |

==== Восстановление удаленного элемента справочника "Теги гостей" по заданному id ====
**''POST /api/v0/tags/restore''**\\
Авторизация: требуется

**Параметры запроса:**

^ Параметр ^ Где ^ Тип ^ Обяз. ^ Описание ^
| ''id'' | строка запроса | integer |  | Идентификатор объекта |

**Ответ 200:** JSON (структура в схеме не описана).

==== Обновление элемента справочника "Теги гостей" ====
**''POST /api/v0/tags/update''**\\
Авторизация: требуется

**Тело запроса** — объект ''TagDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(100) | да | Наименование тега |
| ''isDeleted'' | boolean |  | Признак удаления; по умолчанию ''false'' |
| ''groupId'' | integer | да | ID группы тега |
| ''id'' | integer | да | Идентификатор тега |

**Ответ 200** — объект ''TagDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(100) | да | Наименование тега |
| ''isDeleted'' | boolean |  | Признак удаления; по умолчанию ''false'' |
| ''groupId'' | integer | да | ID группы тега |
| ''id'' | integer | да | Идентификатор тега |

===== Товарные купоны =====

==== Чтение элемента справочника "Товарные купоны" по указанному id ====
**''GET /api/v0/coupons_dish/get''**\\
Авторизация: требуется

**Параметры запроса:**

^ Параметр ^ Где ^ Тип ^ Обяз. ^ Описание ^
| ''id'' | строка запроса | integer | да | Идентификатор объекта |

**Ответ 200** — объект ''CouponDishDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string | да | Наименование |
| ''discountCode'' | integer | да | Код скидки r_keeper (уникальный для купона) |
| ''dishCode'' | integer | да | Код блюда r_keeper |
| ''id'' | integer | да | Идентификатор купона |

Дополнительные коды ответа: ''401'' — Unauthorized.

==== Добавление элемента справочника "Товарные купоны" по указанному id ====
**''POST /api/v0/coupons_dish/insert''**\\
Авторизация: требуется

**Тело запроса** — объект ''CouponDishBaseDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string | да | Наименование |
| ''discountCode'' | integer | да | Код скидки r_keeper (уникальный для купона) |
| ''dishCode'' | integer | да | Код блюда r_keeper |

**Ответ 200** — объект ''CouponDishDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string | да | Наименование |
| ''discountCode'' | integer | да | Код скидки r_keeper (уникальный для купона) |
| ''dishCode'' | integer | да | Код блюда r_keeper |
| ''id'' | integer | да | Идентификатор купона |

Дополнительные коды ответа: ''401'' — Unauthorized.

==== Чтение списка элементов справочника "Товарные купоны" ====
**''GET /api/v0/coupons_dish/list''**\\
Авторизация: требуется

**Ответ 200** — массив объектов ''CouponDishListItemDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string | да | Наименование |
| ''discountCode'' | integer | да | Код скидки r_keeper (уникальный для купона) |
| ''dishCode'' | integer | да | Код блюда r_keeper |
| ''id'' | integer | да | Идентификатор купона |

Дополнительные коды ответа: ''401'' — Unauthorized.

==== Обновление элемента справочника "Товарные купоны" по указанному id ====
**''POST /api/v0/coupons_dish/update''**\\
Авторизация: требуется

**Тело запроса** — объект ''CouponDishDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string | да | Наименование |
| ''discountCode'' | integer | да | Код скидки r_keeper (уникальный для купона) |
| ''dishCode'' | integer | да | Код блюда r_keeper |
| ''id'' | integer | да | Идентификатор купона |

**Ответ 200** — объект ''CouponDishDto'':

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string | да | Наименование |
| ''discountCode'' | integer | да | Код скидки r_keeper (уникальный для купона) |
| ''dishCode'' | integer | да | Код блюда r_keeper |
| ''id'' | integer | да | Идентификатор купона |

Дополнительные коды ответа: ''401'' — Unauthorized.

===== Модели данных =====

Вложенные объекты и перечисления, на которые ссылаются методы этого раздела.

==== AccountStartingBalance ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''sum'' | number |  | Сумма, руб.; мин. 0; макс. 999999999.99 |
| ''lifetime'' | integer |  | Срок жизни начисленных бонусов, дней; мин. 1 |

==== AccountTemplateBaseDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''payLimitPeriod'' | integer |  | Период лимита суммы оплат со счёта |
| ''payLimitAmount'' | number |  | Лимит суммы оплат со счёта; мин. 0; макс. 999999999.99 |
| ''payUseLimitPeriod'' | integer |  | Период лимита количества оплат |
| ''payUseLimitCount'' | integer |  | Лимит количества оплат |
| ''discountLimitPeriod'' | integer |  | Период лимита суммы скидок/бонусов |
| ''discountLimitAmount'' | number |  | Лимит суммы скидок/бонусов; мин. 0; макс. 999999999.99 |
| ''discountUseLimitPeriod'' | integer |  | Период лимита количества применений |
| ''discountUseLimitCount'' | integer |  | Лимит количества применений |
| ''accountGroup'' | [[#iddto|IdDto]] |  | Группа счетов |
| ''messageToScreen'' | string |  | Сообщение для экрана по умолчанию |
| ''messageOnCheck'' | string |  | Сообщение для печати по умолчанию |
| ''discount'' | [[#iddto|IdDto]] |  | Скидка |
| ''rkCode'' | integer |  | Код скидки (бонуса) в r_keeper |
| ''rkBonusTypeCode'' | integer |  | Код типа бонуса в r_keeper |
| ''bonusLifetime'' | integer |  | Срок жизни начисляемых бонусов, дней; мин. 1 |
| ''bonusDelayedDays'' | integer |  | Отложенное начисление бонусов, дней; мин. 1 |
| ''notAwardBonusesIfPaidWithBonuses'' | boolean |  | Не начислять бонусы, если чек оплачен бонусами; по умолчанию ''false'' |
| ''startingBalance'' | [[#accountstartingbalance|AccountStartingBalance]] | да | Стартовый (приветственный) баланс нового счёта |

==== AccountTemplateDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''payLimitPeriod'' | integer |  | Период лимита суммы оплат со счёта |
| ''payLimitAmount'' | number |  | Лимит суммы оплат со счёта; мин. 0; макс. 999999999.99 |
| ''payUseLimitPeriod'' | integer |  | Период лимита количества оплат |
| ''payUseLimitCount'' | integer |  | Лимит количества оплат |
| ''discountLimitPeriod'' | integer |  | Период лимита суммы скидок/бонусов |
| ''discountLimitAmount'' | number |  | Лимит суммы скидок/бонусов; мин. 0; макс. 999999999.99 |
| ''discountUseLimitPeriod'' | integer |  | Период лимита количества применений |
| ''discountUseLimitCount'' | integer |  | Лимит количества применений |
| ''accountGroup'' | [[#iddto|IdDto]] |  | Группа счетов |
| ''messageToScreen'' | string |  | Сообщение для экрана по умолчанию |
| ''messageOnCheck'' | string |  | Сообщение для печати по умолчанию |
| ''discount'' | [[#iddto|IdDto]] |  | Скидка |
| ''rkCode'' | integer |  | Код скидки (бонуса) в r_keeper |
| ''rkBonusTypeCode'' | integer |  | Код типа бонуса в r_keeper |
| ''bonusLifetime'' | integer |  | Срок жизни начисляемых бонусов, дней; мин. 1 |
| ''bonusDelayedDays'' | integer |  | Отложенное начисление бонусов, дней; мин. 1 |
| ''notAwardBonusesIfPaidWithBonuses'' | boolean |  | Не начислять бонусы, если чек оплачен бонусами; по умолчанию ''false'' |
| ''startingBalance'' | [[#accountstartingbalance|AccountStartingBalance]] | да | Стартовый (приветственный) баланс нового счёта |
| ''isRkCodeBonus'' | boolean |  | Код r_keeper является бонусом (а не скидкой) |
| ''isCompositeDiscountBonus'' | boolean |  | Составная скидка начисляет бонусы; по умолчанию ''false'' |
| ''isBonusLifetime'' | boolean |  | У бонусов есть срок жизни; по умолчанию ''false'' |
| ''isBonusDelayed'' | boolean |  | Отложенное начисление бонусов; по умолчанию ''false'' |

==== DiscountLevelDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''rkCode'' | integer | да | Код скидки (бонуса) r_keeper для уровня |
| ''levelAmount'' | number | да | Порог суммы потрат для перехода на уровень; мин. 0; макс. 999999999.99 |
| ''rkBonusTypeCode'' | integer |  | Код типа бонуса r_keeper |
| ''levelName'' | string |  | Название уровня |
| ''isBonus'' | boolean |  | Бонус (а не скидка); по умолчанию ''false'' |

==== IdDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''id'' | integer | да | Идентификатор |