1. 描述
创建社卷。
2. 调用场景
开发者登录http://consoler.{zond_id}.xdua.com后,可以以Super社卷创建自己的社卷。
3. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | AddRouer | |
Url | https://api.xdua.com/rouer | |
Method | POST | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | ADD | |
XduaApiColor | X | 只有持有神令牌,才可以创建社卷 |
XduaApiAudience | {zone_console_app_id} |
只有app_id为{zone_console_app_id} 的应用,也就是consoler.xdua.com才可以发起本请求 |
XduaApiShop | {zone_id} |
社卷直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | u | 需要登录 |
XduaApiRoles | Super | Super可以创建社卷 |
XduaApiResource | role | |
XduaApiKparam | name | |
XduaApiAction | CreateRouer | |
XduaApiRule | CreateRouer | |
XduaApiAstates | 0 | |
XduaApiEnable | true | 接口使能 |
4. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 | |
---|---|---|---|---|---|---|---|
shop_id | body | String | 是 | 在哪个户群创建社卷 | ugrp的代号 | ||
name | body | string | 是 | 健康手环 | 社卷的名称,必须唯一,支持汉字、英文字母、数字、英文格式的下划线,必须以英文字母或汉字开头,4~32个字符 | ||
avatar | body | string | 否 | 社卷图标,不超过40个字符。 | |||
brief | body | string | 否 | 社卷描述,不超过64个字符。 | |||
code | body | string | 是 | Super | 社卷的代号,16个字符以内,小写字母,数字和字母,不能有特殊符号,一旦创建,不可修改 | ||
granter | body | string | 是 | Super | 授权社卷代号,code标准格式 |
5. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 创建的社卷ID |
6. 错误码
7. 描述
删除社卷。
8. 调用场景
根用户在http://consoler.{zond_id}.xdua.com登录. 它会让资源永久消失。。
9. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | DelRouer | |
URL | https://api.xdua.com/rouer | |
Method | DELETE | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | DEL | |
XduaApiColor | X | 只有持有神令牌,才可以创建社卷 |
XduaApiAudience | {zone_console_app_id} |
只有app_id为{zone_console_app_id} 的应用,也就是consoler.xdua.com才可以发起本请求 |
XduaApiShop | {zone_id} |
社卷直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只有资源创建者自己可以访问这个口 |
XduaApiRoles | Super | Super可以删除社卷 |
XduaApiResource | role | |
XduaApiKparam | id | |
XduaApiAction | DeleteRouer | |
XduaApiRule | DeleteRouer | |
XduaApiAstates | 0 | 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
10. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
id | path | string | 是 | rYub4wrT | 要删除的社卷ID |
11. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 删除的社卷ID |
12. 错误码
13. 描述
关闭社卷。
14. 调用场景
神管理员登录http://consoler.{zond_id}.xdua.com后,可以关闭普通开发者的社卷。使得社卷进入DISABLED状态,也只有Super角色重新打开这个社卷。
管理员(Super)
- 登录http://consoler.{zond_id}.xdua.com后,
- 根据条件查询社卷,条件是某个社卷。
- 点击
冻结
,可以关闭社卷。
15. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | DisRouer | |
URL | https://api.xdua.com/rouer | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | DIS | |
XduaApiColor | X | 只有持有神令牌,才可以创建社卷 |
XduaApiAudience | {zone_console_app_id} |
只有app_id为{zone_console_app_id} 的应用,也就是consoler.xdua.com才可以发起本请求 |
XduaApiShop | {zone_id} |
社卷直辖社卷,只有这个社卷的登录人员才可以访问 |
XduaApiSubject | u | 必须是创建者才可以自闭社卷 |
XduaApiRoles | Super | 只有神级管理员才可以关闭普通开发者的社卷 |
XduaApiResource | role | |
XduaApiKparam | id | |
XduaApiAction | DisableRouer | |
XduaApiRule | DisableRouer | |
XduaApiAstates | 0,0 或者0 |
按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
16. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
id | path | string | 是 | rYub4wrT | 要删除的社卷ID |
17. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 删除的社卷ID |
18. 错误码
19. 描述
软删社卷。
20. 调用场景
开发者登录http://consoler.{zond_id}.xdua.com后,可以点击自己的社卷,然后删除掉。如果哪天后悔了,可以联系Super来恢复。
21. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | DolRouer | |
URL | https://api.xdua.com/rouer | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | DOL | |
XduaApiColor | X | 只有持有神令牌,才可以创建社卷 |
XduaApiAudience | {zone_console_app_id} |
只有app_id为{zone_console_app_id} 的应用,也就是consoler.xdua.com才可以发起本请求 |
XduaApiShop | {zone_id} |
社卷直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只有创建者自己才能删除自己创建的社卷 |
XduaApiRoles | Super | 只要登录就可以创建社卷 |
XduaApiResource | role | |
XduaApiKparam | id | |
XduaApiAction | DeletoRouer | |
XduaApiRule | DeletoRouer | |
XduaApiAstates | 0 | 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
22. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
id | path | string | 是 | rYub4wrT | 要删除的社卷ID |
23. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 删除的社卷ID |
24. 错误码
25. 描述
打开社卷。
26. 调用场景
管理员(Super)
- 登录http://consoler.xdua.com后,
- 根据条件查询社卷,条件是某个被冻结的社卷。
- 点击
解冻
,可以解冻店铺。
27. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | EnbRouer | |
URL | https://api.xdua.com/rouer | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | ENB | |
XduaApiColor | X | 只有持有神令牌,才可以创建社卷 |
XduaApiAudience | {zone_console_app_id} |
只有app_id为{zone_console_app_id} 的应用,也就是consoler.xdua.com才可以发起本请求 |
XduaApiShop | {zone_id} |
社卷直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | u | 神登录后解冻开发者的社卷 |
XduaApiRoles | Super | 只有神才可以解冻社卷 |
XduaApiResource | role | |
XduaApiKparam | id | |
XduaApiAction | EnableRouer | |
XduaApiRule | EnableRouer | |
XduaApiAstates | 0 | 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
28. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
id | path | string | 是 | rYub4wrT | 要删除的社卷ID |
29. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 删除的社卷ID |
30. 错误码
31. 描述
详情社卷。
32. 调用场景
管理员登录http://consoler.{zond_id}.xdua.com后,可以随意查询能看见的所有社卷列表。点击其中一个社卷(不管是不是自己的),就可以点击访问。
33. 配置参数
参数名 | 参数值 | 说明 |
---|---|---|
URL | https://api.xdua.com/rouer | |
Method | GET | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | GET | |
XduaApiColor | X | 只有持有神令牌,才可以创建社卷 |
XduaApiAudience | {zone_console_app_id} |
只有app_id为{zone_console_app_id} 的应用,也就是consoler.xdua.com才可以发起本请求 |
XduaApiShop | {zone_id} |
社卷直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | u | !表示除了允许匿名用户之外的所有用户访问 |
XduaApiRoles | Super | 只要Super才可以访问其它用户的社卷 |
XduaApiResource | role | |
XduaApiKparam | id | |
XduaApiAction | GetRouer | |
XduaApiRule | GetRouer | |
XduaApiRouerAstate | 0 | 令牌zone.state必须是0(STATE_ENABLED) |
XduaApiCorpAstate | 0 | 令牌corp.state必须是0(STATE_ENABLED) |
XduaApiShopAstate | 0 | 令牌shop.state必须是0(STATE_ENABLED) |
XduaApiUserAstate | 0 | 令牌user.state必须是0(STATE_ENABLED) |
XduaApiAppAstate | 0 | 令牌 app.state必须是0(STATE_ENABLED) |
XduaApiTokenAstate | 0 | 令牌token.state必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
34. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
id | path | string | 是 | rYub4wrT | 要修改的社卷ID |
35. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 详情的社卷ID |
name | result.data | string | 社卷的名称 | |
avatar | result.data | string | 社卷图标 | |
brief | result.data | string | 社卷的描述 | |
state | result.data | int | 1 | 社卷的状态 |
stato | result.data | string | "冻服更新" | 社卷的状态说明 |
expire | result.data | int | 0 | 社卷状态过期时间(UNIX时间戳) |
creator_id | result.list[] | string | Dmtv7TrE | 社卷创建者ID |
creator_name | result.list[] | string | 辣椒帅 | 社卷创建者名字 |
updator_id | result.list[] | string | XiyRvUp3 | 社卷最近一次更新者ID |
updator_name | result.list[] | string | 周海潮 | 社卷最近一次更新者名字 |
cstamp | result.data | string | 2020-01-20 02:19:55 | 社卷创建时间 |
ustamp | result.data | string | 2020-01-20 02:23:24 | 社卷最近更新时间 |
返回示例
result部分
{
"id":"rYub4wrT",
"data": {
},
}
36. 错误码
37. 描述
私详社卷。
38. 调用场景
开发者登录http://consoler.{zond_id}.xdua.com后,在社卷列表,选择社卷,点击详情,就可以查看自己的社卷。GIT的默认字段和GET不一样。
39. 配置参数
参数名 | 参数值 | 说明 |
---|---|---|
URL | https://api.xdua.com/rouer | |
Method | GET | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | GIT | |
XduaApiColor | X | 只有持有神令牌,才可以创建社卷 |
XduaApiAudience | {zone_console_app_id} |
只有app_id为{zone_console_app_id} 的应用,也就是consoler.xdua.com才可以发起本请求 |
XduaApiShop | {zone_id} |
社卷直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只有自己才可以访问自己创建的社卷 |
XduaApiRoles | Super | 只要登录就可以创建社卷 |
XduaApiResource | role | |
XduaApiKparam | id | |
XduaApiAction | GetRouer | |
XduaApiRule | GetRouer | |
XduaApiRouerAstate | 0 | 令牌zone.state必须是0(STATE_ENABLED) |
XduaApiCorpAstate | 0 | 令牌corp.state必须是0(STATE_ENABLED) |
XduaApiShopAstate | 0 | 令牌shop.state必须是0(STATE_ENABLED) |
XduaApiUserAstate | 0 | 令牌user.state必须是0(STATE_ENABLED) |
XduaApiAppAstate | 0 | 令牌 app.state必须是0(STATE_ENABLED) |
XduaApiTokenAstate | 0 | 令牌token.state必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
40. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
id | path | string | 是 | rYub4wrT | 要修改的社卷ID |
41. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 详情的社卷ID |
name | result.data | string | 社卷的名称 | |
avatar | result.data | string | 社卷图标 | |
brief | result.data | string | 社卷的描述 | |
state | result.data | int | 1 | 社卷的状态 |
stato | result.data | string | "冻服更新" | 社卷的状态说明 |
expire | result.data | int | 0 | 社卷状态过期时间(UNIX时间戳) |
creator_id | result.list[] | string | Dmtv7TrE | 社卷创建者ID |
creator_name | result.list[] | string | 辣椒帅 | 社卷创建者名字 |
updator_id | result.list[] | string | XiyRvUp3 | 社卷最近一次更新者ID |
updator_name | result.list[] | string | 周海潮 | 社卷最近一次更新者名字 |
cstamp | result.data | string | 2020-01-20 02:19:55 | 社卷创建时间 |
ustamp | result.data | string | 2020-01-20 02:23:24 | 社卷最近更新时间 |
返回示例
result部分
{
"id":"rYub4wrT",
"data": {
},
}
42. 错误码
43. 描述
下线社卷。
44. 调用场景
开发者登录http://consoler.{zond_id}.xdua.com后,可以下线自己创建的社卷。
45. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | OffRouer | |
URL | https://api.xdua.com/rouer | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | OFF | |
XduaApiColor | X | 只有持有神令牌,才可以创建社卷 |
XduaApiAudience | {zone_console_app_id} |
只有app_id为{zone_console_app_id} 的应用,也就是consoler.xdua.com才可以发起本请求 |
XduaApiShop | {zone_id} |
社卷直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只能社卷的创建者才能下线自己的社卷 |
XduaApiRoles | Super | 只要登录就可以创建社卷 |
XduaApiResource | role | |
XduaApiKparam | id | |
XduaApiAction | OfflineRouer | |
XduaApiRule | OfflineRouer | |
XduaApiAstates | 0 | 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
46. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
id | path | string | 是 | rYub4wrT | 要删除的社卷ID |
47. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 删除的社卷ID |
48. 错误码
49. 描述
发布社卷。
50. 调用场景
开发者登录http://consoler.{zond_id}.xdua.com后,可以下线/发布自己的社卷。这个动作是管理员不能干涉的。
51. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | PubRouer | |
URL | https://api.xdua.com/rouer | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | PUB | |
XduaApiColor | X | 只有持有神令牌,才可以创建社卷 |
XduaApiAudience | {zone_console_app_id} |
只有app_id为{zone_console_app_id} 的应用,也就是consoler.xdua.com才可以发起本请求 |
XduaApiShop | {zone_id} |
社卷直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 只有社卷的创建者自己才能上下线自己的社卷 |
XduaApiRoles | Super | 只要登录就可以创建社卷 |
XduaApiResource | role | |
XduaApiKparam | id | |
XduaApiAction | OnlineRouer | |
XduaApiRule | OnlineRouer | |
XduaApiAstates | 0 | 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
52. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
id | path | string | 是 | rYub4wrT | 要删除的社卷ID |
53. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 删除的社卷ID |
54. 错误码
55. 描述
私查社卷。
56. 调用场景
开发者登录http://consoler.xdua.com后,可以以Super角色查询所有社卷。
57. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | QriRouer | |
URL | https://api.xdua.com/rouer | |
Method | GET | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | QRI | |
XduaApiColor | X | 只有持有神令牌,才可以创建社卷 |
XduaApiAudience | {zone_console_app_id} |
只有app_id为{zone_console_app_id} 的应用,也就是consoler.xdua.com才可以发起本请求 |
XduaApiShop | {zone_id} |
社卷直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | u | 所有注册用户均可以使用 |
XduaApiRoles | Super | 必须是Super才可以查询角色 |
XduaApiResource | role | |
XduaApiKparam | where |
常量 |
XduaApiAction | QueriRouer | |
XduaApiRule | QueriRouer | |
XduaApiAstates | 0 | 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
58. URL
GET:https://api.xdua.com/rouer
59. 请求参数
60. 返回参数
result.list部分
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 详情的社卷ID |
name | result.list[] | string | 社卷的名称 | |
avatar | result.list[] | string | 社卷图标 | |
brief | result.list[] | string | 社卷的描述 | |
state | result.list[] | int | 0 | 社卷的状态 |
stato | result.list[] | string | "冻服更新" | 社卷的状态说 |
expire | result.list[] | int | 0 | 社卷状态过期时间(UNIX时间戳) |
creator_id | result.list[] | string | Dmtv7TrE | 社卷创建者ID |
creator_name | result.list[] | string | 辣椒帅 | 社卷创建者名字 |
updator_id | result.list[] | string | XiyRvUp3 | 社卷最近一次更新者ID |
updator_name | result.list[] | string | 周海潮 | 社卷最近一次更新者名字 |
cstamp | result.list[] | string | 2020-01-20 02:19:55 | 社卷创建时间 |
ustamp | result.list[] | string | 2020-01-20 02:23:24 | 社卷最近更新时间 |
61. 错误码
62. 描述
查询社卷。
63. 调用场景
开发者登录http://consoler.xdua.com后,可以以Super角色查询属于自己名下的所有社卷。
64. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | QryRouer | |
URL | https://api.xdua.com/rouer | |
Method | GET | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | QRY | |
XduaApiColor | X | 只有持有神令牌,才可以创建社卷 |
XduaApiAudience | {zone_console_app_id} |
只有app_id为{zone_console_app_id} 的应用,也就是consoler.xdua.com才可以发起本请求 |
XduaApiShop | {zone_id} |
社卷直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | u | 所有注册用户均可以使用 |
XduaApiRoles | Super | 必须是Super才可以查询角色 |
XduaApiResource | role | |
XduaApiKparam | where |
常量where |
XduaApiAction | QueryRouer | |
XduaApiRule | QueryRouer | |
XduaApiAstates | 0 | 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
65. URL
GET:https://api.xdua.com/rouer
66. 请求参数
67. 返回参数
result.list部分
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 详情的社卷ID |
name | result.list[] | string | 社卷的名称 | |
avatar | result.list[] | string | 社卷图标 | |
brief | result.list[] | string | 社卷的描述 | |
state | result.list[] | int | 0 | 社卷的状态 |
stato | result.list[] | string | "冻服更新" | 社卷的状态说 |
expire | result.list[] | int | 0 | 社卷状态过期时间(UNIX时间戳) |
creator_id | result.list[] | string | Dmtv7TrE | 社卷创建者ID |
creator_name | result.list[] | string | 辣椒帅 | 社卷创建者名字 |
updator_id | result.list[] | string | XiyRvUp3 | 社卷最近一次更新者ID |
updator_name | result.list[] | string | 周海潮 | 社卷最近一次更新者名字 |
cstamp | result.list[] | string | 2020-01-20 02:19:55 | 社卷创建时间 |
ustamp | result.list[] | string | 2020-01-20 02:23:24 | 社卷最近更新时间 |
68. 错误码
69. 描述
回收社卷。
70. 调用场景
管理员应开发者的要求,登录http://consoler.{zond_id}.xdua.com后,查询到某个开发者下面的被删除的社卷。然后回收。开发者刷新就可以看到了。为此,开发者要提供自己的uid和要回收的社卷的名字。
71. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | RccRouer | |
URL | https://api.xdua.com/rouer | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | RCC | |
XduaApiColor | X | 只有持有神令牌,才可以创建社卷 |
XduaApiAudience | {zone_console_app_id} |
只有app_id为{zone_console_app_id} 的应用,也就是consoler.xdua.com才可以发起本请求 |
XduaApiShop | {zone_id} |
社卷直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | u | u表示除了允许匿名用户之外的所有用户访问 |
XduaApiRoles | Super | 只要登录就可以创建社卷 |
XduaApiResource | role | |
XduaApiKparam | id | |
XduaApiAction | RecycleRouer | |
XduaApiRule | RecycleRouer | |
XduaApiAstates | 0 | 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
72. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
id | path | string | 是 | rYub4wrT | 要删除的社卷ID |
73. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 删除的社卷ID |
74. 错误码
75. 描述
修改社卷。
76. 调用场景
开发者登录http://consoler.{zond_id}.xdua.com后,可以修改自己创建的社卷。修改仅仅限于可以修改的name,brief等字段。
77. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | SetRouer | |
URL | https://api.xdua.com/rouer | |
Method | PUT | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | SET | |
XduaApiColor | X | 只有持有神令牌,才可以创建社卷 |
XduaApiAudience | {zone_console_app_id} |
只有app_id为{zone_console_app_id} 的应用,也就是consoler.xdua.com才可以发起本请求 |
XduaApiShop | {zone_id} |
社卷直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | i,只有创建者自己才可以修改 |
XduaApiRoles | Super | 只要登录就可以创建社卷 |
XduaApiResource | role | |
XduaApiKparam | id | |
XduaApiAction | UpdateRouer | |
XduaApiRule | UpdateRouer | |
XduaApiAstates | 0 | 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
78. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
id | path | string | 是 | rYub4wrT | 要修改的社卷ID | |
name | body | string | 否 | 社卷的名称,必须唯一,支持汉字、英文字母、数字、英文格式的下划线,必须以英文字母或汉字开头,4~32个字符 | ||
avatar | body | string | 否 | 社卷图标,不超过40个字符。 | ||
brief | body | string | 否 | 社卷描述,不超过64个字符。 |
79. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 修改的社卷ID |
updates | result | json dict | 修改的内容 |
示例
result字段
{
"id":"rYub4wrT",
"updates":{
"name":"新的社卷名",
"brief":"新的社卷介绍",
}
}