Giters

TurboServlet / turboNET-doc

turboNET Alpha api document

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

TurboNET Alpha api 文档

Nya~
marked by 桃玖 & CtrlcvsNya & Kiwi

Base URLs: https://api.mai-turbo.net

Swagger3 version (instead of github markdown) : https://api.mai-turbo.net/swagger-ui/index.html

Authentication

网页相关

POST 游戏设置-上传用户头像

POST /web/userOption/upsertUserPortrait

Body 请求参数

{
  "divData": "string"
}

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。
body body UpsertUserPortraitRequestVO 否 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 Unit
401 Unauthorized 请检查权限 Unit
403 Forbidden 请求失败，请检查header和请求体是否正确 Unit

POST 游戏设置-修改用户名称

POST /web/userOption/upsertUserName

Body 请求参数

{
  "turboName": "string"
}

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。
body body TurboCustomNameRequestVO 否 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 Unit
401 Unauthorized 请检查权限 Unit
403 Forbidden 请求失败，请检查header和请求体是否正确 Unit

POST 游戏设置-锁定用户功能券

POST /web/userOption/upsertTicketWhitelist

Body 请求参数

{
  "ticketId": 0
}

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。
body body TurboTicketWhitelistRequestVO 否 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 Unit
401 Unauthorized 请检查权限 Unit
403 Forbidden 请求失败，请检查header和请求体是否正确 Unit

POST 游戏设置-删除用户头像

POST /web/userOption/deleteUserPortrait

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 Unit
401 Unauthorized 请检查权限 Unit
403 Forbidden 请求失败，请检查header和请求体是否正确 Unit

POST 游戏设置-删除用户名称

POST /web/userOption/deleteUserName

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 Unit
401 Unauthorized 请检查权限 Unit
403 Forbidden 请求失败，请检查header和请求体是否正确 Unit

POST 游戏设置-解除用户功能券锁定

POST /web/userOption/deleteTicketWhitelist

需要权限，Admin，Builder，Authorizer

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 Unit
401 Unauthorized 请检查权限 Unit
403 Forbidden 请求失败，请检查header和请求体是否正确 Unit

POST 相片-移除为用户喜欢相片

POST /web/photo/removeFavoritePhoto

Body 请求参数

{
  "photoUUID": "string"
}

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。
body body PhotoFavoriteRequestVO 否 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 Unit
401 Unauthorized 请检查权限 Unit
403 Forbidden 请求失败，请检查header和请求体是否正确 Unit

POST 相片-添加为用户喜欢相片

POST /web/photo/addFavoritePhoto

Body 请求参数

{
  "photoUUID": "string"
}

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。
body body PhotoFavoriteRequestVO 否 none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 Unit
401 Unauthorized 请检查权限 Unit
403 Forbidden 请求失败，请检查header和请求体是否正确 Unit

GET 用户（此API不允许BotKey调用）

GET /web/user

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。此界面仅允许正常网页，不允许BotKey调用！

返回示例

200 Response

