查询用户组接口[单条]

  • 接口说明： 查询用户组接口[单条]
  • 接口地址： /api/groups
  • 请求方式： GET

请求参数

参数名称类型描述
idint用户组 id
includestring查询结果需要关联的数据

请求示例

  1. /api/groups/7?include=permission

返回结果

参数名称类型出现要求描述
dataobject查询成功主体数据
data.typestringclassify数据模型的类型
data.idint查询成功用户组 id
data.attributesobject查询成功数据模型的属性
data.attributes.idint查询成功用户组 id
data.attributes.namestring查询成功用户组名称
data.attributes.typestring查询成功用户组类型
data.attributes.colorstring查询成功用户组颜色
data.attributes.iconobject查询成功用户组图标
data.attributes.isPaidboolean查询成功是否收费
data.attributes.feefloat查询成功收费金额
data.attributes.daysboolean查询成功付费获得天数
data.relationshipsint查询成功与 included 里数据的关联关系
data.relationships.groupPermissionstring查询成功关联的类型
data.relationships.groupPermission.dataobject查询成功主题总数
data.relationships.groupPermission.data.typestring查询成功关联的类型
data.relationships.groupPermission.data.idint查询成功关联的 id
includedarray查询成功关联的数据
included.[].typestring查询成功关联的数据类型
included.[].idint查询成功关联的数据 id
included.[].attributesobject查询成功数据的属性
included.[].attributes.group_idint查询成功关联的用户组 ID
included.[].attributes.permissionstring查询成功关联的用户组权限

返回说明

  • 查询成功， http 状态码： 200
  • 修改失败， http 状态码： 404

返回示例

  1. {
  2.   "data": {
  3.     "type": "groups",
  4.     "id": "7",
  5.     "attributes": {
  6.       "id": 7,
  7.       "name": "游客",
  8.       "type": "",
  9.       "color": "",
  10.       "icon": ""
  11.     },
  12.     "relationships": {
  13.       "groupPermission": {
  14.         "data": [
  15.           {
  16.             "type": "groupPermission",
  17.             "id": "3273"
  18.           },
  19.           {
  20.             "type": "groupPermission",
  21.             "id": "2342"
  22.           }
  23.         ]
  24.       }
  25.     }
  26.   },
  27.   "included": [
  28.     {
  29.       "type": "groupPermission",
  30.       "id": "3273",
  31.       "attributes": {
  32.         "group_id": 7,
  33.         "permission": "group.viewGroup"
  34.       }
  35.     },
  36.     {
  37.       "type": "groupPermission",
  38.       "id": "2342",
  39.       "attributes": {
  40.         "group_id": 7,
  41.         "permission": "groupPermission.updateGroupPermission"
  42.       }
  43.     }
  44.   ]
  45. }