[关闭]
@AlexZFX 2018-05-31T03:56:07.000000Z 字数 14285 阅读 706

工业预警系统API文档

API

基础返回格式

返回的数据格式为: 

  1. {
  2.      "ret":200,
  3.      "data":{
  4.      返回数据内容
  5.      },
  6.      "msg":"错误信息"   
  7.  }

成功时返回200,data,msg，包含数据，失败时返回500和返回内容msg

ret 描述
200 成功
500 失败

锁定状态如下

当用户初次添加邮箱后，邮箱为锁定状态，初次注册后，用户未被锁定，后台管理员锁定用户后，用户将不能登录

ret 描述
0 锁定
1 未锁定

仪器状态如下

status 描述
0 WAINCONFIRM
1 CONFIRMED
2 FIXING
3 FINISHED

错误状态码如下(不定期更新)

状态码 msg
1000 账户不存在
1001 密码错误
1002 注册时账户已存在
1003 验证码输入错误
1004 密码必须包含数字、字母、特殊字符三种,长度属于6-16位之间
2000 邮件发送失败
2001 点击链接验证邮箱失败，邮箱验证码错误

用户使用

1.0 获取验证码
-请求url
/getVerCode
-请求方式
get
-返回格式
二进制图片流

1.1 登录
-请求url
/login
-请求方式
post

-请求参数

  1. {  
  2.   "username":"username",
  3.   "password":"password",
  4.   "verCode":"verCode" 
  5. }

-返回参数

  1. {
  2.     "ret":200,
  3.     "data":{
  4.     "roles": [{
  5.           "id": 1,
  6.           "name": "user"
  7.     },
  8.     {
  9.           "id": 2,
  10.           "name": "maintainer"
  11.     },
  12.     {
  13.           "id": 3,
  14.           "name": "admin"
  15.     }]
  16.     },
  17.     "msg":"success/用户名或密码有误"   
  18. }

1.2 注册
-请求url
/register
-请求方式
post

-请求参数

  1. {
  2.     "username":"username",
  3.     "password":"password",
  4.     "name":"name",//昵称
  5.     "email":"email"
  6. }

-返回参数

  1. {
  2.     "ret":200,
  3.     "data":{
  4.         返回数据内容
  5.     },
  6.     "msg":"success"   
  7. }

1.4 忘记密码
-请求url
/resetPassword
-请求方式
get
-请求参数

  1. {
  2.     "newPassword":"password"
  3. }

-返回参数

  1. {
  2.     "ret":200,
  3.     "data":{},
  4.     "msg":"success" 
  5. }

1.5 设置新密码

2.0 获取用户信息
-请求url
/getUserInfo
-请求方式
get

-请求参数

-返回参数

  1. {
  2.     "ret":200,
  3.     "data":{
  4.         "username":"username",
  5.         "id":"id",
  6.         "email":"email",
  7.         "isEmailLocked":"0/1",
  8.         "description":"description",
  9.         "name":"name",
  10.         "avatar":"url",
  11.         "roles":[]
  12.     },
  13.     "msg":"success" 
  14. }

2.1 修改用户信息
-请求url
/modifyUserInfo
-请求方式
post

-请求参数

  1. {
  2.     "name":"name",
  3.     "description":"description",
  4. }

-返回参数

  1. {
  2.     "ret":200,
  3.     "data":{},
  4.     "msg":"success" 
  5. }

2.2 上传头像
-请求url
/uploadAvatar
-请求方式
post

-请求参数 formData

  1. file:file

-返回参数

  1. {
  2.     "ret":200,
  3.     "data":"avatar_url"
  4.     "msg":"success" 
  5. }

2.3 更改/初设/激活邮箱
-请求url
/updateEmail
-请求方式
post
-请求参数

  1. {
  2.     "email":"email"
  3. }

-返回参数

  1. {
  2.     "ret":200,
  3.     "data":{},
  4.     "msg":"success" 
  5. }

2.4 修改密码
-请求url
/updatePassword
-请求方式
post
-请求参数

  1. {
  2.     "oldPassword":"oldPassword",
  3.     "newPassword":"newPassword",
  4. }

-返回参数

  1. {
  2.     "ret":200,
  3.     "data":{},
  4.     "msg":"success" 
  5. }

