User API - Mrdaigithub/crm GitHub Wiki

User API

功能描述：

  • 获取用户列表信息

请求URL：

  • http://xx.com/api/v1/users/

请求方式：

  • GET

参数：

参数名 必选 类型 说明

返回示例

[
	{
		"user_id": "1",
		"username": "root",
		"user_state": "1",
		"user_tel": "13000000000",
		"role_id": "1",
		"role_name": "root组"
	},
	{
		"user_id": "2",
		"username": "kefu",
		"user_state": "0",
		"user_tel": "13477777777",
		"role_id": "2",
		"role_name": "admin1"
	},
        ...
]

返回参数说明

参数名 类型 说明
user_id Number 用户ID
username String 用户名
user_state Number 用户启用状态
user_tel Number 用户手机号
role_id Number 权限组ID
role_name String 权限组名称

错误状态码

参数名 说明
40010 缺少token参数
40014 无效的token
42001 token参数过期
48001 当前用户权限不足

功能描述：

  • 新建用户

请求URL：

  • http://xx.com/api/v1/users/

请求方式：

  • POST

参数：

参数名 必选 类型 说明
role_id 是 Number 权限组ID
username 是 String 新建的用户名
password 是 String 初始密码
user_tel 是 String 用户的电话号码
user_state 否 Boolean 用户的启用状态

返回示例

{
	"user_id": "66",
	"username": "user1",
	"user_tel": "13000000001",
	"user_state": "0",
	"role_id": "40"
}

返回参数说明

参数名 类型 说明
user_id Number 新增的用户的ID
username String 新增的用户用户名
user_tel String 新增的用户的电话号码
user_state Number 新增的用户的启用状态
role_id Number 新增的用户所属的权限组ID

错误状态码

参数名 说明
40010 缺少token参数
40014 无效的token
42001 token参数过期
48001 权限不足
44001 参数缺失
46008 权限组不存在
46003 用户名重复

功能描述：

  • 删除指定用户

请求URL：

  • http://xx.com/api/v1/users/ID

请求方式：

  • DELETE

参数：

参数名 必选 类型 说明

返回示例

返回参数说明

参数名 类型 说明

错误状态码

参数名 说明
40010 缺少token参数
40014 无效的token
42001 token参数过期
48001 权限不足

功能描述：

  • 更新指定用户信息

请求URL：

  • http://xx.com/api/v1/users/ID

请求方式：

  • PUT

参数：

参数名 必选 类型 说明
role_id 是 Number 权限组ID
username 是 String 要修改的用户名
password 否 String 要修改的密码
user_tel 是 Number 要修改的电话号码
user_state 否 Boolean 要修改的用户启用状态

返回示例

{
	"user_id": "67",
	"username": "user",
	"role_id": "40",
	"user_tel": "1300000000201",
	"user_state": "1"
}

返回参数说明

参数名 类型 说明
user_id Number 被修改的用户ID
username Number 修改后的用户名
role_id Number 修改后的权限组ID
user_tel Number 修改后的用户电话号码
user_state Number 修改后的用户启用状态

错误状态码

参数名 说明
40010 缺少token参数
40014 无效的token
42001 token参数过期
48001 权限不足
44001 参数缺失
46004 用户不存在
46008 权限组不存在
46003 用户名重复

功能描述：

  • 更新用户启用状态

请求URL：

  • http://xx.com/api/v1/users/state/ID

请求方式：

  • PATCH

参数：

参数名 必选 类型 说明
state 是 Boolean 用户的启用状态

返回示例

{
	"user_id": "67",
	"username": "user",
	"role_id": "40",
	"user_tel": "1300000000201",
	"user_state": "1"
}

返回参数说明

参数名 类型 说明
user_id Number 被修改的用户ID
username Number 用户名
role_id Number 权限组ID
user_tel Number 用户电话号码
user_state Number 修改后的用户启用状态

错误状态码

参数名 说明
40010 缺少token参数
40014 无效的token
42001 token参数过期
48001 权限不足
44001 参数缺失
46004 用户不存在