消息接口

• 获取单个消息
• 获取多个消息
• 添加消息
• 修改消息
• 删除消息

请及时更新文档 任何人发现文档和接口不符请及时通知团队维护者

获取单个消息

通用获取消息接口

GET /message/:id

此处id为仪器控-消息id

参数

{
  "id": 1, // 消息id
}

响应

Status: 200 OK
-
{
  "id": 1, // 仪器控消息id
  "sender": "1" // 发件人
  "receiver": "2" // 收件人
  "title": "标题" // 消息标题
  "body": "内容" // 消息内容
  "is_read": 0--未读 / 1--已读 //是否已读
  "ctime": "2018-01-01 00:00:00" // 消息创建时间
  "mtime": "2018-01-01 00:00:00" // 消息修改时间
}

Status: 404 Not Found
-
"没有找到对应的消息"

获取多个消息

通用获取仪器控多条消息接口

GET /message

参数

{
  "sender": "1" // 发件人
  "receiver": "2" // 收件人
  "title": "标题" // 消息标题
  "is_read": 0--未读 / 1--已读 // 是否已读
  "sortby": "name", // 排序字段
  "order": "desc", // 排序方式
  "limit": [0, 20], // 分页筛选
}

响应

Status: 200 OK
-
{
  "total": 200,
  "data": [
    {
      "id": 1, // 仪器控消息id
  	  "sender": "1" // 发件人
   	  "receiver": "2" // 收件人
      "title": "标题" // 消息标题
      "body": "内容" // 消息内容
      "is_read": 0--未读 / 1--已读 //是否已读
      "ctime": "2018-01-01 00:00:00" // 消息创建时间
      "mtime": "2018-01-01 00:00:00" // 消息修改时间
    },
    ...
  ]
}

添加消息

通用添加仪器控消息接口

POST /message

参数

{
  "sender": "1" // 发件人
  "receiver": "2" // 收件人
  "template": "sample.result" / "reserv.result" // 消息模板
}

响应

无 (因为采用的是UDP协议)

Status: 400 Bad Request

修改消息

通用修改仪器控消息接口

PUT /message/:id

参数

{
  "is_read": 0--未读 / 1--已读 //是否已读
}

响应

无 (因为采用的是UDP协议)

Status: 400 Bad Request

删除消息

通用删除仪器控消息接口

DELETE /message/:id

参数

{
  "id": 1, // 消息id
}

响应

无 (因为采用的是UDP协议)

Status: 404 Not Found
Status: 400 Bad Request