调用该接口更新家的基本信息。
| 路径 | /living/home/update |
| 版本号 | 1.1.0 |
| 协议 | HTTPS |
| 请求方法 | POST |
| 是否需要用户身份鉴权 | 是 |
| 超时时间 | 3000 |
请求参数
| 名称 | 位置 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|---|
| name | String | 否 | xxx的家 | 家的名称。 | |
| homeId | String | 是 | c68f1a8f5f5f4a****6ead2f3219 | 家的ID,生活物联网平台赋予家的唯一标识符。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| code | Int |
接口返回码。200表示成功。 |
|
| message | String |
调用失败时,返回的出错信息。 |
|
| localizedMsg | String |
本地语言的错误消息。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.1.0",
"iotToken": "token"
},
"params":{
"name": "xxx的家",
"homeId": "c68f1a8f5f5f4a****6ead2f3219"
}
}
正常返回示例
JSON 格式
{
"id": "4de2c367-c1db-417c-****-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null
}
异常返回示例
JSON 格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 500,
"message": "server error.",
"localizedMsg": null
}
错误码
| HttpCode | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 500 | 500 | Internal Error | Internal Error |
| 503 | 503 | Service Unavailable | Service Unavailable |
| 403 | 403 | Request Limited | Request Limited |
| 401 | 401 | Empty Signature | Empty Signature |
| 400 | 400 | Request Format Error | Request Format Error |
| 200 | 20003 | Find Backend Error | Find Backend Error |
| 200 | 20004 | Backend Service Error | Backend Service Error |
| 200 | 20055 | Backend Service Invalid | Request Format Error |
| 200 | 20056 | Hsf Invoke Timeout | Hsf Invoke Timeout |
| 200 | 401 | Request Authorized Error | Request Authorized Error |
| 200 | 403 | Request Forbidden | Request Forbidden |
| 200 | 500 | Server Error | Server Error |
| 200 | 28805 | Invalid name. | 仅支持字母、数字和汉字 |
| 200 | 28805 | Invalid name. | 仅支持字母、数字和汉字 |