3.1 根据分类id获取个人创建的仪器
-请求url
/getInstrumentByCid
-请求方式
get
-请求参数

  1. cid //分类id
  2. page // 页码 默认为 0 
  3. sort  // sort，排序相关的信息，以property,property(,ASC|DESC)的方式组织，例如sort=id&sort=name,desc表示在按id正序排列基础上按name倒序排列。  
  4. size //每页大小，默认为 10

-返回参数

  1. {
  2.     "ret":"",
  3.     "data": {
  4.         "totalPages": 10,
  5.         "totalElements": 100,
  6.         "size": int,
  7.         "number": 当前页,
  8.         "content": [{
  9.             "id": 1,
  10.             "name": "仪器1",
  11.             "insType": "型号1",
  12.             "param": "参数1",
  13.             "durableYears":"使用年限"
  14.             "description": "描述1",
  15.             "picUrl": "",
  16.             "thresholdValue": 50,
  17.             "category":{
  18.                 "id": int,
  19.                 "name":"name",
  20.                 "description":"des",
  21.             }
  22.           },
  23.           {
  24.             "id": 1,
  25.             "name": "仪器2",
  26.             "insType": "型号2",
  27.             "param": "参数2",
  28.             "description": "描述2",
  29.             "durableYears":"使用年限"
  30.             "picUrl": "",
  31.             "thresholdValue": 60,
  32.             "category":{
  33.                 "id": int,
  34.                 "name":"name",
  35.                 "description":"des",
  36.             }
  37.           }]
  38.     },
  39.     "msg":""
  40. }

3.2 获取单个仪器信息
-请求url
/getInstrumentById
-请求方式
get
-请求参数
id
-返回参数

  1. {
  2.     "ret":"",
  3.     "data":{
  4.         "id": int
  5.         "name": 
  6.         "insType":
  7.         "param":
  8.         "description":
  9.         "durableYears":"使用年限"
  10.         "picUrl":
  11.         "thresholdValue":
  12.         "category":{
  13.                 "id": int,
  14.                 "name":"name",
  15.                 "description":"des",
  16.             }
  17.         }
  18.     "msg":""
  19. }

3.3 获取分类
-请求url
/getCategories
-请求方式
get
-请求参数
无
-返回参数

  1. {
  2.     "ret":200,
  3.     "data":[
  4.         {
  5.             "id":"id",
  6.             "name":"",
  7.             "description":""
  8.         },
  9.         {
  10.             "id":"id",
  11.             "name":"",
  12.             "description":""
  13.         }],
  14.     "msg":"success" 
  15. }

3.4 创建仪器
-请求url
/createInstrument
-请求方式
POST
-请求参数

  1. {
  2.     "cid":"分类id"
  3.     "name":"仪器名称",
  4.     "insType":"型号",
  5.     "durableYears":"使用年限"
  6.     "param":"参数",
  7.     "description":"描述",
  8.     "thresholdValue":"告警阈值",
  9. }

-返回参数

  1. {
  2.     "ret":200,
  3.     "data":仪器id,
  4.     "msg":"success" 
  5. }

3.5 获取用户所有仪器
-请求url
/getUserInstrument
-请求方式
-get
-请求参数

  1. page // 页码 默认为 0 
  2. sort  // sort，排序相关的信息，以property,property(,ASC|DESC)的方式组织，例如sort=id&sort=name,desc表示在按id正序排列基础上按name倒序排列。  
  3. size //每页大小，默认为 10

-返回参数

  1. {
  2.     "ret":"",
  3.     "data":{
  4.         "totalPages": 10,
  5.         "totalElements": 100,
  6.         "size": int,
  7.         "number": 当前页,
  8.         "content": [{
  9.             "id": 1,
  10.             "name": "仪器1",
  11.             "insType": "型号1",
  12.             "param": "参数1",
  13.             "description": "描述1",
  14.             "picUrl": "",
  15.             "thresholdValue": 50,
  16.             "category":{
  17.                 "id": int,
  18.                 "name":"name",
  19.                 "description":"des",
  20.             }
  21.           },
  22.           {
  23.             "id": 1,
  24.             "name": "仪器2",
  25.             "insType": "型号2",
  26.             "param": "参数2",
  27.             "description": "描述2",
  28.             "picUrl": "",
  29.             "thresholdValue": 60,
  30.             "category":{
  31.                 "id": int,
  32.                 "name":"name",
  33.                 "description":"des",
  34.             }
  35.           }]
  36.     }
  37.     "msg":""
  38. }

