上传数据 API
上传运动数据 api
上传运动数据
上传运动数据到后台
POST
/openapi/v1/uploads/
Payload
请求参数
字段名 | 类型 | 含义 | 备注 |
---|---|---|---|
name | 字符串 | 运动的标题 | 最大长度32个字符 |
detail | 字符串 | 运动详情 | 最大长度1500个字符 |
fit_filename | 字符串 | 上传文件名 | 文件名后缀要和file_type一致 |
file_type | 字符串 | 文件类型 | 文件的后缀, 已支持如下: fit |
md5 | 字符串 | 文件md5值(32位小写) | 后台校验上传文件的md5要与该值一致 |
样例
{
"name": "骑行",
"detail": "",
"file_type": "fit",
"fit_filename": "",
"md5": ""
}
Response 201
返回参数
字段名 | 类型 | 含义 | 备注 |
---|---|---|---|
new | 布尔值 | 是否为新上传 | |
upload_id | 整型 | 上传id | 本次上传记录id |
workout_id | 整型 | 轨迹id | 上传文件创建的轨迹id |
credits | 浮点型 | 热度 | 上传轨迹产生的热度 |
uuid | 字符串 | uuid4 | 本次上传记录的uuid |
样例
{
"code": 0,
"msg": "上传成功",
"data": {
"new": true,
"upload_id": 1,
"workout_id": 9,
"credits": 100.0,
"uuid": "123a1ba3-70d9-4867-b680-326e93f67a8e"
}
}
获取上传运动数据记录列表
获取用户上传数据的历史记录, 以分页的列表形式返回
GET
/openapi/v1/uploads/
请求参数
参数 | 位置 | 含义 | 备注 |
---|---|---|---|
offset | query | 获取偏移量 | 从0开始 |
limit | query | 获取个数 | 从1开始,最大值为20 |
返回参数
字段名 | 类型 | 含义 | 备注 |
---|---|---|---|
count | 整型 | 总条数 | 返回用户历史记录总条数 |
previous | 字符串 | 上一页 | 没有上一页返回null |
next | 字符串 | 下一页 | 没有下一页返回null |
results | 数组 | 记录列表 | 没有数据返回空列表 |
new | 布尔值 | 是否为新上传 | |
upload_id | 整型 | 上传id | 本次上传记录id |
workout_id | 整型 | 轨迹id | 上传文件创建的轨迹id |
credits | 浮点型 | 热度 | 上传轨迹产生的热度 |
uuid | 字符串 | uuid4 | 本次上传记录的uuid |
样例
{
"count": 10,
"previous": "",
"next": "",
"results": [
{
"new": true,
"upload_id": 1,
"workout_id": 9,
"credits": 100.0,
"uuid": "123a1ba3-70d9-4867-b680-326e93f67a8e"
}
]
}
Error Response
400
{
"code": 400,
"msg": "API Limited",
"data": {}
}
401
{
"code": 401,
"msg": "Unauthorized Error",
"data": {}
}
500
{
"code": 500,
"msg": "Server Error",
"data": {}
}