1. 描述

修改房人信息。本接口是Butler可以访问的,Butler几乎可以修改Rosr的所有属性。在未来,Rosr的不重要属性可以被其它角色修改。

2. 调用场景

开发者登录超级控制台后,可以修改自己创建的房人。开发者以God角色修改房人。未来可能开放给专门的房人/设备运维。

3. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name SetRosr
URL https://api.xdua.com/rosr
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod SET
XduaApiColor X 只有持有神房人,才可以创建房人
XduaApiAudience ConsoleX 只有rosr_id为ConsoleX的房人,也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 房人直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i i,只有创建者自己才可以修改
XduaApiRoles Butler 只要登录就可以创建房人
XduaApiResource rosr
XduaApiKparam id
XduaApiAction UpdateRosr
XduaApiRule UpdateRosr
XduaApiAstates 0 按序rosr,zone,corp,shop,rosr,rosr,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

4. 请求参数

名称 位置 类型 必填 默认值 示例 说明
id path String 6tYu82hM 房人ID
type body String Mats 房人类型代码,本字段受rosr_type表的code字段外键约束
name body String "803刘姥姥的房间" 房人的平台系统名字,由录入者定义

[!note|label:为什么修改操作只能修改type和name?] 因为rosr本身就是两个元素room和usro的搭配,修改任何一个的效果等同于删除重建。

5. 返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 修改的房人ID
updates result json dict 修改的内容

示例

result字段

{
    "id":"rYub4wrT",
    "updates":{
        "name":"新的房人名",
        "brief":"新的房人介绍",    
    }    
}

6. 错误码

错误码来自于error字段,通用错误码参考地球号通用错误码

7. SDK调用

为了方便测试SetRosr接口。数据库专门提供了一个测试房人rosr_id=TeStTeSt。可以对这个房人的所有属性进行修改,而不用担心损坏数据库。

const XduaClient = require('lovearth-xdua-browser-sdk')
const xduaClient = await XduaClient({
    LOGIN_TOKEN:"eyJhbGciOi...",//开发者在地球号开发者网站创建的登录令牌
})

/*----------------------------
 * 运行如下代码
 * 下面的代码是直接可以运行的
 *--------------------------*/
api_name = "修改房人";
const rosr_id ="TeStTeSt"; //要修改的房人ID

/*----------------------------
 * 下面展示的是修改"TeStTeSt"所有属性的操作,实际上可以只修改其中任何一个到两个参数
 *--------------------------*/
const set_params = {
    type:"Test",        //类别
    name:"测试房人",    //名字
}

const res_api = await xduaClient.setRosr(rosr_id,set_params)

if(res.error == 0){
    console.log("测试成功");    
}else{
    console.log("测试失败");   
    console.log(res); 
}

文档还没有实现

```

{% sample lang="php" -%}

文档还没有实现

```bash

results matching ""

    No results matching ""