3.6 修改仪器信息
-请求url
/modifyInstrument
-请求方式
POST
-请求参数

  1. {
  2.     "id":"id"
  3.     "name":"仪器名称",
  4.     "insType":"型号",
  5.     "durableYears":"使用年限"
  6.     "param":"参数",
  7.     "picUrl":"图片链接"
  8.     "description":"描述",
  9.     "thresholdValue":"告警阈值",
  10. }

-返回参数

  1. {
  2.     "ret":200,
  3.     "data":{},
  4.     "msg":"success" 
  5. }

3.7 上传仪器图片
-请求url
/uploadInstPic
-请求方式
POST
-请求参数 formData

  1. file:file

-返回参数

  1. {
  2.     "ret":200,
  3.     "data":"仪器图片url"
  4.     "msg":"success" 
  5. }

4.0 用户登录后订阅WebSocket 接口

SOCKJS连接点：/webSocket

用户：/user/msg/user

维修人员：/user/msg/maintainer

消息格式：

  1. {
  2.     "id": 1,
  3.     "uid": "用户id",
  4.     "dealer": [
  5.         id: "id",
  6.         name: "name",
  7.         email: "email",
  8.         description: "description"
  9.     ],
  10.     "orderId": orderId,
  11.     "time": "发送时间",
  12.     "machineId": "仪器id",
  13.     "data": "仪器当时数据",
  14.     "status":0/1/2/3,
  15.     "instName":"仪器名称"
  16.     "thresholdValue": 50,
  17.     "content":"消息内容"
  18.     "read":true/false
  19. }

4.1 获取消息
-请求url
/getMessages
-请求方式
GET
-请求参数

  1. page // 页码 默认为 0 
  2. sort  // sort，排序相关的信息，以property,property(,ASC|DESC)的方式组织，例如sort=id&sort=name,desc表示在按id正序排列基础上按name倒序排列。  
  3. size //每页大小，默认为 10

-返回参数

  1. {
  2.     "ret":"",
  3.     "data":{
  4.         "totalPages": 10,
  5.         "totalElements": 100,
  6.         "size": int,
  7.         "number": 当前页,
  8.         "content": [{
  9.             "id": 1,
  10.             "uid": "用户id",
  11.             "time": "发送时间",
  12.             "machineId": "仪器id",
  13.             "data": "仪器当时数据",
  14.             "status":0/1/2/3,
  15.             "instName":"仪器名称"
  16.             "thresholdValue": 50,
  17.             "content":"消息内容"
  18.             "read":true/false
  19.         }，{
  20.             "id": 1,
  21.             "uid": "用户id",
  22.             "time": "发送时间",
  23.             "machineId": "仪器id",
  24.             "data": "仪器当时数据",
  25.             "status":0/1/2/3,
  26.             "instName":"仪器名称"
  27.             "thresholdValue": 50,
  28.             "content":"消息内容"
  29.             "read":true/false
  30.         }]
  31.     }
  32.     "msg":""
  33. }

4.2 设置消息为已读
-请求url
/readMessage
-请求方式
post
-请求参数

  1. {
  2.     "intIds":[1,2,3]
  3. }

-返回参数

  1. {
  2.     "ret":200,
  3.     "data":{},
  4.     "msg":"success" 
  5. }

4.3 设置全部消息为已读
-请求url
/readAllMessage
-请求方式
post
-请求参数
无
-返回参数

  1. {
  2.     "ret":200,
  3.     "data":{},
  4.     "msg":"success" 
  5. }

4.4 删除消息
-请求url
/deleteMessage
-请求方式
post
-请求参数

  1. {
  2.     "intIds":[1,2,3]
  3. }

-返回参数

  1. {
  2.     "ret":200,
  3.     "data":{},
  4.     "msg":"success" 
  5. }

4.5 获取未读消息数
-请求url
/getUnReadNum
-请求方式
get
-请求参数
无
-返回参数

  1. {
  2.     "ret":200,
  3.     "data":10,
  4.     "msg":"success" 
  5. }

5.1获取订单列表
-请求url
/getOrderList
-请求方式
GET
-请求参数

  1. page // 页码 默认为 0 
  2. sort  // sort，排序相关的信息，以property,property(,ASC|DESC)的方式组织，例如sort=id&sort=name,desc表示在按id正序排列基础上按name倒序排列。  
  3. size //每页大小，默认为 10

