# 数据接口
# 考试信息列表
# 功能说明
获取管理端试卷列表的所有试卷信息及对应的核心考试分析数据
# 调用说明
地址:
https://api2.qingsuyun.com/site/api/openApi/examList
方式:get
# 请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 | 
|---|---|---|---|---|
| factoryCode | String | 是 | 123456 | 组织编号 | 
| sign | String | 是 | eyJhbGciOiJIUzI1NiJ9 | 签名 | 
| pageNum | Integer | 是 | 1 | 请求页码 | 
| pageSize | Integer | 是 | 10 | 每页条数,最大1000 | 
# 返回数据
| 名称 | 类型 | 示例值 | 描述 | 
|---|---|---|---|
| code | String | 200 | 状态码,详见说明 | 
| body | String | Json格式字符串 | 返回数据信息或错误信息 | 
| total | Integer | 172 | 总条数 | 
| id | String | 18081427165 | 试卷id | 
| generateType | Integer | 1 | 出题方式(1.固定;2.随机) | 
| paperType | Integer | 2 | 试卷类型(1.公开;2.非公开) | 
| name | String | 测试考试 | 试卷名称 | 
| totalScore | Double | 10 | 试卷总分 | 
| passScore | Double | 5 | 及格分 | 
| createTime | Integer | 1693271317000 | 创建时间(时间戳) | 
| enableTime | Integer | 1719287058000 | 试卷开始时间(时间戳) | 
| expireTime | Integer | 1719294258000 | 试卷结束时间(时间戳) | 
| usingState | Integer | 1 | 发布状态(1.已发布;2.未发布) | 
| examTimeEnable | Integer | 0 | 是否启用考试时间(1.是;0.否) | 
| duration | Integer | 1800 | 试卷考试时长 | 
| classifyName | String | 考试分类 | 试卷分类 | 
| highestScore | String | 0.00 | 最高分 | 
| lowestScore | String | 0.00 | 最低分 | 
| averageScore | String | 0.00 | 平均分 | 
| examTotalAmount | String | 8 | 考试总人次 | 
| passAmount | String | 8 | 及格人次 | 
| firstHandIn | String | 1693367858000 | 最早交卷(时间戳) | 
| lastHandIn | String | 1693367858000 | 最迟交卷(时间戳) | 
| longestTime | String | 82 | 最长耗时(秒) | 
| shortestTime | String | 25 | 最短耗时(秒) | 
# 示例
请求示例
https://api2.qingsuyun.com/site/api/openApi/examList?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9&pageNum=1&pageSize=10
正常返回示例
JSON格式
{
    "code": "200",
    "body": {
        "list": [
            {
                "generateType": 1,
                "generateAdvanced": 2,
                "paperType": 2,
                "name": "高二年级语文期中考试",
                "duration": 550,
                "passScore": 0,
                "createTime": 1693271317000,
                "enableTime": 1719287058000,
                "expireTime": 1719294258000,
                "usingState": 2,
                "examTimeEnable": 0,
                "classifyPath": "51/",
                "id": "18081596164",
                "classifyName": "语文",
                "totalScore": 50,
                "examResult": {
                    "highestScore": "1.00",
                    "lowestScore": "0.50",
                    "averageScore": "0.80",
                    "examTotalAmount": "4",
                    "passAmount": "4",
                    "passRatio": "100.00%",
                    "firstHandIn": 1693271363000,
                    "lastHandIn": 1693271446000,
                    "longestTime": "6",
                    "shortestTime": "5",
                    "paperId": "18081596164"
                },
                "examTotalAmount": 4,
                "passAmount": 4,
                "passRatio": 1,
                "averageScore": 0.8,
                "highestScore": 1,
                "lowestScore": 0.5
            }
        ],
        "total": 936
    }
}
# 考试成绩列表
# 功能说明
获取某张试卷所有的考生答卷信息
# 调用说明
地址:
https://api2.qingsuyun.com/site/api/openApi/examScoreList
方式:get
# 请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 | 
|---|---|---|---|---|
| factoryCode | String | 是 | 123456 | 组织编号 | 
| sign | String | 是 | eyJhbGciOiJIUzI1NiJ9 | 签名 | 
| pageNum | Integer | 是 | 1 | 请求页码 | 
| pageSize | Integer | 是 | 10 | 每页条数,最大1000 | 
| paperId | String | 是 | 18081427165 | 试卷id | 
| judged | Integer | 否 | 0 | 是否判分(0.否;1.是) | 
# 返回数据
| 名称 | 类型 | 示例值 | 描述 | 
|---|---|---|---|
| code | String | 200 | 状态码,详见说明 | 
| body | String | Json格式字符串 | 返回数据信息或错误信息 | 
| total | Integer | 8 | 总条数 | 
| deptName | String | 外语类 | 组织架构名称 | 
| isPassed | String | 不及格 | 是否及格 | 
| nickName | String | 小王 | 考生名称 | 
| useDuration | String | 25 | 考试耗时(秒) | 
| startTime | String | 2020-07-15 09:30:11 | 开始考试时间 | 
| endTime | String | 2020-07-15 09:30:11 | 结束考试时间 | 
| realScore | String | 0.00 | 得分 | 
| userId | String | 1712071 | 考生id | 
| userCode | String | xy001 | 考生账号 | 
# 示例
请求示例
https://api2.qingsuyun.com/site/api/openApi/examScoreList?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9&pageNum=1&pageSize=10&paperId=18081
正常返回示例
JSON格式
{
    "code": "200",
    "body": {
        "list": [
            {
                "deptName": "净天教",
                "deptPath": "220/245/",
                "endTime": "2023-08-29 09:09:23",
                "id": "5332bc5053784157a1c454e81d66c735",
                "isPassed": "及格",
                "nickName": "月清疏",
                "realScore": "1.00",
                "startTime": "2023-08-29 09:09:17",
                "useDuration": 6,
                "userCode": "1001",
                "userId": "11bf7d9d6c9c426980d5f6e8ca163c01"
            },
            {
                "deptName": "蜀山派",
                "deptPath": "234/",
                "endTime": "2023-08-29 09:09:54",
                "id": "37b3b38407874f208d7626e1a326216c",
                "isPassed": "及格",
                "nickName": "龙葵",
                "realScore": "0.50",
                "startTime": "2023-08-29 09:09:48",
                "useDuration": 6,
                "userCode": "1002",
                "userId": "2843ccde67634a6191223ee3a6b3e381"
            }
        ],
        "total": 4
    }
}
# 试卷能力分析
# 功能说明
获取某张试卷的能力分析(知识点)
# 调用说明
地址:
https://api2.qingsuyun.com/site/api/openApi/paper/stats/ability
方式:post
# 请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 | 
|---|---|---|---|---|
| factoryCode | String | 是 | 123456 | 组织编号 | 
| sign | String | 是 | eyJhbGciOiJIUzI1NiJ9 | 签名 | 
| paperId | String | 是 | 18081427165 | 试卷id | 
| pageNum | Integer | 是 | 1 | 请求页码 | 
| pageSize | Integer | 是 | 10 | 每页条数,最大1000 | 
| userCode | String | 否 | 张三 | 成员账号 | 
| deptPathList | Array | 否 | ["1/","2/" ] | 组织架构 | 
# 返回数据
| 名称 | 类型 | 示例值 | 描述 | 
|---|---|---|---|
| code | String | 200 | 状态码,详见说明 | 
| body | String | Json格式字符串 | 返回数据信息或错误信息 | 
| nickName | String | 张三 | 姓名 | 
| userCode | String | zhangsan | 账号 | 
| deptName | String | 部门A;部门B | 组织架构 | 
| totalScore | String | 9.00 (6/14) | 分数 | 
| abilityScoreList | String | [ {"pointId":"f4d","name":"微分","rate":"0/0","amount":"0"} ] | 能力统计列表 | 
| pointId | String | f4d2fe9ee5dc11eb8bb800163e08954a | 知识点id | 
| name | String | 拉格朗日中值定理 | 知识点名称 | 
| rate | String | 0/0 | 答对的知识点对应题数/知识点对应题数 | 
| amount | String | 0 | 答对率(即rate的小数形式) | 
# 示例
请求示例
https://api2.qingsuyun.com/site/api/openApi/paper/stats/ability?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9
post请求request body参数内容:
{
    "paperId":"18081428660",
    "userCode":"",
    "deptPathList":[],
    "pageNum":1,
    "pageSize":10
}
正常返回示例
JSON格式
{
    "code": "200",
    "body": {
        "pageNum": 1,
        "pageSize": 10,
        "nextPage": 2,
        "total": 2,
        "pages": 1,
        "list": [
            {
                "userCode": "1033",
                "userId": "d7caa6bc06cd487c9578d0b19bf9d3bb",
                "thirdType": 8,
                "totalScore": "1.00(1/1)",
                "abilityScoreList": [
                    {
                        "pointId": "2b790a6de7e14afda73e56b4e8ab8c7a",
                        "name": "三角函数",
                        "rate": "1/1",
                        "amount": "100"
                    },
                    {
                        "pointId": "3eff5fd5e0894a4db265c104f35fbedd",
                        "name": "求导",
                        "rate": "1/1",
                        "amount": "100"
                    }
                ],
                "deptName": "天师门",
                "filename": null
            },
            {
                "nickName": "空闻大师",
                "userCode": "1011",
                "userId": "0550ca6947ab4963ae5f9dc78bf074f6",
                "thirdType": 8,
                "totalScore": "10.00(1/1)",
                "abilityScoreList": [
                    {
                        "pointId": "3eff5fd5e0894a4db265c104f35fbedd",
                        "name": "求导",
                        "rate": "0/0",
                        "amount": "0"
                    },
                    {
                        "pointId": "2b790a6de7e14afda73e56b4e8ab8c7a",
                        "name": "三角函数",
                        "rate": "1/1",
                        "amount": "100"
                    }
                ],
                "deptName": "少林派/藏经阁",
                "filename": null
            }
        ],
        "isLastPage": true,
        "size": 0,
        "isFirstPage": false
    }
}
# 考试统计列表
# 功能说明
获取管理端数据中心考试统计列表信息
# 调用说明
地址:
https://api2.qingsuyun.com/site/api/openApi/paperAnlsList
方式:get
# 请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 | 
|---|---|---|---|---|
| factoryCode | String | 是 | 123456 | 组织编号 | 
| sign | String | 是 | eyJhbGciOiJIUzI1NiJ9 | 签名 | 
| pageNum | Integer | 是 | 1 | 请求页码 | 
| pageSize | Integer | 是 | 10 | 每页条数,最大1000 | 
# 返回数据
| 名称 | 类型 | 示例值 | 描述 | 
|---|---|---|---|
| code | String | 200 | 状态码,详见说明 | 
| body | String | Json格式字符串 | 返回数据信息或错误信息 | 
| total | Integer | 8 | 总条数 | 
| id | String | 18081427165 | 试卷id | 
| generateType | Integer | 1 | 出题方式(1.固定;2.随机) | 
| paperType | Integer | 2 | 试卷类型(1.公开;2.非公开) | 
| name | String | 测试考试 | 试卷名称 | 
| totalScore | Integer | 10 | 试卷总分 | 
| passScore | Integer | 10 | 试卷及格分 | 
| duration | Integer | 100 | 试卷考试时长(秒) | 
| usingState | Integer | 1 | 发布状态(1.已发布;2.未发布) | 
| createTime | Integer | 1693271317000 | 创建时间(时间戳) | 
| enableTime | Integer | 1719287058000 | 试卷开始时间(时间戳) | 
| expireTime | Integer | 1719294258000 | 试卷结束时间(时间戳) | 
| examTimeEnable | Integer | 0 | 是否启用考试时间(1.是;0.否) | 
| examTotalAmount | Integer | 1 | 考试人数 | 
| passAmount | Integer | 1 | 及格人数 | 
| passRatio | Double | 1 | 及格率 | 
| averageScore | Double | 0 | 平均分 | 
| highestScore | Double | 0 | 最高分 | 
| lowestScore | Double | 0 | 最低分 | 
| invitedTotalAmount | Integer | 0 | 考试邀请人数(暂不支持自定义信息邀请) | 
# 示例
请求示例
https://api2.qingsuyun.com//site/api/openApi/paperAnlsList?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9&pageNum=1&pageSize=10
正常返回示例
JSON格式
{
    "code": "200",
    "body": {
        "list": [
            {
                "generateType": 1,
                "generateAdvanced": 2,
                "paperType": 2,
                "name": "高等概率论",
                "duration": 1800,
                "passScore": 0,
                "createTime": 1719295527000,
                "enableTime": 1719295873000,
                "expireTime": 1719303073000,
                "usingState": 2,
                "examTimeEnable": 0,
                "id": "18081596922",
                "totalScore": 0,
                "examTotalAmount": 1,
                "passAmount": 1,
                "passRatio": 1,
                "averageScore": 1,
                "highestScore": 1,
                "lowestScore": 1,
                "invitedTotalAmount": 0
            }
        ],
        "total": 1463
    }
}
# 试卷题目信息
# 功能说明
获取某场考试的题目信息
# 调用说明
地址:
https://api2.qingsuyun.com/site/api/openApi/paperQuestion
方式:get
# 请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 | 
|---|---|---|---|---|
| factoryCode | String | 是 | 123456 | 组织编号 | 
| sign | String | 是 | eyJhbGciOiJIUzI1NiJ9 | 签名 | 
| paperId | String | 是 | 18081427165 | 试卷id | 
# 返回数据
| 名称 | 类型 | 示例值 | 描述 | 
|---|---|---|---|
| code | String | 200 | 状态码,详见说明 | 
| body | String | Json格式字符串 | 返回数据信息或错误信息 | 
| questionId | String | 0eed6722cd8f4ca68248fad58f3ba98a | 题目id | 
| questionParentId | String | 0 | 上级题目id | 
| questionType | String | 1 | 题目类型:0.组合题 1.单选 2.多选 3.填空 4.判断 5.简答 | 
| questionContent | String | 中国特色社会主义进入_____的关键时期 | 题目内容 | 
| jsonData | String | Json格式字符串 | 待选答案 | 
| rightAnswers | String | 3 | 正确答案 | 
| sortIndex | String | 1000 | 题目排序号 | 
| score | String | 5 | 题目分数 | 
# 示例
请求示例
https://api2.qingsuyun.com/site/api/openApi/paperQuestion?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9&paperId=18081
正常返回示例
JSON格式
{
  "code": "200",
  "body": [
    {
      "questionId": "0eed6722cd8f4ca68248fad58f3ba98a",
      "questionParentId": "0",
      "questionType": 1,
      "questionContent": "中国共产党第十九次全国代表大会,是在全面建成小康社会决胜阶段、中国特色社会主义进入_____的关键时期召开的一次十分重要的大会。",
      "jsonData": {
        "single": {
          "options": [
            {
              "optionsContent": "新时期;",
              "sortIndex": 0,
              "rightAnswers": false
            },
            {
              "optionsContent": "新阶段;",
              "sortIndex": 1,
              "rightAnswers": false
            },
            {
              "optionsContent": "新征程;",
              "sortIndex": 2,
              "rightAnswers": false
            },
            {
              "optionsContent": "新时代",
              "sortIndex": 3,
              "rightAnswers": true
            }
          ]
        }
      },
      "rightAnswers": "3",
      "sortIndex": 1000,
      "score": 5
    }
  ]
}
# 考生答案信息
# 功能说明
获取某场考试的考生答案信息
# 调用说明
地址:
https://api2.qingsuyun.com/site/api/openApi/paperAnswer
方式:get
# 请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 | 
|---|---|---|---|---|
| factoryCode | String | 是 | 123456 | 组织编号 | 
| sign | String | 是 | eyJhbGciOiJIUzI1NiJ9 | 签名 | 
| paperId | String | 是 | 18081427165 | 试卷id | 
# 返回数据
| 名称 | 类型 | 示例值 | 描述 | 
|---|---|---|---|
| code | String | 200 | 状态码,详见说明 | 
| body | String | Json格式字符串 | 返回数据信息或错误信息 | 
| answerId | String | 49f155fc06774493adc07ed8ae205 | 答卷id | 
| nickName | String | 小李2 | 考生名称 | 
| userId | String | 17120713174708531518756 | 考生id | 
| paperQuestionId | String | ae3accb5aaf411ea9b73080027c2a1af | 题目id | 
| sortIndex | String | 1000 | 题目排序号 | 
| answerContent | String | 2 | 答案内容 | 
| realScore | String | 0 | 考试得分 | 
| remarkList | String | Json格式字符串 | 题目评语列表 | 
| remark | String | 管理员评语 | 题目评语,null则为图片评语 | 
# 示例
请求示例
https://api2.qingsuyun.com/site/api/openApi/paperAnswer?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9&paperId=18081
正常返回示例
JSON格式
{
    "code": "200",
    "body": [
        {
            "examResult": [
                {
                    "id": "c2a4819dd83643548e3c2",
                    "answerId": "3ee7d1ba4f044ed3b354643cc",
                    "paperQuestionId": "396f3b24a4124f92b387f7398",
                    "userId": "2843ccde67634a6191223ee2241",
                    "sortIndex": 5000,
                    "answerContent": "简答题答案",
                    "realScore": 0,
                    "nickName": "龙葵",
                    "remarkList": [
                        {
                            "id": "e8a14896dc364ce7ab5e00854",
                            "factoryCode": "100000",
                            "paperId": "18081596777",
                            "answerId": "3ee7d1ba4f044ed3b354643cc",
                            "answerItemId": "c2a4819dd83643548e524333c2",
                            "remark": "管理员评语1",
                            "creatorId": "171124170050887323454",
                            "creatorType": 0,
                            "createTime": 1704181910000,
                            "dataState": null,
                            "jsonData": {},
                            "creatorName": "超级管理员"
                        },
                        {
                            "id": "486461551076409e9027cf2e79",
                            "factoryCode": "100017",
                            "paperId": "18081596477",
                            "answerId": "3ee7d1ba4f044ed3b354643cc",
                            "answerItemId": "c2a4819dd83643548e524333c2",
                            "remark": null,
                            "creatorId": "171124170050887323454",
                            "creatorType": 0,
                            "createTime": 1704181905000,
                            "dataState": null,
                            "jsonData": {
                                "pictureUrl": [
                                    "https://s.qingsuyun.com/100000/m/20-01/20000101_xe.png"
                                ]
                            },
                            "creatorName": "超级管理员"
                        }
                    ]
                },
            ],
            "userInfo": {
                "answerId": "ee7d1ba4f044ed3b354643cc",
                "nickName": "龙葵",
                "userId": "2843ccde67634a6191223ee2241"
            }
        }
    ]
}
# 考生各考试成绩列表
# 功能说明
获取某考生所有考试成绩列表
# 调用说明
地址:
https://api2.qingsuyun.com/site/api/openApi/userScoreList
方式:get
# 请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 | 
|---|---|---|---|---|
| factoryCode | String | 是 | 123456 | 组织编号 | 
| sign | String | 是 | eyJhbGciOiJIUzI1NiJ9 | 签名 | 
| pageNum | Integer | 是 | 1 | 请求页码 | 
| pageSize | Integer | 是 | 10 | 每页条数,最大1000 | 
| userId | String | 是 | 1712071317449708 | 考生id | 
| paperId | String | 否 | 18081427139 | 试卷id | 
# 返回数据
| 名称 | 类型 | 示例值 | 描述 | 
|---|---|---|---|
| code | String | 200 | 状态码,详见说明 | 
| body | String | Json格式字符串 | 返回数据信息或错误信息 | 
| total | Integer | 505 | 总条数 | 
| paperId | String | 18081427139 | 试卷id | 
| paperName | String | 知识自测(无日期限制) | 试卷名称 | 
| totalScore | String | 100 | 试卷总分 | 
| passScore | String | 80 | 及格分数 | 
| useDuration | String | 59 | 考试耗时(秒) | 
| startTime | String | 1693808531000 | 开始考试时间(时间戳) | 
| endTime | String | 1693808534000 | 结束考试时间(时间戳) | 
| judged | Integer | 1 | 是否判分(1.已判分 0.未判分) | 
| realScore | String | 100 | 考试得分 | 
| examState | String | 3 | 考试状态(1.未开始 2.进行中 3.已完成) | 
# 示例
请求示例
https://api2.qingsuyun.com/site/api/openApi/userScoreList?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9&pageNum=1&pageSize=10&userId=18081
正常返回示例
JSON格式
{
    "code": "200",
    "body": {
        "pageNum": 1,
        "pageSize": 2,
        "nextPage": 2,
        "total": 588,
        "pages": 294,
        "list": [
            {
                "paperId": "18081596095",
                "paperName": "证书考试测试",
                "totalScore": 1,
                "passScore": 0,
                "realScore": 0,
                "useDuration": 3,
                "judged": 1,
                "startTime": 1693808531000,
                "endTime": 1693808534000,
                "examState": 3
            },
            {
                "paperId": "18081596176",
                "paperName": "94非公开随机",
                "totalScore": 51,
                "passScore": 0,
                "realScore": 0,
                "useDuration": 4,
                "judged": 1,
                "startTime": 1693808312000,
                "endTime": 1693808316000,
                "examState": 3
            }
        ],
        "isLastPage": false,
        "size": 588,
        "isFirstPage": true
    }
}
# 查询未考人员
# 功能说明
获取某场考试的尚未参加考试的考生列表
# 调用说明
地址:
https://api2.qingsuyun.com/site/api/openApi/noPublicNotAttendanceList
方式:post
# 请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 | 
|---|---|---|---|---|
| factoryCode | String | 是 | 123456 | 组织编号 | 
| sign | String | 是 | eyJhbGciOiJIUzI1NiJ9 | 签名 | 
| paperId | String | 是 | 18081427165 | 试卷id | 
| pageNum | Integer | 是 | 1 | 请求页码 | 
| pageSize | Integer | 是 | 10 | 每页条数,最大1000 | 
# 返回数据
| 名称 | 类型 | 示例值 | 描述 | 
|---|---|---|---|
| code | String | 200 | 状态码,详见说明 | 
| body | String | Json格式字符串 | 返回数据信息或错误信息 | 
| total | Integer | 100 | 总条数 | 
| nickName | String | 小李2 | 考生姓名 | 
| userId | String | 17120713174708531518756 | 考生id | 
| userCode | String | 9999 | 考生账号 | 
| tagName | String | 标签1 | 标签 | 
| deptName | String | 大观园 | 组织架构 | 
| paperName | String | 期中考试 | 试卷名称 | 
# 示例
请求示例
https://api2.qingsuyun.com/site/api/openApi/noPublicNotAttendanceList?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9&paperId=18081&pageNum=1&pageSize=100
正常返回示例
JSON格式
{
    "code": "200",
    "body": {
        "pageNum": 1,
        "pageSize": 1,
        "nextPage": 2,
        "total": 3,
        "pages": 3,
        "list": [
            {
                "userId": "2843ccde67634a613ee33e381",
                "nickName": "龙葵",
                "userCode": "1002",
                "examineeSource": 5,
                "createTime": 1704858751000,
                "tagName": "AAA",
                "deptName": "四大部洲",
                "deptId": "aa9c438416ff11ed9cda001",
                "thirdType": 8,
                "paperName": "未考人员"
            }
        ],
        "isLastPage": false,
        "size": 3,
        "isFirstPage": true
    }
}
# 课程信息列表
# 功能说明
获取管理端课程信息列表
# 调用说明
地址:
https://api2.qingsuyun.com/site/api/openApi/courseList
方式:get
# 请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 | 
|---|---|---|---|---|
| factoryCode | String | 是 | 123456 | 组织编号 | 
| sign | String | 是 | eyJhbGciOiJIUzI1NiJ9 | 签名 | 
| classifyPath | String | 否 | 2/3/ | 分类路径编号(传参需要url编码) | 
| pageNum | Integer | 是 | 1 | 请求页码 | 
| pageSize | Integer | 是 | 10 | 每页条数,最大1000 | 
# 返回数据
| 名称 | 类型 | 示例值 | 描述 | 
|---|---|---|---|
| code | String | 200 | 状态码,详见说明 | 
| body | String | Json格式字符串 | 返回数据信息或错误信息 | 
| total | Integer | 8 | 总条数 | 
| id | String | 10b81f08cbc511ea9b73080027c2a1af | 课程id | 
| title | String | 测试课程 | 课程标题 | 
| contentInfo | String | 课程内容 | 课程内容 | 
| usingState | String | 1 | 发布状态(1.已发布 2.待发布) | 
# 示例
请求示例
https://api2.qingsuyun.com/site/api/openApi/courseList?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9&pageNum=1&pageSize=10
正常返回示例
JSON格式
{
    "code": "200",
    "body": {
        "pageNum": 1,
        "pageSize": 1,
        "nextPage": 2,
        "total": 73,
        "pages": 73,
        "list": [
            {
                "creatorId": "1711241700508873452628454",
                "creatorType": 0,
                "createTime": 1693809141000,
                "id": "5f382acf98a04ce58563275c67676100",
                "code": 216,
                "title": "C语言与程序设计基础",
                "contentInfo": "67",
                "examRef": 0,
                "usingState": 1,
                "publishTime": 1693809155000,
                "classifyPath": "14/",
                "isPreventCheat": 0,
                "editTime": 1693816279000,
                "finishTime": 1696003200000,
                "creditHourSet": 3,
                "jsonData": {
                    "beginTime": "2023-09-01 00:00:00",
                    "cashWay": 1,
                    "weight": 1000
                },
                "classifyName": "分类1",
                "creatorName": "超级管理员"
            }
        ],
        "isLastPage": false,
        "size": 73,
        "isFirstPage": true
    }
}
# 课程学习情况
# 功能说明
获取某门课程的学员学习情况
# 调用说明
地址:
https://api2.qingsuyun.com/site/api/openApi/courseSchedule
方式:get
# 请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 | 
|---|---|---|---|---|
| factoryCode | String | 是 | 123456 | 组织编号 | 
| sign | String | 是 | eyJhbGciOiJIUzI1NiJ9 | 签名 | 
| pageNum | Integer | 是 | 1 | 请求页码 | 
| pageSize | Integer | 是 | 10 | 每页条数,最大1000 | 
| courseId | String | 是 | 18081427165 | 课程id | 
# 返回数据
| 名称 | 类型 | 示例值 | 描述 | 
|---|---|---|---|
| code | String | 200 | 状态码,详见说明 | 
| body | String | Json格式字符串 | 返回数据信息或错误信息 | 
| total | Integer | 8 | 总条数 | 
| userId | String | 1712071 | 考生id | 
| finished | String | 0 | 是否完成课程 0.否 1.是 | 
| finishedTime | String | 2022-10-26 15:02:23 | 完成时间 | 
| examResult | String | 4 | 考试结果 | 
| studyedDuration | Integer | 0 | 学习时长(秒) | 
| coursewareCount | String | 2 | 课程所含课数 | 
| finishedCount | String | 0 | 已完成课程数 | 
| nickName | String | 小李2 | 考生名称 | 
| userCode | String | xiaoli | 账号 | 
| deptId | String | aae08954a,c84a | 组织架构id(逗号分隔) | 
| deptName | String | 部门A;部门A/研发部 | 组织架构名称 | 
| examScoreList | Array | 见返回示例 | 章节考试结果列表 | 
| id | String | 74e90c5a842508e74 | 答卷id | 
| paperId | String | 18081594904 | 试卷id | 
| paperName | String | 地图考试2 | 试卷名称 | 
| realScore | Double | 0.0 | 得分 | 
# 示例
请求示例
https://api2.qingsuyun.com/site/api/openApi/courseSchedule?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9&pageNum=1&pageSize=10&courseId=18081
正常返回示例
JSON格式
{
  "code": "200",
  "body": {
    "total": 1,
    "list":  [
      {
        "id": "32e9ced2c74911ea9b73080027c2a1af",
        "userId": "1712071317449708531518756",
        "finished": 0,
        "finishedTime": "2022-10-26 15:02:23",
        "coursewareCount": 2,
        "finishedCount": 0,
        "nickName": "小李2",
        "examResult": "4.0",
                "studyedDuration": 0,
                "userCode": "zc15",
                "tagName": "标签2,标签3",
                "deptId": "baa2c1aabac011eba04d00163e08954a,c82742b7bac011eba04d00163e08954a",
                "deptName": "部门A;部门A/研发部",
                "examScoreList": [
                    {
                        "id": "74e90c5a8693499c8241f5b042508e74",
                        "paperId": "18081594904",
                        "paperName": "地图考试2",
                        "userId": "0123ef9fe8d146a08ea6670a61838681",
                        "realScore": 0.0,
                        "createTime": "2022-10-26 14:58:03"
                    }
                ]
      }
    ] 
  }
}
# 考试邀请成员(按userId)
# 功能说明
考试邀请成员(按userId)
# 调用说明
地址:
https://api2.qingsuyun.com/site/api/openApi/examInviteByUserId
方式:post
# 请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 | 
|---|---|---|---|---|
| factoryCode | String | 是 | 123456 | 组织编号 | 
| sign | String | 是 | eyJhbGciOiJIUzI1NiJ9 | 签名 | 
| userIdList | Array | 是 | ["c90327332fbfb","b332933i12d"] | 用户id集合 | 
| paperId | String | 是 | 18081427457 | 试卷id | 
# 返回数据
| 名称 | 类型 | 示例值 | 描述 | 
|---|---|---|---|
| code | String | 200 | 状态码,详见说明 | 
| body | String | Json格式字符串 | 返回数据信息或错误信息 | 
# 示例
请求示例
https://api2.qingsuyun.com/site/api/openApi/examInviteByUserId?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9
post请求request body参数内容
{
  "userIdList": ["c90327332fbfb","b332933i12d"],
  "paperId": "18081427457"
}
正常返回示例
JSON格式
{
  "code" : "200"
}
# 考试邀请成员(按userCode)
# 功能说明
考试邀请成员(按userCode)
# 调用说明
地址:
https://api2.qingsuyun.com/site/api/openApi/examInviteByUserCode
方式:post
# 请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 | 
|---|---|---|---|---|
| factoryCode | String | 是 | 123456 | 组织编号 | 
| sign | String | 是 | eyJhbGciOiJIUzI1NiJ9 | 签名 | 
| userCodeList | Array | 是 | ["ddd","xy002"] | 用户code集合 | 
| paperId | String | 是 | 18081427457 | 试卷id | 
# 返回数据
| 名称 | 类型 | 示例值 | 描述 | 
|---|---|---|---|
| code | String | 200 | 状态码,详见说明 | 
| body | String | Json格式字符串 | 返回数据信息或错误信息 | 
# 示例
请求示例
https://api2.qingsuyun.com/site/api/openApi/examInviteByUserCode?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9
post请求request body参数内容
{
  "userCodeList": ["ddd","xy002"],
  "paperId": "18081427457"
}
正常返回示例
JSON格式
{
  "code" : "200"
}
# 根据成员删除考试邀请
# 功能说明
删除考试邀请成员(按userCode)
# 调用说明
地址:
https://api2.qingsuyun.com/site/api/openApi/examInvite/deleteByUserCodes
方式:post
# 请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 | 
|---|---|---|---|---|
| factoryCode | String | 是 | 123456 | 组织编号 | 
| sign | String | 是 | eyJhbGciOiJIUzI1NiJ9 | 签名 | 
| userCodeList | Array | 是 | ["ddd","xy002"] | 用户code集合 | 
| paperId | String | 否 | 18081427457 | 试卷id | 
# 返回数据
| 名称 | 类型 | 示例值 | 描述 | 
|---|---|---|---|
| code | String | 200 | 状态码,详见说明 | 
| body | String | Json格式字符串 | 返回数据信息或错误信息 | 
# 示例
请求示例
https://api2.qingsuyun.com/site/api/openApi/examInvite/deleteByUserCodes?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9
post请求request body参数内容
{
  "userCodeList": ["ddd","xy002"],
  "paperId": "18081427457"
}
正常返回示例
JSON格式
{
  "code" : "200"
}
# 课程分类列表
# 功能说明
获取课程分类列表
# 调用说明
地址:
https://api2.qingsuyun.com/site/api/openApi/courseClassifyList
方式:get
# 请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 | 
|---|---|---|---|---|
| factoryCode | String | 是 | 123456 | 组织编号 | 
| sign | String | 是 | eyJhbGciOiJIUzI1NiJ9 | 签名 | 
| classifyPath | String | 否 | 2/3/ | 上层分类路径, 顶层传空 | 
# 返回数据
| 名称 | 类型 | 示例值 | 描述 | 
|---|---|---|---|
| code | String | 200 | 状态码,详见说明 | 
| body | String | Json格式字符串 | 返回数据信息或错误信息 | 
# 示例
请求示例
https://api2.qingsuyun.com/site/api/openApi/courseClassifyList?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9&classifyPath=2%2F3%2F
正常返回示例
JSON格式
{
    "code": "200",
    "body": [
        {
            "name": "我的课程",
            "classifyCode": "1",
            "classifyPath": "1/"
        }
    ]
}
# 课程邀请成员(按userId)
# 功能说明
课程邀请成员(按userId)
# 调用说明
地址:
https://api2.qingsuyun.com/site/api/openApi/courseInviteByUserId
方式:post
# 请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 | 
|---|---|---|---|---|
| factoryCode | String | 是 | 123456 | 组织编号 | 
| sign | String | 是 | eyJhbGciOiJIUzI1NiJ9 | 签名 | 
| userIdList | Array | 是 | ["c90327332fbfb","b332933i12d"] | 用户id集合 | 
| courseId | String | 是 | 8479210f5b3fb8d | 课程id | 
# 返回数据
| 名称 | 类型 | 示例值 | 描述 | 
|---|---|---|---|
| code | String | 200 | 状态码,详见说明 | 
| body | String | Json格式字符串 | 返回数据信息或错误信息 | 
# 示例
请求示例
https://api2.qingsuyun.com/site/api/openApi/courseInviteByUserId?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9
post请求request body参数内容:
{
    "userIdList": ["c90327332fbfb","b332933i12d"],
     "courseId": "8479210f5b3f4f7fba7ff386592d5b8d"
}
正常返回示例
JSON格式
{
     "code" : "200",
     "body" : "邀请成员成功"
}
# 课程邀请成员(按userCode)
# 功能说明
课程邀请成员(按userCode)
# 调用说明
地址:
https://api2.qingsuyun.com/site/api/openApi/courseInviteByUserCode
方式:post
# 请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 | 
|---|---|---|---|---|
| factoryCode | String | 是 | 123456 | 组织编号 | 
| sign | String | 是 | eyJhbGciOiJIUzI1NiJ9 | 签名 | 
| userCodeList | Array | 是 | ["ddd","xy002"] | 用户code集合 | 
| courseId | String | 是 | 8479210f5b3fd5b8d | 课程id | 
# 返回数据
| 名称 | 类型 | 示例值 | 描述 | 
|---|---|---|---|
| code | String | 200 | 状态码,详见说明 | 
| body | String | Json格式字符串 | 返回数据信息或错误信息 | 
# 示例
请求示例
https://api2.qingsuyun.com/site/api/openApi/courseInviteByUserCode?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9
post请求request body参数内容:
{
    "userCodeList": ["ddd","xy002"],
    "courseId": "8479210f5b3f4f7fba7ff386592d5b8d"
}
正常返回示例
JSON格式
{
     "code" : "200"
}
# 根据成员删除课程邀请
# 功能说明
根据成员删除课程邀请(按userCode)
# 调用说明
地址:
https://api2.qingsuyun.com/site/api/openApi/courseInvite/deleteByUserCodes
方式:post
# 请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 | 
|---|---|---|---|---|
| factoryCode | String | 是 | 123456 | 组织编号 | 
| sign | String | 是 | eyJhbGciOiJIUzI1NiJ9 | 签名 | 
| userCodeList | Array | 是 | ["ddd","xy002"] | 用户code集合 | 
| courseId | String | 是 | 847921592d5b8d | 课程id | 
# 返回数据
| 名称 | 类型 | 示例值 | 描述 | 
|---|---|---|---|
| code | String | 200 | 状态码,详见说明 | 
| body | String | Json格式字符串 | 返回数据信息或错误信息 | 
# 示例
请求示例
https://api2.qingsuyun.com/site/api/openApi/courseInvite/deleteByUserCodes?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9
post请求request body参数内容:
{
    "userCodeList": ["ddd","xy002"],
    "courseId": "8479210f5b3f4f7fba7ff386592d5b8d"
}
正常返回示例
JSON格式
{
     "code" : "200"
}
# 查询证书
# 功能说明
查询证书
# 调用说明
地址:
https://api2.qingsuyun.com/site/api/openApi/map/certs
方式:get
# 请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 | 
|---|---|---|---|---|
| factoryCode | String | 是 | 123456 | 组织编号 | 
| sign | String | 是 | eyJhbGciOiJIUzI1NiJ9 | 签名 | 
| eventId | String | 是 | 8888 | 任务id | 
| eventType | String | 是 | 2 | 证书类型(1.考试;2.学习地图/kaiyun官方官网) | 
| pageNum | int | 否 | 1 | 页码 | 
| pageSize | int | 否 | 100 | 分页参数,最大1000 | 
# 返回数据
| 名称 | 类型 | 示例值 | 描述 | 
|---|---|---|---|
| code | String | 200 | 状态码,详见说明 | 
| body | String | Json格式字符串 | 返回数据信息或错误信息 | 
| total | int | 100 | 证书数量 | 
| paperId | String | 9999 | 任务id | 
| certName | String | 入职培训考试 | 证书名称 | 
| userId | String | b73fe4b6a836c45 | 学员id | 
| nickName | String | 黄盖 | 学员姓名 | 
| userCode | String | 999999 | 学员账号 | 
| certSerial | String | A-00006 | 证书编号 | 
| certType | int | 1 | 证书类型(1.考试;2.学习地图/kaiyun官方官网) | 
| certUrl | String | https://s.qingsuyun.com/88/cert/1180/5b03.png | 证书图片路径 | 
| publishTime | String | 1742175585000 | 证书发放时间 | 
| receiveTime | String | 1742175585000 | 证书生成时间 | 
# 示例
请求示例
https://api2.qingsuyun.com/site/api/openApi/map/certs?eventId=18081775034&eventType=2&sign=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9&factoryCode=123456
正常返回示例
JSON格式
{
    "code": "200",
    "body": {
        "pageNum": 1,
        "pageSize": 10,
        "nextPage": 2,
        "total": 2,
        "pages": 1,
        "list": [
            {
                "id": "5b030ad8984e48069bda9b6e38edc00f",
                "userId": "53b168eb73fe4b6a836c459c704e9bef",
                "certId": "f0807a5f29a14dfd9c4166c6c6955681",
                "generateStatus": 1,
                "generateType": 1,
                "certUrl": "https://s.qingsuyun.com/126891/cert/118081775034/5b030ad8984e48069bda9b6e38edc00f.png",
                "createTime": 1742175584000,
                "certName": "学员证书",
                "paperId": "18081775034",
                "answerId": "6421735c14eb4fc28f7edaa517e34c1a",
                "publishState": 1,
                "publishTime": 1742175585000,
                "jsonData": {
                    "certType": 1,
                    "certSerial": "A-00006"
                },
                "nickName": "贾谊",
                "userCode": "1001",
                "deptId": "61145a2f9c2211eba3367cd30aeb7800,7b7670209b6811eba3367cd30aeb7800",
                "deptName": "大观园/蘅芜苑;大观园/潇湘馆",
                "receiveTime": 1742175584000,
                "expireStatus": 1,
                "thirdType": 8
            }
        ],
        "isLastPage": true,
        "size": 2,
        "isFirstPage": true
    }
}