1. 描述
修改小区。
2. 调用场景
开发者登录超级控制台后,可以修改自己创建的小区。修改仅仅限于可以修改的name,brief等字段。
3. 配置参数
参数意义参考接口参数
| 参数名 | 参数值 | 说明 |
|---|---|---|
| Name | SetVila | |
| URL | https://api.xdua.com/vila | |
| Method | PUT | |
| XduaApiHttpSchema | HTTPS | 只走HTTPS |
| XduaApiMethod | SET | |
| XduaApiColor | X | 只有持有神令牌，才可以创建小区 |
| XduaApiAudience | ConsoleX | 只有vila_id为ConsoleX的小区，也就是consolex.xdua.com才可以发起本请求 |
| XduaApiShop | XdUaXduA | 小区直辖店铺,只有这个店铺的登录人员才可以访问 |
| XduaApiSubject | i | i,只有创建者自己才可以修改 |
| XduaApiRoles | Zoon | 只要登录就可以创建小区 |
| XduaApiResource | vila | |
| XduaApiKparam | id | |
| XduaApiAction | UpdateVila | |
| XduaApiRule | UpdateVila | |
| XduaApiAvilas | 0 | 按序vila,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED) |
| XduaApiEnable | true | 接口使能 |
4. 请求参数
| 名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
|---|---|---|---|---|---|---|
| id | path | string | 是 | rYub4wrT | 要修改的小区ID | |
| name | body | string | 否 | 小区的名称，必须唯一，支持汉字、英文字母、数字、英文格式的下划线，必须以英文字母或汉字开头，4~32个字符 | ||
| avatar | body | string | 否 | 小区图标，不超过40个字符。 | ||
| brief | body | string | 否 | 小区描述，不超过64个字符。 |
|secret |path|string|生成新的secret的kid|后端会用kid连同后台生成的随机数共同生成新的secret|必须 | |igrp |body|string|小区绑定的户群名|examp_ugrp|可选| |name |body|string|小区的名字|小区名字|可选| |brief |body|String|小区的介绍|小区简介|可选| |avatar |body|string|小区的图标url|http://开头的图片地址|可选| |enabled|body|String|使能|0:关闭 1：打开|可选|
5. 返回参数
| 名称 | 位置 | 类型 | 示例 | 说明 |
|---|---|---|---|---|
| id | result | string | rYub4wrT | 修改的小区ID |
| ipdates | result | json dict | 修改的内容 |
示例
result字段
{
"id":"rYub4wrT",
"updates":{
"name":"新的小区名",
"brief":"新的小区介绍",
}
}