pdf_code/zzb_data/file/docx/test.txt

5461 lines
141 KiB
Plaintext
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

[
{
"type": "text",
"index": 1,
"data": "文档编号:"
},
{
"type": "text",
"index": 2,
"data": "版 本 号: 1.0.0"
},
{
"type": "text",
"index": 3,
"data": "密 级: 高 级"
},
{
"type": "text",
"index": 4,
"data": "四川赛事-赛事数据对接接口"
},
{
"type": "text",
"index": 5,
"data": "说明书 V1.0.0"
},
{
"type": "text",
"index": 6,
"data": "一.引言"
},
{
"type": "text",
"index": 7,
"data": "接口交互信息采用json格式。"
},
{
"type": "text",
"index": 8,
"data": "接口要求"
},
{
"type": "text",
"index": 9,
"data": "变更情况记录"
},
{
"type": "text",
"index": 11,
"data": "2.1引言"
},
{
"type": "text",
"index": 12,
"data": "2.1.1编写目的"
},
{
"type": "text",
"index": 13,
"data": "本说明书针对外部系统与本系统进行数据交互的接口技术规范进行说明,用于指导开发人员进行相关业务的开发。"
},
{
"type": "text",
"index": 14,
"data": "预期的读者为外部对接人员。"
},
{
"type": "text",
"index": 15,
"data": "2.1.2 背景"
},
{
"type": "text",
"index": 16,
"data": "对外接口。"
},
{
"type": "text",
"index": 17,
"data": "2.2概览"
},
{
"type": "text",
"index": 18,
"data": "2.2.1交互场景"
},
{
"type": "text",
"index": 19,
"data": "2.2.2接口表"
},
{
"type": "text",
"index": 20,
"data": "2.2.3 返回码表"
},
{
"type": "text",
"index": 22,
"data": "2.2.4 Ajax请求"
},
{
"type": "text",
"index": 23,
"data": "POST方式分两种请求"
},
{
"type": "text",
"index": 24,
"data": "json:"
},
{
"type": "text",
"index": 25,
"data": "contentType: 'application/json; charset=utf-8 '"
},
{
"type": "text",
"index": 26,
"data": "form:"
},
{
"type": "text",
"index": 27,
"data": "contentType: 'application/x-www-form-urlencoded; charset=utf-8'"
},
{
"type": "text",
"index": 28,
"data": "GET方式"
},
{
"type": "text",
"index": 29,
"data": "contentType: 'application/x-www-form-urlencoded; charset=utf-8'"
},
{
"type": "text",
"index": 30,
"data": "2.2.5 安全校验"
},
{
"type": "text",
"index": 31,
"data": "接口调用需要先获取token获取token后发起接口请求token有效时间2小时。"
},
{
"type": "text",
"index": 32,
"data": "请求头header 中添加"
},
{
"type": "text",
"index": 33,
"data": "Authorization Bearer + 空格 + token"
},
{
"type": "text",
"index": 34,
"data": "三. 接口说明"
},
{
"type": "text",
"index": 35,
"data": "测试接口地址:"
},
{
"type": "text",
"index": 36,
"data": "${HOST_API} http://123.249.81.28:8710"
},
{
"type": "text",
"index": 37,
"data": "生产接口地址:"
},
{
"type": "text",
"index": 38,
"data": "${HOST_API} http://47.100.109.201:9110"
},
{
"type": "text",
"index": 39,
"data": "3.1 获取授权接口V1.0"
},
{
"type": "text",
"index": 40,
"data": "3.1.1获取授权token接口"
},
{
"type": "text",
"index": 42,
"data": "3.2 接口说明V1.0"
},
{
"type": "text",
"index": 43,
"data": "3.2.1赛事数据接口"
},
{
"type": "text",
"index": 45,
"data": "成功"
},
{
"type": "text",
"index": 47,
"data": "失败"
}
]
[
{
"type": "table",
"index": 10,
"data": [
[
"日期",
"修改内容",
"版本号",
"作者"
],
[
"2024-08-30",
"初始化文档",
"V1.0.0",
"柴泽宾"
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
]
]
},
{
"type": "table",
"index": 21,
"data": [
[
"返回码",
"返回码说明"
],
[
"1",
"操作成功 AJAX端非1返回码都按照错误处理"
],
[
"-1",
"操作失败"
]
]
},
{
"type": "table",
"index": 41,
"data": [
[
"说明",
"获取接口授权接口",
"获取接口授权接口",
"获取接口授权接口",
"获取接口授权接口"
],
[
"请求",
"${HOST_API}/oauth/oauth/token",
"${HOST_API}/oauth/oauth/token",
"method",
"POST(from)"
],
[
"请求参数",
"请求参数",
"请求参数",
"请求参数",
"请求参数"
],
[
"参数名",
"类型",
"是否必填",
"参数说明",
"参数说明"
],
[
"请求头header",
"",
"",
"",
""
],
[
"",
"",
"",
"",
""
],
[
"请求体body",
"",
"",
"",
""
],
[
"grant_type",
"String",
"是",
"固定值 client_credentials",
"固定值 client_credentials"
],
[
"client_id",
"String",
"是",
"业务系统编码",
"业务系统编码"
],
[
"client_secret",
"String",
"是",
"授权秘钥",
"授权秘钥"
],
[
"返回字段说明(JSON)",
"返回字段说明(JSON)",
"返回字段说明(JSON)",
"返回字段说明(JSON)",
"返回字段说明(JSON)"
],
[
"字段名称",
"字段类型",
"字段说明",
"取值说明",
"取值说明"
],
[
"code",
"整型",
"操作状态码",
"1成功 非1失败",
"1成功 非1失败"
],
[
"msg",
"文本",
"请求信息说明",
"成功/失败信息",
"成功/失败信息"
],
[
"data ",
"对象Object",
"",
"参见返回示例",
"参见返回示例"
],
[
"access_token",
"String",
"Token凭证",
"授权使用",
"授权使用"
],
[
"token_type",
"String",
"Token类型",
"Bearer访问接口使用",
"Bearer访问接口使用"
],
[
"expires_in",
"Int",
"有效时间秒",
"建议获取后存储控制重新获取的频率",
"建议获取后存储控制重新获取的频率"
],
[
"返回示例",
"返回示例",
"返回示例",
"返回示例",
"返回示例"
],
[
"{\n \"code\": 1,\n \"msg\": \"成功\",\n \"data\": {\n \"access_token\": \"0c4dc05c-44a0-43d2-be98-a39fdf77e94c\",\n \"token_type\": \"bearer\",\n \"expires_in\": 7199,\n \"scope\": \"api\"\n }\n}\n",
"{\n \"code\": 1,\n \"msg\": \"成功\",\n \"data\": {\n \"access_token\": \"0c4dc05c-44a0-43d2-be98-a39fdf77e94c\",\n \"token_type\": \"bearer\",\n \"expires_in\": 7199,\n \"scope\": \"api\"\n }\n}\n",
"{\n \"code\": 1,\n \"msg\": \"成功\",\n \"data\": {\n \"access_token\": \"0c4dc05c-44a0-43d2-be98-a39fdf77e94c\",\n \"token_type\": \"bearer\",\n \"expires_in\": 7199,\n \"scope\": \"api\"\n }\n}\n",
"{\n \"code\": 1,\n \"msg\": \"成功\",\n \"data\": {\n \"access_token\": \"0c4dc05c-44a0-43d2-be98-a39fdf77e94c\",\n \"token_type\": \"bearer\",\n \"expires_in\": 7199,\n \"scope\": \"api\"\n }\n}\n",
"{\n \"code\": 1,\n \"msg\": \"成功\",\n \"data\": {\n \"access_token\": \"0c4dc05c-44a0-43d2-be98-a39fdf77e94c\",\n \"token_type\": \"bearer\",\n \"expires_in\": 7199,\n \"scope\": \"api\"\n }\n}\n"
],
[
"请求示例1:",
"请求示例1:",
"请求示例1:",
"请求示例1:",
"请求示例1:"
],
[
"",
"",
"",
"",
""
],
[
"获取资源请求示例:",
"获取资源请求示例:",
"获取资源请求示例:",
"获取资源请求示例:",
"获取资源请求示例:"
],
[
"",
"",
"",
"",
""
],
[
"\n\n",
"\n\n",
"\n\n",
"\n\n",
"\n\n"
]
]
},
{
"type": "table",
"index": 44,
"data": [
[
"说明",
"用户信息查询接口",
"用户信息查询接口",
"用户信息查询接口",
"用户信息查询接口",
"用户信息查询接口",
"请求",
"${HOST_API}/race/info/syncSave"
],
[
"${HOST_API}/race/info/syncSave",
"method",
"Post",
"Post",
"请求参数",
"请求参数",
"请求参数",
"请求参数"
],
[
"请求参数",
"请求参数",
"参数名",
"类型",
"是否必填",
"参数说明",
"参数说明",
"参数说明"
],
[
"请求头header",
"",
"",
"",
"",
"",
"Authorization",
"String"
],
[
"是",
"Bearer + 空格 + token",
"Bearer + 空格 + token",
"Bearer + 空格 + token",
"请求参数",
"请求参数",
"请求参数",
"请求参数"
],
[
"请求参数",
"请求参数",
"raceId",
"String",
"是",
"赛事主键id",
"赛事主键id",
"赛事主键id"
],
[
"communityGames",
"String",
"是",
"是否为社区运动会Y=是N=否)",
"是否为社区运动会Y=是N=否)",
"是否为社区运动会Y=是N=否)",
"raceName",
"String"
],
[
"是",
"赛事名称",
"赛事名称",
"赛事名称",
"raceContent\n",
"String",
"是",
"赛事简介"
],
[
"赛事简介",
"赛事简介",
"raceLevel\n",
"String",
"是",
"赛事等级国际级1国家级2省级3市级4区县级5街道/乡镇6社区/村7其他8",
"赛事等级国际级1国家级2省级3市级4区县级5街道/乡镇6社区/村7其他8",
"赛事等级国际级1国家级2省级3市级4区县级5街道/乡镇6社区/村7其他8"
],
[
"provinceFund\n",
"String",
"是",
"资金投入\n省级投入万元\n",
"资金投入\n省级投入万元\n",
"资金投入\n省级投入万元\n",
"cityFund\n",
"String"
],
[
"是",
"资金投入\n市州级投入万元\n",
"资金投入\n市州级投入万元\n",
"资金投入\n市州级投入万元\n",
"districtFund\n",
"String",
"是",
"资金投入\n区县级投入万元\n"
],
[
"资金投入\n区县级投入万元\n",
"资金投入\n区县级投入万元\n",
"provinceId\n",
"Long",
"是",
"赛事省",
"赛事省",
"赛事省"
],
[
"cityId\n",
"Long",
"是",
"赛事市州",
"赛事市州",
"赛事市州",
"districtId\n",
"Long"
],
[
"是",
"是",
"赛事区县",
"赛事区县",
"streetName\n",
"Long",
"Long",
"Long"
],
[
"否",
"赛事街道名称",
"赛事街道名称",
"赛事街道名称",
"communityName\n",
"Long",
"Long",
"Long"
],
[
"否",
"赛事名称",
"赛事名称",
"赛事名称",
"addrDesc\n",
"String",
"String",
"String"
],
[
"否",
"比赛详细地址",
"比赛详细地址",
"比赛详细地址",
"enrollStartDate",
"String",
"String",
"String"
],
[
"否",
"赛事报名开始时间\nyyyy-MM-dd",
"赛事报名开始时间\nyyyy-MM-dd",
"赛事报名开始时间\nyyyy-MM-dd",
"enrollEndDate",
"String",
"String",
"String"
],
[
"否",
"赛事报名结束时间\nyyyy-MM-dd",
"赛事报名结束时间\nyyyy-MM-dd",
"赛事报名结束时间\nyyyy-MM-dd",
"enrollMethod\n",
"String",
"String",
"String"
],
[
"否",
"赛事报名方式\n",
"赛事报名方式\n",
"赛事报名方式\n",
"startDate\n",
"String",
"String",
"String"
],
[
"是",
"赛事开始时间\nyyyy-MM-dd",
"赛事开始时间\nyyyy-MM-dd",
"赛事开始时间\nyyyy-MM-dd",
"endDate\n",
"String",
"String",
"String"
],
[
"是",
"赛事结束时间\nyyyy-MM-dd",
"赛事结束时间\nyyyy-MM-dd",
"赛事结束时间\nyyyy-MM-dd",
"managerName\n",
"String",
"String",
"String"
],
[
"否",
"赛事联系人",
"赛事联系人",
"赛事联系人",
"managerPhone\n",
"String",
"String",
"String"
],
[
"否",
"负责人电话",
"负责人电话",
"负责人电话",
"sponsorName\n",
"String",
"String",
"String"
],
[
"是",
"第一主办方名称",
"第一主办方名称",
"第一主办方名称",
"undertakeName\n",
"String",
"String",
"String"
],
[
"否",
"承办方名称",
"承办方名称",
"承办方名称",
"jointlyName\n",
"String",
"String",
"String"
],
[
"否",
"协办方名称",
"协办方名称",
"协办方名称",
"webDomain\n",
"String",
"String",
"String"
],
[
"否",
"直播或转播链接",
"直播或转播链接",
"直播或转播链接",
"promotionLink\n",
"String",
"String",
"String"
],
[
"否",
"宣传报道链接",
"宣传报道链接",
"宣传报道链接",
"raceOther\n",
"String",
"String",
"String"
],
[
"否",
"其他",
"其他",
"其他",
"raceImgUrl",
"String",
"String",
"String"
],
[
"是",
"赛事封面",
"赛事封面",
"赛事封面",
"bsxcImageList",
"Array[]",
"Array[]",
"Array[]"
],
[
"否",
"比赛现场图片0/5",
"比赛现场图片0/5",
"比赛现场图片0/5",
"-savePath",
"",
"",
""
],
[
"",
"",
"",
"",
"kmsImageList",
"Array[]",
"Array[]",
"Array[]"
],
[
"否",
"开幕式图片0/5",
"开幕式图片0/5",
"开幕式图片0/5",
"-savePath",
"",
"",
""
],
[
"",
"",
"",
"",
"bjskImageList",
"Array[]",
"Array[]",
"Array[]"
],
[
"否",
"颁奖时刻图片0/5",
"颁奖时刻图片0/5",
"颁奖时刻图片0/5",
"-savePath",
"",
"",
""
],
[
"",
"",
"",
"",
"raceScore",
"",
"",
""
],
[
"否",
"赛事成绩",
"赛事成绩",
"赛事成绩",
"scoreFileList",
"Array[]",
"Array[]",
"Array[]"
],
[
"否",
"赛事成绩公告上传",
"赛事成绩公告上传",
"赛事成绩公告上传",
"-filePath",
"",
"",
"是"
],
[
"文件路径",
"文件路径",
"文件路径",
"-fileName",
"",
"",
"是",
"文件名称"
],
[
"文件名称",
"文件名称",
"rulesFileList",
"Array[]",
"Array[]",
"否",
"赛事规程",
"赛事规程"
],
[
"赛事规程",
"-filePath",
"",
"",
"是",
"文件路径",
"文件路径",
"文件路径"
],
[
"-fileName",
"",
"",
"是",
"文件名称",
"文件名称",
"文件名称",
"zhixuFileList"
],
[
"Array[]",
"Array[]",
"否",
"赛事秩序册",
"赛事秩序册",
"赛事秩序册",
"-filePath",
""
],
[
"",
"是",
"文件路径",
"文件路径",
"文件路径",
"-fileName",
"",
""
],
[
"是",
"文件名称",
"文件名称",
"文件名称",
"otherFileList",
"Array[]",
"Array[]",
"否"
],
[
"其他相关文件",
"其他相关文件",
"其他相关文件",
"-filePath",
"",
"",
"是",
"文件路径"
],
[
"文件路径",
"文件路径",
"-fileName",
"",
"",
"是",
"文件名称",
"文件名称"
],
[
"文件名称",
"videoFileList",
"Array[]",
"Array[]",
"否",
"赛事视频",
"赛事视频",
"赛事视频"
],
[
"-filePath",
"",
"",
"是",
"文件路径",
"文件路径",
"文件路径",
"-fileName"
],
[
"",
"",
"是",
"文件名称",
"文件名称",
"文件名称",
"noticeFileList",
""
],
[
"",
"否",
"赛事通知",
"赛事通知",
"赛事通知",
"-filePath",
"",
""
],
[
"是",
"文件路径",
"文件路径",
"文件路径",
"-fileName",
"",
"",
"是"
],
[
"文件名称",
"文件名称",
"文件名称",
"raceItemList",
"Array[]",
"Array[]",
"是",
"运动会规模"
],
[
"运动会规模",
"运动会规模",
"-itemId",
"",
"",
"是",
"项目id",
"项目id"
],
[
"项目id",
"-itemName",
"",
"",
"是",
"项目名称",
"项目名称",
"项目名称"
],
[
"-itemIds",
"Array[]",
"Array[]",
"是",
"项目子类id",
"项目子类id",
"项目子类id",
"-raceNumber"
],
[
"",
"",
"是",
"比赛场次",
"比赛场次",
"比赛场次",
"-playerTimes",
""
],
[
"",
"是",
"参数人数",
"参数人数",
"参数人数",
"-playerNumber",
"",
""
],
[
"是",
"参数人次",
"参数人次",
"参数人次",
"-remarks",
"",
"",
"是"
],
[
"备注",
"备注",
"备注",
"返回字段说明(JSON)",
"返回字段说明(JSON)",
"返回字段说明(JSON)",
"返回字段说明(JSON)",
"返回字段说明(JSON)"
],
[
"返回字段说明(JSON)",
"字段名称",
"字段类型",
"字段类型",
"字段说明",
"取值说明",
"取值说明",
"取值说明"
],
[
"code",
"整型",
"整型",
"操作状态码",
"1成功 非1失败",
"1成功 非1失败",
"1成功 非1失败",
"data"
],
[
"",
"",
"",
"",
"",
"",
"msg",
"文本"
],
[
"文本",
"请求信息说明",
"成功/失败信息",
"成功/失败信息",
"成功/失败信息",
"",
"",
""
],
[
"",
"",
"",
"",
"返回示例",
"返回示例",
"返回示例",
"返回示例"
],
[
"返回示例",
"返回示例",
"{\n    \"code\":1,\n    \"data\":[\n        {\n            \"studentCode\":\"202310070090\"\n        }],\n    \"msg\":\"成功\"\n}\n\n{\n \"code\": -1,\n \"msg\": \"参数必填项不能为空\"\n}\n\n\n",
"{\n    \"code\":1,\n    \"data\":[\n        {\n            \"studentCode\":\"202310070090\"\n        }],\n    \"msg\":\"成功\"\n}\n\n{\n \"code\": -1,\n \"msg\": \"参数必填项不能为空\"\n}\n\n\n",
"{\n    \"code\":1,\n    \"data\":[\n        {\n            \"studentCode\":\"202310070090\"\n        }],\n    \"msg\":\"成功\"\n}\n\n{\n \"code\": -1,\n \"msg\": \"参数必填项不能为空\"\n}\n\n\n",
"{\n    \"code\":1,\n    \"data\":[\n        {\n            \"studentCode\":\"202310070090\"\n        }],\n    \"msg\":\"成功\"\n}\n\n{\n \"code\": -1,\n \"msg\": \"参数必填项不能为空\"\n}\n\n\n",
"{\n    \"code\":1,\n    \"data\":[\n        {\n            \"studentCode\":\"202310070090\"\n        }],\n    \"msg\":\"成功\"\n}\n\n{\n \"code\": -1,\n \"msg\": \"参数必填项不能为空\"\n}\n\n\n",
"{\n    \"code\":1,\n    \"data\":[\n        {\n            \"studentCode\":\"202310070090\"\n        }],\n    \"msg\":\"成功\"\n}\n\n{\n \"code\": -1,\n \"msg\": \"参数必填项不能为空\"\n}\n\n\n"
],
[
"请求示例1:",
"请求示例1:",
"请求示例1:",
"请求示例1:",
"请求示例1:",
"请求示例1:",
"\n",
"\n"
],
[
"\n",
"\n",
"\n",
"\n",
"获取资源请求示例:",
"获取资源请求示例:",
"获取资源请求示例:",
"获取资源请求示例:"
],
[
"获取资源请求示例:",
"获取资源请求示例:",
"",
"",
"",
"",
"",
""
],
[
"\n\n",
"\n\n",
"\n\n",
"\n\n",
"\n\n",
"\n\n"
],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[]
]
},
{
"type": "table",
"index": 46,
"data": [
[
"字段名称",
"字段类型",
"字段说明",
"取值说明"
],
[
"code",
"整型",
"操作状态码",
"1成功"
],
[
"msg",
"文本",
"信息说明",
"操作成功说明"
],
[
"data",
"JSON数据",
"Json数据",
"在实际接口说明中定义"
]
]
},
{
"type": "table",
"index": 48,
"data": [
[
"字段名称",
"字段类型",
"字段说明",
"取值说明"
],
[
"code",
"整型",
"操作状态码",
"失败 不等于1表示失败"
],
[
"msg",
"文本",
"出错信息说明",
"操作失败说明"
]
]
}
]
[
{
"index": 4,
"depth": 1,
"data": "四川赛事-赛事数据对接接口"
},
{
"index": 5,
"depth": 1,
"data": "说明书 V1.0.0"
},
{
"index": 6,
"depth": 2,
"data": "一.引言"
},
{
"index": 8,
"depth": 2,
"data": "接口要求"
},
{
"index": 11,
"depth": 3,
"data": "2.1引言"
},
{
"index": 12,
"depth": 4,
"data": "2.1.1编写目的"
},
{
"index": 15,
"depth": 4,
"data": "2.1.2 背景"
},
{
"index": 17,
"depth": 3,
"data": "2.2概览"
},
{
"index": 18,
"depth": 4,
"data": "2.2.1交互场景"
},
{
"index": 19,
"depth": 4,
"data": "2.2.2接口表"
},
{
"index": 20,
"depth": 4,
"data": "2.2.3 返回码表"
},
{
"index": 22,
"depth": 4,
"data": "2.2.4 Ajax请求"
},
{
"index": 30,
"depth": 4,
"data": "2.2.5 安全校验"
},
{
"index": 34,
"depth": 2,
"data": "三. 接口说明"
},
{
"index": 39,
"depth": 3,
"data": "3.1 获取授权接口V1.0"
},
{
"index": 40,
"depth": 4,
"data": "3.1.1获取授权token接口"
},
{
"index": 42,
"depth": 3,
"data": "3.2 接口说明V1.0"
},
{
"index": 43,
"depth": 4,
"data": "3.2.1赛事数据接口"
},
{
"index": 45,
"depth": 1,
"data": "成功"
},
{
"index": 47,
"depth": 1,
"data": "失败"
}
]
[
{
"type": "text",
"index": 1,
"data": "文档编号:"
},
{
"type": "text",
"index": 2,
"data": "版 本 号: 1.0.0"
},
{
"type": "text",
"index": 3,
"data": "密 级: 高 级"
},
{
"type": "text",
"index": 4,
"data": "四川赛事-赛事数据对接接口"
},
{
"type": "text",
"index": 5,
"data": "说明书 V1.0.0"
},
{
"type": "text",
"index": 6,
"data": "一.引言"
},
{
"type": "text",
"index": 7,
"data": "接口交互信息采用json格式。"
},
{
"type": "text",
"index": 8,
"data": "接口要求"
},
{
"type": "text",
"index": 9,
"data": "变更情况记录"
},
{
"type": "text",
"index": 11,
"data": "2.1引言"
},
{
"type": "text",
"index": 12,
"data": "2.1.1编写目的"
},
{
"type": "text",
"index": 13,
"data": "本说明书针对外部系统与本系统进行数据交互的接口技术规范进行说明,用于指导开发人员进行相关业务的开发。"
},
{
"type": "text",
"index": 14,
"data": "预期的读者为外部对接人员。"
},
{
"type": "text",
"index": 15,
"data": "2.1.2 背景"
},
{
"type": "text",
"index": 16,
"data": "对外接口。"
},
{
"type": "text",
"index": 17,
"data": "2.2概览"
},
{
"type": "text",
"index": 18,
"data": "2.2.1交互场景"
},
{
"type": "text",
"index": 19,
"data": "2.2.2接口表"
},
{
"type": "text",
"index": 20,
"data": "2.2.3 返回码表"
},
{
"type": "text",
"index": 22,
"data": "2.2.4 Ajax请求"
},
{
"type": "text",
"index": 23,
"data": "POST方式分两种请求"
},
{
"type": "text",
"index": 24,
"data": "json:"
},
{
"type": "text",
"index": 25,
"data": "contentType: 'application/json; charset=utf-8 '"
},
{
"type": "text",
"index": 26,
"data": "form:"
},
{
"type": "text",
"index": 27,
"data": "contentType: 'application/x-www-form-urlencoded; charset=utf-8'"
},
{
"type": "text",
"index": 28,
"data": "GET方式"
},
{
"type": "text",
"index": 29,
"data": "contentType: 'application/x-www-form-urlencoded; charset=utf-8'"
},
{
"type": "text",
"index": 30,
"data": "2.2.5 安全校验"
},
{
"type": "text",
"index": 31,
"data": "接口调用需要先获取token获取token后发起接口请求token有效时间2小时。"
},
{
"type": "text",
"index": 32,
"data": "请求头header 中添加"
},
{
"type": "text",
"index": 33,
"data": "Authorization Bearer + 空格 + token"
},
{
"type": "text",
"index": 34,
"data": "三. 接口说明"
},
{
"type": "text",
"index": 35,
"data": "测试接口地址:"
},
{
"type": "text",
"index": 36,
"data": "${HOST_API} http://123.249.81.28:8710"
},
{
"type": "text",
"index": 37,
"data": "生产接口地址:"
},
{
"type": "text",
"index": 38,
"data": "${HOST_API} http://47.100.109.201:9110"
},
{
"type": "text",
"index": 39,
"data": "3.1 获取授权接口V1.0"
},
{
"type": "text",
"index": 40,
"data": "3.1.1获取授权token接口"
},
{
"type": "text",
"index": 42,
"data": "3.2 接口说明V1.0"
},
{
"type": "text",
"index": 43,
"data": "3.2.1赛事数据接口"
},
{
"type": "text",
"index": 45,
"data": "成功"
},
{
"type": "text",
"index": 47,
"data": "失败"
}
]
[
{
"type": "table",
"index": 10,
"data": [
[
"日期",
"修改内容",
"版本号",
"作者"
],
[
"2024-08-30",
"初始化文档",
"V1.0.0",
"柴泽宾"
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
]
]
},
{
"type": "table",
"index": 21,
"data": [
[
"返回码",
"返回码说明"
],
[
"1",
"操作成功 AJAX端非1返回码都按照错误处理"
],
[
"-1",
"操作失败"
]
]
},
{
"type": "table",
"index": 41,
"data": [
[
"说明",
"获取接口授权接口",
"获取接口授权接口",
"获取接口授权接口",
"获取接口授权接口"
],
[
"请求",
"${HOST_API}/oauth/oauth/token",
"${HOST_API}/oauth/oauth/token",
"method",
"POST(from)"
],
[
"请求参数",
"请求参数",
"请求参数",
"请求参数",
"请求参数"
],
[
"参数名",
"类型",
"是否必填",
"参数说明",
"参数说明"
],
[
"请求头header",
"",
"",
"",
""
],
[
"",
"",
"",
"",
""
],
[
"请求体body",
"",
"",
"",
""
],
[
"grant_type",
"String",
"是",
"固定值 client_credentials",
"固定值 client_credentials"
],
[
"client_id",
"String",
"是",
"业务系统编码",
"业务系统编码"
],
[
"client_secret",
"String",
"是",
"授权秘钥",
"授权秘钥"
],
[
"返回字段说明(JSON)",
"返回字段说明(JSON)",
"返回字段说明(JSON)",
"返回字段说明(JSON)",
"返回字段说明(JSON)"
],
[
"字段名称",
"字段类型",
"字段说明",
"取值说明",
"取值说明"
],
[
"code",
"整型",
"操作状态码",
"1成功 非1失败",
"1成功 非1失败"
],
[
"msg",
"文本",
"请求信息说明",
"成功/失败信息",
"成功/失败信息"
],
[
"data ",
"对象Object",
"",
"参见返回示例",
"参见返回示例"
],
[
"access_token",
"String",
"Token凭证",
"授权使用",
"授权使用"
],
[
"token_type",
"String",
"Token类型",
"Bearer访问接口使用",
"Bearer访问接口使用"
],
[
"expires_in",
"Int",
"有效时间秒",
"建议获取后存储控制重新获取的频率",
"建议获取后存储控制重新获取的频率"
],
[
"返回示例",
"返回示例",
"返回示例",
"返回示例",
"返回示例"
],
[
"{\n \"code\": 1,\n \"msg\": \"成功\",\n \"data\": {\n \"access_token\": \"0c4dc05c-44a0-43d2-be98-a39fdf77e94c\",\n \"token_type\": \"bearer\",\n \"expires_in\": 7199,\n \"scope\": \"api\"\n }\n}\n",
"{\n \"code\": 1,\n \"msg\": \"成功\",\n \"data\": {\n \"access_token\": \"0c4dc05c-44a0-43d2-be98-a39fdf77e94c\",\n \"token_type\": \"bearer\",\n \"expires_in\": 7199,\n \"scope\": \"api\"\n }\n}\n",
"{\n \"code\": 1,\n \"msg\": \"成功\",\n \"data\": {\n \"access_token\": \"0c4dc05c-44a0-43d2-be98-a39fdf77e94c\",\n \"token_type\": \"bearer\",\n \"expires_in\": 7199,\n \"scope\": \"api\"\n }\n}\n",
"{\n \"code\": 1,\n \"msg\": \"成功\",\n \"data\": {\n \"access_token\": \"0c4dc05c-44a0-43d2-be98-a39fdf77e94c\",\n \"token_type\": \"bearer\",\n \"expires_in\": 7199,\n \"scope\": \"api\"\n }\n}\n",
"{\n \"code\": 1,\n \"msg\": \"成功\",\n \"data\": {\n \"access_token\": \"0c4dc05c-44a0-43d2-be98-a39fdf77e94c\",\n \"token_type\": \"bearer\",\n \"expires_in\": 7199,\n \"scope\": \"api\"\n }\n}\n"
],
[
"请求示例1:",
"请求示例1:",
"请求示例1:",
"请求示例1:",
"请求示例1:"
],
[
"",
"",
"",
"",
""
],
[
"获取资源请求示例:",
"获取资源请求示例:",
"获取资源请求示例:",
"获取资源请求示例:",
"获取资源请求示例:"
],
[
"",
"",
"",
"",
""
],
[
"\n\n",
"\n\n",
"\n\n",
"\n\n",
"\n\n"
]
]
},
{
"type": "table",
"index": 44,
"data": [
[
"说明",
"用户信息查询接口",
"用户信息查询接口",
"用户信息查询接口",
"用户信息查询接口",
"用户信息查询接口",
"请求",
"${HOST_API}/race/info/syncSave"
],
[
"${HOST_API}/race/info/syncSave",
"method",
"Post",
"Post",
"请求参数",
"请求参数",
"请求参数",
"请求参数"
],
[
"请求参数",
"请求参数",
"参数名",
"类型",
"是否必填",
"参数说明",
"参数说明",
"参数说明"
],
[
"请求头header",
"",
"",
"",
"",
"",
"Authorization",
"String"
],
[
"是",
"Bearer + 空格 + token",
"Bearer + 空格 + token",
"Bearer + 空格 + token",
"请求参数",
"请求参数",
"请求参数",
"请求参数"
],
[
"请求参数",
"请求参数",
"raceId",
"String",
"是",
"赛事主键id",
"赛事主键id",
"赛事主键id"
],
[
"communityGames",
"String",
"是",
"是否为社区运动会Y=是N=否)",
"是否为社区运动会Y=是N=否)",
"是否为社区运动会Y=是N=否)",
"raceName",
"String"
],
[
"是",
"赛事名称",
"赛事名称",
"赛事名称",
"raceContent\n",
"String",
"是",
"赛事简介"
],
[
"赛事简介",
"赛事简介",
"raceLevel\n",
"String",
"是",
"赛事等级国际级1国家级2省级3市级4区县级5街道/乡镇6社区/村7其他8",
"赛事等级国际级1国家级2省级3市级4区县级5街道/乡镇6社区/村7其他8",
"赛事等级国际级1国家级2省级3市级4区县级5街道/乡镇6社区/村7其他8"
],
[
"provinceFund\n",
"String",
"是",
"资金投入\n省级投入万元\n",
"资金投入\n省级投入万元\n",
"资金投入\n省级投入万元\n",
"cityFund\n",
"String"
],
[
"是",
"资金投入\n市州级投入万元\n",
"资金投入\n市州级投入万元\n",
"资金投入\n市州级投入万元\n",
"districtFund\n",
"String",
"是",
"资金投入\n区县级投入万元\n"
],
[
"资金投入\n区县级投入万元\n",
"资金投入\n区县级投入万元\n",
"provinceId\n",
"Long",
"是",
"赛事省",
"赛事省",
"赛事省"
],
[
"cityId\n",
"Long",
"是",
"赛事市州",
"赛事市州",
"赛事市州",
"districtId\n",
"Long"
],
[
"是",
"是",
"赛事区县",
"赛事区县",
"streetName\n",
"Long",
"Long",
"Long"
],
[
"否",
"赛事街道名称",
"赛事街道名称",
"赛事街道名称",
"communityName\n",
"Long",
"Long",
"Long"
],
[
"否",
"赛事名称",
"赛事名称",
"赛事名称",
"addrDesc\n",
"String",
"String",
"String"
],
[
"否",
"比赛详细地址",
"比赛详细地址",
"比赛详细地址",
"enrollStartDate",
"String",
"String",
"String"
],
[
"否",
"赛事报名开始时间\nyyyy-MM-dd",
"赛事报名开始时间\nyyyy-MM-dd",
"赛事报名开始时间\nyyyy-MM-dd",
"enrollEndDate",
"String",
"String",
"String"
],
[
"否",
"赛事报名结束时间\nyyyy-MM-dd",
"赛事报名结束时间\nyyyy-MM-dd",
"赛事报名结束时间\nyyyy-MM-dd",
"enrollMethod\n",
"String",
"String",
"String"
],
[
"否",
"赛事报名方式\n",
"赛事报名方式\n",
"赛事报名方式\n",
"startDate\n",
"String",
"String",
"String"
],
[
"是",
"赛事开始时间\nyyyy-MM-dd",
"赛事开始时间\nyyyy-MM-dd",
"赛事开始时间\nyyyy-MM-dd",
"endDate\n",
"String",
"String",
"String"
],
[
"是",
"赛事结束时间\nyyyy-MM-dd",
"赛事结束时间\nyyyy-MM-dd",
"赛事结束时间\nyyyy-MM-dd",
"managerName\n",
"String",
"String",
"String"
],
[
"否",
"赛事联系人",
"赛事联系人",
"赛事联系人",
"managerPhone\n",
"String",
"String",
"String"
],
[
"否",
"负责人电话",
"负责人电话",
"负责人电话",
"sponsorName\n",
"String",
"String",
"String"
],
[
"是",
"第一主办方名称",
"第一主办方名称",
"第一主办方名称",
"undertakeName\n",
"String",
"String",
"String"
],
[
"否",
"承办方名称",
"承办方名称",
"承办方名称",
"jointlyName\n",
"String",
"String",
"String"
],
[
"否",
"协办方名称",
"协办方名称",
"协办方名称",
"webDomain\n",
"String",
"String",
"String"
],
[
"否",
"直播或转播链接",
"直播或转播链接",
"直播或转播链接",
"promotionLink\n",
"String",
"String",
"String"
],
[
"否",
"宣传报道链接",
"宣传报道链接",
"宣传报道链接",
"raceOther\n",
"String",
"String",
"String"
],
[
"否",
"其他",
"其他",
"其他",
"raceImgUrl",
"String",
"String",
"String"
],
[
"是",
"赛事封面",
"赛事封面",
"赛事封面",
"bsxcImageList",
"Array[]",
"Array[]",
"Array[]"
],
[
"否",
"比赛现场图片0/5",
"比赛现场图片0/5",
"比赛现场图片0/5",
"-savePath",
"",
"",
""
],
[
"",
"",
"",
"",
"kmsImageList",
"Array[]",
"Array[]",
"Array[]"
],
[
"否",
"开幕式图片0/5",
"开幕式图片0/5",
"开幕式图片0/5",
"-savePath",
"",
"",
""
],
[
"",
"",
"",
"",
"bjskImageList",
"Array[]",
"Array[]",
"Array[]"
],
[
"否",
"颁奖时刻图片0/5",
"颁奖时刻图片0/5",
"颁奖时刻图片0/5",
"-savePath",
"",
"",
""
],
[
"",
"",
"",
"",
"raceScore",
"",
"",
""
],
[
"否",
"赛事成绩",
"赛事成绩",
"赛事成绩",
"scoreFileList",
"Array[]",
"Array[]",
"Array[]"
],
[
"否",
"赛事成绩公告上传",
"赛事成绩公告上传",
"赛事成绩公告上传",
"-filePath",
"",
"",
"是"
],
[
"文件路径",
"文件路径",
"文件路径",
"-fileName",
"",
"",
"是",
"文件名称"
],
[
"文件名称",
"文件名称",
"rulesFileList",
"Array[]",
"Array[]",
"否",
"赛事规程",
"赛事规程"
],
[
"赛事规程",
"-filePath",
"",
"",
"是",
"文件路径",
"文件路径",
"文件路径"
],
[
"-fileName",
"",
"",
"是",
"文件名称",
"文件名称",
"文件名称",
"zhixuFileList"
],
[
"Array[]",
"Array[]",
"否",
"赛事秩序册",
"赛事秩序册",
"赛事秩序册",
"-filePath",
""
],
[
"",
"是",
"文件路径",
"文件路径",
"文件路径",
"-fileName",
"",
""
],
[
"是",
"文件名称",
"文件名称",
"文件名称",
"otherFileList",
"Array[]",
"Array[]",
"否"
],
[
"其他相关文件",
"其他相关文件",
"其他相关文件",
"-filePath",
"",
"",
"是",
"文件路径"
],
[
"文件路径",
"文件路径",
"-fileName",
"",
"",
"是",
"文件名称",
"文件名称"
],
[
"文件名称",
"videoFileList",
"Array[]",
"Array[]",
"否",
"赛事视频",
"赛事视频",
"赛事视频"
],
[
"-filePath",
"",
"",
"是",
"文件路径",
"文件路径",
"文件路径",
"-fileName"
],
[
"",
"",
"是",
"文件名称",
"文件名称",
"文件名称",
"noticeFileList",
""
],
[
"",
"否",
"赛事通知",
"赛事通知",
"赛事通知",
"-filePath",
"",
""
],
[
"是",
"文件路径",
"文件路径",
"文件路径",
"-fileName",
"",
"",
"是"
],
[
"文件名称",
"文件名称",
"文件名称",
"raceItemList",
"Array[]",
"Array[]",
"是",
"运动会规模"
],
[
"运动会规模",
"运动会规模",
"-itemId",
"",
"",
"是",
"项目id",
"项目id"
],
[
"项目id",
"-itemName",
"",
"",
"是",
"项目名称",
"项目名称",
"项目名称"
],
[
"-itemIds",
"Array[]",
"Array[]",
"是",
"项目子类id",
"项目子类id",
"项目子类id",
"-raceNumber"
],
[
"",
"",
"是",
"比赛场次",
"比赛场次",
"比赛场次",
"-playerTimes",
""
],
[
"",
"是",
"参数人数",
"参数人数",
"参数人数",
"-playerNumber",
"",
""
],
[
"是",
"参数人次",
"参数人次",
"参数人次",
"-remarks",
"",
"",
"是"
],
[
"备注",
"备注",
"备注",
"返回字段说明(JSON)",
"返回字段说明(JSON)",
"返回字段说明(JSON)",
"返回字段说明(JSON)",
"返回字段说明(JSON)"
],
[
"返回字段说明(JSON)",
"字段名称",
"字段类型",
"字段类型",
"字段说明",
"取值说明",
"取值说明",
"取值说明"
],
[
"code",
"整型",
"整型",
"操作状态码",
"1成功 非1失败",
"1成功 非1失败",
"1成功 非1失败",
"data"
],
[
"",
"",
"",
"",
"",
"",
"msg",
"文本"
],
[
"文本",
"请求信息说明",
"成功/失败信息",
"成功/失败信息",
"成功/失败信息",
"",
"",
""
],
[
"",
"",
"",
"",
"返回示例",
"返回示例",
"返回示例",
"返回示例"
],
[
"返回示例",
"返回示例",
"{\n    \"code\":1,\n    \"data\":[\n        {\n            \"studentCode\":\"202310070090\"\n        }],\n    \"msg\":\"成功\"\n}\n\n{\n \"code\": -1,\n \"msg\": \"参数必填项不能为空\"\n}\n\n\n",
"{\n    \"code\":1,\n    \"data\":[\n        {\n            \"studentCode\":\"202310070090\"\n        }],\n    \"msg\":\"成功\"\n}\n\n{\n \"code\": -1,\n \"msg\": \"参数必填项不能为空\"\n}\n\n\n",
"{\n    \"code\":1,\n    \"data\":[\n        {\n            \"studentCode\":\"202310070090\"\n        }],\n    \"msg\":\"成功\"\n}\n\n{\n \"code\": -1,\n \"msg\": \"参数必填项不能为空\"\n}\n\n\n",
"{\n    \"code\":1,\n    \"data\":[\n        {\n            \"studentCode\":\"202310070090\"\n        }],\n    \"msg\":\"成功\"\n}\n\n{\n \"code\": -1,\n \"msg\": \"参数必填项不能为空\"\n}\n\n\n",
"{\n    \"code\":1,\n    \"data\":[\n        {\n            \"studentCode\":\"202310070090\"\n        }],\n    \"msg\":\"成功\"\n}\n\n{\n \"code\": -1,\n \"msg\": \"参数必填项不能为空\"\n}\n\n\n",
"{\n    \"code\":1,\n    \"data\":[\n        {\n            \"studentCode\":\"202310070090\"\n        }],\n    \"msg\":\"成功\"\n}\n\n{\n \"code\": -1,\n \"msg\": \"参数必填项不能为空\"\n}\n\n\n"
],
[
"请求示例1:",
"请求示例1:",
"请求示例1:",
"请求示例1:",
"请求示例1:",
"请求示例1:",
"\n",
"\n"
],
[
"\n",
"\n",
"\n",
"\n",
"获取资源请求示例:",
"获取资源请求示例:",
"获取资源请求示例:",
"获取资源请求示例:"
],
[
"获取资源请求示例:",
"获取资源请求示例:",
"",
"",
"",
"",
"",
""
],
[
"\n\n",
"\n\n",
"\n\n",
"\n\n",
"\n\n",
"\n\n"
],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[]
]
},
{
"type": "table",
"index": 46,
"data": [
[
"字段名称",
"字段类型",
"字段说明",
"取值说明"
],
[
"code",
"整型",
"操作状态码",
"1成功"
],
[
"msg",
"文本",
"信息说明",
"操作成功说明"
],
[
"data",
"JSON数据",
"Json数据",
"在实际接口说明中定义"
]
]
},
{
"type": "table",
"index": 48,
"data": [
[
"字段名称",
"字段类型",
"字段说明",
"取值说明"
],
[
"code",
"整型",
"操作状态码",
"失败 不等于1表示失败"
],
[
"msg",
"文本",
"出错信息说明",
"操作失败说明"
]
]
}
]
[
{
"index": 4,
"depth": 1,
"data": "四川赛事-赛事数据对接接口"
},
{
"index": 5,
"depth": 1,
"data": "说明书 V1.0.0"
},
{
"index": 6,
"depth": 2,
"data": "一.引言"
},
{
"index": 8,
"depth": 2,
"data": "接口要求"
},
{
"index": 11,
"depth": 3,
"data": "2.1引言"
},
{
"index": 12,
"depth": 4,
"data": "2.1.1编写目的"
},
{
"index": 15,
"depth": 4,
"data": "2.1.2 背景"
},
{
"index": 17,
"depth": 3,
"data": "2.2概览"
},
{
"index": 18,
"depth": 4,
"data": "2.2.1交互场景"
},
{
"index": 19,
"depth": 4,
"data": "2.2.2接口表"
},
{
"index": 20,
"depth": 4,
"data": "2.2.3 返回码表"
},
{
"index": 22,
"depth": 4,
"data": "2.2.4 Ajax请求"
},
{
"index": 30,
"depth": 4,
"data": "2.2.5 安全校验"
},
{
"index": 34,
"depth": 2,
"data": "三. 接口说明"
},
{
"index": 39,
"depth": 3,
"data": "3.1 获取授权接口V1.0"
},
{
"index": 40,
"depth": 4,
"data": "3.1.1获取授权token接口"
},
{
"index": 42,
"depth": 3,
"data": "3.2 接口说明V1.0"
},
{
"index": 43,
"depth": 4,
"data": "3.2.1赛事数据接口"
},
{
"index": 45,
"depth": 1,
"data": "成功"
},
{
"index": 47,
"depth": 1,
"data": "失败"
}
]
[
{
"type": "text",
"index": 1,
"data": "文档编号:"
},
{
"type": "text",
"index": 2,
"data": "版 本 号: 1.0.0"
},
{
"type": "text",
"index": 3,
"data": "密 级: 高 级"
},
{
"type": "text",
"index": 4,
"data": "四川赛事-赛事数据对接接口"
},
{
"type": "text",
"index": 5,
"data": "说明书 V1.0.0"
},
{
"type": "text",
"index": 6,
"data": "一.引言"
},
{
"type": "text",
"index": 7,
"data": "接口交互信息采用json格式。"
},
{
"type": "text",
"index": 8,
"data": "接口要求"
},
{
"type": "text",
"index": 9,
"data": "变更情况记录"
},
{
"type": "text",
"index": 11,
"data": "2.1引言"
},
{
"type": "text",
"index": 12,
"data": "2.1.1编写目的"
},
{
"type": "text",
"index": 13,
"data": "本说明书针对外部系统与本系统进行数据交互的接口技术规范进行说明,用于指导开发人员进行相关业务的开发。"
},
{
"type": "text",
"index": 14,
"data": "预期的读者为外部对接人员。"
},
{
"type": "text",
"index": 15,
"data": "2.1.2 背景"
},
{
"type": "text",
"index": 16,
"data": "对外接口。"
},
{
"type": "text",
"index": 17,
"data": "2.2概览"
},
{
"type": "text",
"index": 18,
"data": "2.2.1交互场景"
},
{
"type": "text",
"index": 19,
"data": "2.2.2接口表"
},
{
"type": "text",
"index": 20,
"data": "2.2.3 返回码表"
},
{
"type": "text",
"index": 22,
"data": "2.2.4 Ajax请求"
},
{
"type": "text",
"index": 23,
"data": "POST方式分两种请求"
},
{
"type": "text",
"index": 24,
"data": "json:"
},
{
"type": "text",
"index": 25,
"data": "contentType: 'application/json; charset=utf-8 '"
},
{
"type": "text",
"index": 26,
"data": "form:"
},
{
"type": "text",
"index": 27,
"data": "contentType: 'application/x-www-form-urlencoded; charset=utf-8'"
},
{
"type": "text",
"index": 28,
"data": "GET方式"
},
{
"type": "text",
"index": 29,
"data": "contentType: 'application/x-www-form-urlencoded; charset=utf-8'"
},
{
"type": "text",
"index": 30,
"data": "2.2.5 安全校验"
},
{
"type": "text",
"index": 31,
"data": "接口调用需要先获取token获取token后发起接口请求token有效时间2小时。"
},
{
"type": "text",
"index": 32,
"data": "请求头header 中添加"
},
{
"type": "text",
"index": 33,
"data": "Authorization Bearer + 空格 + token"
},
{
"type": "text",
"index": 34,
"data": "三. 接口说明"
},
{
"type": "text",
"index": 35,
"data": "测试接口地址:"
},
{
"type": "text",
"index": 36,
"data": "${HOST_API} http://123.249.81.28:8710"
},
{
"type": "text",
"index": 37,
"data": "生产接口地址:"
},
{
"type": "text",
"index": 38,
"data": "${HOST_API} http://47.100.109.201:9110"
},
{
"type": "text",
"index": 39,
"data": "3.1 获取授权接口V1.0"
},
{
"type": "text",
"index": 40,
"data": "3.1.1获取授权token接口"
},
{
"type": "text",
"index": 42,
"data": "3.2 接口说明V1.0"
},
{
"type": "text",
"index": 43,
"data": "3.2.1赛事数据接口"
},
{
"type": "text",
"index": 45,
"data": "成功"
},
{
"type": "text",
"index": 47,
"data": "失败"
}
]
[
{
"type": "table",
"index": 10,
"data": [
[
"日期",
"修改内容",
"版本号",
"作者"
],
[
"2024-08-30",
"初始化文档",
"V1.0.0",
"柴泽宾"
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
]
]
},
{
"type": "table",
"index": 21,
"data": [
[
"返回码",
"返回码说明"
],
[
"1",
"操作成功 AJAX端非1返回码都按照错误处理"
],
[
"-1",
"操作失败"
]
]
},
{
"type": "table",
"index": 41,
"data": [
[
"说明",
"获取接口授权接口",
"获取接口授权接口",
"获取接口授权接口",
"获取接口授权接口"
],
[
"请求",
"${HOST_API}/oauth/oauth/token",
"${HOST_API}/oauth/oauth/token",
"method",
"POST(from)"
],
[
"请求参数",
"请求参数",
"请求参数",
"请求参数",
"请求参数"
],
[
"参数名",
"类型",
"是否必填",
"参数说明",
"参数说明"
],
[
"请求头header",
"",
"",
"",
""
],
[
"",
"",
"",
"",
""
],
[
"请求体body",
"",
"",
"",
""
],
[
"grant_type",
"String",
"是",
"固定值 client_credentials",
"固定值 client_credentials"
],
[
"client_id",
"String",
"是",
"业务系统编码",
"业务系统编码"
],
[
"client_secret",
"String",
"是",
"授权秘钥",
"授权秘钥"
],
[
"返回字段说明(JSON)",
"返回字段说明(JSON)",
"返回字段说明(JSON)",
"返回字段说明(JSON)",
"返回字段说明(JSON)"
],
[
"字段名称",
"字段类型",
"字段说明",
"取值说明",
"取值说明"
],
[
"code",
"整型",
"操作状态码",
"1成功 非1失败",
"1成功 非1失败"
],
[
"msg",
"文本",
"请求信息说明",
"成功/失败信息",
"成功/失败信息"
],
[
"data ",
"对象Object",
"",
"参见返回示例",
"参见返回示例"
],
[
"access_token",
"String",
"Token凭证",
"授权使用",
"授权使用"
],
[
"token_type",
"String",
"Token类型",
"Bearer访问接口使用",
"Bearer访问接口使用"
],
[
"expires_in",
"Int",
"有效时间秒",
"建议获取后存储控制重新获取的频率",
"建议获取后存储控制重新获取的频率"
],
[
"返回示例",
"返回示例",
"返回示例",
"返回示例",
"返回示例"
],
[
"{\n \"code\": 1,\n \"msg\": \"成功\",\n \"data\": {\n \"access_token\": \"0c4dc05c-44a0-43d2-be98-a39fdf77e94c\",\n \"token_type\": \"bearer\",\n \"expires_in\": 7199,\n \"scope\": \"api\"\n }\n}\n",
"{\n \"code\": 1,\n \"msg\": \"成功\",\n \"data\": {\n \"access_token\": \"0c4dc05c-44a0-43d2-be98-a39fdf77e94c\",\n \"token_type\": \"bearer\",\n \"expires_in\": 7199,\n \"scope\": \"api\"\n }\n}\n",
"{\n \"code\": 1,\n \"msg\": \"成功\",\n \"data\": {\n \"access_token\": \"0c4dc05c-44a0-43d2-be98-a39fdf77e94c\",\n \"token_type\": \"bearer\",\n \"expires_in\": 7199,\n \"scope\": \"api\"\n }\n}\n",
"{\n \"code\": 1,\n \"msg\": \"成功\",\n \"data\": {\n \"access_token\": \"0c4dc05c-44a0-43d2-be98-a39fdf77e94c\",\n \"token_type\": \"bearer\",\n \"expires_in\": 7199,\n \"scope\": \"api\"\n }\n}\n",
"{\n \"code\": 1,\n \"msg\": \"成功\",\n \"data\": {\n \"access_token\": \"0c4dc05c-44a0-43d2-be98-a39fdf77e94c\",\n \"token_type\": \"bearer\",\n \"expires_in\": 7199,\n \"scope\": \"api\"\n }\n}\n"
],
[
"请求示例1:",
"请求示例1:",
"请求示例1:",
"请求示例1:",
"请求示例1:"
],
[
"",
"",
"",
"",
""
],
[
"获取资源请求示例:",
"获取资源请求示例:",
"获取资源请求示例:",
"获取资源请求示例:",
"获取资源请求示例:"
],
[
"",
"",
"",
"",
""
],
[
"\n\n",
"\n\n",
"\n\n",
"\n\n",
"\n\n"
]
]
},
{
"type": "table",
"index": 44,
"data": [
[
"说明",
"用户信息查询接口",
"用户信息查询接口",
"用户信息查询接口",
"用户信息查询接口",
"用户信息查询接口",
"请求",
"${HOST_API}/race/info/syncSave"
],
[
"${HOST_API}/race/info/syncSave",
"method",
"Post",
"Post",
"请求参数",
"请求参数",
"请求参数",
"请求参数"
],
[
"请求参数",
"请求参数",
"参数名",
"类型",
"是否必填",
"参数说明",
"参数说明",
"参数说明"
],
[
"请求头header",
"",
"",
"",
"",
"",
"Authorization",
"String"
],
[
"是",
"Bearer + 空格 + token",
"Bearer + 空格 + token",
"Bearer + 空格 + token",
"请求参数",
"请求参数",
"请求参数",
"请求参数"
],
[
"请求参数",
"请求参数",
"raceId",
"String",
"是",
"赛事主键id",
"赛事主键id",
"赛事主键id"
],
[
"communityGames",
"String",
"是",
"是否为社区运动会Y=是N=否)",
"是否为社区运动会Y=是N=否)",
"是否为社区运动会Y=是N=否)",
"raceName",
"String"
],
[
"是",
"赛事名称",
"赛事名称",
"赛事名称",
"raceContent\n",
"String",
"是",
"赛事简介"
],
[
"赛事简介",
"赛事简介",
"raceLevel\n",
"String",
"是",
"赛事等级国际级1国家级2省级3市级4区县级5街道/乡镇6社区/村7其他8",
"赛事等级国际级1国家级2省级3市级4区县级5街道/乡镇6社区/村7其他8",
"赛事等级国际级1国家级2省级3市级4区县级5街道/乡镇6社区/村7其他8"
],
[
"provinceFund\n",
"String",
"是",
"资金投入\n省级投入万元\n",
"资金投入\n省级投入万元\n",
"资金投入\n省级投入万元\n",
"cityFund\n",
"String"
],
[
"是",
"资金投入\n市州级投入万元\n",
"资金投入\n市州级投入万元\n",
"资金投入\n市州级投入万元\n",
"districtFund\n",
"String",
"是",
"资金投入\n区县级投入万元\n"
],
[
"资金投入\n区县级投入万元\n",
"资金投入\n区县级投入万元\n",
"provinceId\n",
"Long",
"是",
"赛事省",
"赛事省",
"赛事省"
],
[
"cityId\n",
"Long",
"是",
"赛事市州",
"赛事市州",
"赛事市州",
"districtId\n",
"Long"
],
[
"是",
"是",
"赛事区县",
"赛事区县",
"streetName\n",
"Long",
"Long",
"Long"
],
[
"否",
"赛事街道名称",
"赛事街道名称",
"赛事街道名称",
"communityName\n",
"Long",
"Long",
"Long"
],
[
"否",
"赛事名称",
"赛事名称",
"赛事名称",
"addrDesc\n",
"String",
"String",
"String"
],
[
"否",
"比赛详细地址",
"比赛详细地址",
"比赛详细地址",
"enrollStartDate",
"String",
"String",
"String"
],
[
"否",
"赛事报名开始时间\nyyyy-MM-dd",
"赛事报名开始时间\nyyyy-MM-dd",
"赛事报名开始时间\nyyyy-MM-dd",
"enrollEndDate",
"String",
"String",
"String"
],
[
"否",
"赛事报名结束时间\nyyyy-MM-dd",
"赛事报名结束时间\nyyyy-MM-dd",
"赛事报名结束时间\nyyyy-MM-dd",
"enrollMethod\n",
"String",
"String",
"String"
],
[
"否",
"赛事报名方式\n",
"赛事报名方式\n",
"赛事报名方式\n",
"startDate\n",
"String",
"String",
"String"
],
[
"是",
"赛事开始时间\nyyyy-MM-dd",
"赛事开始时间\nyyyy-MM-dd",
"赛事开始时间\nyyyy-MM-dd",
"endDate\n",
"String",
"String",
"String"
],
[
"是",
"赛事结束时间\nyyyy-MM-dd",
"赛事结束时间\nyyyy-MM-dd",
"赛事结束时间\nyyyy-MM-dd",
"managerName\n",
"String",
"String",
"String"
],
[
"否",
"赛事联系人",
"赛事联系人",
"赛事联系人",
"managerPhone\n",
"String",
"String",
"String"
],
[
"否",
"负责人电话",
"负责人电话",
"负责人电话",
"sponsorName\n",
"String",
"String",
"String"
],
[
"是",
"第一主办方名称",
"第一主办方名称",
"第一主办方名称",
"undertakeName\n",
"String",
"String",
"String"
],
[
"否",
"承办方名称",
"承办方名称",
"承办方名称",
"jointlyName\n",
"String",
"String",
"String"
],
[
"否",
"协办方名称",
"协办方名称",
"协办方名称",
"webDomain\n",
"String",
"String",
"String"
],
[
"否",
"直播或转播链接",
"直播或转播链接",
"直播或转播链接",
"promotionLink\n",
"String",
"String",
"String"
],
[
"否",
"宣传报道链接",
"宣传报道链接",
"宣传报道链接",
"raceOther\n",
"String",
"String",
"String"
],
[
"否",
"其他",
"其他",
"其他",
"raceImgUrl",
"String",
"String",
"String"
],
[
"是",
"赛事封面",
"赛事封面",
"赛事封面",
"bsxcImageList",
"Array[]",
"Array[]",
"Array[]"
],
[
"否",
"比赛现场图片0/5",
"比赛现场图片0/5",
"比赛现场图片0/5",
"-savePath",
"",
"",
""
],
[
"",
"",
"",
"",
"kmsImageList",
"Array[]",
"Array[]",
"Array[]"
],
[
"否",
"开幕式图片0/5",
"开幕式图片0/5",
"开幕式图片0/5",
"-savePath",
"",
"",
""
],
[
"",
"",
"",
"",
"bjskImageList",
"Array[]",
"Array[]",
"Array[]"
],
[
"否",
"颁奖时刻图片0/5",
"颁奖时刻图片0/5",
"颁奖时刻图片0/5",
"-savePath",
"",
"",
""
],
[
"",
"",
"",
"",
"raceScore",
"",
"",
""
],
[
"否",
"赛事成绩",
"赛事成绩",
"赛事成绩",
"scoreFileList",
"Array[]",
"Array[]",
"Array[]"
],
[
"否",
"赛事成绩公告上传",
"赛事成绩公告上传",
"赛事成绩公告上传",
"-filePath",
"",
"",
"是"
],
[
"文件路径",
"文件路径",
"文件路径",
"-fileName",
"",
"",
"是",
"文件名称"
],
[
"文件名称",
"文件名称",
"rulesFileList",
"Array[]",
"Array[]",
"否",
"赛事规程",
"赛事规程"
],
[
"赛事规程",
"-filePath",
"",
"",
"是",
"文件路径",
"文件路径",
"文件路径"
],
[
"-fileName",
"",
"",
"是",
"文件名称",
"文件名称",
"文件名称",
"zhixuFileList"
],
[
"Array[]",
"Array[]",
"否",
"赛事秩序册",
"赛事秩序册",
"赛事秩序册",
"-filePath",
""
],
[
"",
"是",
"文件路径",
"文件路径",
"文件路径",
"-fileName",
"",
""
],
[
"是",
"文件名称",
"文件名称",
"文件名称",
"otherFileList",
"Array[]",
"Array[]",
"否"
],
[
"其他相关文件",
"其他相关文件",
"其他相关文件",
"-filePath",
"",
"",
"是",
"文件路径"
],
[
"文件路径",
"文件路径",
"-fileName",
"",
"",
"是",
"文件名称",
"文件名称"
],
[
"文件名称",
"videoFileList",
"Array[]",
"Array[]",
"否",
"赛事视频",
"赛事视频",
"赛事视频"
],
[
"-filePath",
"",
"",
"是",
"文件路径",
"文件路径",
"文件路径",
"-fileName"
],
[
"",
"",
"是",
"文件名称",
"文件名称",
"文件名称",
"noticeFileList",
""
],
[
"",
"否",
"赛事通知",
"赛事通知",
"赛事通知",
"-filePath",
"",
""
],
[
"是",
"文件路径",
"文件路径",
"文件路径",
"-fileName",
"",
"",
"是"
],
[
"文件名称",
"文件名称",
"文件名称",
"raceItemList",
"Array[]",
"Array[]",
"是",
"运动会规模"
],
[
"运动会规模",
"运动会规模",
"-itemId",
"",
"",
"是",
"项目id",
"项目id"
],
[
"项目id",
"-itemName",
"",
"",
"是",
"项目名称",
"项目名称",
"项目名称"
],
[
"-itemIds",
"Array[]",
"Array[]",
"是",
"项目子类id",
"项目子类id",
"项目子类id",
"-raceNumber"
],
[
"",
"",
"是",
"比赛场次",
"比赛场次",
"比赛场次",
"-playerTimes",
""
],
[
"",
"是",
"参数人数",
"参数人数",
"参数人数",
"-playerNumber",
"",
""
],
[
"是",
"参数人次",
"参数人次",
"参数人次",
"-remarks",
"",
"",
"是"
],
[
"备注",
"备注",
"备注",
"返回字段说明(JSON)",
"返回字段说明(JSON)",
"返回字段说明(JSON)",
"返回字段说明(JSON)",
"返回字段说明(JSON)"
],
[
"返回字段说明(JSON)",
"字段名称",
"字段类型",
"字段类型",
"字段说明",
"取值说明",
"取值说明",
"取值说明"
],
[
"code",
"整型",
"整型",
"操作状态码",
"1成功 非1失败",
"1成功 非1失败",
"1成功 非1失败",
"data"
],
[
"",
"",
"",
"",
"",
"",
"msg",
"文本"
],
[
"文本",
"请求信息说明",
"成功/失败信息",
"成功/失败信息",
"成功/失败信息",
"",
"",
""
],
[
"",
"",
"",
"",
"返回示例",
"返回示例",
"返回示例",
"返回示例"
],
[
"返回示例",
"返回示例",
"{\n    \"code\":1,\n    \"data\":[\n        {\n            \"studentCode\":\"202310070090\"\n        }],\n    \"msg\":\"成功\"\n}\n\n{\n \"code\": -1,\n \"msg\": \"参数必填项不能为空\"\n}\n\n\n",
"{\n    \"code\":1,\n    \"data\":[\n        {\n            \"studentCode\":\"202310070090\"\n        }],\n    \"msg\":\"成功\"\n}\n\n{\n \"code\": -1,\n \"msg\": \"参数必填项不能为空\"\n}\n\n\n",
"{\n    \"code\":1,\n    \"data\":[\n        {\n            \"studentCode\":\"202310070090\"\n        }],\n    \"msg\":\"成功\"\n}\n\n{\n \"code\": -1,\n \"msg\": \"参数必填项不能为空\"\n}\n\n\n",
"{\n    \"code\":1,\n    \"data\":[\n        {\n            \"studentCode\":\"202310070090\"\n        }],\n    \"msg\":\"成功\"\n}\n\n{\n \"code\": -1,\n \"msg\": \"参数必填项不能为空\"\n}\n\n\n",
"{\n    \"code\":1,\n    \"data\":[\n        {\n            \"studentCode\":\"202310070090\"\n        }],\n    \"msg\":\"成功\"\n}\n\n{\n \"code\": -1,\n \"msg\": \"参数必填项不能为空\"\n}\n\n\n",
"{\n    \"code\":1,\n    \"data\":[\n        {\n            \"studentCode\":\"202310070090\"\n        }],\n    \"msg\":\"成功\"\n}\n\n{\n \"code\": -1,\n \"msg\": \"参数必填项不能为空\"\n}\n\n\n"
],
[
"请求示例1:",
"请求示例1:",
"请求示例1:",
"请求示例1:",
"请求示例1:",
"请求示例1:",
"\n",
"\n"
],
[
"\n",
"\n",
"\n",
"\n",
"获取资源请求示例:",
"获取资源请求示例:",
"获取资源请求示例:",
"获取资源请求示例:"
],
[
"获取资源请求示例:",
"获取资源请求示例:",
"",
"",
"",
"",
"",
""
],
[
"\n\n",
"\n\n",
"\n\n",
"\n\n",
"\n\n",
"\n\n"
],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[]
]
},
{
"type": "table",
"index": 46,
"data": [
[
"字段名称",
"字段类型",
"字段说明",
"取值说明"
],
[
"code",
"整型",
"操作状态码",
"1成功"
],
[
"msg",
"文本",
"信息说明",
"操作成功说明"
],
[
"data",
"JSON数据",
"Json数据",
"在实际接口说明中定义"
]
]
},
{
"type": "table",
"index": 48,
"data": [
[
"字段名称",
"字段类型",
"字段说明",
"取值说明"
],
[
"code",
"整型",
"操作状态码",
"失败 不等于1表示失败"
],
[
"msg",
"文本",
"出错信息说明",
"操作失败说明"
]
]
}
]
[
{
"index": 4,
"depth": 1,
"data": "四川赛事-赛事数据对接接口"
},
{
"index": 5,
"depth": 1,
"data": "说明书 V1.0.0"
},
{
"index": 6,
"depth": 2,
"data": "一.引言"
},
{
"index": 8,
"depth": 2,
"data": "接口要求"
},
{
"index": 11,
"depth": 3,
"data": "2.1引言"
},
{
"index": 12,
"depth": 4,
"data": "2.1.1编写目的"
},
{
"index": 15,
"depth": 4,
"data": "2.1.2 背景"
},
{
"index": 17,
"depth": 3,
"data": "2.2概览"
},
{
"index": 18,
"depth": 4,
"data": "2.2.1交互场景"
},
{
"index": 19,
"depth": 4,
"data": "2.2.2接口表"
},
{
"index": 20,
"depth": 4,
"data": "2.2.3 返回码表"
},
{
"index": 22,
"depth": 4,
"data": "2.2.4 Ajax请求"
},
{
"index": 30,
"depth": 4,
"data": "2.2.5 安全校验"
},
{
"index": 34,
"depth": 2,
"data": "三. 接口说明"
},
{
"index": 39,
"depth": 3,
"data": "3.1 获取授权接口V1.0"
},
{
"index": 40,
"depth": 4,
"data": "3.1.1获取授权token接口"
},
{
"index": 42,
"depth": 3,
"data": "3.2 接口说明V1.0"
},
{
"index": 43,
"depth": 4,
"data": "3.2.1赛事数据接口"
},
{
"index": 45,
"depth": 1,
"data": "成功"
},
{
"index": 47,
"depth": 1,
"data": "失败"
}
]
[
{
"type": "text",
"index": 1,
"data": "文档编号:"
},
{
"type": "text",
"index": 2,
"data": "版 本 号: 1.0.0"
},
{
"type": "text",
"index": 3,
"data": "密 级: 高 级"
},
{
"type": "text",
"index": 4,
"data": "四川赛事-赛事数据对接接口"
},
{
"type": "text",
"index": 5,
"data": "说明书 V1.0.0"
},
{
"type": "text",
"index": 6,
"data": "一.引言"
},
{
"type": "text",
"index": 7,
"data": "接口交互信息采用json格式。"
},
{
"type": "text",
"index": 8,
"data": "接口要求"
},
{
"type": "text",
"index": 9,
"data": "变更情况记录"
},
{
"type": "text",
"index": 11,
"data": "2.1引言"
},
{
"type": "text",
"index": 12,
"data": "2.1.1编写目的"
},
{
"type": "text",
"index": 13,
"data": "本说明书针对外部系统与本系统进行数据交互的接口技术规范进行说明,用于指导开发人员进行相关业务的开发。"
},
{
"type": "text",
"index": 14,
"data": "预期的读者为外部对接人员。"
},
{
"type": "text",
"index": 15,
"data": "2.1.2 背景"
},
{
"type": "text",
"index": 16,
"data": "对外接口。"
},
{
"type": "text",
"index": 17,
"data": "2.2概览"
},
{
"type": "text",
"index": 18,
"data": "2.2.1交互场景"
},
{
"type": "text",
"index": 19,
"data": "2.2.2接口表"
},
{
"type": "text",
"index": 20,
"data": "2.2.3 返回码表"
},
{
"type": "text",
"index": 22,
"data": "2.2.4 Ajax请求"
},
{
"type": "text",
"index": 23,
"data": "POST方式分两种请求"
},
{
"type": "text",
"index": 24,
"data": "json:"
},
{
"type": "text",
"index": 25,
"data": "contentType: 'application/json; charset=utf-8 '"
},
{
"type": "text",
"index": 26,
"data": "form:"
},
{
"type": "text",
"index": 27,
"data": "contentType: 'application/x-www-form-urlencoded; charset=utf-8'"
},
{
"type": "text",
"index": 28,
"data": "GET方式"
},
{
"type": "text",
"index": 29,
"data": "contentType: 'application/x-www-form-urlencoded; charset=utf-8'"
},
{
"type": "text",
"index": 30,
"data": "2.2.5 安全校验"
},
{
"type": "text",
"index": 31,
"data": "接口调用需要先获取token获取token后发起接口请求token有效时间2小时。"
},
{
"type": "text",
"index": 32,
"data": "请求头header 中添加"
},
{
"type": "text",
"index": 33,
"data": "Authorization Bearer + 空格 + token"
},
{
"type": "text",
"index": 34,
"data": "三. 接口说明"
},
{
"type": "text",
"index": 35,
"data": "测试接口地址:"
},
{
"type": "text",
"index": 36,
"data": "${HOST_API} http://123.249.81.28:8710"
},
{
"type": "text",
"index": 37,
"data": "生产接口地址:"
},
{
"type": "text",
"index": 38,
"data": "${HOST_API} http://47.100.109.201:9110"
},
{
"type": "text",
"index": 39,
"data": "3.1 获取授权接口V1.0"
},
{
"type": "text",
"index": 40,
"data": "3.1.1获取授权token接口"
},
{
"type": "text",
"index": 42,
"data": "3.2 接口说明V1.0"
},
{
"type": "text",
"index": 43,
"data": "3.2.1赛事数据接口"
},
{
"type": "text",
"index": 45,
"data": "成功"
},
{
"type": "text",
"index": 47,
"data": "失败"
}
]
[
{
"type": "table",
"index": 10,
"data": [
[
"日期",
"修改内容",
"版本号",
"作者"
],
[
"2024-08-30",
"初始化文档",
"V1.0.0",
"柴泽宾"
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
],
[
"",
"",
"",
""
]
]
},
{
"type": "table",
"index": 21,
"data": [
[
"返回码",
"返回码说明"
],
[
"1",
"操作成功 AJAX端非1返回码都按照错误处理"
],
[
"-1",
"操作失败"
]
]
},
{
"type": "table",
"index": 41,
"data": [
[
"说明",
"获取接口授权接口",
"获取接口授权接口",
"获取接口授权接口",
"获取接口授权接口"
],
[
"请求",
"${HOST_API}/oauth/oauth/token",
"${HOST_API}/oauth/oauth/token",
"method",
"POST(from)"
],
[
"请求参数",
"请求参数",
"请求参数",
"请求参数",
"请求参数"
],
[
"参数名",
"类型",
"是否必填",
"参数说明",
"参数说明"
],
[
"请求头header",
"",
"",
"",
""
],
[
"",
"",
"",
"",
""
],
[
"请求体body",
"",
"",
"",
""
],
[
"grant_type",
"String",
"是",
"固定值 client_credentials",
"固定值 client_credentials"
],
[
"client_id",
"String",
"是",
"业务系统编码",
"业务系统编码"
],
[
"client_secret",
"String",
"是",
"授权秘钥",
"授权秘钥"
],
[
"返回字段说明(JSON)",
"返回字段说明(JSON)",
"返回字段说明(JSON)",
"返回字段说明(JSON)",
"返回字段说明(JSON)"
],
[
"字段名称",
"字段类型",
"字段说明",
"取值说明",
"取值说明"
],
[
"code",
"整型",
"操作状态码",
"1成功 非1失败",
"1成功 非1失败"
],
[
"msg",
"文本",
"请求信息说明",
"成功/失败信息",
"成功/失败信息"
],
[
"data ",
"对象Object",
"",
"参见返回示例",
"参见返回示例"
],
[
"access_token",
"String",
"Token凭证",
"授权使用",
"授权使用"
],
[
"token_type",
"String",
"Token类型",
"Bearer访问接口使用",
"Bearer访问接口使用"
],
[
"expires_in",
"Int",
"有效时间秒",
"建议获取后存储控制重新获取的频率",
"建议获取后存储控制重新获取的频率"
],
[
"返回示例",
"返回示例",
"返回示例",
"返回示例",
"返回示例"
],
[
"{\n \"code\": 1,\n \"msg\": \"成功\",\n \"data\": {\n \"access_token\": \"0c4dc05c-44a0-43d2-be98-a39fdf77e94c\",\n \"token_type\": \"bearer\",\n \"expires_in\": 7199,\n \"scope\": \"api\"\n }\n}\n",
"{\n \"code\": 1,\n \"msg\": \"成功\",\n \"data\": {\n \"access_token\": \"0c4dc05c-44a0-43d2-be98-a39fdf77e94c\",\n \"token_type\": \"bearer\",\n \"expires_in\": 7199,\n \"scope\": \"api\"\n }\n}\n",
"{\n \"code\": 1,\n \"msg\": \"成功\",\n \"data\": {\n \"access_token\": \"0c4dc05c-44a0-43d2-be98-a39fdf77e94c\",\n \"token_type\": \"bearer\",\n \"expires_in\": 7199,\n \"scope\": \"api\"\n }\n}\n",
"{\n \"code\": 1,\n \"msg\": \"成功\",\n \"data\": {\n \"access_token\": \"0c4dc05c-44a0-43d2-be98-a39fdf77e94c\",\n \"token_type\": \"bearer\",\n \"expires_in\": 7199,\n \"scope\": \"api\"\n }\n}\n",
"{\n \"code\": 1,\n \"msg\": \"成功\",\n \"data\": {\n \"access_token\": \"0c4dc05c-44a0-43d2-be98-a39fdf77e94c\",\n \"token_type\": \"bearer\",\n \"expires_in\": 7199,\n \"scope\": \"api\"\n }\n}\n"
],
[
"请求示例1:",
"请求示例1:",
"请求示例1:",
"请求示例1:",
"请求示例1:"
],
[
"",
"",
"",
"",
""
],
[
"获取资源请求示例:",
"获取资源请求示例:",
"获取资源请求示例:",
"获取资源请求示例:",
"获取资源请求示例:"
],
[
"",
"",
"",
"",
""
],
[
"\n\n",
"\n\n",
"\n\n",
"\n\n",
"\n\n"
]
]
},
{
"type": "table",
"index": 44,
"data": [
[
"说明",
"用户信息查询接口",
"用户信息查询接口",
"用户信息查询接口",
"用户信息查询接口",
"用户信息查询接口",
"请求",
"${HOST_API}/race/info/syncSave"
],
[
"${HOST_API}/race/info/syncSave",
"method",
"Post",
"Post",
"请求参数",
"请求参数",
"请求参数",
"请求参数"
],
[
"请求参数",
"请求参数",
"参数名",
"类型",
"是否必填",
"参数说明",
"参数说明",
"参数说明"
],
[
"请求头header",
"",
"",
"",
"",
"",
"Authorization",
"String"
],
[
"是",
"Bearer + 空格 + token",
"Bearer + 空格 + token",
"Bearer + 空格 + token",
"请求参数",
"请求参数",
"请求参数",
"请求参数"
],
[
"请求参数",
"请求参数",
"raceId",
"String",
"是",
"赛事主键id",
"赛事主键id",
"赛事主键id"
],
[
"communityGames",
"String",
"是",
"是否为社区运动会Y=是N=否)",
"是否为社区运动会Y=是N=否)",
"是否为社区运动会Y=是N=否)",
"raceName",
"String"
],
[
"是",
"赛事名称",
"赛事名称",
"赛事名称",
"raceContent\n",
"String",
"是",
"赛事简介"
],
[
"赛事简介",
"赛事简介",
"raceLevel\n",
"String",
"是",
"赛事等级国际级1国家级2省级3市级4区县级5街道/乡镇6社区/村7其他8",
"赛事等级国际级1国家级2省级3市级4区县级5街道/乡镇6社区/村7其他8",
"赛事等级国际级1国家级2省级3市级4区县级5街道/乡镇6社区/村7其他8"
],
[
"provinceFund\n",
"String",
"是",
"资金投入\n省级投入万元\n",
"资金投入\n省级投入万元\n",
"资金投入\n省级投入万元\n",
"cityFund\n",
"String"
],
[
"是",
"资金投入\n市州级投入万元\n",
"资金投入\n市州级投入万元\n",
"资金投入\n市州级投入万元\n",
"districtFund\n",
"String",
"是",
"资金投入\n区县级投入万元\n"
],
[
"资金投入\n区县级投入万元\n",
"资金投入\n区县级投入万元\n",
"provinceId\n",
"Long",
"是",
"赛事省",
"赛事省",
"赛事省"
],
[
"cityId\n",
"Long",
"是",
"赛事市州",
"赛事市州",
"赛事市州",
"districtId\n",
"Long"
],
[
"是",
"是",
"赛事区县",
"赛事区县",
"streetName\n",
"Long",
"Long",
"Long"
],
[
"否",
"赛事街道名称",
"赛事街道名称",
"赛事街道名称",
"communityName\n",
"Long",
"Long",
"Long"
],
[
"否",
"赛事名称",
"赛事名称",
"赛事名称",
"addrDesc\n",
"String",
"String",
"String"
],
[
"否",
"比赛详细地址",
"比赛详细地址",
"比赛详细地址",
"enrollStartDate",
"String",
"String",
"String"
],
[
"否",
"赛事报名开始时间\nyyyy-MM-dd",
"赛事报名开始时间\nyyyy-MM-dd",
"赛事报名开始时间\nyyyy-MM-dd",
"enrollEndDate",
"String",
"String",
"String"
],
[
"否",
"赛事报名结束时间\nyyyy-MM-dd",
"赛事报名结束时间\nyyyy-MM-dd",
"赛事报名结束时间\nyyyy-MM-dd",
"enrollMethod\n",
"String",
"String",
"String"
],
[
"否",
"赛事报名方式\n",
"赛事报名方式\n",
"赛事报名方式\n",
"startDate\n",
"String",
"String",
"String"
],
[
"是",
"赛事开始时间\nyyyy-MM-dd",
"赛事开始时间\nyyyy-MM-dd",
"赛事开始时间\nyyyy-MM-dd",
"endDate\n",
"String",
"String",
"String"
],
[
"是",
"赛事结束时间\nyyyy-MM-dd",
"赛事结束时间\nyyyy-MM-dd",
"赛事结束时间\nyyyy-MM-dd",
"managerName\n",
"String",
"String",
"String"
],
[
"否",
"赛事联系人",
"赛事联系人",
"赛事联系人",
"managerPhone\n",
"String",
"String",
"String"
],
[
"否",
"负责人电话",
"负责人电话",
"负责人电话",
"sponsorName\n",
"String",
"String",
"String"
],
[
"是",
"第一主办方名称",
"第一主办方名称",
"第一主办方名称",
"undertakeName\n",
"String",
"String",
"String"
],
[
"否",
"承办方名称",
"承办方名称",
"承办方名称",
"jointlyName\n",
"String",
"String",
"String"
],
[
"否",
"协办方名称",
"协办方名称",
"协办方名称",
"webDomain\n",
"String",
"String",
"String"
],
[
"否",
"直播或转播链接",
"直播或转播链接",
"直播或转播链接",
"promotionLink\n",
"String",
"String",
"String"
],
[
"否",
"宣传报道链接",
"宣传报道链接",
"宣传报道链接",
"raceOther\n",
"String",
"String",
"String"
],
[
"否",
"其他",
"其他",
"其他",
"raceImgUrl",
"String",
"String",
"String"
],
[
"是",
"赛事封面",
"赛事封面",
"赛事封面",
"bsxcImageList",
"Array[]",
"Array[]",
"Array[]"
],
[
"否",
"比赛现场图片0/5",
"比赛现场图片0/5",
"比赛现场图片0/5",
"-savePath",
"",
"",
""
],
[
"",
"",
"",
"",
"kmsImageList",
"Array[]",
"Array[]",
"Array[]"
],
[
"否",
"开幕式图片0/5",
"开幕式图片0/5",
"开幕式图片0/5",
"-savePath",
"",
"",
""
],
[
"",
"",
"",
"",
"bjskImageList",
"Array[]",
"Array[]",
"Array[]"
],
[
"否",
"颁奖时刻图片0/5",
"颁奖时刻图片0/5",
"颁奖时刻图片0/5",
"-savePath",
"",
"",
""
],
[
"",
"",
"",
"",
"raceScore",
"",
"",
""
],
[
"否",
"赛事成绩",
"赛事成绩",
"赛事成绩",
"scoreFileList",
"Array[]",
"Array[]",
"Array[]"
],
[
"否",
"赛事成绩公告上传",
"赛事成绩公告上传",
"赛事成绩公告上传",
"-filePath",
"",
"",
"是"
],
[
"文件路径",
"文件路径",
"文件路径",
"-fileName",
"",
"",
"是",
"文件名称"
],
[
"文件名称",
"文件名称",
"rulesFileList",
"Array[]",
"Array[]",
"否",
"赛事规程",
"赛事规程"
],
[
"赛事规程",
"-filePath",
"",
"",
"是",
"文件路径",
"文件路径",
"文件路径"
],
[
"-fileName",
"",
"",
"是",
"文件名称",
"文件名称",
"文件名称",
"zhixuFileList"
],
[
"Array[]",
"Array[]",
"否",
"赛事秩序册",
"赛事秩序册",
"赛事秩序册",
"-filePath",
""
],
[
"",
"是",
"文件路径",
"文件路径",
"文件路径",
"-fileName",
"",
""
],
[
"是",
"文件名称",
"文件名称",
"文件名称",
"otherFileList",
"Array[]",
"Array[]",
"否"
],
[
"其他相关文件",
"其他相关文件",
"其他相关文件",
"-filePath",
"",
"",
"是",
"文件路径"
],
[
"文件路径",
"文件路径",
"-fileName",
"",
"",
"是",
"文件名称",
"文件名称"
],
[
"文件名称",
"videoFileList",
"Array[]",
"Array[]",
"否",
"赛事视频",
"赛事视频",
"赛事视频"
],
[
"-filePath",
"",
"",
"是",
"文件路径",
"文件路径",
"文件路径",
"-fileName"
],
[
"",
"",
"是",
"文件名称",
"文件名称",
"文件名称",
"noticeFileList",
""
],
[
"",
"否",
"赛事通知",
"赛事通知",
"赛事通知",
"-filePath",
"",
""
],
[
"是",
"文件路径",
"文件路径",
"文件路径",
"-fileName",
"",
"",
"是"
],
[
"文件名称",
"文件名称",
"文件名称",
"raceItemList",
"Array[]",
"Array[]",
"是",
"运动会规模"
],
[
"运动会规模",
"运动会规模",
"-itemId",
"",
"",
"是",
"项目id",
"项目id"
],
[
"项目id",
"-itemName",
"",
"",
"是",
"项目名称",
"项目名称",
"项目名称"
],
[
"-itemIds",
"Array[]",
"Array[]",
"是",
"项目子类id",
"项目子类id",
"项目子类id",
"-raceNumber"
],
[
"",
"",
"是",
"比赛场次",
"比赛场次",
"比赛场次",
"-playerTimes",
""
],
[
"",
"是",
"参数人数",
"参数人数",
"参数人数",
"-playerNumber",
"",
""
],
[
"是",
"参数人次",
"参数人次",
"参数人次",
"-remarks",
"",
"",
"是"
],
[
"备注",
"备注",
"备注",
"返回字段说明(JSON)",
"返回字段说明(JSON)",
"返回字段说明(JSON)",
"返回字段说明(JSON)",
"返回字段说明(JSON)"
],
[
"返回字段说明(JSON)",
"字段名称",
"字段类型",
"字段类型",
"字段说明",
"取值说明",
"取值说明",
"取值说明"
],
[
"code",
"整型",
"整型",
"操作状态码",
"1成功 非1失败",
"1成功 非1失败",
"1成功 非1失败",
"data"
],
[
"",
"",
"",
"",
"",
"",
"msg",
"文本"
],
[
"文本",
"请求信息说明",
"成功/失败信息",
"成功/失败信息",
"成功/失败信息",
"",
"",
""
],
[
"",
"",
"",
"",
"返回示例",
"返回示例",
"返回示例",
"返回示例"
],
[
"返回示例",
"返回示例",
"{\n    \"code\":1,\n    \"data\":[\n        {\n            \"studentCode\":\"202310070090\"\n        }],\n    \"msg\":\"成功\"\n}\n\n{\n \"code\": -1,\n \"msg\": \"参数必填项不能为空\"\n}\n\n\n",
"{\n    \"code\":1,\n    \"data\":[\n        {\n            \"studentCode\":\"202310070090\"\n        }],\n    \"msg\":\"成功\"\n}\n\n{\n \"code\": -1,\n \"msg\": \"参数必填项不能为空\"\n}\n\n\n",
"{\n    \"code\":1,\n    \"data\":[\n        {\n            \"studentCode\":\"202310070090\"\n        }],\n    \"msg\":\"成功\"\n}\n\n{\n \"code\": -1,\n \"msg\": \"参数必填项不能为空\"\n}\n\n\n",
"{\n    \"code\":1,\n    \"data\":[\n        {\n            \"studentCode\":\"202310070090\"\n        }],\n    \"msg\":\"成功\"\n}\n\n{\n \"code\": -1,\n \"msg\": \"参数必填项不能为空\"\n}\n\n\n",
"{\n    \"code\":1,\n    \"data\":[\n        {\n            \"studentCode\":\"202310070090\"\n        }],\n    \"msg\":\"成功\"\n}\n\n{\n \"code\": -1,\n \"msg\": \"参数必填项不能为空\"\n}\n\n\n",
"{\n    \"code\":1,\n    \"data\":[\n        {\n            \"studentCode\":\"202310070090\"\n        }],\n    \"msg\":\"成功\"\n}\n\n{\n \"code\": -1,\n \"msg\": \"参数必填项不能为空\"\n}\n\n\n"
],
[
"请求示例1:",
"请求示例1:",
"请求示例1:",
"请求示例1:",
"请求示例1:",
"请求示例1:",
"\n",
"\n"
],
[
"\n",
"\n",
"\n",
"\n",
"获取资源请求示例:",
"获取资源请求示例:",
"获取资源请求示例:",
"获取资源请求示例:"
],
[
"获取资源请求示例:",
"获取资源请求示例:",
"",
"",
"",
"",
"",
""
],
[
"\n\n",
"\n\n",
"\n\n",
"\n\n",
"\n\n",
"\n\n"
],
[],
[],
[],
[],
[],
[],
[],
[],
[],
[]
]
},
{
"type": "table",
"index": 46,
"data": [
[
"字段名称",
"字段类型",
"字段说明",
"取值说明"
],
[
"code",
"整型",
"操作状态码",
"1成功"
],
[
"msg",
"文本",
"信息说明",
"操作成功说明"
],
[
"data",
"JSON数据",
"Json数据",
"在实际接口说明中定义"
]
]
},
{
"type": "table",
"index": 48,
"data": [
[
"字段名称",
"字段类型",
"字段说明",
"取值说明"
],
[
"code",
"整型",
"操作状态码",
"失败 不等于1表示失败"
],
[
"msg",
"文本",
"出错信息说明",
"操作失败说明"
]
]
}
]
[
{
"index": 4,
"depth": 1,
"data": "四川赛事-赛事数据对接接口"
},
{
"index": 5,
"depth": 1,
"data": "说明书 V1.0.0"
},
{
"index": 6,
"depth": 2,
"data": "一.引言"
},
{
"index": 8,
"depth": 2,
"data": "接口要求"
},
{
"index": 11,
"depth": 3,
"data": "2.1引言"
},
{
"index": 12,
"depth": 4,
"data": "2.1.1编写目的"
},
{
"index": 15,
"depth": 4,
"data": "2.1.2 背景"
},
{
"index": 17,
"depth": 3,
"data": "2.2概览"
},
{
"index": 18,
"depth": 4,
"data": "2.2.1交互场景"
},
{
"index": 19,
"depth": 4,
"data": "2.2.2接口表"
},
{
"index": 20,
"depth": 4,
"data": "2.2.3 返回码表"
},
{
"index": 22,
"depth": 4,
"data": "2.2.4 Ajax请求"
},
{
"index": 30,
"depth": 4,
"data": "2.2.5 安全校验"
},
{
"index": 34,
"depth": 2,
"data": "三. 接口说明"
},
{
"index": 39,
"depth": 3,
"data": "3.1 获取授权接口V1.0"
},
{
"index": 40,
"depth": 4,
"data": "3.1.1获取授权token接口"
},
{
"index": 42,
"depth": 3,
"data": "3.2 接口说明V1.0"
},
{
"index": 43,
"depth": 4,
"data": "3.2.1赛事数据接口"
},
{
"index": 45,
"depth": 1,
"data": "成功"
},
{
"index": 47,
"depth": 1,
"data": "失败"
}
]