家人用户服务接口

更新时间：2018-12-29 16:32:02

公共字段

以下参数通过登录信息中提取，不需要每次调用的时候传递

参数名称 参数
用户ID identityId
租户ID tenantId
登录用户租户ID identityTenantId
appKey appKey
资源隔离ID isolationId
环境（开发，线上） env
调用方Ip clientIp
语言 language
地理位置、ip locale

人车通行中的家人

1. 创建家人

定义描述

path 版本 描述 是否需要用户身份的鉴权
/uc/virtual/user/create 1.0.4 创建当前登录用户名下的家人 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 描述
attrList List 否 用户的属性及属性值。 若为空,则表示只创建一个无属性的用户。属性Key必须是在规定的系统属性中选择，具体系统属性定义参见虚拟用户属性定义表

attrList列表结构

参数 类型 必填 描述
attrKey String 是 属性Key
attrValue String 是 属性值

返回参数

参数 类型 描述
userId String 创建的家人用户ID
attrList List 用户的属性值，意义同请求参数

attrList列表结构

参数 类型 必填 描述
attrKey String 是 属性Key
attrValue String 是 属性值

示例

请求示例

{
    "request": {
        "iotToken": "{token}",
        "apiVer": "1.0.4"
    },
    "id": 1508212818676,
    "params": {
        "attrList": [
              {
                 "attrKey":"name",
                 "attrValue":"爷爷"
              }
        ]
    },
    "version": "1.0"
}

正常返回示例

{
    "code": 200,
    "message": "success",
    "data": {
        "userId":"AAAAAAAAAAFF99BDD428F58AA5A18",
        "attrList":[
            {
               "attrKey":"name",
               "attrValue":"爷爷"
            }
        ]
    }
}

异常返回示例

{
 "code":503,
 "id":"4fa207ca-fffd-48bb-94b8-e6f7ca6c99c3",
 "localizedMsg":"服务不可用",
 "message":"service not available."
}

错误码

请参考公共错误码

2. 获取家人用户列表

定义描述

path 版本 描述 是否需要用户身份的鉴权
/uc/virtual/user/list 1.0.4 查询当前登录用户名下的家人用户列表 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 描述
pageNo Integer 是 当前页号，从1开始的页序号
pageSize Integer 是 页大小，单页的item数量上限

返回参数

参数 类型 描述
total Long 家人用户总数
pageNo Integer 当前页号
pageSize Integer 页大小
data List 家人用户列表

data列表结构

参数 类型 必填 描述
userId String 是 家人用户ID
attrList List 是 用户的属性及属性值。属性Key必须是在规定的系统属性中选择，具体系统属性定义参见虚拟用户属性定义表

attrList列表结构

参数 类型 必填 描述
attrKey String 是 属性Key
attrValue String 是 属性值

示例

请求示例

{
    "request": {
        "iotToken": "{token}",
        "apiVer": "1.0.4"
    },
    "id": 1508212818676,
    "params": {
           "pageNo":1,
           "pageSize":10
    },
    "version": "1.0"
}

正常返回示例

{
    "code": 200,
    "message": "success",
    "data": {
        "total":1,
        "pageNo":1,
        "pageSize":10,
        "data":[
            {
                "userId":"AAAAAAAAAAAA4FF99BDD428F58AA5A18",
                "attrList":[
                   {
                       "attrKey":"name",
                       "attrValue":"爷爷"
                   }
                ]
            }
        ]
    }
}

异常返回示例

{
 "code":503,
 "id":"4fa207ca-fffd-48bb-94b8-e6f7ca6c99c3",
 "localizedMsg":"服务不可用",
 "message":"service not available."
}

错误码

请参考公共错误码

3. 更新家人用户基础信息

定义描述

path 版本 描述 是否需要用户身份的鉴权
/uc/virtual/user/update 1.0.4 更新当前登录用户名下的虚拟用户信息 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 描述
virtualUserId String 是 虚拟用户ID
opType Integer 是 更新时属性时的操作类型(opType)的类型,目前仅支持三种:1:ADD,2:UPDATE,3:DELETE
attrList List 是 用户的属性及属性值。属性Key必须是在规定的系统属性中选择，具体系统属性定义参见虚拟用户属性定义表

attrList列表结构

参数 类型 必填 描述
attrKey String 是 属性Key
attrValue String 是 属性值

返回参数

参数 类型 描述
userId String 创建的虚拟用户ID
attrList List 用户的属性值，意义同请求参数

attrList列表结构

参数 类型 必填 描述
attrKey String 是 属性Key
attrValue String 是 属性值

示例

请求示例

{
    "request": {
        "iotToken": "{token}",
        "apiVer": "1.0.4"
    },
    "id": 1508212818676,
    "params": {
           "userId":"1AAAAAAAAAAA9BDD428F58AA5A18",
           "opType":2,
           "attrList":[
               {
                    "attrKey":"name",
                    "attrValue":"小李"
               }
           ]
    },
    "version": "1.0"
}

正常返回示例

{
    "code": 200,
    "message": "success",
    "data": {
        "userId":"AAAAAAAAAAA4FF99BDD428F58AA5A18",
        "attrList":[
            {
               "attrKey":"name",
               "attrValue":"小明"
            }
        ]
    }
}

异常返回示例

{
 "code":503,
 "id":"4fa207ca-fffd-48bb-94b8-e6f7ca6c99c3",
 "localizedMsg":"服务不可用",
 "message":"service not available."
}

错误码

错误码 错误信息 来源 详细描述
28528 operation type not support. 业务 不支持当前传入的虚拟用户信息更新操作类型
28529 virtual user attr list is empty. 业务 虚拟用户的属性列表为空

4. 删除家人

定义描述

path 版本 描述 是否需要用户身份的鉴权
/uc/virtual/user/delete 1.0.4 删除当前登录用户名下的虚拟用户 是，客户端SDK需启用身份的鉴权

请求参数

参数 类型 必填 描述
virtualUserId String 是 虚拟用户ID

返回参数

参数 类型 描述

示例

请求示例

{
    "request": {
        "iotToken": "{token}",
        "apiVer": "1.0.4"
    },
    "id": 1508212818676,
    "params": {
           "userId":"1AAAAAAAAAAAAFF99BDD428F58AA5A18"
    },
    "version": "1.0"
}

正常返回示例

{
    "code": 200,
    "message": "success",
    "data": null
}

异常返回示例

{
 "code":503,
 "id":"4fa207ca-fffd-48bb-94b8-e6f7ca6c99c3",
 "localizedMsg":"服务不可用",
 "message":"service not available."
}

错误码

请参考公共错误码

results matching ""

    No results matching ""