接口列表

客户新建、修改、查询接口
客户删除接口

单位查询、新建接口
单位删除接口

客户新建、修改、查询接口

功能

客户的新增、修改、查询

地址

/api/customers/customers

GET方法查询客户列表

参数说明

名称 类型 说明 备注 是否必须
name string 根据客户人的名字查询 否
organization_name string 根据客户人的单位名称查询 否
organization_id int 根据单位id查询 否
wechat string 根据微信查询 否
phoneNumber string 根据客户人的手机号查询 否
page int
默认1
count int 默认20

参数说明：
根据客户的修改时间从新到旧排序

返回格式

  1. {
  2.     "data": [
  3.         {
  4.             "id": 3,
  5.             "name": "李白",
  6.             "organization_id": 1,
  7.             "job": "国务院院长",
  8.             "sex": 1,
  9.             "phoneNumber": 123456,
  10.             "wechat": "C_duxin",
  11.             "qq": "123456",
  12.             "birthday": "2021-01-01",
  13.             "status": 1,
  14.             "createTime": "2021-07-13 08:19:33",
  15.             "updateTime": "2021-07-13 08:20:35",
  16.             "note": null,
  17.             "organization_name": "WTO",
  18.             "organization_address": "北京省北京市西北旺县亮家店村15号楼601"
  19.         }
  20.     ],
  21.     "status": 0,
  22.     "page_info": {
  23.         "total": 1,
  24.         "page": 1,
  25.         "count": 1
  26.     }
  27. }

POST方法新建、修改客户

参数说明

名称 类型 说明 备注 是否必须
customers_id int 有id的时候是修改已有，没有的时候是新建 修改：必须
新建：不传
name string 客户人的名字 是
job string 职位 否
sex int 性别
1：男
2：女
3：未知		 否，默认3
phoneNumber int 电话号码 否
wechat string 微信 否
qq string qq 否
birthday string 生日 格式：
2001-12-12		 否
organization_id int 单位id 是

参数说明：

返回格式

  1. {   
  2.     status: 0,
  3.     msg: '操作成功'
  4. }
  5. 或
  6. {   
  7.     status: 1,
  8.     msg: '失败描述'
  9. }

客户删除接口

功能

删除客户信息

地址

/api/customers/delcustomers

请求方法

POST

参数说明

名称 类型 说明 备注 是否必须
customers_id 客户id 是

返回格式

  1. {   
  2.     status: 0,
  3.     msg: '删除成功'
  4. }

单位查询、修改、新建接口

功能

查询单位、修改、新建单位

地址

/api/customers/organization

GET方法查询单位

参数说明

名称 类型 说明 备注 是否必须
name int 名字，根据传入参数模糊查询 否，不传的时候查询全部

返回格式

  1. {   
  2.     status: 0,
  3.     page_info: {
  4.         total: 100, page: 1, count: 20
  5.     },
  6.     data: [
  7.         {
  8.             id：1, name: xx, provience: xx, city: xx, county: xx, address: xx,
  9.             createTime: '2020-01-01 00:00:00', updateTime: '2020-01-01 00:00:00', 
  10.         },
  11.         {..}
  12.     ]
  13. }

POST方法新建、修改单位

参数说明

名称 类型 说明 备注 是否必须
organization_id int 单位id 修改：必须
新建：不传
organization_name string 单位名字 是
provience string 省份 否
city string 市区 否
county string 县 否
address string 县以下详细地址 否
note string 备注 否

返回格式

  1. {   
  2.     status: 0,
  3.     msg: '操作成功'
  4. }
  5. {   
  6.     status: 1,
  7.     msg: '失败描述'
  8. }

单位删除接口

功能

删除单位信息

地址

/api/customers/delorganization

请求方法

POST

参数说明

名称 类型 说明 备注 是否必须
organization_id 单位id 是

返回格式

  1. {   
  2.     status: 0,
  3.     msg: '删除成功'
  4. }

创建、修改、查看用户接口

功能

地址

/api/user/user

POST请求方法

创建、修改

参数说明

名称 类型 说明 备注 是否必须
user_id int 用户id 创建用户：不传
修改用户：是
username string 用户名 创建用户：是
修改用户：不传
password string 密码 创建用户：是
修改用户：不传
name string 姓名 是
email string 否
department string 部门 否
role_id int 角色组id 是
sex int 性别，
1：男
2：女
3：未知		 否
phoneNumber int 否
position string 否
status string -1：逻辑删除
0：禁止
1：启用		 否，默认1

