修改子账户接口
更新时间:2023-01-12
1.功能说明
1.1.通过该接口可以修改子账户的相关信息,如:姓名/公司名称、重置密码、账户冻结/禁用等;
1.2.接口调用地址:http(s)://api.guoyangyun.com/api/user/updateAccount.htm
1.4.请求方式:以HTTP POST请求的方式(推荐使用post方式)。
1.5.汉字字符集:UTF-8,请注意参数的大小写。
1.2.接口调用地址:http(s)://api.guoyangyun.com/api/user/updateAccount.htm
1.4.请求方式:以HTTP POST请求的方式(推荐使用post方式)。
1.5.汉字字符集:UTF-8,请注意参数的大小写。
2.输入参数
参数 | 名称 | 类型 | 必须 | 描述 |
公共参数 | 公共参数 | — | 是 | 详见《公共参数和配置》文档 |
username | 子账户名 | String | 是 | 要修改的子账户登录名 |
corp | 姓名/公司名称 | String | 否 |
1. 修改后的姓名/公司名称; 2. 为空则表示不修改。 |
password | 登录密码 | String | 否 |
1. 重置后的密码,为空则表示不修改; 2. 密码必须是6-18位 |
status | 账户状态 | String | 否 |
1. 设置子账户的状态,为空则表示不修改; 2. 状态值:{01=正常、02=冻结、03=禁用} |
3.调用示例
http(s)://api.guoyangyun.com/api/user/updateAccount.htm?appkey=XXXXX&appsecret=XXXXX&username=guoyang001&corp=测试公司&password=Qw94858&status=01
4.Json返回
4.1.返回参数
参数 | 名称 | 类型 | 描述 |
code | 返回码 | String | 提交返回结果。0:表示成功,其他:失败。(状态码详见:《公共错误代码定义》) |
msg | 信息描述 | String | 返回码对应的中文描述。 |
data | 账户信息 | List | 返回修改后的账户信息 |
created | 创建时间 | String | 账户的创建时间 |
modified | 修改时间 | String | 账户最近一次修改时间 |
primaryName | 主账户名 | String | 主账户的登录名称 |
username | 账户名称 | String | 账户登录名称 |
mobile | 手机号码 | String | 账户绑定的手机号码 |
corp | 姓名/公司名称 | String | 账户姓名或者公司名称 |
status | 账户状态 | String | 账户当前状态{01=正常、02=冻结、03=禁用} |
4.2.调用成功样例
{
"msg":"成功",
"code":"0",
"data":{
"created":"2019-09-25 16:00:26",
"modified":"2023-06-29 10:09:54",
"primaryName":"a123456", //主账户名
"username":"test11", //子账户名
"mobile":null,
"corp":"测试公司",
"status":"01" //账户状态:{01=正常、02=冻结、03=禁用}
}
}
4.3.调用失败样例
{
"code":"XXXX",
"msg":"错误提示内容"
}