Role

INFO

Каждый ответ приходит в общем конверте — code, message, messages, status_code, time — а полезная нагрузка лежит в data. Таблицы ниже описывают содержимое data.

POST /role/create

Create a role with its permission access map.

Тело запроса

Поле	Тип	Обязательно	Описание
name	string	Да	Role name
access	object	Да	permission map: key → access degree (a|s|r|d)
web_access	object	Нет	permission map for the web back-office surface
mobile_access	object	Нет	permission map for the mobile/POS surface

{
  "name": "string",
  "access": {},
  "web_access": {},
  "mobile_access": {}
}

Ответ

Поле	Тип	Описание
_id	string
name	string
web	boolean
mobile	boolean

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "_id": "string",
    "name": "string",
    "web": false,
    "mobile": false
  },
  "time": "2025-05-01T12:00:00Z"
}

PUT /role/update

Update an existing role and its permission access map.

Тело запроса

Поле	Тип	Обязательно	Описание
name	string	Да	Role name
access	object	Да	permission map: key → access degree (a|s|r|d)
web_access	object	Нет	permission map for the web back-office surface
mobile_access	object	Нет	permission map for the mobile/POS surface
_id	string	Да

{
  "name": "string",
  "access": {},
  "web_access": {},
  "mobile_access": {},
  "_id": "string"
}

Ответ

Структура ответа совпадает с POST /role/create.

DELETE /role/delete/{id}

Delete a role

Параметры пути

Параметр	Тип	Обязательно	Описание
id	string	Да

Тело запроса

Тело запроса не требуется.

Ответ

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": "ok",
  "time": "2025-05-01T12:00:00Z"
}

GET /role/get-by-id/{id}

Get role using its _id

Параметры пути

Параметр	Тип	Обязательно	Описание
id	string	Да

Тело запроса

Тело запроса не требуется.

Ответ

Структура ответа совпадает с POST /role/create.

POST /role/get-paging

Get roles by paging

Тело запроса

Поле	Тип	Обязательно	Описание
page	number	Да	По умолчанию: 1
limit	number	Да	По умолчанию: 20
search	string	Нет
nin	string[]	Нет

{
  "page": 1,
  "limit": 20,
  "search": "string",
  "nin": [
    "63f8b0c4e4b0d3a2f8e4b0c4"
  ]
}

Ответ

data.total — общее количество записей, data.data[] — записи текущей страницы. Таблица ниже описывает одну запись.

Поле	Тип	Описание
_id	string
name	string
web	boolean
mobile	boolean

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "total": 0,
    "data": [
      {
        "_id": "string",
        "name": "string",
        "web": false,
        "mobile": false
      }
    ]
  },
  "time": "2025-05-01T12:00:00Z"
}

---

Эта страница сгенерирована из спецификации OpenAPI.