返回格式

  1. {   
  2.     status: 0,
  3.     msg: 操作成功
  4. }
  5. // 或者
  6. {   
  7.     status: 1,
  8.     msg: 创建失败
  9. }

示例

  1. post参数
  2. {
  3.     "user_id": 2,
  4.     "username": "lucy",
  5.     "password": "123456",
  6.     "name": "lucily",
  7.     "role_id": 2,
  8.     "status": 0
  9. }
  10. 返回格式
  11. {
  12.     "data": [
  13.         {
  14.             "id": 1,
  15.             "username": "tom",
  16.             "date_joined": "2021-07-15 17:42:13",
  17.             "department": null,
  18.             "name": "Tom",
  19.             "sex": 3,
  20.             "phoneNumber": null,
  21.             "position": null,
  22.             "note": null,
  23.             "status": 1,
  24.             "role_name": "general"
  25.         },
  26.         {
  27.             "id": 2,
  28.             "username": "lucy",
  29.             "date_joined": "2021-07-15 17:42:26",
  30.             "department": null,
  31.             "name": "lucily",
  32.             "sex": 3,
  33.             "phoneNumber": null,
  34.             "position": null,
  35.             "note": null,
  36.             "status": 0,
  37.             "role_name": "general"
  38.         }
  39.     ],
  40.     "status": 0,
  41.     "page_info": {
  42.         "total": 2,
  43.         "page": 1,
  44.         "count": 20
  45.     }
  46. }

GET请求方法

查看用户

参数说明

名称 类型 说明 备注 是否必须
page 否，默认1
count 否，默认20
status string all：所有（）
0：禁止
1：启用		 否，默认all

返回格式

  1. {
  2.     "data": [
  3.         {
  4.             "id": 1,
  5.             "last_login": null,
  6.             "username": "admin",
  7.             "date_joined": "2021-07-15 08:57:28",
  8.             "department": null,
  9.             "name": "1st",
  10.             "role_id": 1,
  11.             "sex": 3,
  12.             "phoneNumber": null,
  13.             "position": null,
  14.             "email": null,
  15.             "forbidden": 0,
  16.             "createTime": "2021-07-15 08:57:28",
  17.             "updateTime": "2021-07-15 09:00:37",
  18.             "note": null
  19.         }
  20.     ],
  21.     "status": 0,
  22.     "page_info": {
  23.         "total": 1,
  24.         "page": 1,
  25.         "count": 20
  26.     }
  27. }

修改密码接口

功能

修改密码接口

地址

/api/user/password

请求方法

POST

参数说明

名称 类型 说明 备注 是否必须
username string 用户名 是
old_password string 旧密码 是
new_password string 新密码 是

说明：修改密码后会自动推出，需要重新登入

返回格式

  1. {   
  2.     status: 0,
  3.     msg: 修改成功
  4. }
  5. // 或者
  6. {   
  7.     status: 1,
  8.     msg: 修改失败
  9. }

创建、修改角色组接口

功能

地址

/api/user/role

POST请求方法

创建、修改角色组

参数说明

名称 类型 说明 备注 是否必须
role_id int 用户id 创建：不传
修改：是
name string 名字 否

返回格式

  1. {   
  2.     status: 0,
  3.     msg: 操作成功
  4. }
  5. // 或者
  6. {   
  7.     status: 1,
  8.     msg: 操作失败
  9. }

GET请求方法

查看角色组

参数说明

名称 类型 说明 备注 是否必须

返回格式

  1. {
  2.     "data": [
  3.         {
  4.             "id": 1,
  5.             "name": "admin",
  6.             "content": null,
  7.             "forbidden": 0,
  8.             "createTime": "2021-07-15 08:56:43",
  9.             "updateTime": "2021-07-15 08:56:43",
  10.             "note": null
  11.         },
  12.         {
  13.             "id": 2,
  14.             "name": "general",
  15.             "content": null,
  16.             "forbidden": 0,
  17.             "createTime": "2021-07-15 08:56:52",
  18.             "updateTime": "2021-07-15 08:56:52",
  19.             "note": null
  20.         }
  21.     ],
  22.     "status": 0
  23. }

删除组接口

功能

删除组

地址

/api/user/delrole

请求方法

POST

参数说明

名称 类型 说明 备注 是否必须
role_id int role的id 是

返回格式

略