-返回参数

  1. {
  2.     "ret":"",
  3.     "data":{
  4.         "totalPages": 10,
  5.         "totalElements": 100,
  6.         "size": int,
  7.         "number": 当前页,
  8.         "content": [{
  9.             "id": 1,
  10.             "maintainStatus": "维修状态码",
  11.             "createTime": "开始时间",
  12.             "confirmTime": "确认时间",
  13.             "fixTime": "维修时间",
  14.             "finishTime": "完成时间",
  15.             "maintainer/owner":{
  16.                 "username":"username",
  17.                 "id":"id",
  18.                 "email":"email",
  19.                 "isEmailLocked":"0/1",
  20.                 "description":"description",
  21.                 "name":"name",
  22.                 "avatar":"url",
  23.             },
  24.             instrument:{
  25.                 "id": 1,
  26.                 "name": "仪器1",
  27.                 "insType": "型号1",
  28.                 "param": "参数1",
  29.                 "durableYears":"使用年限"
  30.                 "description": "描述1",
  31.                 "picUrl": "",
  32.                 "thresholdValue": 50,
  33.                 "category":{
  34.                     "id": int,
  35.                     "name":"name",
  36.                     "description":"des",
  37.                 }
  38.             }
  39.           },{
  40.             "id": 1,
  41.             "maintainStatus": "维修状态码",
  42.             "createTime": "开始时间",
  43.             "confirmTime": "确认时间",
  44.             "fixTime": "维修时间",
  45.             "finishTime": "完成时间",
  46.             "maintainer/owner":{
  47.                 "username":"username",
  48.                 "id":"id",
  49.                 "email":"email",
  50.                 "isEmailLocked":"0/1",
  51.                 "description":"description",
  52.                 "name":"name",
  53.                 "avatar":"url",
  54.             },
  55.             instrument:{
  56.                 "id": 1,
  57.                 "name": "仪器1",
  58.                 "insType": "型号1",
  59.                 "param": "参数1",
  60.                 "durableYears":"使用年限"
  61.                 "description": "描述1",
  62.                 "picUrl": "",
  63.                 "thresholdValue": 50,
  64.                 "category":{
  65.                     "id": int,
  66.                     "name":"name",
  67.                     "description":"des",
  68.                 }
  69.             }
  70.           }]
  71.     }
  72.     "msg":""
  73. }

5.2获取单个订单详情
-请求url
/getOrderDetail
-请求方式
GET
-请求参数

  1. {
  2.     "id":"订单id"
  3. }

-返回参数

  1. {
  2.     "ret":200,
  3.     "data":{
  4.             "id": 1,
  5.             "maintainStatus": "维修状态码",
  6.             "createTime": "开始时间",
  7.             "confirmTime": "确认时间",
  8.             "fixTime": "维修时间",
  9.             "finishTime": "完成时间",
  10.             "maintainer/owner":{
  11.                 "username":"username",
  12.                 "id":"id",
  13.                 "email":"email",
  14.                 "isEmailLocked":"0/1",
  15.                 "description":"description",
  16.                 "name":"name",
  17.                 "avatar":"url",
  18.             },
  19.             instrument:{
  20.                 "id": 1,
  21.                 "name": "仪器1",
  22.                 "insType": "型号1",
  23.                 "param": "参数1",
  24.                 "durableYears":"使用年限"
  25.                 "description": "描述1",
  26.                 "picUrl": "",
  27.                 "thresholdValue": 50,
  28.                 "category":{
  29.                     "id": int,
  30.                     "name":"name",
  31.                     "description":"des",
  32.                 }
  33.             }
  34.           },
  35.     "msg":"success" 
  36. }

5.3确认订单（waitConfirm->confirmed）
-请求url
/confirmOrder
-请求方式
POST
-请求参数

  1. {
  2.     "orderIds":["确认的订单Idlist"]
  3. }

-返回参数

  1. {
  2.     "ret":200,
  3.     "data":{},
  4.     "msg":"success" 
  5. }

5.4开始维修（Confirmed->Fixing）
-请求url
/fixingOeder
-请求方式
POST
-请求参数

  1. {
  2.     "orderIds":["开始的订单Idlist"]
  3. }

