Skip to content

Role ​

INFO

Har bir javob umumiy konvertda qaytadi — code, message, messages, status_code, time — foydali yuk esa data ichida. Quyidagi jadvallar faqat data ichini tavsiflaydi.

POST /role/create ​

Create a role with its permission access map.

So‘rov tanasi

MaydonTurMajburiyTavsif
namestringHaRole name
accessobjectHapermission map: key → access degree (a|s|r|d)
web_accessobjectYo‘qpermission map for the web back-office surface
mobile_accessobjectYo‘qpermission map for the mobile/POS surface
json
{
  "name": "string",
  "access": {},
  "web_access": {},
  "mobile_access": {}
}

Javob

MaydonTurTavsif
_idstring
namestring
webboolean
mobileboolean
json
{
  "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.

So‘rov tanasi

MaydonTurMajburiyTavsif
namestringHaRole name
accessobjectHapermission map: key → access degree (a|s|r|d)
web_accessobjectYo‘qpermission map for the web back-office surface
mobile_accessobjectYo‘qpermission map for the mobile/POS surface
_idstringHa
json
{
  "name": "string",
  "access": {},
  "web_access": {},
  "mobile_access": {},
  "_id": "string"
}

Javob

Javob tuzilishi quyidagi bilan bir xil: POST /role/create.

DELETE /role/delete/{id} ​

Delete a role

Yo‘l parametrlari

ParametrTurMajburiyTavsif
idstringHa

So‘rov tanasi

So‘rov tanasi talab qilinmaydi.

Javob

json
{
  "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

Yo‘l parametrlari

ParametrTurMajburiyTavsif
idstringHa

So‘rov tanasi

So‘rov tanasi talab qilinmaydi.

Javob

Javob tuzilishi quyidagi bilan bir xil: POST /role/create.

POST /role/get-paging ​

Get roles by paging

So‘rov tanasi

MaydonTurMajburiyTavsif
pagenumberHaStandart: 1
limitnumberHaStandart: 20
searchstringYo‘q
ninstring[]Yo‘q
json
{
  "page": 1,
  "limit": 20,
  "search": "string",
  "nin": [
    "63f8b0c4e4b0d3a2f8e4b0c4"
  ]
}

Javob

data.total — jami yozuvlar soni, data.data[] — joriy sahifadagi yozuvlar. Quyidagi jadval bitta yozuvni tavsiflaydi.

MaydonTurTavsif
_idstring
namestring
webboolean
mobileboolean
json
{
  "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"
}

Bu sahifa OpenAPI spetsifikatsiyasidan yaratilgan.

Bito 2.0 Integration API