目录标题
title: 善逸mis
language_tabs:
- shell: Shell
- http: HTTP
- javascript: JavaScript
- ruby: Ruby
- python: Python
- php: PHP
- java: Java
- go: Go
toc_footers: []
includes: []
search: true
code_clipboard: true
highlight_theme: darkula
headingLevel: 2
generator: “@tarslib/widdershins v4.0.23”
善逸mis
Base URLs:
Authentication
shanyi-mis-api
POST 修改用户状态
POST /user/changeStatusById
Body 请求参数
{
"id": 5,
"status": 0
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
Token | header | string | 否 | none |
body | body | object | 否 | none |
» id | body | integer | 是 | none |
» status | body | integer | 是 | none |
返回示例
成功
{
"msg": "success",
"code": 200
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
» msg | string | true | none | none | |
» code | integer | true | none | none |
POST 查询用户打卡
POST /user/searchCheckInByPage
Body 请求参数
{
"page": 1,
"length": 10,
"userId": null,
"nickName": "",
"name": "",
"email": "2534165765@qq.com",
"startTime": "",
"endTime": "",
"order": "desc"
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
Token | header | string | 否 | none |
body | body | object | 否 | none |
» page | body | integer | 是 | none |
» length | body | integer | 是 | none |
» userId | body | integer | 否 | none |
» nickName | body | string | 否 | none |
» name | body | string | 否 | none |
body | string | 否 | none | |
» startTime | body | string | 否 | none |
» endTime | body | string | 否 | none |
» order | body | string | 是 | none |
返回示例
成功
{
"msg": "success",
"result": {
"totalCount": 1,
"pageSize": 10,
"totalPage": 1,
"pageIndex": 1,
"list": [
{
"images": "https://thirdwx.qlogo.cn/mmopen/vi_32/6ibtnStKibXDUTibnu052w40ps0DKqcUZBYaAiberiasgSsTGXwCLAicmXng2gE48ZnibYrmnPIiaVlNWjpCYiby85ibgM8Q/132",
"user_id": 5,
"nickName": "绊象",
"name": "陈泽胜",
"time": "2024-05-21T17:34:25",
"text": "今天打卡",
"analysis": "暂无"
}
]
},
"code": 200
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
» msg | string | true | none | none | |
» result | object | true | none | none | |
»» totalCount | integer | true | none | none | |
»» pageSize | integer | true | none | none | |
»» totalPage | integer | true | none | none | |
»» pageIndex | integer | true | none | none | |
»» list | [object] | true | none | none | |
»»» images | string | false | none | none | |
»»» user_id | integer | false | none | none | |
»»» nickName | string | false | none | none | |
»»» name | string | false | none | none | |
»»» time | string | false | none | none | |
»»» text | string | false | none | none | |
»»» analysis | string | false | none | none | |
» code | integer | true | none | none |
POST 查询活动
POST /mis_user/searchActivityByPage
前端返回要查询活动的信息,后端返回分页查询的活动信息
Body 请求参数
{
"page": 1,
"length": 10,
"id": null,
"activityName": "",
"startTime": "",
"endTime": "",
"status": null
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
Token | header | string | 否 | none |
body | body | object | 否 | none |
» page | body | integer | 是 | none |
» length | body | integer | 是 | none |
» id | body | integer | 否 | none |
» activityName | body | string | 否 | none |
» startTime | body | string | 否 | none |
» endTime | body | string | 否 | none |
» status | body | integer | 否 | 活动状态(0未开始,1进行中,2已结束) |
返回示例
成功
{
"msg": "success",
"result": {
"totalCount": 7,
"pageSize": 10,
"totalPage": 1,
"pageIndex": 1,
"list": [
{
"reward": "大白兔礼包",
"start_time": "2024-06-01",
"requirements": "连续打卡1天",
"participants_count": 103,
"name": "六一活动",
"end_time": "2024-08-07",
"description": "儿童节活动",
"count_day": 1,
"id": 1,
"picture": "https://lhplanet-1316168555.cos.ap-beijing.myqcloud.com/shanyi/development-documentation/development-documentation-v3.0.assets/202406221703940.png",
"status": 1
},
{
"reward": "劳动礼包",
"start_time": "2024-05-01",
"requirements": "连续打卡5天",
"participants_count": 502,
"name": "五一活动",
"end_time": "2024-08-30",
"description": "劳动节活动",
"count_day": 5,
"id": 2,
"picture": "https://lhplanet-1316168555.cos.ap-beijing.myqcloud.com/shanyi/development-documentation/development-documentation-v3.0.assets/202406221704667.png",
"status": 1
},
{
"reward": "春节大礼包",
"start_time": "2024-02-01",
"requirements": "连续打卡10天",
"participants_count": 1000,
"name": "春节活动",
"end_time": "2024-03-01",
"description": "春节活动",
"count_day": 10,
"id": 3,
"picture": "https://lhplanet-1316168555.cos.ap-beijing.myqcloud.com/shanyi/development-documentation/development-documentation-v3.0.assets/202406221705143.png",
"status": 1
},
{
"reward": "有机会获得健康饮食礼包或运动器材",
"start_time": "2024-06-14",
"requirements": "用户每天上传一张照片,这张照片可以是与父亲一起共进餐,或者为父亲准备的美食照片。可以只包含食物,不一定要包含父亲。即图片要求满足下面之一即可:1.有食物;2.有人物和食物;",
"participants_count": 1003,
"name": "\"父爱如山,食在心间\"父亲节特别活动",
"end_time": "2024-06-23",
"description": "上传与父亲的进餐瞬间",
"count_day": 5,
"id": 8,
"picture": "https://lhplanet-1316168555.cos.ap-beijing.myqcloud.com/shanyi/development-documentation/development-documentation-v3.0.assets/202406161248411.jpg",
"status": 1
},
{
"reward": "欢度元旦大礼包",
"start_time": "2023-12-31",
"requirements": "连续打卡1天",
"participants_count": 0,
"name": "元旦活动",
"end_time": "2023-12-31",
"description": "欢度元旦",
"count_day": 1,
"id": 9,
"picture": "https://lhplanet-1316168555.cos.ap-beijing.myqcloud.com/shanyi/development-documentation/development-documentation-v3.0.assets/202406221929172.png",
"status": 1
},
{
"reward": "情人节大礼包",
"start_time": "2024-02-14",
"requirements": "打卡一天",
"participants_count": 0,
"name": "情人节活动",
"end_time": "2024-02-14",
"description": "情人节",
"count_day": 1,
"id": 10,
"picture": "https://lhplanet-1316168555.cos.ap-beijing.myqcloud.com/shanyi/development-documentation/development-documentation-v3.0.assets/202406221932526.png",
"status": 1
},
{
"reward": "5积分",
"start_time": "2024-06-20",
"requirements": "发布一张光盘图片",
"participants_count": 0,
"name": "七一活动",
"end_time": "2024-06-27",
"description": "学习建党精神,珍惜粮食资源",
"count_day": 0,
"id": 12,
"picture": "https://lhplanet-1316168555.cos.ap-beijing.myqcloud.com/shanyi/development-documentation/development-documentation-v3.0.assets/202406232003814.jpg",
"status": 1
}
]
},
"code": 200
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
» code | integer | true | none | none | |
» msg | string | true | none | none | |
» result | object | true | none | none | |
»» totalCount | integer | true | none | none | |
»» pageSize | integer | true | none | none | |
»» totalPage | integer | true | none | none | |
»» pageIndex | integer | true | none | none | |
»» list | [object] | true | none | none | |
»»» reward | string | true | none | none | |
»»» start_time | string | true | none | none | |
»»» requirements | string | true | none | none | |
»»» participants_count | integer | true | none | none | |
»»» name | string | true | none | none | |
»»» end_time | string | true | none | none | |
»»» description | string | true | none | none | |
»»» id | integer | true | none | none | |
»»» picture | string | true | none | none | |
»»» status | integer | true | none | none | |
»»» count_day | integer | true | none | none |
POST 新增活动
POST /mis_user/addActivity
前端返回要新增的活动信息,后端插入新的活动
Body 请求参数
{
"name": "测试活动",
"description": "测试活动",
"requirements": "测试需要",
"startTime": "2000-01-01",
"endTime": "2025-01-01",
"reward": "棒棒糖",
"picture": "http://dummyimage.com/400x400",
"status": 0,
"countDay": 1
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
Token | header | string | 否 | none |
body | body | object | 否 | none |
» name | body | string | 是 | none |
» description | body | string | 是 | none |
» requirements | body | string | 是 | none |
» startTime | body | string | 是 | none |
» endTime | body | string | 是 | none |
» reward | body | string | 是 | none |
» picture | body | string | 是 | none |
» status | body | integer | 是 | none |
» countDay | body | integer | 是 | none |
返回示例
成功
{
"msg": "success",
"code": 200
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
» code | integer | true | none | none | |
» msg | string | true | none | none |
POST 修改活动
POST /mis_user/updateActivity
前端返回修改后的活动信息,后端更新互动信息
Body 请求参数
{
"id": 5,
"name": "修改测试活动",
"description": "修改测试活动",
"requirements": "修改测试活动",
"startTime": "2010-01-02",
"endTime": "2030-01-03",
"reward": "修改奖励",
"status": "2",
"picture": "http://dummyimage.com/400x400"
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
Token | header | string | 否 | none |
body | body | object | 否 | none |
» id | body | integer | 是 | none |
» name | body | string | 是 | none |
» description | body | string | 是 | none |
» requirements | body | string | 是 | none |
» startTime | body | string | 是 | none |
» endTime | body | string | 是 | none |
» reward | body | string | 是 | none |
» status | body | string | 是 | none |
» picture | body | string | 是 | none |
返回示例
成功
{
"msg": "success",
"code": 200
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
» code | string | true | none | none | |
» msg | string | true | none | none |
POST 分页查询用户
POST /user/searchByPage
Body 请求参数
{
"id": null,
"nickName": "",
"name": "",
"phone": "",
"email": "",
"status": null,
"order": "",
"page": 1,
"length": 10
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
Token | header | string | 否 | none |
body | body | object | 否 | none |
» id | body | integer | 否 | none |
» nickName | body | string | 否 | none |
» name | body | string | 否 | none |
» phone | body | string | 否 | none |
body | string | 否 | none | |
» status | body | integer | 否 | none |
» order | body | string | 否 | none |
» page | body | integer | 否 | none |
» length | body | integer | 否 | none |
返回示例
200 Response
{
"msg": "string",
"result": {
"totalCount": 0,
"pageSize": 0,
"totalPage": 0,
"pageIndex": 0,
"list": [
"string"
]
},
"code": 0
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
» msg | string | true | none | none | |
» result | object | true | none | none | |
»» totalCount | integer | true | none | none | |
»» pageSize | integer | true | none | none | |
»» totalPage | integer | true | none | none | |
»» pageIndex | integer | true | none | none | |
»» list | [string] | true | none | none | |
» code | integer | true | none | none |
POST 根据用户id查询用户信息
POST /user/searchById
Body 请求参数
{
"id": 6
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
Token | header | string | 否 | none |
body | body | object | 否 | none |
» id | body | integer | 是 | ID 编号 |
返回示例
500 Response
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
500 | Internal Server Error | 服务器错误 | Inline |