-返回参数

  1. {
  2.     "ret":200,
  3.     "data":{},
  4.     "msg":"success" 
  5. }

5.5结束订单（Fixing->Finished）
-请求url
/finishOrder
-请求方式
POST
-请求参数

  1. {
  2.     "orderIds":["结束的订单Idlist"]
  3. }

-返回参数

  1. {
  2.     "ret":200,
  3.     "data":{},
  4.     "msg":"success" 
  5. }

5.6 根据订单状态获取订单列表
-请求url
/getOrderByStatus
-请求方式
GET
-请求参数

  1. status 0/1/2/3  // 
  2. page // 页码 默认为 0 
  3. sort  // sort，排序相关的信息，以property,property(,ASC|DESC)的方式组织，例如sort=id&sort=name,desc表示在按id正序排列基础上按name倒序排列。  
  4. size //每页大小，默认为 10

-返回参数

  1. {
  2.     "ret":"",
  3.     "data":{
  4.         "totalPages": 10,
  5.         "totalElements": 100,
  6.         "size": int,
  7.         "number": 当前页,
  8.         "content": [{
  9.             "id": 1,
  10.             "maintainStatus": "维修状态码",
  11.             "createTime": "开始时间",
  12.             "confirmTime": "确认时间",
  13.             "fixTime": "维修时间",
  14.             "finishTime": "完成时间",
  15.             "maintainer/owner":{
  16.                 "username":"username",
  17.                 "id":"id",
  18.                 "email":"email",
  19.                 "isEmailLocked":"0/1",
  20.                 "description":"description",
  21.                 "name":"name",
  22.                 "avatar":"url",
  23.             },
  24.             instrument:{
  25.                 "id": 1,
  26.                 "name": "仪器1",
  27.                 "insType": "型号1",
  28.                 "param": "参数1",
  29.                 "durableYears":"使用年限"
  30.                 "description": "描述1",
  31.                 "picUrl": "",
  32.                 "thresholdValue": 50,
  33.                 "category":{
  34.                     "id": int,
  35.                     "name":"name",
  36.                     "description":"des",
  37.                 }
  38.             }
  39.           },{
  40.             "id": 1,
  41.             "maintainStatus": "维修状态码",
  42.             "createTime": "开始时间",
  43.             "confirmTime": "确认时间",
  44.             "fixTime": "维修时间",
  45.             "finishTime": "完成时间",
  46.             "maintainer/owner":{
  47.                 "username":"username",
  48.                 "id":"id",
  49.                 "email":"email",
  50.                 "isEmailLocked":"0/1",
  51.                 "description":"description",
  52.                 "name":"name",
  53.                 "avatar":"url",
  54.             },
  55.             instrument:{
  56.                 "id": 1,
  57.                 "name": "仪器1",
  58.                 "insType": "型号1",
  59.                 "param": "参数1",
  60.                 "durableYears":"使用年限"
  61.                 "description": "描述1",
  62.                 "picUrl": "",
  63.                 "thresholdValue": 50,
  64.                 "category":{
  65.                     "id": int,
  66.                     "name":"name",
  67.                     "description":"des",
  68.                 }
  69.             }
  70.           }]
  71.     }
  72.     "msg":""
  73. }

后台管理

1.0 创建分类
-请求url
/admin/createCategory
-请求方式
POST
-请求参数

  1. {
  2.     "name":"name",
  3.     "description":"description"
  4. }

-返回参数

  1. {
  2.     "ret":200,
  3.     "data":{},
  4.     "msg":"success" 
  5. }

1.1 修改分类
-请求url
/admin/modifyCategory
-请求方式
post
-请求参数

  1. {
  2.     "id":"id",
  3.     "name":"name",
  4.     "description":"description"
  5. }

-返回参数

  1. {
  2.     "ret":200,
  3.     "data":{},
  4.     "msg":"success" 
  5. }

1.2 删除分类
-请求url
/admin/deleteCategory
-请求方式
post
-请求参数

  1. {
  2.     "id":"id"
  3. }

-返回参数

  1. {
  2.     "ret":200,
  3.     "data":{},
  4.     "msg":"success" 
  5. }

1.3 获取分类
-请求url
/getCategories
-请求方式
get
-请求参数
无
-返回参数

  1. {
  2.     "ret":200,
  3.     "data":[
  4.         {
  5.             "id":"id",
  6.             "name":"",
  7.             "description":""
  8.         },
  9.         {
  10.             "id":"id",
  11.             "name":"",
  12.             "description":""
  13.         }],
  14.     "msg":"success" 
  15. }

