用户搜索

1 功能说明

搜索用户

2 接口调用说明

2.1 URL
http://yourdomain.kf5.com/api/v1/user/search
2.2 格式

JSON

2.3 HTTP请求方式

GET, POST

2.4 IP限制

2.5 输入参数说明
参数名称是否必须类型描述
namestring用户昵称(参数name和role不能同时为空)
rolestring角色。end_user:普通用户,agent:客服,admin:管理员
currentpageinteger当前显示的数据页数,默认为1,表示第一页
pagesizeinteger每页显示的记录条数,默认为10条
2.6 请求示例
http://yourdomain.kf5.com/api/v1/user/search?name=22&role=end_user&pagesize=15&sign=12d45c66523dd069d7c64c22fea10f34
2.7 返回参数说明
参数名称说明
err返回码。0:执行成功,1:有错误
msg如果错误,返回错误信息。
count查询到的记录总数
currentpage当前显示的第几页
pagesize分页大小
datas返回数据
id用户ID编号
username用户邮箱
name昵称
role角色
organization_id所属组织编号
photo头像
phone电话
details详细信息
notes注释
signature用户签名
status帐号状态
2.8 正确返回示例
Content-type: text/html; charset=utf-8
{
	"err":0,
	"msg":"",
	"count":"3",
	"currentpage":"1",
	"pagesize":"15",
	"datas":{
		"0" : {
			"username":"your@126.com",
			"name":"222",
			"role":"end_user",
			...
		}
		...
	}
}
2.9 错误返回示例
Content-type: text/html; charset=utf-8
{
 	"err":1,
	"msg":"参数错误"
}

3 备注