admin message - BISTU-CETC/order_system GitHub Wiki
私信管理接口
基于私信本身的查询接口
接口说明
用于后台管理系统查询私信,只有管理员能访问接口。
提交地址
get /admin/messages
MIME 类型
无
请求参数
变量定义:
| 字段名 | 类型 | 必输 | 默认值 | 说明 |
|---|---|---|---|---|
| title | string | 否 | "" | 根据私信标题模糊查询 |
| senderStudentJobId | string | 否 | "" | 根据学号工号模糊查询 |
| receiverStudentJobId | string | 否 | "" | 根据学号工号模糊查询 |
| size | int | 否 | 10 | 指定页面条数 |
| current | int | 否 | 1 | 当前页数 |
注意:所有查询条件都是选输,除了 size 和 current 有默认值外,其他查询条件符合以下规则:如果输入字段不为"",则将其用于检索条件;否则,则不将其作为检索条件。如果不传递任何参数,默认返回 10 条记录大小的第一页。
请求参数示例:
{
title: "授权",
senderStudentJobId: "201902"
size: 10,
current: 1
}
请求返回
要求返回:私信本身的所有信息,私信发送者和接收者详细信息(可以调用后台 UserDao 接口)。 必要信息如下:
- id: 私信 id,
- senderName: 发送者姓名,
- receiverName: 接收者姓名,
- createTime: 创建时间,
- total: 返回的总记录数,
- size: 返回本页记录大小,
- current: 当前查询页码,
- pages: 总页面数量
私信修改
接口说明
用于后台管理系统修改任何一条私信的内容,只有管理员能访问接口。
提交地址
put /admin/message
MIME 类型
application/json
请求参数
变量定义:
| 字段名 | 类型 | 必输 | 默认值 | 说明 |
|---|---|---|---|---|
| id | int | 是 | 待修改的私信 id | |
| title | string | 是 | 私信标题,不允许为空 | |
| description | string | 是 | 私信内容,不允许为空 |
请求参数示例:
{
id: 1
title: "关于账号授权",
description :"账号允许授权"
}
请求返回
无
私信删除
接口说明
用于后台管理系统删除(真删除)任何一条私信,只有管理员能访问接口。
提交地址
delete /admin/messages
MIME 类型
application/json
请求参数
变量定义:
| 字段名 | 类型 | 必输 | 默认值 | 说明 |
|---|---|---|---|---|
| idList | array | 是 | 待删除的私信 id |
请求参数示例:
{
"idList": [1, 3, 4, 6]
}
请求返回
无
管理员批量发送私信
接口说明
用于管理员给批量的用户发送私信,暂时作为发送提示信息用
提交地址
post /admin/bunchMessages
MIME 类型
multipart/form-data
请求参数
变量定义:
| 字段名 | 类型 | 必输 | 默认值 | 说明 |
|---|---|---|---|---|
| receiverIdList | array | 是 | 私信就收者信息 | |
| title | string | 是 | 私信标题 | |
| description | string | 是 | 私信内容 | |
| attachment | file | 否 | 私信附件 |
请求返回
无