1.4 创建模板仪器
-请求url
/admin/createInstrument
-请求方式
post
-请求参数

  1. {
  2.     "cid":cid
  3.     "name":"仪器名称",
  4.     "insType":"型号",
  5.     "durableYears":"使用年限"
  6.     "param":"参数",
  7.     "description":"描述",
  8.     "thresholdValue":"告警阈值",
  9. }

-返回参数

  1. {
  2.     "ret":200,
  3.     "data":{},
  4.     "msg":"success" 
  5. }

1.5 获取用户所有仪器
-请求url
/getUserInstrument
-请求方式
-get
-请求参数

  1. page // 页码 默认为 0 
  2. sort  // sort，排序相关的信息，以property,property(,ASC|DESC)的方式组织，例如sort=id&sort=name,desc表示在按id正序排列基础上按name倒序排列。  
  3. size //每页大小，默认为 10
  4. uid  //用户id
  5. keyword //模糊搜索

-返回参数

  1. {
  2.     "ret":"",
  3.     "data":{
  4.         "totalPages": 10,
  5.         "totalElements": 100,
  6.         "size": int,
  7.         "number": 当前页,
  8.         "content": [{
  9.             "id": 1,
  10.             "name": "仪器1",
  11.             "insType": "型号1",
  12.             "param": "参数1",
  13.             "durableYears":"使用年限"
  14.             "description": "描述1",
  15.             "picUrl": "",
  16.             "thresholdValue": 50,
  17.             "category":{
  18.                 "id": int,
  19.                 "name":"name",
  20.                 "description":"des",
  21.             }
  22.           },
  23.           {
  24.             "id": 1,
  25.             "name": "仪器2",
  26.             "insType": "型号2",
  27.             "param": "参数2",
  28.             "durableYears":"使用年限"
  29.             "description": "描述2",
  30.             "picUrl": "",
  31.             "thresholdValue": 60,
  32.             "category":{
  33.                 "id": int,
  34.                 "name":"name",
  35.                 "description":"des",
  36.             }
  37.           }]
  38.     }
  39.     "msg":""
  40. }

1.6 根据分类id获取模板仪器
-请求url
/getModelInstrumentByCid
-请求方式
get
-请求参数

  1. cid //分类id
  2. page // 页码 默认为 0 
  3. sort  // sort，排序相关的信息，以property,property(,ASC|DESC)的方式组织，例如sort=id&sort=name,desc表示在按id正序排列基础上按name倒序排列。  
  4. size //每页大小，默认为 10

-返回参数

  1. {
  2.     "ret":"",
  3.     "data":{
  4.         "totalPages": int,
  5.         "totalElements": int ,
  6.         "content":[{
  7.             "id": int
  8.             "name":
  9.             "insType":
  10.             "param":
  11.             "durableYears":"使用年限"
  12.             "description":
  13.             "picUrl":
  14.             "thresholdValue":
  15.             "category":{
  16.                 "id": int,
  17.                 "name":"name",
  18.                 "description":"des",
  19.             }
  20.         }，{
  21.             "id": int
  22.             "name": 
  23.             "insType":
  24.             "param":
  25.             "description":
  26.             "durableYears":"使用年限"
  27.             "picUrl":
  28.             "thresholdValue":
  29.             "category":{
  30.                 "id": int,
  31.                 "name":"name",
  32.                 "description":"des",
  33.             }
  34.         }],
  35.         "size": int,
  36.         "number":"当前页",
  37.     }
  38.     "msg":""
  39. }

1.7 删除仪器
-请求url
/deleteInstrument
-请求方式
POST
-请求参数

  1. {
  2.     "id":仪器id
  3. }

-返回参数

  1. {
  2.     "ret":200,
  3.     "data":{},
  4.     "msg":"success" 
  5. }

2.0 获取所有用户信息
-请求url
/admin/getUserInfo
-请求方式
get
-请求参数

  1. page // 页码 默认为 0   
  2. size //每页大小，默认为 10
  3. sort  // 根据创建时间 desc表示倒叙排列
  4. keyWord //模糊搜索
  5. roleName // 必须 user//maintainer

