set.users.delete — Видалення: Користувачі
Призначення
Видаляє запис з довідника Користувачі.
Авторизація
- Логін/пароль: так.
meta.user_card: обов’язково.
Увага
Видалення це найскладніший сценарій у будь-якій системі, бо людям подобається робити незворотні речі, а потім питати “як повернути?”.
Параметри params
| Поле | Тип | Обовʼязково | Опис |
|---|
| id | int | так | Ідентифікатор запису (PK = Ind). |
Правила / обмеження
-
М’яке видалення:
Users.Deleted=1. -
Не можна видалити
Ind=0. -
Не можна видалити самого себе (використовується
meta.user_card->user_id).
Результат
Для цього довідника видалення м’яке (soft-delete): у відповіді буде soft=true, а запис залишиться у таблиці з прапорцем Deleted=1.
Для перегляду таких записів використовуйте:
get.deleted_users.list(спеціальний довідник)- або
get.users.listзinclude_deleted=true
Приклад запиту
Мокап: mockups/dictionaries/users/set.delete/request.json
{
"auth": {
"login": "<LOGIN>",
"password": "<PASSWORD>"
},
"method": "set.users.delete",
"params": {
"id": 2
},
"meta": {
"user_card": "<USER_CARD>",
"client_name": "MyIntegration",
"client_version": "1.0.0"
},
"id": "users-delete-001"
}
Приклад відповіді (успіх)
Мокап: mockups/dictionaries/users/set.delete/response.ok.json
{
"ok": true,
"result": {
"deleted": true,
"soft": true,
"id": 2
},
"meta": {
"api_version": "0.1.0",
"ts": "2026-01-26T12:00:00+00:00"
},
"id": "users-delete-001"
}
Типові помилки
-
NOT_FOUND— запис не знайдено. -
FORBIDDEN— заборонено видаляти службовий запис (наприклад,id=0).