[TOC]
{
"id":123456789,
"type":"xxx",
"subtype":"xxxx",
"data":{
"key":"value"
}
}{
"id":123456789,
"status":0,
"message":"successful",
"data":{
"key":"value"
}
}所需参数介绍:
| 参数 | 介绍 | 调用方 | 样例 |
|---|---|---|---|
| id | 事件处理id,整型,请求端发送,接收端返回时原样返回 | 请求、返回 | "id":123456 |
| status | 返回请求处理状态,请求时status填写0。默认返回0时为请求处理成功,若失败返回错误码 | 返回 | "status":0 |
| message | 状态简略信息,若成功调用则返回"successful",失败返回错误信息 | 返回 | "message":"successful" |
| type | 请求类型 | 请求 | "type":"user" |
| subtype | 请求子类型 | 请求 | "subtype":"login" |
| data | 包含附加或返回的请求数据 | 请求、返回 | "data":{"token":"xxxxxxxxxxxxx"} |
API说明
此API用于生成一个5位字母数字混合的图形验证码
成功则返回图片的base64数据和一个5位rand值。
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/captcha
POST发送请求的json文本
{
"id":事件ID, # 整数型
"type":"img",
"subtype":"generate",
"data":{}
}Python端返回成功处理情况
{
"id":请求时的ID, # 整数型
"status":0,
"message":"successful",
"data":{
"imgdata":"iVBORw0yrfmx5m7975n32/23Y+cdf1Rv9oA6.....(以下省略)",
"rand":"CST43" #随机文本
}
}id字段需是整型数据。若是文本型数字数据,返回时自动转换成整数型数据;若是非数字型文本,则返回-1。id用于让前端在服务繁忙时能够对应服务;- Python成功返回时的
imgdata为验证码base64图片数据,前端获得数据后进行转码再显示; rand为随机字符串,前端获得验证码后需要将验证码和rand文本MD5加密后传给后端进行验证,hash = MD5(code+rand)。- 验证码不区分大小写,请自行将验证码转换成全部小写再进行hash操作。
Python端返回失败处理情况
{
"id":"请求时的ID",
"status":1000, # 错误码
"message":"验证码文件创建失败",
"data":{},
}status传递的错误码类型为整型。具体的错误码详见全局status表和局部status表。
所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -3 |
| -2 |
| -1 |
API说明
此API用于校验用户输入的验证码是否正确,在目前版本中,此API暂时用不到
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/captcha
POST发送请求的json文本
{
"id":事件ID, # 整数型
"type":"img",
"subtype":"validate",
"data":{"hash":"asddwfw……"}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| hash | string | 32 | cffb7f1eb316fd45bbfbd43082e36f9c | hash = MD5(imgcode + rand |
hash字段的数据要求是用户填写的验证码内容与rand文本进行MD5加密获得。即hash = MD5(code + rand)- 验证码不区分大小写,请自行将验证码转换成全部小写再进行hash操作。
Python端返回成功处理情况
{
"id":请求时的ID, # 整数型
"status":0,
"message":"successful",
"data":{}
}Python端返回失败处理情况
{
"id":请求时的ID,
"status":-1, # 验证码hash值不匹配
"message":"验证码hash值不匹配",
"data":{},
}status传递的错误码类型为整型。具体的错误码详见全局status表和局部status表。
所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -404 |
| -3 |
| -2 |
| -1 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Error captcha hash | 校验失败,验证码hash值不匹配(包括验证码过期) |
API说明
最新修改:增加了command_type字段,可缺省,默认为1,用于判断短信信息种类
此API用于以手机号作为账号进行注册时发送短信验证码
成功则向指定手机发送短信,并返回一个5位rand值,用于用户注册时
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/captcha
POST发送请求的json文本
{
"id":事件ID,
"type":"sms",
"subtype":"generate",
"data":{
"phone":"137xxxxxxxx",
"command_type":1
}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| phone | string | 11 | 13750687010 | 中国大陆11位手机号 | ||
| command_type | √ | int | 1 | 1为注册账号,2为找回密码 | ||
| hash | √ | string | 32 | cffb7f1eb316fd45bbfbd43082e36f9c | 该字段目前不使用hash = MD5(imgcode + rand |
phone字段需用文本型传递,且只能为中国大陆手机号,不支持国外手机号hash字段的数据要求是用户填写的验证码内容与rand文本进行MD5加密获得。即hash = MD5(code + rand)
Python端返回成功处理情况
{
"id":请求时的ID,
"status":0,
"message":"successful",
"data":{
"rand":"DSf4s"
}
}- 新版本里将返回数据
data中的code字段删除了。 rand为随机字符串,前端获得验证码后需要将验证码和rand文本进行MD5加密后传给后端端进行验证,hash = MD5(code+rand),此hash用于账号注册。- 手机验证码的时效为3min,由后端处理。验证码超时后端会返回
status = -4的错误。
Python端返回失败处理情况
{
"id":请求时的ID,
"status":1016, #错误码
"message":"手机号格式错误",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -404 |
| -3 |
| -2 |
| -1 |
局部status表
| status |
|---|
| 具体错误码请看腾讯云短信错误码 |
status传递的错误码类型为整型。具体的错误码参照腾讯云短信服务API文档。 短信错误码
API说明
此API用于以手机号作为登录凭证时的登录请求
成功返回token值
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/user/login
POST发送请求的json文本
{
"id":1234,
"type":"login",
"subtype":"pass",
"data":{
"phone":"13750687010",
"pass":"wlc570Q0",
"enduring":False,
}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| phone | string | 11 | 13750687010 | 登录账号(手机号) | ||
| pass | string | 由前端决定 | wlc570Q0 | 登录密码 | ||
| enduring | √ | int | 1 | False | 是否为长效登录,1为长效,0为非长效(无操作10min) 默认为0 |
phone字段需用文本型传递pass字段的长度由前端限制,后端只取其MD5值进行判断
Python端返回成功处理情况
{
"id": 1234,
"status": 0,
"message": "Successful",
"data": {
"token": "debc454ea24827b67178482fd73f37c3"
}
}- 获取的
token用于后期所有需要用户验证的请求操作。 - 账号每登录一次即可获得一个
token - 一个账号同时获得10个以上的
token时,自动删除早期的token,维持token数在10以内 - 获得的
token未被用于任何操作超过10min后将被自动删除(设置为长效token的除外) - 若
enduring传递了非int类型数据,则自动为0
Python端返回失败处理情况
{
"id":1234,
"status":101, #错误码
"message":"Error password",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -3 |
| -2 |
| -1 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Incorrect user | 无该账号记录 |
| 101 | Error password | 用户输入的密码错误 |
| 200 | Invalid record number | 有两条及以上该账号的数据 |
| 300 | Add token failed | 获取token失败 |
API说明
此API用于以手机号作为登录凭证时的注册请求
成功返回token值
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/user/register
POST发送请求的json文本
{
"id":0,
"status":0,
"type":"register",
"subtype":"phone",
"data":{
"phone":"13750687010",
"hash":"cffb7f1eb316fd45bbfbd43082e36f9c",
"pass":"wlc570Q0"
}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| phone | string | 11 | 13750687010 | 登录账号(手机号) | ||
| hash | string | 32 | cffb7f1eb316fd45bbfbd43082e36f9c | 此hash由手机验证码的code与rand进行MD5加密获得hash=MD5(smscode+rand) |
||
| pass | string | 由前端决定 | wlc570Q0 | 登录密码 |
phone字段需用文本型传递pass字段的长度由前端限制,后端只取其MD5值进行判断
Python端返回成功处理情况
{
"id": 1234,
"status": 0,
"message": "Successful",
"data": {}
}Python端返回失败处理情况
{
"id":1234,
"status":101, #错误码
"message":"Phone number existed",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -3 |
| -2 |
| -1 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Incorrect user data | 创建账号失败 |
| 101 | Phone number existed | 手机号已存在 |
| 102 | Incorrect user information | 创建用户资料失败 |
| 200 | Invalid record number | 有两条及以上该账号的数据 |
| 400 | Error hash | Hash校验文本错误 |
API说明
此API用于找回以手机号作为登录凭证时的密码找回
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/user/password
POST发送请求的json文本
{
"id":0,
"status":0,
"type":"password",
"subtype":"forget",
"data":{
"phone":"13750687010",
"hash":"cffb7f1eb316fd45bbfbd43082e36f9c",
"pass":"wlc570Q0"
}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| phone | string | 11 | 13750687010 | 登录账号(手机号) | ||
| hash | string | 32 | cffb7f1eb316fd45bbfbd43082e36f9c | 此hash由手机验证码的code与rand进行MD5加密获得hash=MD5(smscode+rand) |
||
| pass | string | 由前端决定 | wlc570Q0 | 登录密码 |
- 使用api前,需要先调用一次短信验证码发送请求,且短信请求中command_type为2
phone字段需用文本型传递pass字段的长度由前端限制,后端只取其MD5值进行判断
Python端返回成功处理情况
{
"id": 1234,
"status": 0,
"message": "Successful",
"data": {}
}Python端返回失败处理情况
{
"id":1234,
"status":101, #错误码
"message":"Phone number existed",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -3 |
| -2 |
| -1 |
局部status表
| status | message | 内容 |
|---|---|---|
| 400 | Error hash | Hash校验文本错误 |
API说明
此API用于找回以手机号作为登录凭证时的密码修改
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/user/password
POST发送请求的json文本
{
"id":0,
"status":0,
"type":"password",
"subtype":"change",
"data":{
"phone":"13750687010",
"old":"wlc570Q0",
"new":"abc123"
}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| phone | string | 11 | 13750687010 | 登录账号(手机号) | ||
| old | string | 由前端决定 | cffb7f1eb316fd45bbfbd43082e36f9c | 老密码 | ||
| new | string | 由前端决定 | abc123 | 新密码 |
phone字段需用文本型传递old、new字段的长度由前端限制,后端只取其MD5值进行判断
Python端返回成功处理情况
{
"id": 1234,
"status": 0,
"message": "Successful",
"data": {}
}Python端返回失败处理情况
{
"id":1234,
"status":101, #错误码
"message":"Phone number existed",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -3 |
| -2 |
| -1 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Incorrect user | 无该账号记录 |
| 101 | Error password | 用户输入的密码错误 |
| 200 | Invalid record number | 有两条及以上该账号的数据 |
| 300 | Add token failed | 获取token失败 |
API说明
此API用于通过phone值获取对应用户信息
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/user/nickname?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":0,
"type":"info",
"subtype":"nickname",
"data":{
"user_id":"13750687010"
}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| phone | string | 11 | 13750687010 | 登录账号(手机号) |
Python端返回成功处理情况
{
"id": -1,
"status": 0,
"message": "Successful",
"data": {
"nickname": "FatBallFish"
}
}Python端返回失败处理情况
{
"id": -1,
"status": 1,
"message": "Error Token",
"data": {}
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -100 |
| -3 |
| -2 |
| -1 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | user not existed | 账号不存在 |
| 200 | Unkonwn user info Error | 同一phone大于2条 |
API说明
此API用于通过token值获取对应用户信息
API类型
请求类型:GET
API地址:
https://dmt.lcworkroom.cn/api/user/info?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
Python端返回成功处理情况
{
"id": -1,
"status": 0,
"message": "Successful",
"data": {
"phone": "13750687010",
"name": "\u738b\u51cc\u8d85",
"nickname": "FatBallFish",
"email": "893721708@qq.com",
"level": 1
}
}Python端返回失败处理情况
{
"id": -1,
"status": 1,
"message": "Error Token",
"data": {}
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -100 |
局部status表
| status | message | 内容 |
|---|---|---|
| 1 | Error Token | token不正确 |
API说明
此API用于更新用户信息
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/user/info?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":0,
"type":"info",
"subtype":"update",
"data":{
"phone":"13750687010",
"name":"王凌超",
"nickname":"FatBallFish",
"email":"893721708@qq.com"}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| phone | string | 11 | 13750687010 | 登录账号(手机号) | ||
| name | √ | √ | string | 20 | cffb7f1eb316fd45bbfbd43082e36f9c | |
| nickname | √ | √ | string | 20 | wlc570Q0 | 登录密码 |
| √ | √ | string | 50 | 893721708@qq.com | 邮箱地址 | |
| level | √ | int | 1 | 用户等级 |
phone用作检验机制,不可被修改level字段若被使用则必须传递数值,不能为空
Python端返回成功处理情况
{
"id": 1234,
"status": 0,
"message": "Successful",
"data": {}
}Python端返回失败处理情况
{
"id":1234,
"status":101, #错误码
"message":"Phone number existed",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -101 |
| -100 |
| -3 |
| -2 |
| -1 |
API说明
此API用于上传用户的头像图片
成功返回头像的url地址
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/portrait?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":1234,
"type":"portrait",
"subtype":"upload",
"data":{
"base64":img_base64 # string型
}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| base64 | string | /9j/4AAQSkZJRgABAQEA.......(长度过长省略) | 图片的base64格式文本,前端尽量限制图片大小在1M以下,否则容易卡顿,3M以上请求容易失败 |
base64可选择是否带有base头标识,实际不影响。标识例子:data:image/jpg;base64,- 若该用户原先已有头像,新头像将自动覆盖原有头像,原头像被删除。
Python端返回成功处理情况
{
"id": 1234,
"status": 0,
"message": "Successful",
"data": {
"url": "./api/get/portrait/13750687010"
}
}Python端返回失败处理情况
{
"id":1234,
"status":-100, #错误码
"message":"Missing necessary args",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -101 |
| -100 |
| -3 |
| -2 |
| -1 |
API说明
此API用于通过token值获取对应用户信息
API类型
请求类型:GET
API地址:
https://dmt.lcworkroom.cn/api/get/portrait/<user_id>
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| user_id | string | 11 | 13750687010 | 用户id |
API例子
https://dmt.lcworkroom.cn/api/get/portrait/13750687010
Python端返回成功处理情况
二进制型图片数据(bytes)- 前端调用此api时,直接将api地址写在
src中即可,例如:<img src="proxy.php?url=https%3A%2F%2Fdmt.lcworkroom.cn%2Fget%2Fportrait%2F1180310086">
Python端返回失败处理情况
视情况返回以下三种图片:
1.在服务器域名外访问此api,返回“ban.jpg”,提示“多媒体站内图片,禁止外部引用”
2.输入的user_id不存在但格式正确返回“default.jpg”,即默认头像
3.输入的user_id格式出错(出现非数字字符),返回“error.jpg”,提示“参数传递错误,无法获取图片”- 调用此api时,请注意当前api所在地址,若非
https://dmt.lcworkroom.cn或http://localhost这两个根域名的话,将会返回ban.jpg
所用到的全局status
无
API说明
此API用于检验token是否有效,若有效并刷新token有效时间。
API类型
请求类型:GET
API地址:
https://dmt.lcworkroom.cn/api/user/doki?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
Python端返回成功处理情况
{
"id": id,
"status": 0,
"message": "Successful",
"data": {}
}Python端返回失败处理情况
{
"id": -1,
"status": 1,
"message": "Token not existed",
"data": {}
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -100 |
局部status表
| status | message | 内容 |
|---|---|---|
| 1 | Token not existed | Token不存在 |
| 200 | Invalid token number | 同一Token大于2条 |
API说明
此API用于增加论坛文章内容
成功返回article_id
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/article?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":1234,
"type":"article",
"subtype":"add",
"data":{
"title":"测试文章",
"content":"王凌超"}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| title | string | 255 | 测试文章 | 文章id | ||
| content | string | 这是一篇测试文章 | 文章内容 |
Python端返回成功处理情况
{
"id": 1234,
"status": 0,
"message": "Successful",
"data": {
"article_id":1565920055
}
}Python端返回失败处理情况
{
"id":1234,
"status":-200, #错误码
"message":"Failure to operate database",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -101 |
| -100 |
| -3 |
| -2 |
| -1 |
API说明
此API用于更新论坛文章内容
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/article?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":1234,
"type":"article",
"subtype":"update",
"data":{
"article_id":1565920055,
"content":"王凌超"}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| article_id | bigint | 10 | 1565920055 | 文章id | ||
| content | string | 这是一篇测试文章,测试一下更新效果 | 文章内容 |
article_id用作检验机制,不可被修改
Python端返回成功处理情况
{
"id": 1234,
"status": 0,
"message": "Successful",
"data": {}
}Python端返回失败处理情况
{
"id":1234,
"status":100, #错误码
"message":"Error article_id",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -101 |
| -100 |
| -3 |
| -2 |
| -1 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Error article_id | 文章id错误,很有可能不存在 |
| 101 | Error user_id | 文章作者id与当前登录id不一致 |
API说明
此API用于删除论坛文章
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/article?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":1234,
"type":"article",
"subtype":"delete",
"data":{
"article_id":1565920055}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| article_id | bigint | 10 | 1565920055 | 文章id |
Python端返回成功处理情况
{
"id": 1234,
"status": 0,
"message": "Successful",
"data": {}
}Python端返回失败处理情况
{
"id":1234,
"status":100, #错误码
"message":"Error article_id",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -101 |
| -100 |
| -3 |
| -2 |
| -1 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Error article_id | 文章id错误,很有可能不存在 |
| 101 | Error user_id | 文章作者id与当前登录id不一致 |
API说明
此API用于获取游客论坛文章列表
API类型
请求类型:GET、POST
两个请求功能一致,就是参数传递方式不一样。
token只能传在url中
API地址:
https://dmt.lcworkroom.cn/api/get/article/list
参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 默认值 | 例子 | 备注 |
|---|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 | |||
| keywords | √ | √ | string | 测试 | 搜索关键字,设置后将以此关键字模糊匹配title和content字段内容,模糊匹配 | ||
| article_id | √ | √ | int | 10 | 1565926081 | 文章id,精确匹配 | |
| user_id | √ | √ | string | 11 | 13750687010 | 用户id,精确匹配 | |
| title | √ | √ | string | 测试文章 | 文章标题,模糊匹配 | ||
| content | √ | √ | string | 这是 | 文章内容,模糊匹配 | ||
| order | √ | √ | string | update_time DESC | title ASC,update_time DESC | 排序规则,使用SQL语句,为空则默认以更新时间进行排序 | |
| start | √ | √ | int | 0 | 0 | 记录索引开始,默认起始为 0 | |
| num | √ | √ | int | 50 | 10 | 返回记录数,默认返回50条 | |
| mode | √ | int | 0 | 0 | 0为显示文章源格式,1为文章简介,自动返回第一行文字 |
- 只传递
token参数则返回所有文章 - 如果
keywords不为空则优先使用keywords,article_id、title、content则被忽略; keywords用于title和content的并集查询,模糊匹配;article_id、user_id、title、content可交集查询;order中可用于排序的字段有article_id,user_id,title,content,create_time,update_time;order排序方法有:升序asc、降序desc,大小写不区分。多条件排序时用英文半角,分割- 当实际记录数小于
num的值时,只返回实际记录数量的记录
URL例程
https://dmt.lcworkroom.cn/api/get/article/list?token=99c9150238fa21051f558ceccad55b8a
Python端返回成功处理情况
{
"id": -1,
"status": 0,
"message": "successful",
"data": {
"num": 1,
"list": [
{"article_id": 1565926081,
"user_id": "13750687010",
"nickename": "FatBallFish",
"title": "测试文章",
"content": "这是一篇测试文章",
"create_time": "2019-08-16 11:28:01",
"update_time": "2019-08-16 11:28:01"}
]
}
}Python端返回失败处理情况
{
"id": -1,
"status": -101,
"message": "Error Token",
"data": {}
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -203 |
| -200 |
| -101 |
| -100 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Error Order | 排序规则错误 |
| 101 | Error num | num值错误,不能<1 |
API说明
此API用于增加论坛文章的评论内容
成功返回article_id、comment_id、father_id
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/comment?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":1234,
"type":"comment",
"subtype":"add",
"data":{
"article_id":1565926081,
"content":"这是一条用API请求的子级评论",
"father_id":"76bd7b76fcd0b23f3d171f39b416d936"
}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| article_id | int | 10 | 1565926081 | 文章id | ||
| content | string | 这是一篇测试文章 | 文章内容 | |||
| father_id | √ | √ | string | 32 | 76bd7b76fcd0b23f3d171f39b416d936 | 父评论id(MD5加密文本),若为空则为根评论,默认为空 |
article_id、father_id用作检验机制,不可被修改
Python端返回成功处理情况
{
"id": 1234,
"status": 0,
"message": "Successful",
"data": {
"article_id": 1565926081,
"comment_id": "354b6ded0748cd837d0ebf06230b9770",
"father_id":"76bd7b76fcd0b23f3d171f39b416d936"
}
}Python端返回失败处理情况
{
"id":1234,
"status":100, #错误码
"message":"Error article_id",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -101 |
| -100 |
| -3 |
| -2 |
| -1 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Error article_id | 文章id错误,很有可能不存在 |
| 101 | Error father_id | 父评论错误,很有可能不存在 |
API说明
此API用于更新论坛文章评论内容
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/comment?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":1234,
"type":"comment",
"subtype":"update",
"data":{
"comment_id":"d757d9ea4c9c1860299a0341524a6a7d",
"content":"这是一条用API更新的子级评论"
}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| comment_id | string | 32 | d757d9ea4c9c1860299a0341524a6a7d | 评论id | ||
| content | string | 这是一篇测试文章,测试一下更新效果 | 文章内容 |
comment_id用作检验机制,不可被修改
Python端返回成功处理情况
{
"id": 1234,
"status": 0,
"message": "Successful",
"data": {}
}Python端返回失败处理情况
{
"id":1234,
"status":100, #错误码
"message":"Error article_id",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -101 |
| -100 |
| -3 |
| -2 |
| -1 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Error comment_id | 评论id错误,很有可能不存在 |
| 101 | Error user_id | 评论作者id与当前登录id不一致 |
API说明
此API用于删除论坛评论文章
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/comment?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":0,
"type":"comment",
"subtype":"delete",
"data":{
"comment_id":"a301c03e1248eabf83785b5548d603ec"}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| comment_id | string | 32 | a301c03e1248eabf83785b5548d603ec | 评论id |
Python端返回成功处理情况
{
"id": 1234,
"status": 0,
"message": "Successful",
"data": {}
}Python端返回失败处理情况
{
"id":1234,
"status":100, #错误码
"message":"Error article_id",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -101 |
| -100 |
| -3 |
| -2 |
| -1 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Error comment_id | 评论id错误,很有可能不存在 |
| 101 | Error user_id | 评论作者id与当前登录id不一致 |
API说明
最新修改:增加user_id字段,可缺省,用于筛选该用户发表过的所有评论
此API用于获取游客论坛文章评论列表
API类型
请求类型:GET、POST
两个请求功能一致,就是参数传递方式不一样。
token只能传在url中
API地址:
https://dmt.lcworkroom.cn/api/get/comment/list
参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 默认值 | 例子 | 备注 |
|---|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 | |||
| article_id | int | 10 | 1565926081 | 文章id,精确匹配 | |||
| comment_id | √ | √ | string | 32 | d757d9ea4c9c1860299a0341524a6a7d | 评论id,精确匹配 | |
| father_id | √ | √ | string | 32 | a301c03e1248eabf83785b5548d603ec | 父评论id,精确匹配 | |
| user_id | √ | √ | string | 11 | 13750687010 | 用户id,精确匹配 | |
| content | √ | √ | string | 这是一条评论内容 | 评论内容,模糊匹配 | ||
| order | √ | √ | string | update_time DESC | title ASC,update_time DESC | 排序规则,使用SQL语句,为空则默认以更新时间进行排序 | |
| start | √ | √ | int | 0 | 0 | 记录索引开始,默认起始为 0 | |
| num | √ | √ | int | 50 | 10 | 返回记录数,默认返回50条 |
- 只传递
token和article_id参数则返回该文章的所有根评论,不含子评论。 article_id、comment_id、father_id、user_id、content可交集查询;order中可用于排序的字段有article_id,user_id,comment_id、father_id、,content,create_time,update_time;order排序方法有:升序asc、降序desc,大小写不区分。多条件排序时用英文半角,分割- 当实际记录数小于
num的值时,只返回实际记录数量的记录
URL例程
Python端返回成功处理情况
{
"id": -1,
"status": 0,
"message": "successful",
"data": {
"num": 2,
"list": [
{
"article_id": 1565926081,
"comment_id": "76bd7b76fcd0b23f3d171f39b416d936",
"father_id": "",
"user_id": "13750687010",
"nickename": "FatBallFish",
"content": "这是一条更新过的评论",
"create_time": "2019-08-18 09:41:41",
"update_time": "2019-08-18 11:08:43"
},
{
"article_id": 1565926081,
"comment_id": "1aa6ddf68bea87f2305dd9fd5d3bb2c8",
"father_id": "",
"user_id": "13750687010",
"nickename": "FatBallFish",
"content": "这是一条测试评论",
"create_time": "2019-08-18 09:32:16",
"update_time": "2019-08-18 09:32:16"
}
]
}
}Python端返回失败处理情况
{
"id": -1,
"status": -101,
"message": "Error Token",
"data": {}
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -203 |
| -200 |
| -101 |
| -100 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Error order | 排序规则错误 |
| 101 | Error num | num值错误,不能<1 |
| 102 | Error article_id | 错误的文章id |
API说明
此API用于增加论坛活动
成功返回active_id
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/active?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":1234,
"type":"active",
"subtype":"add",
"data":{
"title":"校友召集令",
"content":"恰逢更名时机,召集校友来此一聚",
"start_time":"2019-08-24 00:00:00",
"end_time":"2019-8-25 0:0:0"
}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| title | string | 255 | 测试文章 | 文章id | ||
| content | string | 这是一篇测试文章 | 文章内容 | |||
| start_time | datetime | 2019-08-24 00:00:00 | 请按照标准的时间格式文本进行传递,否则会报错 | |||
| end_time | datetime | 2019-08-25 00:00:00 | 请按照标准的时间格式文本进行传递,否则会报错 |
Python端返回成功处理情况
{
"id": 1234,
"status": 0,
"message": "Successful",
"data": {
"active_id":78554587
}
}Python端返回失败处理情况
{
"id":1234,
"status":-200, #错误码
"message":"Failure to operate database",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -101 |
| -100 |
| -3 |
| -2 |
| -1 |
局部status表
| status | message | 内容 |
|---|---|---|
| 102 | Error format or data for time | 开始时间或结束时间格式或数据错误 |
API说明
此API用于更新论坛活动
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/active?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":1234,
"type":"active",
"subtype":"update",
"data":{
"active_id":78554587,
"title":"校友召集令",
"content":"恰逢更名时机,召集校友来此一聚,更新活动内容",
"start_time":"2019-08-25 00:00:00",
"end_time":"2019-08-26 00:00:00"
}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| active_id | int | 8 | 78554587 | 活动id | ||
| title | string | 255 | 测试文章 | 文章id | ||
| content | string | 这是一篇测试文章 | 文章内容 | |||
| start_time | datetime | 2019-08-24 00:00:00 | 请按照标准的时间格式文本进行传递,否则会报错 | |||
| end_time | datetime | 2019-08-25 00:00:00 | 请按照标准的时间格式文本进行传递,否则会报错 |
Python端返回成功处理情况
{
"id": 1234,
"status": 0,
"message": "Successful",
"data": {}
}Python端返回失败处理情况
{
"id":1234,
"status":-200, #错误码
"message":"Failure to operate database",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -101 |
| -100 |
| -3 |
| -2 |
| -1 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Error active_id | 错误的活动id |
| 101 | Error user_id | 活动发起者id与当前登录id不一致 |
| 102 | Error format or data for time | 开始时间或结束时间格式或数据错误 |
API说明
此API用于删除论坛活动
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/active?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":1234,
"type":"active",
"subtype":"delete",
"data":{
"active_id":86889745
}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| active_id | int | 8 | 78554587 | 活动id |
Python端返回成功处理情况
{
"id": 1234,
"status": 0,
"message": "Successful",
"data": {}
}Python端返回失败处理情况
{
"id":1234,
"status":-200, #错误码
"message":"Failure to operate database",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -101 |
| -100 |
| -3 |
| -2 |
| -1 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Error active_id | 错误的活动id |
| 101 | Error user_id | 活动发起者id与当前登录id不一致 |
API说明
最新修改:增加user_id字段,可缺省,用于筛选该用户参加过的所有活动
此API用于获取论坛活动列表
API类型
请求类型:GET、POST
两个请求功能一致,就是参数传递方式不一样。
token只能传在url中
API地址:
https://dmt.lcworkroom.cn/api/get/active/list
参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 默认值 | 例子 | 备注 |
|---|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 | |||
| keywords | √ | √ | string | 测试 | 搜索关键字,设置后将以此关键字模糊匹配title和content字段内容,模糊匹配 | ||
| active_id | √ | √ | int | 8 | 78554587 | 活动id,精确匹配 | |
| user_id | √ | √ | str | 13750687010 | 用户id,精确匹配 | ||
| title | √ | √ | string | 测试文章 | 活动标题,模糊匹配 | ||
| content | √ | √ | string | 这是 | 活动内容,模糊匹配 | ||
| order | √ | √ | string | update_time DESC | title ASC,update_time DESC | 排序规则,使用SQL语句,为空则默认以更新时间进行排序 | |
| start | √ | √ | int | 0 | 0 | 记录索引开始,默认起始为 0 | |
| num | √ | √ | int | 50 | 10 | 返回记录数,默认返回50条 | |
| mode | √ | int | 0 | 0 | 0为显示文章源格式,1为文章简介,自动返回第一行文字 |
- 只传递
token参数则返回所有活动 - 如果
keywords不为空则优先使用keywords,article_id、title、content则被忽略; keywords用于title和content的并集查询,模糊匹配;active_id、user_id、title、content可交集查询;order中可用于排序的字段有active_id,user_id,title,content,start_time,end_time,create_time,update_time;order排序方法有:升序asc、降序desc,大小写不区分。多条件排序时用英文半角,分割- 当实际记录数小于
num的值时,只返回实际记录数量的记录
URL例程
https://dmt.lcworkroom.cn/api/get/active/list?token=99c9150238fa21051f558ceccad55b8a
Python端返回成功处理情况
{
"id": -1,
"status": 0,
"message": "successful",
"data": {
"num": 1,
"list": [
{"active_id": 78554587,
"user_id": "13750687010",
"nickename": "FatBallFish",
"title": "校友召集令",
"content": "恰逢更名时机,召集校友来此一聚,更新活动内容",
"start_time": "2019-08-25 00:00:00",
"end_time": "2019-08-26 00:00:00",
"create_time": "2019-08-24 15:29:57",
"update_time": "2019-08-24 15:29:57"}
]
}
}Python端返回失败处理情况
{
"id": -1,
"status": -101,
"message": "Error Token",
"data": {}
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -203 |
| -200 |
| -101 |
| -100 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Error Order | 排序规则错误 |
| 101 | Error num | num值错误,不能<1 |
API说明
此API用于用户加入活动
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/active?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":1234,
"type":"active",
"subtype":"join",
"data":{
"active_id":78554587,
}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| active_id | int | 8 | 78554587 | 活动id |
Python端返回成功处理情况
{
"id": 1234,
"status": 0,
"message": "Successful",
"data": {}
}Python端返回失败处理情况
{
"id":1234,
"status":-200, #错误码
"message":"Failure to operate database",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -101 |
| -100 |
| -3 |
| -2 |
| -1 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Error active_id | 错误的活动id,可能并不存在 |
| 102 | Already joined | 用户已加入此活动 |
API说明
此API用于用户加入活动
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/active?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":1234,
"type":"active",
"subtype":"exit",
"data":{
"active_id":78554587,
}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| active_id | int | 8 | 78554587 | 活动id |
Python端返回成功处理情况
{
"id": 1234,
"status": 0,
"message": "Successful",
"data": {}
}Python端返回失败处理情况
{
"id":1234,
"status":-200, #错误码
"message":"Failure to operate database",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -101 |
| -100 |
| -3 |
| -2 |
| -1 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Error active_id | 错误的活动id,可能并不存在 |
| 101 | Error user_id | 活动参与者id与当前登录id不一致或无权限或该用户未加入此活动 |
| 102 | Error format or data for time | 开始时间或结束时间格式或数据错误 |
API说明
此API用于获取论坛活动成员列表
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/get/active/member
参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 默认值 | 例子 | 备注 |
|---|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 | |||
| active_id | int | 8 | 78554587 | 活动id,精确匹配 | |||
| order | √ | √ | string | update_time DESC | join_time ASC | 排序规则,使用SQL语句,为空则默认以加入时间升序排序 | |
| start | √ | √ | int | 0 | 0 | 记录索引开始,默认起始为 0 | |
| num | √ | √ | int | 50 | 10 | 返回记录数,默认返回50条 |
order中可用于排序的字段有active_id,user_id,title,content,start_time,end_time,create_time,update_time;order排序方法有:升序asc、降序desc,大小写不区分。多条件排序时用英文半角,分割- 当实际记录数小于
num的值时,只返回实际记录数量的记录
URL例程
Python端返回成功处理情况
{
"id": -1,
"status": 0,
"message": "successful",
"data": {
"num": 1,
"list": [
"13750687010"
]
}
}Python端返回失败处理情况
{
"id": -1,
"status": -101,
"message": "Error Token",
"data": {}
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -203 |
| -200 |
| -101 |
| -100 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Error Order | 排序规则错误 |
| 102 | Error active_id | 错误的活动id |
API说明
此API获取所有用户列表,仅管理员权限用户可用
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/admin/user?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得,管理员token |
POST发送请求的json文本
{
"id":1234,
"type":"user",
"subtype":"list",
"data":{}
}Python端返回成功处理情况
{
"id": 0,
"status": 0,
"message": "successful",
"data": [
{
"phone": "13566284913",
"name": "\u8bb8\u6df3\u7693",
"nickname": "\u8bb8\u5927\u5e05\u54e5",
"email": "1010549831@qq.com",
"level": 1},
{
"phone": "13750687010",
"name": "\u738b\u51cc\u8d85",
"nickname": "FatBallFish",
"email": "893721708@qq.com",
"level": 1},
{
"phone": "15857174214",
"name": null,
"nickname": null,
"email": null,
"level": 1},
{
"phone": "15925868186",
"name": null,
"nickname": null,
"email": null,
"level": 1},
{
"phone": "17767174231",
"name": null,
"nickname": null,
"email": null,
"level": 1},
{
"phone": "17816064319",
"name": "\u94b1\u4e39",
"nickname": "\u86cb\u86cb",
"email": "3391791582@qq.com",
"level": 1},
{
"phone": "19857160634",
"name": null,
"nickname": null,
"email": null,
"level": 1}
]
}Python端返回失败处理情况
{
"id":1234,
"status":-103, #错误码
"message":"No permission to operate",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -103 |
| -101 |
| -100 |
| -3 |
| -2 |
| -1 |
API说明
此API用于通过user_id值获取对应用户信息,仅管理员权限用户可用
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/admin/user?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":0,
"type":"user",
"subtype":"info",
"data":{"phone":"13750687010"}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| phone | string | 11 | 13750687010 | 登录账号(手机号) |
Python端返回成功处理情况
{
"id": -1,
"status": 0,
"message": "Successful",
"data": {
"phone": "13750687010",
"name": "\u738b\u51cc\u8d85",
"nickname": "FatBallFish",
"email": "893721708@qq.com",
"level": 1
}
}Python端返回失败处理情况
{
"id": -1,
"status": 1,
"message": "Error Token",
"data": {}
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -103 |
| -101 |
| -100 |
| -3 |
| -2 |
| -1 |
API说明
此API用于更新用户信息,仅管理员权限用户可用
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/admin/user?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":0,
"type":"user",
"subtype":"update",
"data":{
"phone":"13750687010",
"name":"王凌超",
"nickname":"FatBallFish",
"email":"893721708@qq.com"}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| phone | string | 11 | 13750687010 | 登录账号(手机号) | ||
| name | √ | √ | string | 20 | cffb7f1eb316fd45bbfbd43082e36f9c | |
| nickname | √ | √ | string | 20 | wlc570Q0 | 登录密码 |
| √ | √ | string | 50 | 893721708@qq.com | 邮箱地址 | |
| level | √ | int | 1 | 用户等级 |
phone用作检验机制,不可被修改level字段若被使用则必须传递数值,不能为空
Python端返回成功处理情况
{
"id": 1234,
"status": 0,
"message": "Successful",
"data": {}
}Python端返回失败处理情况
{
"id":1234,
"status":101, #错误码
"message":"Phone number existed",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -103 |
| -101 |
| -100 |
| -3 |
| -2 |
| -1 |
API说明
此API用于通过user_id值删除对应用户,仅管理员权限用户可用
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/admin/user?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":0,
"type":"user",
"subtype":"delete",
"data":{"phone":"13750687010"}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| phone | string | 11 | 13750687010 | 登录账号(手机号) |
Python端返回成功处理情况
{
"id": -1,
"status": 0,
"message": "Successful",
"data": {}
}Python端返回失败处理情况
{
"id": -1,
"status": 1,
"message": "Error Token",
"data": {}
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -103 |
| -101 |
| -100 |
| -3 |
| -2 |
| -1 |
API说明
此API用于获取游客论坛文章列表
获取单篇文章信息也用此api,传递一个article_id参数即可获取只有一个数据的列表
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/admin/article?token
url参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":0,
"type":"article",
"subtype":"list",
"data":{
"user_id":"13750687010",
}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 默认值 | 例子 | 备注 |
|---|---|---|---|---|---|---|---|
| keywords | √ | √ | string | 测试 | 搜索关键字,设置后将以此关键字模糊匹配title和content字段内容,模糊匹配 | ||
| article_id | √ | √ | int | 10 | 1565926081 | 文章id,精确匹配 | |
| user_id | √ | √ | string | 11 | 13750687010 | 用户id,精确匹配 | |
| title | √ | √ | string | 测试文章 | 文章标题,模糊匹配 | ||
| content | √ | √ | string | 这是 | 文章内容,模糊匹配 | ||
| order | √ | √ | string | update_time DESC | title ASC,update_time DESC | 排序规则,使用SQL语句,为空则默认以更新时间进行排序 | |
| start | √ | √ | int | 0 | 0 | 记录索引开始,默认起始为 0 | |
| num | √ | √ | int | 50 | 10 | 返回记录数,默认返回50条 | |
| mode | √ | int | 0 | 0 | 0为显示文章源格式,1为文章简介,自动返回第一行文字 |
- 不传任何字段参数则返回所有文章
- 如果
keywords不为空则优先使用keywords,article_id、title、content则被忽略; keywords用于title和content的并集查询,模糊匹配;article_id、user_id、title、content可交集查询;order中可用于排序的字段有article_id,user_id,title,content,create_time,update_time;order排序方法有:升序asc、降序desc,大小写不区分。多条件排序时用英文半角,分割- 当实际记录数小于
num的值时,只返回实际记录数量的记录
Python端返回成功处理情况
{
"id": -1,
"status": 0,
"message": "successful",
"data": {
"num": 1,
"list": [
{"article_id": 1565926081,
"user_id": "13750687010",
"nickename": "FatBallFish",
"title": "测试文章",
"content": "这是一篇测试文章",
"create_time": "2019-08-16 11:28:01",
"update_time": "2019-08-16 11:28:01"}
]
}
}Python端返回失败处理情况
{
"id": -1,
"status": -101,
"message": "Error Token",
"data": {}
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -203 |
| -200 |
| -101 |
| -100 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Error Order | 排序规则错误 |
| 101 | Error num | num值错误,不能<1 |
API说明
此API用于增加论坛文章内容
成功返回article_id
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/admin/article?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":1234,
"type":"article",
"subtype":"add",
"data":{
"user_id":"13750687010",
"title":"测试文章",
"content":"王凌超"}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| user_id | string | 11 | 13750687010 | 文章作者id | ||
| title | string | 255 | 测试文章 | 文章id | ||
| content | string | 这是一篇测试文章 | 文章内容 |
Python端返回成功处理情况
{
"id": 1234,
"status": 0,
"message": "Successful",
"data": {
"article_id":1565920055
}
}Python端返回失败处理情况
{
"id":1234,
"status":-200, #错误码
"message":"Failure to operate database",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -101 |
| -100 |
| -3 |
| -2 |
| -1 |
API说明
此API用于更新论坛文章内容
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/admin/article?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":1234,
"type":"article",
"subtype":"update",
"data":{
"user_id":"13750687010",
"article_id":1565920055,
"content":"王凌超"}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| user_id | string | 11 | 13750687010 | 文章作者id | ||
| article_id | bigint | 10 | 1565920055 | 文章id | ||
| title_id | √ | string | 11 | 测试标题 | 文章标题,可缺省 | |
| content | string | 这是一篇测试文章,测试一下更新效果 | 文章内容 |
article_id用作检验机制,不可被修改
Python端返回成功处理情况
{
"id": 1234,
"status": 0,
"message": "Successful",
"data": {}
}Python端返回失败处理情况
{
"id":1234,
"status":100, #错误码
"message":"Error article_id",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -101 |
| -100 |
| -3 |
| -2 |
| -1 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Error article_id | 文章id错误,很有可能不存在 |
| 101 | Error user_id | 文章作者id与当前登录id不一致 |
API说明
此API用于删除论坛文章
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/admin/article?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":1234,
"type":"article",
"subtype":"delete",
"data":{
"article_id":1565920055}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| user_id | string | 11 | 13750687010 | 文章作者id | ||
| article_id | bigint | 10 | 1565920055 | 文章id |
Python端返回成功处理情况
{
"id": 1234,
"status": 0,
"message": "Successful",
"data": {}
}Python端返回失败处理情况
{
"id":1234,
"status":100, #错误码
"message":"Error article_id",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -101 |
| -100 |
| -3 |
| -2 |
| -1 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Error article_id | 文章id错误,很有可能不存在 |
| 101 | Error user_id | 文章作者id与当前登录id不一致 |
API说明
最新修改:增加user_id字段,可缺省,用于筛选该用户发表过的所有评论
此API用于获取游客论坛文章评论列表
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/admin/comment?token=
url参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":0,
"type":"comment",
"subtype":"list",
"data":{
"user_id":"13750687010",
"article_id":1568546112,
}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 默认值 | 例子 | 备注 |
|---|---|---|---|---|---|---|---|
| article_id | int | 10 | 1565926081 | 文章id,精确匹配 | |||
| comment_id | √ | √ | string | 32 | d757d9ea4c9c1860299a0341524a6a7d | 评论id,精确匹配 | |
| father_id | √ | √ | string | 32 | a301c03e1248eabf83785b5548d603ec | 父评论id,精确匹配 | |
| user_id | √ | √ | string | 11 | 13750687010 | 用户id,精确匹配 | |
| content | √ | √ | string | 这是一条评论内容 | 评论内容,模糊匹配 | ||
| order | √ | √ | string | update_time DESC | title ASC,update_time DESC | 排序规则,使用SQL语句,为空则默认以更新时间进行排序 | |
| start | √ | √ | int | 0 | 0 | 记录索引开始,默认起始为 0 | |
| num | √ | √ | int | 50 | 10 | 返回记录数,默认返回50条 |
- 只传递
token和article_id参数则返回该文章的所有根评论,不含子评论。 article_id、comment_id、father_id、user_id、content可交集查询;order中可用于排序的字段有article_id,user_id,comment_id、father_id、,content,create_time,update_time;order排序方法有:升序asc、降序desc,大小写不区分。多条件排序时用英文半角,分割- 当实际记录数小于
num的值时,只返回实际记录数量的记录
Python端返回成功处理情况
{
"id": -1,
"status": 0,
"message": "successful",
"data": {
"num": 2,
"list": [
{
"article_id": 1565926081,
"comment_id": "76bd7b76fcd0b23f3d171f39b416d936",
"father_id": "",
"user_id": "13750687010",
"nickename": "FatBallFish",
"content": "这是一条更新过的评论",
"create_time": "2019-08-18 09:41:41",
"update_time": "2019-08-18 11:08:43"
},
{
"article_id": 1565926081,
"comment_id": "1aa6ddf68bea87f2305dd9fd5d3bb2c8",
"father_id": "",
"user_id": "13750687010",
"nickename": "FatBallFish",
"content": "这是一条测试评论",
"create_time": "2019-08-18 09:32:16",
"update_time": "2019-08-18 09:32:16"
}
]
}
}Python端返回失败处理情况
{
"id": -1,
"status": -101,
"message": "Error Token",
"data": {}
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -203 |
| -200 |
| -101 |
| -100 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Error order | 排序规则错误 |
| 101 | Error num | num值错误,不能<1 |
| 102 | Error article_id | 错误的文章id |
API说明
此API用于增加论坛文章的评论内容
成功返回article_id、comment_id、father_id
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/admin/comment?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":1234,
"type":"comment",
"subtype":"add",
"data":{
"article_id":1565926081,
"user_id":"13750687010"
"content":"这是一条用API请求的子级评论",
"father_id":"76bd7b76fcd0b23f3d171f39b416d936"
}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| article_id | int | 10 | 1565926081 | 文章id | ||
| user_id | string | 11 | 13750687010 | 评论者id | ||
| content | string | 这是一篇测试文章 | 文章内容 | |||
| father_id | √ | √ | string | 32 | 76bd7b76fcd0b23f3d171f39b416d936 | 父评论id(MD5加密文本),若为空则为根评论,默认为空 |
article_id、father_id用作检验机制,不可被修改
Python端返回成功处理情况
{
"id": 1234,
"status": 0,
"message": "Successful",
"data": {
"article_id": 1565926081,
"comment_id": "354b6ded0748cd837d0ebf06230b9770",
"father_id":"76bd7b76fcd0b23f3d171f39b416d936",
}
}Python端返回失败处理情况
{
"id":1234,
"status":100, #错误码
"message":"Error article_id",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -101 |
| -100 |
| -3 |
| -2 |
| -1 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Error article_id | 文章id错误,很有可能不存在 |
| 101 | Error father_id | 父评论错误,很有可能不存在 |
API说明
此API用于更新论坛文章评论内容
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/admin/comment?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":1234,
"type":"comment",
"subtype":"update",
"data":{
"user_id":"13750687010",
"comment_id":"d757d9ea4c9c1860299a0341524a6a7d",
"content":"这是一条用API更新的子级评论"
}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| user_id | string | 11 | 13750687010 | 评论者id | ||
| comment_id | string | 32 | d757d9ea4c9c1860299a0341524a6a7d | 评论id | ||
| content | string | 这是一篇测试文章,测试一下更新效果 | 文章内容 |
user_id、comment_id用作检验机制,不可被修改
Python端返回成功处理情况
{
"id": 1234,
"status": 0,
"message": "Successful",
"data": {}
}Python端返回失败处理情况
{
"id":1234,
"status":100, #错误码
"message":"Error article_id",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -101 |
| -100 |
| -3 |
| -2 |
| -1 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Error comment_id | 评论id错误,很有可能不存在 |
| 101 | Error user_id | 评论作者id与当前登录id不一致或无权限 |
API说明
此API用于删除论坛评论文章
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/admin/comment?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":0,
"type":"comment",
"subtype":"delete",
"data":{
"user_id":"13750687010",
"comment_id":"a301c03e1248eabf83785b5548d603ec"}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| user_id | string | 11 | 13750687010 | 评论者id | ||
| comment_id | string | 32 | a301c03e1248eabf83785b5548d603ec | 评论id |
Python端返回成功处理情况
{
"id": 1234,
"status": 0,
"message": "Successful",
"data": {}
}Python端返回失败处理情况
{
"id":1234,
"status":100, #错误码
"message":"Error article_id",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -101 |
| -100 |
| -3 |
| -2 |
| -1 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Error comment_id | 评论id错误,很有可能不存在 |
| 101 | Error user_id | 评论作者id与当前登录id不一致或无权限 |
API说明
最新修改:增加user_id字段,可缺省,用于筛选该用户参加过的所有活动
此API用于获取论坛活动列表
API类型
请求类型:POST
token只能传在url中
API地址:
https://dmt.lcworkroom.cn/api/admin/active?token=
url参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":0,
"type":"active",
"subtype":"list",
"data":{
"user_id":"13750687010",
}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 默认值 | 例子 | 备注 |
|---|---|---|---|---|---|---|---|
| keywords | √ | √ | string | 测试 | 搜索关键字,设置后将以此关键字模糊匹配title和content字段内容,模糊匹配 | ||
| active_id | √ | √ | int | 8 | 78554587 | 活动id,精确匹配 | |
| user_id | √ | √ | str | 13750687010 | 用户id,精确匹配 | ||
| title | √ | √ | string | 测试文章 | 活动标题,模糊匹配 | ||
| content | √ | √ | string | 这是 | 活动内容,模糊匹配 | ||
| order | √ | √ | string | update_time DESC | title ASC,update_time DESC | 排序规则,使用SQL语句,为空则默认以更新时间进行排序 | |
| start | √ | √ | int | 0 | 0 | 记录索引开始,默认起始为 0 | |
| num | √ | √ | int | 50 | 10 | 返回记录数,默认返回50条 | |
| mode | √ | int | 0 | 0 | 0为显示文章源格式,1为文章简介,自动返回第一行文字 |
- 只传递
token参数则返回所有活动 - 如果
keywords不为空则优先使用keywords,article_id、title、content则被忽略; keywords用于title和content的并集查询,模糊匹配;active_id、user_id、title、content可交集查询;order中可用于排序的字段有active_id,user_id,title,content,start_time,end_time,create_time,update_time;order排序方法有:升序asc、降序desc,大小写不区分。多条件排序时用英文半角,分割- 当实际记录数小于
num的值时,只返回实际记录数量的记录
Python端返回成功处理情况
{
"id": -1,
"status": 0,
"message": "successful",
"data": {
"num": 1,
"list": [
{
"active_id": 78554587,
"user_id": "13750687010",
"nickname": "FatBallFish",
"title": "\u6821\u53cb\u53ec\u96c6\u4ee42",
"content": "\u6070\u9022\u66f4\u540d\u65f6\u673a\uff0c\u53ec\u96c6\u6821\u53cb\u6765\u6b64\u4e00\u805a\uff0c\u66f4\u65b0\u6d3b\u52a8\u5185\u5bb9",
"start_time": "2019-08-25 00:00:00",
"end_time": "2019-08-26 00:00:00",
"create_time": "2019-08-24 15:29:57",
"update_time": "2019-08-24 16:13:14"
}
]
}
}Python端返回失败处理情况
{
"id": -1,
"status": -101,
"message": "Error Token",
"data": {}
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -203 |
| -200 |
| -103 |
| -101 |
| -100 |
| -3 |
| -2 |
| -1 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Error Order | 排序规则错误 |
| 101 | Error num | num值错误,不能<1 |
API说明
此API用于获取论坛活动成员列表
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/admin/active?token=
url参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":0,
"type":"active",
"subtype":"member",
"data":{
"active_id":78554587,
}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 默认值 | 例子 | 备注 |
|---|---|---|---|---|---|---|---|
| active_id | int | 8 | 78554587 | 活动id,精确匹配 | |||
| order | √ | √ | string | update_time DESC | join_time ASC | 排序规则,使用SQL语句,为空则默认以加入时间升序排序 | |
| start | √ | √ | int | 0 | 0 | 记录索引开始,默认起始为 0 | |
| num | √ | √ | int | 50 | 10 | 返回记录数,默认返回50条 |
order中可用于排序的字段有active_id,user_id,title,content,start_time,end_time,create_time,update_time;order排序方法有:升序asc、降序desc,大小写不区分。多条件排序时用英文半角,分割- 当实际记录数小于
num的值时,只返回实际记录数量的记录
Python端返回成功处理情况
{
"id": -1,
"status": 0,
"message": "successful",
"data": {
"num": 1,
"list": [
"13750687010"
]
}
}Python端返回失败处理情况
{
"id": -1,
"status": -101,
"message": "Error Token",
"data": {}
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -203 |
| -200 |
| -101 |
| -100 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Error Order | 排序规则错误 |
| 102 | Error active_id | 错误的活动id |
API说明
此API用于增加论坛活动,仅管理员使用
成功返回active_id
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/admin/active?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":1234,
"type":"active",
"subtype":"add",
"data":{
"user_id":"13750687010",
"title":"校友召集令",
"content":"恰逢更名时机,召集校友来此一聚",
"start_time":"2019-08-24 00:00:00",
"end_time":"2019-8-25 0:0:0"
}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| user_id | string | 11 | 13750687010 | 活动发起者id | ||
| title | string | 255 | 测试文章 | 文章id | ||
| content | string | 这是一篇测试文章 | 文章内容 | |||
| start_time | datetime | 2019-08-24 00:00:00 | 请按照标准的时间格式文本进行传递,否则会报错 | |||
| end_time | datetime | 2019-08-25 00:00:00 | 请按照标准的时间格式文本进行传递,否则会报错 |
Python端返回成功处理情况
{
"id": 1234,
"status": 0,
"message": "Successful",
"data": {
"active_id":78554587
}
}Python端返回失败处理情况
{
"id":1234,
"status":-200, #错误码
"message":"Failure to operate database",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -103 |
| -101 |
| -100 |
| -3 |
| -2 |
| -1 |
局部status表
| status | message | 内容 |
|---|---|---|
| 102 | Error format or data for time | 开始时间或结束时间格式或数据错误 |
API说明
此API用于更新论坛活动,仅管理员使用
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/admin/active?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":1234,
"type":"active",
"subtype":"update",
"data":{
"user_id":"13750687010",
"active_id":78554587,
"title":"校友召集令",
"content":"恰逢更名时机,召集校友来此一聚,更新活动内容",
"start_time":"2019-08-25 00:00:00",
"end_time":"2019-08-26 00:00:00"
}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| user_id | string | 11 | 13750687010 | 活动发起者id | ||
| active_id | int | 8 | 78554587 | 活动id | ||
| title | string | 255 | 测试文章 | 文章id | ||
| content | string | 这是一篇测试文章 | 文章内容 | |||
| start_time | datetime | 2019-08-24 00:00:00 | 请按照标准的时间格式文本进行传递,否则会报错 | |||
| end_time | datetime | 2019-08-25 00:00:00 | 请按照标准的时间格式文本进行传递,否则会报错 |
Python端返回成功处理情况
{
"id": 1234,
"status": 0,
"message": "Successful",
"data": {}
}Python端返回失败处理情况
{
"id":1234,
"status":-200, #错误码
"message":"Failure to operate database",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -103 |
| -101 |
| -100 |
| -3 |
| -2 |
| -1 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Error active_id | 错误的活动id |
| 101 | Error user_id | 活动发起者id与当前登录id不一致 |
| 102 | Error format or data for time | 开始时间或结束时间格式或数据错误 |
API说明
此API用于删除论坛活动
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/admin/active?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":1234,
"type":"active",
"subtype":"delete",
"data":{
"user_id":"13750687010",
"active_id":86889745
}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| user_id | string | 11 | 13750687010 | 活动发起者id | ||
| active_id | int | 8 | 78554587 | 活动id |
Python端返回成功处理情况
{
"id": 1234,
"status": 0,
"message": "Successful",
"data": {}
}Python端返回失败处理情况
{
"id":1234,
"status":-200, #错误码
"message":"Failure to operate database",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -103 |
| -101 |
| -100 |
| -3 |
| -2 |
| -1 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Error active_id | 错误的活动id |
| 101 | Error user_id | 活动发起者id与当前登录id不一致 |
API说明
此API用于用户加入活动
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/admin/active?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":1234,
"type":"active",
"subtype":"join",
"data":{
"user_id":"13750687010",
"active_id":78554587,
}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| user_id | string | 11 | 13750687010 | 参与者id | ||
| active_id | int | 8 | 78554587 | 活动id |
Python端返回成功处理情况
{
"id": 1234,
"status": 0,
"message": "Successful",
"data": {}
}Python端返回失败处理情况
{
"id":1234,
"status":-200, #错误码
"message":"Failure to operate database",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -103 |
| -101 |
| -100 |
| -3 |
| -2 |
| -1 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Error active_id | 错误的活动id,可能并不存在 |
| 102 | Already joined | 用户已加入此活动 |
API说明
此API用于用户加入活动
API类型
请求类型:POST
API地址:
https://dmt.lcworkroom.cn/api/admin/active?token=
url 参数表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| token | string | 32 | debc454ea24827b67178482fd73f37c3 | 由登录api返回获得 |
POST发送请求的json文本
{
"id":1234,
"type":"active",
"subtype":"exit",
"data":{
"user_id":"13750687010",
"active_id":78554587,
}
}data字段表
| 参数 | 可否为空 | 可否缺省 | 数据类型 | 字段长度 | 例子 | 备注 |
|---|---|---|---|---|---|---|
| user_id | stirng | 11 | 13750687010 | 活动参与者id | ||
| active_id | int | 8 | 78554587 | 活动id |
Python端返回成功处理情况
{
"id": 1234,
"status": 0,
"message": "Successful",
"data": {}
}Python端返回失败处理情况
{
"id":1234,
"status":-200, #错误码
"message":"Failure to operate database",
"data":{},
}所用到的全局status
全局参数详情请看全局Status表
| status |
|---|
| -200 |
| -103 |
| -101 |
| -100 |
| -3 |
| -2 |
| -1 |
局部status表
| status | message | 内容 |
|---|---|---|
| 100 | Error active_id | 错误的活动id,可能并不存在 |
| 101 | Error user_id | 活动参与者id与当前登录id不一致或无权限或该用户未加入此活动 |
| 102 | Error format or data for time | 开始时间或结束时间格式或数据错误 |
所有的全局status值皆小于0
大于 0 的status值皆为请求局部status值
| 参数 | Message | 内容 | 请求类型 |
|---|---|---|---|
| 0 | successful | 函数处理正确 | POST、GET |
| -1 | Error JSON key | json文本必需key缺失 | POST |
| -2 | Error JSON value | json文本value错误 | POST |
| -3 | Error data key | data数据中必需key缺失 | POST |
| -4 | Error Hash | Hash校验文本错误 | POST |
| -100 | Missing necessary args | api地址中缺少token参数 | POST、GET |
| -101 | Error token | token不正确 | POST、GET |
| -102 | Get userid failed for the token | 使用该token获取userid失败 | POST、GET |
| -103 | No permission to operate | 用户无权操作 | POST |
| -200 | Failure to operate database | 数据库操作失败,检查SQL语句是否正确 | POST、GET |
| -201 | Necessary key-value can't be empty | 关键键值对值不可为空 | POST |
| -202 | Missing necessary data key-value | 缺少关键的键值对 | POST |
| -203 | Arg's value type error | 键值对数据类型错误 | POST |
| -204 | Arg's value error | 键值对数据错误 | POST |
| -404 | Unknown Error | 未知的Redis错误 | POST |
| -500 | COS upload Error | COS储存上传失败 | POST |
-
status传递的错误码类型为整型。 -
手机验证码相关的错误码详见短信错误码