-返回参数

  1. {
  2.     "ret":"",
  3.     "data":{
  4.         "totalPages": int,
  5.         "totalElements": int ,
  6.         "content":[
  7.             {
  8.                 "uid": "uid",
  9.                 "username": "username",
  10.                 "equipmentNumber": int,
  11.                 "orderNumber": int,
  12.                 "email": "123@qq.com",
  13.                 "isEmailLock": 0
  14.             },
  15.             {
  16.                 "uid": "uid",
  17.                 "username": "username",
  18.                 "equipmentNumber": int,
  19.                 "orderNumber": int,
  20.                 "email": "123@qq.com",
  21.                 "isEmailLock": 0
  22.             }
  23.         ],
  24.         "size": int,
  25.         "number":"当前页",
  26.     }
  27.     "msg":""
  28. }

2.1 获取用户仪器列表
-请求url
/admin/getInstruments
-请求方式
get
-请求参数

  1. page // 页码 默认为 0   
  2. size //每页大小，默认为 10
  3. sort // 根据创建时间 desc表示倒叙排列
  4. uid  //用户id  可选，如果没有按顺序返回
  5. keyWord //模糊搜索 可选

-返回参数

  1. {
  2.     "ret":"",
  3.     "data":{
  4.         "totalPages": int,
  5.         "totalElements": int ,
  6.         "content": [{
  7.             "id": 1,
  8.             "name": "仪器1",
  9.             "insType": "型号1",
  10.             "param": "参数1",
  11.             "durableYears":"使用年限"
  12.             "description": "描述1",
  13.             "picUrl": "",
  14.             "thresholdValue": 50,
  15.             "category":{
  16.                 "id": int,
  17.                 "name":"name",
  18.                 "description":"des",
  19.             }
  20.           },
  21.           {
  22.             "id": 1,
  23.             "name": "仪器2",
  24.             "insType": "型号2",
  25.             "param": "参数2",
  26.             "description": "描述2",
  27.             "durableYears":"使用年限"
  28.             "picUrl": "",
  29.             "thresholdValue": 60,
  30.             "category":{
  31.                 "id": int,
  32.                 "name":"name",
  33.                 "description":"des",
  34.             }
  35.           }]
  36.         "size": int,
  37.         "number":"当前页",
  38.     }
  39.     "msg":""
  40. }

2.2 根据用户/维修人员的id获取维修工单列表
-请求url
/admin/getOrderList
-请求方式
get
-请求参数

  1. page // 页码 默认为 0 
  2. sort  // sort，
  3. size //每页大小，默认为 10
  4. uid  //用户/维修人员的id
  5. status // 维修状态

-返回参数

  1. {
  2.     "ret":"",
  3.     "data":{
  4.         "totalPages": int,
  5.         "totalElements": int ,
  6.         "content": {
  7.             "id": 1,
  8.             "maintainStatus": "维修状态码",
  9.             "createTime": "开始时间",
  10.             "maintainer/owner": "username"
  11.             instrument:{
  12.                 "id": 1,
  13.                 "name": "仪器1",
  14.                 "category":{
  15.                     "name":"name",
  16.                 }
  17.             }
  18.           }
  19.         "size": int,
  20.         "number":"当前页",
  21.     }
  22.     "msg":""
  23. }

2.3 获取维修工单详情(复用getOrderDetail)
-请求url
/admin/getOrderDetail
-请求方式
get
-请求参数

  1. {
  2.     "id":"订单id"
  3. }

-返回参数

  1. {
  2.     "ret":"",
  3.     "data":{
  4.         "totalPages": int,
  5.         "totalElements": int ,
  6.         "content": {
  7.             "id": 1,
  8.             "maintainStatus": "维修状态码",
  9.             "createTime": "开始时间",
  10.             "confirmTime": "确认时间",
  11.             "fixTime": "维修时间",
  12.             "finishTime": "完成时间",
  13.             "maintainer":{
  14.                 "username":"username",
  15.                 "id":"id",
  16.                 "email":"email",
  17.                 "isEmailLocked":"0/1",
  18.                 "description":"description",
  19.                 "name":"name",
  20.                 "avatar":"url",
  21.             },
  22.             "owner":{
  23.                 "username":"username",
  24.                 "id":"id",
  25.                 "email":"email",
  26.                 "isEmailLocked":"0/1",
  27.                 "description":"description",
  28.                 "name":"name",
  29.                 "avatar":"url",
  30.             },
  31.             "instrument":{
  32.                 "id": 1,
  33.                 "name": "仪器1",
  34.                 "insType": "型号1",
  35.                 "param": "参数1",
  36.                 "durableYears":"使用年限"
  37.                 "description": "描述1",
  38.                 "picUrl": "",
  39.                 "thresholdValue": 50,
  40.                 "category":{
  41.                     "id": int,
  42.                     "name":"name",
  43.                     "description":"des",
  44.                 }
  45.             }
  46.           }
  47.         "size": int,
  48.         "number":"当前页",
  49.     }
  50.     "msg":""
  51. }