{
  "isSuccess": true,
  "data": {
    "username": "string",
    "permissionLevel": "string",
    "email": "string",
    "qqNumber": "string",
    "mai2Name": "string",
    "mai2SHA256": "string",
    "botToken": "string"
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVOUserResponseVO
401 Unauthorized 请检查权限 FinalResponseVOUserResponseVO
403 Forbidden 请求失败，请检查header是否正确 FinalResponseVOUserResponseVO

GET 加速盒子-游玩信息

GET /web/turbo

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。

返回示例

200 Response

{
  "isSuccess": true,
  "data": {
    "show": true,
    "turboInfoList": [
      {
        "name": "string",
        "allRequestsNumber": 0,
        "cacheRequestsNumber": 0,
        "fixedRequestNumber": 0,
        "cacheHitRate": "string",
        "detail": {
          "isEmptyDetail": true,
          "tenMinutesDetail": {},
          "thirtyMinutesDetail": {},
          "hourDetail": {},
          "playerDetail": [
            null
          ]
        }
      }
    ]
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVOTurboResponseVO
401 Unauthorized 请检查权限 FinalResponseVOTurboResponseVO
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVOTurboResponseVO

GET 游戏数据-用户功能票

GET /web/ticket

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。

返回示例

200 Response

{
  "isSuccess": true,
  "data": {
    "ticketList": [
      {
        "ticketId": 0,
        "ticketName": "string",
        "ticketImg": "string",
        "ticketCount": 0
      }
    ],
    "turboTicketInfo": {
      "ticketId": 0,
      "ticketName": "string",
      "ticketImg": "string"
    },
    "isEnableTurboTicket": true,
    "isTicketEmpty": true
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVOTicketResponseVO
401 Unauthorized 请检查权限 FinalResponseVOTicketResponseVO
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVOTicketResponseVO

GET 记录-游玩记录

GET /web/record

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。

返回示例

200 Response

{
  "isSuccess": true,
  "data": {
    "show": true,
    "recordList": [
      {
        "userInfo": {
          "trackNumber": 0,
          "musicPlayDate": "string",
          "isClear": true,
          "isAchievementNewRecord": true,
          "isDxScoreNewRecord": true,
          "comboStatusImg": "string",
          "syncStatusImg": "string",
          "userDxScore": 0,
          "userBeforeRating": 0,
          "userAfterRating": 0,
          "userAchievementStr": "string",
          "userAchievementRankImg": "string",
          "userCombo": 0,
          "maxCombo": 0,
          "userSync": 0,
          "maxSync": 0,
          "dxStarImg": "string"
        },
        "musicInfo": {
          "musicName": "string",
          "musicLevel": 0,
          "musicDiff": "string",
          "musicDiffImg": "string",
          "musicIcon": "string",
          "isDxMusic": true,
          "maxDxScore": 0
        },
        "detailInfo": {
          "isEnabledCriticalPerfect": true,
          "isEnabledFastAndLate": true,
          "fast": 0,
          "late": 0,
          "tap": {},
          "hold": {},
          "slide": {},
          "touch": {},
          "mai2Break": {}
        }
      }
    ]
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVORecordResponseVO
401 Unauthorized 请检查权限 FinalResponseVORecordResponseVO
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVORecordResponseVO

GET 排行榜-在排行榜中隐藏自己

GET /web/ranking/userIgnored/enable

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。

返回示例

200 Response

{
  "isSuccess": true,
  "data": "string"
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVOString
401 Unauthorized 请检查权限 FinalResponseVOString
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVOString

GET 排行榜-在排行榜中取消隐藏自己

GET /web/ranking/userIgnored/disable

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。

返回示例

200 Response

{
  "isSuccess": true,
  "data": "string"
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVOString
401 Unauthorized 请检查权限 FinalResponseVOString
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVOString

GET 排行榜-觉醒排行榜-TurboNET注册用户排行

GET /web/ranking/totalAchievement/users

请求参数

名称 位置 类型 必选 说明
index query Int 是 索引
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。

返回示例

200 Response

{
  "isSuccess": true,
  "data": {
    "singlePlayerRanking": [
      {
        "playerRanking": 0,
        "playerName": "string",
        "playerTotalAchievement": 0
      }
    ],
    "userRanking": {
      "playerRanking": 0,
      "playerTotalAchievement": 0,
      "playerPercent": 0,
      "isIgnored": true
    },
    "totalPages": 0,
    "totalElements": 0
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVORankingAchievementResponseVO
401 Unauthorized 请检查权限 FinalResponseVORankingAchievementResponseVO
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVORankingAchievementResponseVO

GET 排行榜-觉醒排行榜-全国加速盒子玩家排行

GET /web/ranking/totalAchievement/everyone

请求参数

名称 位置 类型 必选 说明
index query Int 是 索引
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。

返回示例

200 Response

{
  "isSuccess": true,
  "data": {
    "singlePlayerRanking": [
      {
        "playerRanking": 0,
        "playerName": "string",
        "playerTotalAchievement": 0
      }
    ],
    "userRanking": {
      "playerRanking": 0,
      "playerTotalAchievement": 0,
      "playerPercent": 0,
      "isIgnored": true
    },
    "totalPages": 0,
    "totalElements": 0
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVORankingAchievementResponseVO
401 Unauthorized 请检查权限 FinalResponseVORankingAchievementResponseVO
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVORankingAchievementResponseVO

GET 排行榜-DX RATING排行榜-TurboNET注册用户排行

GET /web/ranking/deluxRanking/users

请求参数

名称 位置 类型 必选 说明
index query Int 是 索引
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。

返回示例

200 Response

{
  "isSuccess": true,
  "data": {
    "singlePlayerRanking": [
      {
        "playerRanking": 0,
        "playerName": "string",
        "playerRating": 0
      }
    ],
    "userRanking": {
      "playerRanking": 0,
      "playerRating": 0,
      "playerPercent": 0,
      "isIgnored": true
    },
    "totalPages": 0,
    "totalElements": 0
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVORankingResponseVO
401 Unauthorized 请检查权限 FinalResponseVORankingResponseVO
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVORankingResponseVO

GET 排行榜-DX RATING排行榜-全国加速盒子玩家排行

GET /web/ranking/deluxRanking/everyone

请求参数

名称 位置 类型 必选 说明
index query Int 是 索引
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。

返回示例

200 Response

{
  "isSuccess": true,
  "data": {
    "singlePlayerRanking": [
      {
        "playerRanking": 0,
        "playerName": "string",
        "playerRating": 0
      }
    ],
    "userRanking": {
      "playerRanking": 0,
      "playerRating": 0,
      "playerPercent": 0,
      "isIgnored": true
    },
    "totalPages": 0,
    "totalElements": 0
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVORankingResponseVO
401 Unauthorized 请检查权限 FinalResponseVORankingResponseVO
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVORankingResponseVO

GET 游戏数据-游戏数据

GET /web/playerData

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。

返回示例

200 Response

{
  "isSuccess": true,
  "data": {
    "achievement": {
      "sssp": 0,
      "sss": 0,
      "ssp": 0,
      "ss": 0,
      "sp": 0,
      "s": 0
    },
    "combo": {
      "app": 0,
      "ap": 0,
      "fcp": 0,
      "fc": 0
    },
    "sync": {
      "fsdp": 0,
      "fsd": 0,
      "fsp": 0,
      "fs": 0
    },
    "userInfo": {
      "name": "string",
      "playCount": 0
    },
    "allMusic": 0
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVOPlayerDataResponseVO
401 Unauthorized 请检查权限 FinalResponseVOPlayerDataResponseVO
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVOPlayerDataResponseVO

GET 相片-用户历史相片

GET /web/photo/getHistoryPhotoList

请求参数

名称 位置 类型 必选 说明
index query Int 是 索引
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。

返回示例

200 Response

{
  "isSuccess": true,
  "data": {
    "photoList": {
      "totalPages": 0,
      "totalElements": 0,
      "size": 0,
      "content": [
        {
          "photoUUID": "string",
          "photoImg": "string",
          "date": "string",
          "isFavorite": true
        }
      ],
      "number": 0,
      "sort": {
        "empty": true,
        "sorted": true,
        "unsorted": true
      },
      "pageable": {
        "offset": 0,
        "sort": {
          "empty": null,
          "sorted": null,
          "unsorted": null
        },
        "paged": true,
        "pageNumber": 0,
        "pageSize": 0,
        "unpaged": true
      },
      "numberOfElements": 0,
      "first": true,
      "last": true,
      "empty": true
    }
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVOPhotoResponseVO
401 Unauthorized 请检查权限 FinalResponseVOPhotoResponseVO
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVOPhotoResponseVO

GET 相片-用户喜爱相片

GET /web/photo/getFavoritePhotoList

请求参数

名称 位置 类型 必选 说明
index query Int 是 索引
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。

返回示例

200 Response

{
  "isSuccess": true,
  "data": {
    "photoList": {
      "totalPages": 0,
      "totalElements": 0,
      "size": 0,
      "content": [
        {
          "photoUUID": "string",
          "photoImg": "string",
          "date": "string",
          "isFavorite": true
        }
      ],
      "number": 0,
      "sort": {
        "empty": true,
        "sorted": true,
        "unsorted": true
      },
      "pageable": {
        "offset": 0,
        "sort": {
          "empty": null,
          "sorted": null,
          "unsorted": null
        },
        "paged": true,
        "pageNumber": 0,
        "pageSize": 0,
        "unpaged": true
      },
      "numberOfElements": 0,
      "first": true,
      "last": true,
      "empty": true
    }
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVOPhotoResponseVO
401 Unauthorized 请检查权限 FinalResponseVOPhotoResponseVO
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVOPhotoResponseVO

GET 权限展示

GET /web/permission

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。

返回示例

200 Response

{
  "isSuccess": true,
  "data": {
    "permissionLevel": "ADMIN",
    "username": "string",
    "qqNumber": "string",
    "permissionList": [
      {
        "permissionDescription": "string",
        "isGranted": true
      }
    ],
    "authorizationsList": [
      {
        "userBefore": "ADMIN",
        "userAfter": "ADMIN",
        "authorizationUsername": "string",
        "changedDate": "string"
      }
    ],
    "bannedList": [
      {
        "bannedUsername": "string",
        "changedByUsername": "string",
        "changedDate": "string"
      }
    ]
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVOPermissionResponseVO
401 Unauthorized 请检查权限 FinalResponseVOPermissionResponseVO
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVOPermissionResponseVO

GET 网络状态查询

GET /web/network

包含zlibSkippedCount, retryExceptionCount, panicCount, allPacketNums}

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。

返回示例

200 Response

{
  "isSuccess": true,
  "data": {
    "packets": {
      "zlibSkippedCount": 0,
      "retryExceptionCount": 0,
      "panicCount": 0,
      "allPacketNums": 0
    },
    "packetsBefore": {
      "zlibSkippedCount": 0,
      "retryExceptionCount": 0,
      "panicCount": 0
    }
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVONetworkResponseVO
401 Unauthorized 请检查权限 FinalResponseVONetworkResponseVO
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVONetworkResponseVO

GET 用户主页

GET /web/home

包含playerName, playerRating, totalAwake, courseRank, classRank, iconId

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。

返回示例

200 Response

{
  "isSuccess": true,
  "data": {
    "playerName": "string",
    "playerRating": 0,
    "totalAwake": 0,
    "courseRank": 0,
    "classRank": 0,
    "iconId": 0,
    "loginAccount": "string",
    "loginEmail": "string",
    "lastPlayDate": "string",
    "banState": 0,
    "isPortrait": true,
    "portrait": "string"
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVOHomeResponseVO
401 Unauthorized 请检查权限 FinalResponseVOHomeResponseVO
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVOHomeResponseVO

GET Turbo盒子工具-机台设置-友人对战完成度显示

GET /web/command/qrUdemaeShowAchievement

需要权限，Admin，Builder

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。

返回示例

200 Response

{
  "isSuccess": true,
  "data": {
    "qrCodeBase64": "string",
    "qrCodeValidTime": "string"
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVOQrResponseVO
401 Unauthorized 请检查权限 FinalResponseVOQrResponseVO
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVOQrResponseVO

GET Turbo盒子工具-机台设置-PING 机台

GET /web/command/qrPing

需要权限，Admin，Builder

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。

返回示例

200 Response

{
  "isSuccess": true,
  "data": {
    "qrCodeBase64": "string",
    "qrCodeValidTime": "string"
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVOQrResponseVO
401 Unauthorized 请检查权限 FinalResponseVOQrResponseVO
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVOQrResponseVO

GET Turbo盒子工具-机台设置-遮挡用户名

GET /web/command/qrMaskUsername

需要权限，Admin，Builder

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。

返回示例

200 Response

{
  "isSuccess": true,
  "data": {
    "qrCodeBase64": "string",
    "qrCodeValidTime": "string"
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVOQrResponseVO
401 Unauthorized 请检查权限 FinalResponseVOQrResponseVO
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVOQrResponseVO

GET Turbo盒子工具-个人设置-Maiturbo NET 加速盒子机台登入

GET /web/command/qrLogin

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。

返回示例

200 Response

{
  "isSuccess": true,
  "data": {
    "qrCodeBase64": "string",
    "qrCodeValidTime": "string"
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVOQrResponseVO
401 Unauthorized 请检查权限 FinalResponseVOQrResponseVO
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVOQrResponseVO

GET Turbo盒子工具-个人设置-Maiturbo NET 加速盒子Kastanj机台登入

GET /web/command/qrKastanjLogin

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。

返回示例

200 Response

{
  "isSuccess": true,
  "data": {
    "qrCodeBase64": "string",
    "qrCodeValidTime": "string"
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVOQrResponseVO
401 Unauthorized 请检查权限 FinalResponseVOQrResponseVO
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVOQrResponseVO

授权相关

POST 解除用户封禁（此API不允许BotKey调用）

POST /permission/unbanUser

Body 请求参数

{
  "changeUsername": "string"
}

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。此界面仅允许正常网页，不允许BotKey调用！
body body PermissionRequestVO 否 none

返回示例

200 Response

{
  "isSuccess": true,
  "data": "string"
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVOString
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVOString

POST 取消授权用户

POST /permission/deauthorizeUser

Body 请求参数

{
  "changeUsername": "string"
}

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。
body body PermissionRequestVO 否 none

返回示例

200 Response

{
  "isSuccess": true,
  "data": "string"
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVOString
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVOString

POST 取消技术实施员（此API不允许BotKey调用）

POST /permission/deBuilderUser

Body 请求参数

{
  "changeUsername": "string"
}

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。此界面仅允许正常网页，不允许BotKey调用！
body body PermissionRequestVO 否 none

返回示例

200 Response

{
  "isSuccess": true,
  "data": "string"
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVOString
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVOString

POST 给予技术实施员（此API不允许BotKey调用）

POST /permission/builderUser

Body 请求参数

{
  "changeUsername": "string"
}

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。此界面仅允许正常网页，不允许BotKey调用！
body body PermissionRequestVO 否 none

返回示例

200 Response

{
  "isSuccess": true,
  "data": "string"
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVOString
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVOString

POST 给予用户封禁（此API不允许BotKey调用）

POST /permission/banUser

Body 请求参数

{
  "changeUsername": "string"
}

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。此界面仅允许正常网页，不允许BotKey调用！
body body PermissionRequestVO 否 none

返回示例

200 Response

{
  "isSuccess": true,
  "data": "string"
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVOString
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVOString

POST 给予授权用户

POST /permission/authorizeUser

Body 请求参数

{
  "changeUsername": "string"
}

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。
body body PermissionRequestVO 否 none

返回示例

200 Response

{
  "isSuccess": true,
  "data": "string"
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVOString
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVOString

GET 展示用户权限

GET /permission/showUserPermission

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。

返回示例

200 Response

{
  "isSuccess": true,
  "data": "ADMIN"
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVOPermissionEnum
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVOPermissionEnum

Bot相关

POST 解绑

POST /bot/unbind

Body 请求参数

{
  "botKey": "string"
}

请求参数

名称 位置 类型 必选 说明
body body BotUnbindRequestVO 否 none

返回示例

200 Response

{
  "isSuccess": true,
  "data": "string"
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVOString
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVOString

POST 绑定

POST /bot/bind

RequestBody需要两个参数，一个botToken一个botName，botName是由你自己定的，只是用来标记是哪个bot，会在用户前端显示。用户想要绑定，需要去net点击右上角头像，找到botToken。

Body 请求参数

{
  "botToken": "string",
  "botName": "string"
}

请求参数

名称 位置 类型 必选 说明
body body BotBindRequestVO 否 none

返回示例

200 Response

{
  "isSuccess": true,
  "data": {
    "botKey": "string"
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVOBotBindResponseVO
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVOBotBindResponseVO

GET 绑定列表

GET /bot/bindList

请求参数

名称 位置 类型 必选 说明
Authorization header string 是 权限校验Token。如果为正常网页，那么Bearer开头；如果为Bot，那么BotKey开头。

返回示例

200 Response

{
  "isSuccess": true,
  "data": [
    {
      "botKey": "string",
      "botName": "string",
      "useCount": 0,
      "bindDate": "string"
    }
  ]
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功请求 FinalResponseVOListBotBindListResponseVO
403 Forbidden 请求失败，请检查header和请求体是否正确 FinalResponseVOListBotBindListResponseVO

权限相关

POST token验证

POST /auth/tokenValidation

Body 请求参数

{
  "token": "string",
  "refreshToken": "string",
  "botToken": "string"
}

请求参数

名称 位置 类型 必选 说明
body body TokenValidationRequestVO 否 none

返回示例

200 Response

{
  "isSuccess": true,
  "data": {
    "token": "string"
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK OK FinalResponseVORefreshTokenResponseVO

POST 重置密码

POST /auth/resetPassword

Body 请求参数

{
  "email": "string",
  "captchaToken": "string"
}

请求参数

名称 位置 类型 必选 说明
body body ResetPasswordRequestVO 否 none

返回示例

200 Response

{
  "isSuccess": true,
  "data": {}
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK OK FinalResponseVONull

POST 重置密码-验证

POST /auth/resetPassword/verify

Body 请求参数

{
  "token": "string",
  "valid": "string",
  "password": "string"
}

请求参数

名称 位置 类型 必选 说明
body body ResetPasswordValidRequestVO 否 none

返回示例

200 Response

{
  "isSuccess": true,
  "data": {}
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK OK FinalResponseVONull

POST 重置密码

POST /auth/resetPassword/isValid

Body 请求参数

{
  "token": "string",
  "valid": "string"
}

请求参数

名称 位置 类型 必选 说明
body body ResetPasswordIsValidRequestVO 否 none

返回示例

200 Response

{
  "isSuccess": true,
  "data": {}
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK OK FinalResponseVONull

POST 注册

POST /auth/register

Body 请求参数

{
  "username": "string",
  "password": "string",
  "email": "string",
  "qqNumber": "string",
  "weChatID": "string",
  "captchaToken": "string"
}

请求参数

名称 位置 类型 必选 说明
body body RegisterRequestVO 否 none

返回示例

200 Response

{
  "isSuccess": true,
  "data": {
    "msg": "string"
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK OK FinalResponseVORegisterResponseVO

POST 注册验证

POST /auth/register/verify

Body 请求参数

{
  "token": "string",
  "valid": "string"
}

请求参数

名称 位置 类型 必选 说明
body body RegisterVerifyRequestVO 否 none

返回示例

200 Response

{
  "isSuccess": true,
  "data": {}
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK OK FinalResponseVONull

POST 刷新Token

POST /auth/refreshToken

Body 请求参数

{
  "refreshToken": "string"
}

请求参数

名称 位置 类型 必选 说明
body body RefreshTokenRequestVO 否 none

返回示例

200 Response

{
  "isSuccess": true,
  "data": {
    "token": "string"
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK OK FinalResponseVORefreshTokenResponseVO

POST 登出

POST /auth/logout

Body 请求参数

{
  "token": "string",
  "refreshToken": "string"
}

请求参数

名称 位置 类型 必选 说明
body body LogoutRequestVO 否 none

返回示例

200 Response

{
  "isSuccess": true,
  "data": {}
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK OK FinalResponseVONull

POST 登录

POST /auth/login

Body 请求参数

{
  "username": "string",
  "password": "string",
  "captchaToken": "string"
}

请求参数

名称 位置 类型 必选 说明
body body LoginRequestVO 否 none

返回示例

200 Response

{
  "isSuccess": true,
  "data": {
    "token": "string",
    "refreshToken": "string"
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK OK FinalResponseVOLoginResponseVO

POST 用户名是否有效

POST /auth/isUsernameValid

Body 请求参数

{
  "username": "string"
}

请求参数

名称 位置 类型 必选 说明
body body RegisterUsernameValidRequestVO 否 none

返回示例

200 Response

{
  "isSuccess": true,
  "data": {}
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK OK FinalResponseVONull

POST 二次确认

POST /auth/isSecondStepsValid

Body 请求参数

{
  "email": "string",
  "qqNumber": "string"
}

请求参数

名称 位置 类型 必选 说明
body body RegisterSecondStepsValidRequestVO 否 none

返回示例

200 Response

{
  "isSuccess": true,
  "data": {}
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK OK FinalResponseVONull

数据模型

FinalResponseVOListBotBindListResponseVO

{
  "isSuccess": true,
  "data": [
    {
      "botKey": "string",
      "botName": "string",
      "useCount": 0,
      "bindDate": "string"
    }
  ]
}

属性

名称 类型 必选 约束 中文名 说明
isSuccess boolean true none none
data [BotBindListResponseVO] false none none

BotBindListResponseVO

{
  "botKey": "string",
  "botName": "string",
  "useCount": 0,
  "bindDate": "string"
}

属性

名称 类型 必选 约束 中文名 说明
botKey string true none none
botName string true none none
useCount integer(int32) true none none
bindDate string true none none

FinalResponseVOPermissionEnum

{
  "isSuccess": true,
  "data": "ADMIN"
}

属性

名称 类型 必选 约束 中文名 说明
isSuccess boolean true none none
data string false none none

枚举值

属性 值
data ADMIN
data BUILDER
data AUTHORIZER
data USER
data BANNED

QrResponseVO

{
  "qrCodeBase64": "string",
  "qrCodeValidTime": "string"
}

属性

名称 类型 必选 约束 中文名 说明
qrCodeBase64 string true none none
qrCodeValidTime string true none none

FinalResponseVOQrResponseVO

{
  "isSuccess": true,
  "data": {
    "qrCodeBase64": "string",
    "qrCodeValidTime": "string"
  }
}

属性

名称 类型 必选 约束 中文名 说明
isSuccess boolean true none none
data QrResponseVO false none none

HomeResponseVO

{
  "playerName": "string",
  "playerRating": 0,
  "totalAwake": 0,
  "courseRank": 0,
  "classRank": 0,
  "iconId": 0,
  "loginAccount": "string",
  "loginEmail": "string",
  "lastPlayDate": "string",
  "banState": 0,
  "isPortrait": true,
  "portrait": "string"
}

属性

名称 类型 必选 约束 中文名 说明
playerName string true none none
playerRating integer(int32) true none none
totalAwake integer(int32) true none none
courseRank integer(int32) true none none
classRank integer(int32) true none none
iconId integer(int32) true none none
loginAccount string true none none
loginEmail string true none none
lastPlayDate string true none none
banState integer(int32) true none none
isPortrait boolean true none none
portrait string false none none

FinalResponseVOHomeResponseVO

{
  "isSuccess": true,
  "data": {
    "playerName": "string",
    "playerRating": 0,
    "totalAwake": 0,
    "courseRank": 0,
    "classRank": 0,
    "iconId": 0,
    "loginAccount": "string",
    "loginEmail": "string",
    "lastPlayDate": "string",
    "banState": 0,
    "isPortrait": true,
    "portrait": "string"
  }
}

属性

名称 类型 必选 约束 中文名 说明
isSuccess boolean true none none
data HomeResponseVO false none none

PacketResultHourDTO

{
  "zlibSkippedCount": 0,
  "retryExceptionCount": 0,
  "panicCount": 0,
  "allPacketNums": 0
}

属性

名称 类型 必选 约束 中文名 说明
zlibSkippedCount integer(int32) true none none
retryExceptionCount integer(int32) true none none
panicCount integer(int32) true none none
allPacketNums integer(int32) true none none

PacketResultBeforeDTO

{
  "zlibSkippedCount": 0,
  "retryExceptionCount": 0,
  "panicCount": 0
}

属性

名称 类型 必选 约束 中文名 说明
zlibSkippedCount integer(int32) true none none
retryExceptionCount integer(int32) true none none
panicCount integer(int32) true none none

NetworkResponseVO

{
  "packets": {
    "zlibSkippedCount": 0,
    "retryExceptionCount": 0,
    "panicCount": 0,
    "allPacketNums": 0
  },
  "packetsBefore": {
    "zlibSkippedCount": 0,
    "retryExceptionCount": 0,
    "panicCount": 0
  }
}

属性

名称 类型 必选 约束 中文名 说明
packets PacketResultHourDTO true none none
packetsBefore PacketResultBeforeDTO true none none

FinalResponseVONetworkResponseVO

{
  "isSuccess": true,
  "data": {
    "packets": {
      "zlibSkippedCount": 0,
      "retryExceptionCount": 0,
      "panicCount": 0,
      "allPacketNums": 0
    },
    "packetsBefore": {
      "zlibSkippedCount": 0,
      "retryExceptionCount": 0,
      "panicCount": 0
    }
  }
}

属性

名称 类型 必选 约束 中文名 说明
isSuccess boolean true none none
data NetworkResponseVO false none none

PermissionResponseVO

{
  "permissionLevel": "ADMIN",
  "username": "string",
  "qqNumber": "string",
  "permissionList": [
    {
      "permissionDescription": "string",
      "isGranted": true
    }
  ],
  "authorizationsList": [
    {
      "userBefore": "ADMIN",
      "userAfter": "ADMIN",
      "authorizationUsername": "string",
      "changedDate": "string"
    }
  ],
  "bannedList": [
    {
      "bannedUsername": "string",
      "changedByUsername": "string",
      "changedDate": "string"
    }
  ]
}

属性

名称 类型 必选 约束 中文名 说明
permissionLevel string true none none
username string true none none
qqNumber string true none none
permissionList [PermissionListResponseVO] true none none
authorizationsList [AuthorizationResponseVO] true none none
bannedList [BanResponseVO] true none none

枚举值

属性 值
permissionLevel ADMIN
permissionLevel BUILDER
permissionLevel AUTHORIZER
permissionLevel USER
permissionLevel BANNED

PermissionListResponseVO

{
  "permissionDescription": "string",
  "isGranted": true
}

属性

名称 类型 必选 约束 中文名 说明
permissionDescription string true none none
isGranted boolean true none none

FinalResponseVOPermissionResponseVO

{
  "isSuccess": true,
  "data": {
    "permissionLevel": "ADMIN",
    "username": "string",
    "qqNumber": "string",
    "permissionList": [
      {
        "permissionDescription": "string",
        "isGranted": true
      }
    ],
    "authorizationsList": [
      {
        "userBefore": "ADMIN",
        "userAfter": "ADMIN",
        "authorizationUsername": "string",
        "changedDate": "string"
      }
    ],
    "bannedList": [
      {
        "bannedUsername": "string",
        "changedByUsername": "string",
        "changedDate": "string"
      }
    ]
  }
}

属性

名称 类型 必选 约束 中文名 说明
isSuccess boolean true none none
data PermissionResponseVO false none none

BanResponseVO

{
  "bannedUsername": "string",
  "changedByUsername": "string",
  "changedDate": "string"
}

属性

名称 类型 必选 约束 中文名 说明
bannedUsername string true none none
changedByUsername string true none none
changedDate string true none none

AuthorizationResponseVO

{
  "userBefore": "ADMIN",
  "userAfter": "ADMIN",
  "authorizationUsername": "string",
  "changedDate": "string"
}

属性

名称 类型 必选 约束 中文名 说明
userBefore string true none none
userAfter string true none none
authorizationUsername string true none none
changedDate string true none none

枚举值

属性 值
userBefore ADMIN
userBefore BUILDER
userBefore AUTHORIZER
userBefore USER
userBefore BANNED
userAfter ADMIN
userAfter BUILDER
userAfter AUTHORIZER
userAfter USER
userAfter BANNED

SortObject

{
  "empty": true,
  "sorted": true,
  "unsorted": true
}

属性

名称 类型 必选 约束 中文名 说明
empty boolean false none none
sorted boolean false none none
unsorted boolean false none none

PhotoResponseVO

{
  "photoList": {
    "totalPages": 0,
    "totalElements": 0,
    "size": 0,
    "content": [
      {
        "photoUUID": "string",
        "photoImg": "string",
        "date": "string",
        "isFavorite": true
      }
    ],
    "number": 0,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "pageable": {
      "offset": 0,
      "sort": {
        "empty": true,
        "sorted": true,
        "unsorted": true
      },
      "paged": true,
      "pageNumber": 0,
      "pageSize": 0,
      "unpaged": true
    },
    "numberOfElements": 0,
    "first": true,
    "last": true,
    "empty": true
  }
}

属性

名称 类型 必选 约束 中文名 说明
photoList PagePhotoListVO true none none

PhotoListVO

{
  "photoUUID": "string",
  "photoImg": "string",
  "date": "string",
  "isFavorite": true
}

属性

名称 类型 必选 约束 中文名 说明
photoUUID string true none none
photoImg string(byte) true none none
date string true none none
isFavorite boolean true none none

PageableObject

{
  "offset": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "paged": true,
  "pageNumber": 0,
  "pageSize": 0,
  "unpaged": true
}

属性

名称 类型 必选 约束 中文名 说明
offset integer(int64) false none none
sort SortObject false none none
paged boolean false none none
pageNumber integer(int32) false none none
pageSize integer(int32) false none none
unpaged boolean false none none

PagePhotoListVO

{
  "totalPages": 0,
  "totalElements": 0,
  "size": 0,
  "content": [
    {
      "photoUUID": "string",
      "photoImg": "string",
      "date": "string",
      "isFavorite": true
    }
  ],
  "number": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "pageable": {
    "offset": 0,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "paged": true,
    "pageNumber": 0,
    "pageSize": 0,
    "unpaged": true
  },
  "numberOfElements": 0,
  "first": true,
  "last": true,
  "empty": true
}

属性

名称 类型 必选 约束 中文名 说明
totalPages integer(int32) false none none
totalElements integer(int64) false none none
size integer(int32) false none none
content [PhotoListVO] false none none
number integer(int32) false none none
sort SortObject false none none
pageable PageableObject false none none
numberOfElements integer(int32) false none none
first boolean false none none
last boolean false none none
empty boolean false none none

FinalResponseVOPhotoResponseVO

{
  "isSuccess": true,
  "data": {
    "photoList": {
      "totalPages": 0,
      "totalElements": 0,
      "size": 0,
      "content": [
        {
          "photoUUID": "string",
          "photoImg": "string",
          "date": "string",
          "isFavorite": true
        }
      ],
      "number": 0,
      "sort": {
        "empty": true,
        "sorted": true,
        "unsorted": true
      },
      "pageable": {
        "offset": 0,
        "sort": {
          "empty": null,
          "sorted": null,
          "unsorted": null
        },
        "paged": true,
        "pageNumber": 0,
        "pageSize": 0,
        "unpaged": true
      },
      "numberOfElements": 0,
      "first": true,
      "last": true,
      "empty": true
    }
  }
}

属性

名称 类型 必选 约束 中文名 说明
isSuccess boolean true none none
data PhotoResponseVO false none none

UserInfoVO

{
  "name": "string",
  "playCount": 0
}

属性

名称 类型 必选 约束 中文名 说明
name string true none none
playCount integer(int32) true none none

SyncVO

{
  "fsdp": 0,
  "fsd": 0,
  "fsp": 0,
  "fs": 0
}

属性

名称 类型 必选 约束 中文名 说明
fsdp integer(int32) true none none
fsd integer(int32) true none none
fsp integer(int32) true none none
fs integer(int32) true none none

PlayerDataResponseVO

{
  "achievement": {
    "sssp": 0,
    "sss": 0,
    "ssp": 0,
    "ss": 0,
    "sp": 0,
    "s": 0
  },
  "combo": {
    "app": 0,
    "ap": 0,
    "fcp": 0,
    "fc": 0
  },
  "sync": {
    "fsdp": 0,
    "fsd": 0,
    "fsp": 0,
    "fs": 0
  },
  "userInfo": {
    "name": "string",
    "playCount": 0
  },
  "allMusic": 0
}

属性

名称 类型 必选 约束 中文名 说明
achievement AchievementVO true none none
combo ComboVO true none none
sync SyncVO true none none
userInfo UserInfoVO true none none
allMusic integer(int32) true none none

FinalResponseVOPlayerDataResponseVO

{
  "isSuccess": true,
  "data": {
    "achievement": {
      "sssp": 0,
      "sss": 0,
      "ssp": 0,
      "ss": 0,
      "sp": 0,
      "s": 0
    },
    "combo": {
      "app": 0,
      "ap": 0,
      "fcp": 0,
      "fc": 0
    },
    "sync": {
      "fsdp": 0,
      "fsd": 0,
      "fsp": 0,
      "fs": 0
    },
    "userInfo": {
      "name": "string",
      "playCount": 0
    },
    "allMusic": 0
  }
}

属性

名称 类型 必选 约束 中文名 说明
isSuccess boolean true none none
data PlayerDataResponseVO false none none

ComboVO

{
  "app": 0,
  "ap": 0,
  "fcp": 0,
  "fc": 0
}

属性

名称 类型 必选 约束 中文名 说明
app integer(int32) true none none
ap integer(int32) true none none
fcp integer(int32) true none none
fc integer(int32) true none none

AchievementVO

{
  "sssp": 0,
  "sss": 0,
  "ssp": 0,
  "ss": 0,
  "sp": 0,
  "s": 0
}

属性

名称 类型 必选 约束 中文名 说明
sssp integer(int32) true none none
sss integer(int32) true none none
ssp integer(int32) true none none
ss integer(int32) true none none
sp integer(int32) true none none
s integer(int32) true none none

UserRanking

{
  "playerRanking": 0,
  "playerRating": 0,
  "playerPercent": 0,
  "isIgnored": true
}

属性

名称 类型 必选 约束 中文名 说明
playerRanking integer(int32) true none none
playerRating integer(int32) true none none
playerPercent number(double) true none none
isIgnored boolean true none none

SinglePlayerRanking

{
  "playerRanking": 0,
  "playerName": "string",
  "playerRating": 0
}

属性

名称 类型 必选 约束 中文名 说明
playerRanking integer(int32) true none none
playerName string true none none
playerRating integer(int32) true none none

RankingResponseVO

{
  "singlePlayerRanking": [
    {
      "playerRanking": 0,
      "playerName": "string",
      "playerRating": 0
    }
  ],
  "userRanking": {
    "playerRanking": 0,
    "playerRating": 0,
    "playerPercent": 0,
    "isIgnored": true
  },
  "totalPages": 0,
  "totalElements": 0
}

属性

名称 类型 必选 约束 中文名 说明
singlePlayerRanking [SinglePlayerRanking] true none none
userRanking UserRanking true none none
totalPages integer(int32) true none none
totalElements integer(int64) true none none

FinalResponseVORankingResponseVO

{
  "isSuccess": true,
  "data": {
    "singlePlayerRanking": [
      {
        "playerRanking": 0,
        "playerName": "string",
        "playerRating": 0
      }
    ],
    "userRanking": {
      "playerRanking": 0,
      "playerRating": 0,
      "playerPercent": 0,
      "isIgnored": true
    },
    "totalPages": 0,
    "totalElements": 0
  }
}

属性

名称 类型 必选 约束 中文名 说明
isSuccess boolean true none none
data RankingResponseVO false none none

UserAchievementRanking

{
  "playerRanking": 0,
  "playerTotalAchievement": 0,
  "playerPercent": 0,
  "isIgnored": true
}

属性

名称 类型 必选 约束 中文名 说明
playerRanking integer(int32) true none none
playerTotalAchievement integer(int64) true none none
playerPercent number(double) true none none
isIgnored boolean true none none

SinglePlayerAchievementRanking

{
  "playerRanking": 0,
  "playerName": "string",
  "playerTotalAchievement": 0
}

属性

名称 类型 必选 约束 中文名 说明
playerRanking integer(int32) true none none
playerName string true none none
playerTotalAchievement integer(int64) true none none

RankingAchievementResponseVO

{
  "singlePlayerRanking": [
    {
      "playerRanking": 0,
      "playerName": "string",
      "playerTotalAchievement": 0
    }
  ],
  "userRanking": {
    "playerRanking": 0,
    "playerTotalAchievement": 0,
    "playerPercent": 0,
    "isIgnored": true
  },
  "totalPages": 0,
  "totalElements": 0
}

属性

名称 类型 必选 约束 中文名 说明
singlePlayerRanking [SinglePlayerAchievementRanking] true none none
userRanking UserAchievementRanking true none none
totalPages integer(int32) true none none
totalElements integer(int64) true none none

FinalResponseVORankingAchievementResponseVO

{
  "isSuccess": true,
  "data": {
    "singlePlayerRanking": [
      {
        "playerRanking": 0,
        "playerName": "string",
        "playerTotalAchievement": 0
      }
    ],
    "userRanking": {
      "playerRanking": 0,
      "playerTotalAchievement": 0,
      "playerPercent": 0,
      "isIgnored": true
    },
    "totalPages": 0,
    "totalElements": 0
  }
}

属性

名称 类型 必选 约束 中文名 说明
isSuccess boolean true none none
data RankingAchievementResponseVO false none none

UserInfo

{
  "trackNumber": 0,
  "musicPlayDate": "string",
  "isClear": true,
  "isAchievementNewRecord": true,
  "isDxScoreNewRecord": true,
  "comboStatusImg": "string",
  "syncStatusImg": "string",
  "userDxScore": 0,
  "userBeforeRating": 0,
  "userAfterRating": 0,
  "userAchievementStr": "string",
  "userAchievementRankImg": "string",
  "userCombo": 0,
  "maxCombo": 0,
  "userSync": 0,
  "maxSync": 0,
  "dxStarImg": "string"
}

属性

名称 类型 必选 约束 中文名 说明
trackNumber integer(int32) true none none
musicPlayDate string true none none
isClear boolean true none none
isAchievementNewRecord boolean true none none
isDxScoreNewRecord boolean true none none
comboStatusImg string true none none
syncStatusImg string true none none
userDxScore integer(int32) true none none
userBeforeRating integer(int32) true none none
userAfterRating integer(int32) true none none
userAchievementStr string true none none
userAchievementRankImg string true none none
userCombo integer(int32) true none none
maxCombo integer(int32) true none none
userSync integer(int32) true none none
maxSync integer(int32) true none none
dxStarImg string true none none

RecordResponseVO

{
  "show": true,
  "recordList": [
    {
      "userInfo": {
        "trackNumber": 0,
        "musicPlayDate": "string",
        "isClear": true,
        "isAchievementNewRecord": true,
        "isDxScoreNewRecord": true,
        "comboStatusImg": "string",
        "syncStatusImg": "string",
        "userDxScore": 0,
        "userBeforeRating": 0,
        "userAfterRating": 0,
        "userAchievementStr": "string",
        "userAchievementRankImg": "string",
        "userCombo": 0,
        "maxCombo": 0,
        "userSync": 0,
        "maxSync": 0,
        "dxStarImg": "string"
      },
      "musicInfo": {
        "musicName": "string",
        "musicLevel": 0,
        "musicDiff": "string",
        "musicDiffImg": "string",
        "musicIcon": "string",
        "isDxMusic": true,
        "maxDxScore": 0
      },
      "detailInfo": {
        "isEnabledCriticalPerfect": true,
        "isEnabledFastAndLate": true,
        "fast": 0,
        "late": 0,
        "tap": {
          "criticalPerfect": 0,
          "perfect": 0,
          "great": 0,
          "good": 0,
          "miss": 0
        },
        "hold": {
          "criticalPerfect": 0,
          "perfect": 0,
          "great": 0,
          "good": 0,
          "miss": 0
        },
        "slide": {
          "criticalPerfect": 0,
          "perfect": 0,
          "great": 0,
          "good": 0,
          "miss": 0
        },
        "touch": {
          "criticalPerfect": 0,
          "perfect": 0,
          "great": 0,
          "good": 0,
          "miss": 0
        },
        "mai2Break": {
          "criticalPerfect": 0,
          "perfect": 0,
          "great": 0,
          "good": 0,
          "miss": 0
        }
      }
    }
  ]
}

属性

名称 类型 必选 约束 中文名 说明
show boolean true none none
recordList [Mai2Record] true none none

NotesInfo

{
  "criticalPerfect": 0,
  "perfect": 0,
  "great": 0,
  "good": 0,
  "miss": 0
}

属性

名称 类型 必选 约束 中文名 说明
criticalPerfect integer(int32) true none none
perfect integer(int32) true none none
great integer(int32) true none none
good integer(int32) true none none
miss integer(int32) true none none

MusicInfo

{
  "musicName": "string",
  "musicLevel": 0,
  "musicDiff": "string",
  "musicDiffImg": "string",
  "musicIcon": "string",
  "isDxMusic": true,
  "maxDxScore": 0
}

属性

名称 类型 必选 约束 中文名 说明
musicName string true none none
musicLevel integer(int32) true none none
musicDiff string true none none
musicDiffImg string true none none
musicIcon string true none none
isDxMusic boolean true none none
maxDxScore integer(int32) true none none

Mai2Record

{
  "userInfo": {
    "trackNumber": 0,
    "musicPlayDate": "string",
    "isClear": true,
    "isAchievementNewRecord": true,
    "isDxScoreNewRecord": true,
    "comboStatusImg": "string",
    "syncStatusImg": "string",
    "userDxScore": 0,
    "userBeforeRating": 0,
    "userAfterRating": 0,
    "userAchievementStr": "string",
    "userAchievementRankImg": "string",
    "userCombo": 0,
    "maxCombo": 0,
    "userSync": 0,
    "maxSync": 0,
    "dxStarImg": "string"
  },
  "musicInfo": {
    "musicName": "string",
    "musicLevel": 0,
    "musicDiff": "string",
    "musicDiffImg": "string",
    "musicIcon": "string",
    "isDxMusic": true,
    "maxDxScore": 0
  },
  "detailInfo": {
    "isEnabledCriticalPerfect": true,
    "isEnabledFastAndLate": true,
    "fast": 0,
    "late": 0,
    "tap": {
      "criticalPerfect": 0,
      "perfect": 0,
      "great": 0,
      "good": 0,
      "miss": 0
    },
    "hold": {
      "criticalPerfect": 0,
      "perfect": 0,
      "great": 0,
      "good": 0,
      "miss": 0
    },
    "slide": {
      "criticalPerfect": 0,
      "perfect": 0,
      "great": 0,
      "good": 0,
      "miss": 0
    },
    "touch": {
      "criticalPerfect": 0,
      "perfect": 0,
      "great": 0,
      "good": 0,
      "miss": 0
    },
    "mai2Break": {
      "criticalPerfect": 0,
      "perfect": 0,
      "great": 0,
      "good": 0,
      "miss": 0
    }
  }
}

属性

名称 类型 必选 约束 中文名 说明
userInfo UserInfo true none none
musicInfo MusicInfo true none none
detailInfo DetailInfo true none none

FinalResponseVORecordResponseVO

{
  "isSuccess": true,
  "data": {
    "show": true,
    "recordList": [
      {
        "userInfo": {
          "trackNumber": 0,
          "musicPlayDate": "string",
          "isClear": true,
          "isAchievementNewRecord": true,
          "isDxScoreNewRecord": true,
          "comboStatusImg": "string",
          "syncStatusImg": "string",
          "userDxScore": 0,
          "userBeforeRating": 0,
          "userAfterRating": 0,
          "userAchievementStr": "string",
          "userAchievementRankImg": "string",
          "userCombo": 0,
          "maxCombo": 0,
          "userSync": 0,
          "maxSync": 0,
          "dxStarImg": "string"
        },
        "musicInfo": {
          "musicName": "string",
          "musicLevel": 0,
          "musicDiff": "string",
          "musicDiffImg": "string",
          "musicIcon": "string",
          "isDxMusic": true,
          "maxDxScore": 0
        },
        "detailInfo": {
          "isEnabledCriticalPerfect": true,
          "isEnabledFastAndLate": true,
          "fast": 0,
          "late": 0,
          "tap": {},
          "hold": {},
          "slide": {},
          "touch": {},
          "mai2Break": {}
        }
      }
    ]
  }
}

属性

名称 类型 必选 约束 中文名 说明
isSuccess boolean true none none
data RecordResponseVO false none none

DetailInfo

{
  "isEnabledCriticalPerfect": true,
  "isEnabledFastAndLate": true,
  "fast": 0,
  "late": 0,
  "tap": {
    "criticalPerfect": 0,
    "perfect": 0,
    "great": 0,
    "good": 0,
    "miss": 0
  },
  "hold": {
    "criticalPerfect": 0,
    "perfect": 0,
    "great": 0,
    "good": 0,
    "miss": 0
  },
  "slide": {
    "criticalPerfect": 0,
    "perfect": 0,
    "great": 0,
    "good": 0,
    "miss": 0
  },
  "touch": {
    "criticalPerfect": 0,
    "perfect": 0,
    "great": 0,
    "good": 0,
    "miss": 0
  },
  "mai2Break": {
    "criticalPerfect": 0,
    "perfect": 0,
    "great": 0,
    "good": 0,
    "miss": 0
  }
}

属性

名称 类型 必选 约束 中文名 说明
isEnabledCriticalPerfect boolean true none none
isEnabledFastAndLate boolean true none none
fast integer(int32) true none none
late integer(int32) true none none
tap NotesInfo true none none
hold NotesInfo true none none
slide NotesInfo true none none
touch NotesInfo true none none
mai2Break NotesInfo true none none

TurboTicketInfoVO

{
  "ticketId": 0,
  "ticketName": "string",
  "ticketImg": "string"
}

属性

名称 类型 必选 约束 中文名 说明
ticketId integer(int32) true none none
ticketName string true none none
ticketImg string true none none

TicketVO

{
  "ticketId": 0,
  "ticketName": "string",
  "ticketImg": "string",
  "ticketCount": 0
}

属性

名称 类型 必选 约束 中文名 说明
ticketId integer(int32) true none none
ticketName string true none none
ticketImg string true none none
ticketCount integer(int32) true none none

TicketResponseVO

{
  "ticketList": [
    {
      "ticketId": 0,
      "ticketName": "string",
      "ticketImg": "string",
      "ticketCount": 0
    }
  ],
  "turboTicketInfo": {
    "ticketId": 0,
    "ticketName": "string",
    "ticketImg": "string"
  },
  "isEnableTurboTicket": true,
  "isTicketEmpty": true
}

属性

名称 类型 必选 约束 中文名 说明
ticketList [TicketVO] true none none
turboTicketInfo TurboTicketInfoVO false none none
isEnableTurboTicket boolean true none none
isTicketEmpty boolean true none none

FinalResponseVOTicketResponseVO

{
  "isSuccess": true,
  "data": {
    "ticketList": [
      {
        "ticketId": 0,
        "ticketName": "string",
        "ticketImg": "string",
        "ticketCount": 0
      }
    ],
    "turboTicketInfo": {
      "ticketId": 0,
      "ticketName": "string",
      "ticketImg": "string"
    },
    "isEnableTurboTicket": true,
    "isTicketEmpty": true
  }
}

属性

名称 类型 必选 约束 中文名 说明
isSuccess boolean true none none
data TicketResponseVO false none none

TurboVO

{
  "name": "string",
  "allRequestsNumber": 0,
  "cacheRequestsNumber": 0,
  "fixedRequestNumber": 0,
  "cacheHitRate": "string",
  "detail": {
    "isEmptyDetail": true,
    "tenMinutesDetail": {
      "playerCount": 0,
      "playCount": 0
    },
    "thirtyMinutesDetail": {
      "playerCount": 0,
      "playCount": 0
    },
    "hourDetail": {
      "playerCount": 0,
      "playCount": 0
    },
    "playerDetail": [
      {
        "playerLoginDate": "string",
        "playerName": "string",
        "playerRating": 0
      }
    ]
  }
}

属性

名称 类型 必选 约束 中文名 说明
name string true none none
allRequestsNumber integer(int32) true none none
cacheRequestsNumber integer(int32) true none none
fixedRequestNumber integer(int32) true none none
cacheHitRate string true none none
detail TurboDetailResponseVO true none none

TurboSingleDetailPlayerVO

{
  "playerLoginDate": "string",
  "playerName": "string",
  "playerRating": 0
}

属性

名称 类型 必选 约束 中文名 说明
playerLoginDate string true none none
playerName string true none none
playerRating integer(int32) true none none

TurboResponseVO

{
  "show": true,
  "turboInfoList": [
    {
      "name": "string",
      "allRequestsNumber": 0,
      "cacheRequestsNumber": 0,
      "fixedRequestNumber": 0,
      "cacheHitRate": "string",
      "detail": {
        "isEmptyDetail": true,
        "tenMinutesDetail": {
          "playerCount": 0,
          "playCount": 0
        },
        "thirtyMinutesDetail": {
          "playerCount": 0,
          "playCount": 0
        },
        "hourDetail": {
          "playerCount": 0,
          "playCount": 0
        },
        "playerDetail": [
          {
            "playerLoginDate": null,
            "playerName": null,
            "playerRating": null
          }
        ]
      }
    }
  ]
}

属性

名称 类型 必选 约束 中文名 说明
show boolean true none none
turboInfoList [TurboVO] true none none

TurboPlayDetailVO

{
  "playerCount": 0,
  "playCount": 0
}

属性

名称 类型 必选 约束 中文名 说明
playerCount integer(int32) true none none
playCount integer(int32) true none none

TurboDetailResponseVO

{
  "isEmptyDetail": true,
  "tenMinutesDetail": {
    "playerCount": 0,
    "playCount": 0
  },
  "thirtyMinutesDetail": {
    "playerCount": 0,
    "playCount": 0
  },
  "hourDetail": {
    "playerCount": 0,
    "playCount": 0
  },
  "playerDetail": [
    {
      "playerLoginDate": "string",
      "playerName": "string",
      "playerRating": 0
    }
  ]
}

属性

名称 类型 必选 约束 中文名 说明
isEmptyDetail boolean true none none
tenMinutesDetail TurboPlayDetailVO true none none
thirtyMinutesDetail TurboPlayDetailVO true none none
hourDetail TurboPlayDetailVO true none none
playerDetail [TurboSingleDetailPlayerVO] true none none

FinalResponseVOTurboResponseVO

{
  "isSuccess": true,
  "data": {
    "show": true,
    "turboInfoList": [
      {
        "name": "string",
        "allRequestsNumber": 0,
        "cacheRequestsNumber": 0,
        "fixedRequestNumber": 0,
        "cacheHitRate": "string",
        "detail": {
          "isEmptyDetail": true,
          "tenMinutesDetail": {},
          "thirtyMinutesDetail": {},
          "hourDetail": {},
          "playerDetail": [
            null
          ]
        }
      }
    ]
  }
}

属性

名称 类型 必选 约束 中文名 说明
isSuccess boolean true none none
data TurboResponseVO false none none

UserResponseVO

{
  "username": "string",
  "permissionLevel": "string",
  "email": "string",
  "qqNumber": "string",
  "mai2Name": "string",
  "mai2SHA256": "string",
  "botToken": "string"
}

属性

名称 类型 必选 约束 中文名 说明
username string true none none
permissionLevel string true none none
email string true none none
qqNumber string true none none
mai2Name string true none none
mai2SHA256 string true none none
botToken string true none none

FinalResponseVOUserResponseVO

{
  "isSuccess": true,
  "data": {
    "username": "string",
    "permissionLevel": "string",
    "email": "string",
    "qqNumber": "string",
    "mai2Name": "string",
    "mai2SHA256": "string",
    "botToken": "string"
  }
}

属性

名称 类型 必选 约束 中文名 说明
isSuccess boolean true none none
data UserResponseVO false none none

RegisterSecondStepsValidRequestVO

{
  "email": "string",
  "qqNumber": "string"
}

属性

名称 类型 必选 约束 中文名 说明
email string true none none
qqNumber string true none none

RegisterUsernameValidRequestVO

{
  "username": "string"
}

属性

名称 类型 必选 约束 中文名 说明
username string true none none

LoginResponseVO

{
  "token": "string",
  "refreshToken": "string"
}

属性

名称 类型 必选 约束 中文名 说明
token string true none none
refreshToken string true none none

FinalResponseVOLoginResponseVO

{
  "isSuccess": true,
  "data": {
    "token": "string",
    "refreshToken": "string"
  }
}

属性

名称 类型 必选 约束 中文名 说明
isSuccess boolean true none none
data LoginResponseVO false none none

LoginRequestVO

{
  "username": "string",
  "password": "string",
  "captchaToken": "string"
}

属性

名称 类型 必选 约束 中文名 说明
username string true none none
password string true none none
captchaToken string true none none

LogoutRequestVO

{
  "token": "string",
  "refreshToken": "string"
}

属性

名称 类型 必选 约束 中文名 说明
token string true none none
refreshToken string true none none

RefreshTokenRequestVO

{
  "refreshToken": "string"
}

属性

名称 类型 必选 约束 中文名 说明
refreshToken string true none none

RegisterVerifyRequestVO

{
  "token": "string",
  "valid": "string"
}

属性

名称 类型 必选 约束 中文名 说明
token string true none none
valid string true none none

RegisterResponseVO

{
  "msg": "string"
}

属性

名称 类型 必选 约束 中文名 说明
msg string true none none

FinalResponseVORegisterResponseVO

{
  "isSuccess": true,
  "data": {
    "msg": "string"
  }
}

属性

名称 类型 必选 约束 中文名 说明
isSuccess boolean true none none
data RegisterResponseVO false none none

RegisterRequestVO

{
  "username": "string",
  "password": "string",
  "email": "string",
  "qqNumber": "string",
  "weChatID": "string",
  "captchaToken": "string"
}

属性

名称 类型 必选 约束 中文名 说明
username string true none none
password string true none none
email string true none none
qqNumber string true none none
weChatID string true none none
captchaToken string true none none

ResetPasswordIsValidRequestVO

{
  "token": "string",
  "valid": "string"
}

属性

名称 类型 必选 约束 中文名 说明
token string true none none
valid string true none none

ResetPasswordValidRequestVO

{
  "token": "string",
  "valid": "string",
  "password": "string"
}

属性

名称 类型 必选 约束 中文名 说明
token string true none none
valid string true none none
password string true none none

Null

{}

属性

None

FinalResponseVONull

{
  "isSuccess": true,
  "data": {}
}

属性

名称 类型 必选 约束 中文名 说明
isSuccess boolean true none none
data Null false none none

ResetPasswordRequestVO

{
  "email": "string",
  "captchaToken": "string"
}

属性

名称 类型 必选 约束 中文名 说明
email string true none none
captchaToken string true none none

RefreshTokenResponseVO

{
  "token": "string"
}

属性

名称 类型 必选 约束 中文名 说明
token string true none none

FinalResponseVORefreshTokenResponseVO

{
  "isSuccess": true,
  "data": {
    "token": "string"
  }
}

属性

名称 类型 必选 约束 中文名 说明
isSuccess boolean true none none
data RefreshTokenResponseVO false none none

TokenValidationRequestVO

{
  "token": "string",
  "refreshToken": "string",
  "botToken": "string"
}

属性

名称 类型 必选 约束 中文名 说明
token string false none none
refreshToken string false none none
botToken string false none none

FinalResponseVOBotBindResponseVO

{
  "isSuccess": true,
  "data": {
    "botKey": "string"
  }
}

属性

名称 类型 必选 约束 中文名 说明
isSuccess boolean true none none
data BotBindResponseVO false none none

BotBindResponseVO

{
  "botKey": "string"
}

属性

名称 类型 必选 约束 中文名 说明
botKey string true none none

BotBindRequestVO

{
  "botToken": "string",
  "botName": "string"
}

属性

名称 类型 必选 约束 中文名 说明
botToken string true none none
botName string true none none

BotUnbindRequestVO

{
  "botKey": "string"
}

属性

名称 类型 必选 约束 中文名 说明
botKey string true none none

FinalResponseVOString

{
  "isSuccess": true,
  "data": "string"
}

属性

名称 类型 必选 约束 中文名 说明
isSuccess boolean true none none
data string false none none

PermissionRequestVO

{
  "changeUsername": "string"
}

属性

名称 类型 必选 约束 中文名 说明
changeUsername string true none none

PhotoFavoriteRequestVO

{
  "photoUUID": "string"
}

属性

名称 类型 必选 约束 中文名 说明
photoUUID string true none none

TurboTicketWhitelistRequestVO

{
  "ticketId": 0
}

属性

名称 类型 必选 约束 中文名 说明
ticketId integer(int32) true none none

TurboCustomNameRequestVO

{
  "turboName": "string"
}

属性

名称 类型 必选 约束 中文名 说明
turboName string true none none

Unit

{}

属性

None

UpsertUserPortraitRequestVO

{
  "divData": "string"
}

属性

名称 类型 必选 约束 中文名 说明
divData string true none none

About

turboNET Alpha api document

License:MIT License