2.4 获取仪器详情（复用/getInstrumentById）
-请求url
/admin/getInstrumentById
-请求方式
get
-请求参数

  1. id

-返回参数

  1. {
  2.     "ret":"",
  3.     "data":{
  4.         "id": int
  5.         "name": 
  6.         "insType":
  7.         "param":
  8.         "description":
  9.         "durableYears":"使用年限"
  10.         "picUrl":
  11.         "thresholdValue":
  12.         "category":{
  13.                 "id": int,
  14.                 "name":"name",
  15.                 "description":"des",
  16.             },
  17.         "owner":{
  18.             "username":"",
  19.             "name":""
  20.             "description":"",
  21.             "email":"",
  22.             }
  23.         }
  24.     "msg":""
  25. }

2.5 获取仪器数据
-请求url
/getDataByMachineId
-请求方式
GET
-请求参数
machineId: 1
-返回参数

  1. {
  2.     "ret":
  3.     "msg":
  4.     "data":[
  5.         {
  6.             "time":时间戳
  7.             "data":12
  8.         },{
  9.             "time":时间戳
  10.             "data":12
  11.         },{
  12.             "time":时间戳
  13.             "data":12
  14.         },{
  15.             "time":时间戳
  16.             "data":12
  17.         }
  18.     ]
  19. }

3.1 锁定用户
-请求url
/admin/lockUser
-请求方式
POST
-请求参数

  1. {
  2.     "indIds":[用户idlist]
  3. }

-返回参数

  1. {
  2.     "ret":200,
  3.     "data":{},
  4.     "msg":"success" 
  5. }

3.2 解锁用户
-请求url
/admin/unlockUser
-请求方式
POST
-请求参数

  1. {
  2.     "indIds":[用户idlist]
  3. }

-返回参数

  1. {
  2.     "ret":200,
  3.     "data":{},
  4.     "msg":"success" 
  5. }

仪器数据部分(端口8081)

1.0 获取当前的数据发送情况
-请求url
/jobInfo
-请求方式
GET
-请求参数
无
-返回参数

  1. {
  2.     "workerIds":[1,2,3,4],
  3.     "pausedIds":[5,6,7,8]
  4. }

1.1 请求开始给某个仪器发送数据
-请求url
/startMachineInfo
-请求方式
POST
-请求参数

  1. formdata形式
  2. machineId：仪器id
  3. time：期望发送的时间间隔，以cron表达式形式发送

-返回参数
success
1.2 根据仪器id暂停发送任务
-请求url
/pauseByMachineId
-请求方式
post
-请求参数
machineId:123123
-返回参数
success
1.3 根据仪器id重新开始任务
-请求url
/restartById
-请求方式
POST
-请求参数
machineId:23123
-返回参数
success
1.4 停止一个数据发送任务
-请求url
/stopone
-请求方式
POST
-请求参数
machineId:312312
-返回参数
success
1.5 暂停全部
-请求url
/pauseAll
-请求方式
POST
-请求参数
无
-返回参数
success
1.6 重启全部暂停的
-请求url
/restartAll
-请求方式
POST
-请求参数
no
-返回参数
success
1.7 停止所有任务
-请求url
/stopAll
-请求方式
POST
-请求参数
no
-返回参数
success
1.8 根据仪器id重设时间间隔
-请求url
/resetTime
-请求方式
POST
-请求参数

  1. machineId:21312
  2. time:"cron表达式"

-返回参数
success
1.7 根据
-请求url
-请求方式
-请求参数
-返回参数
1.7 根据
-请求url
-请求方式
-请求参数
-返回参数
1.7 根据
-请求url
-请求方式
-请求参数
-返回参数

添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注