笔试系统

获取试卷列表

GET /open_api/v1/exams

请求参数：

返回结果（data中的内容）：

例：

{
  "errcode": 0,
  "errmsg": "成功",
  "data": {
    "count": 2,
    "exams": [
      {
        "id": 1,
        "name": "测试试卷一",
        "creator_name": "李四",
        "questions_count": 5,
        "duration": 30,
        "total_score": 100
      },
      {
        "id": 2,
        "name": "测试试卷二",
        "creator_name": "王五",
        "questions_count": 10,
        "duration": 60,
        "total_score": 100
      }
    ]
  }
}

删除试卷

DELETE /open_api/v1/exams/:id

返回结果:

例：

{
  "errcode": 0,
  "errmsg": "成功"
}

获取试卷批量发放链接

GET /open_api/v1/exams/:id/exam_link

请求参数：

返回结果:

例：

{
  "errcode": 0,
  "errmsg": "成功",
  "data": {
    "url": "https://www.showmebug.com/xxx"
  }
}

更新试卷批量发放链接

PATCH /open_api/v1/exams/:id/exam_link

注：更新链接会导致之前的链接失效

请求参数：

返回结果:

例：

{
  "errcode": 0,
  "errmsg": "成功",
  "data": {
    "url": "https://www.showmebug.com/xxx"
  }
}

创建考场

POST /open_api/v1/exam_rooms

请求参数：

返回结果：

例：

{
    "errcode": 0,
    "errmsg": "请求成功",
    "data": {
        "id": 543,
        "name": "测试考场111"
    }
}

获取考场列表

GET /open_api/v1/exam_rooms

请求参数：

返回结果（data中的内容）：

例：

{
  "errcode": 0,
  "errmsg": "成功",
  "data": {
    "count": 2,
    "exam_rooms": [
      {
        "id": 1,
        "creator_name": "李四",
        "name": "默认考场",
        "written_pads_count": 5,
        "limit_exam_start_time": false,
        "exam_started_at": "",
        "exam_delayed_arrival_times_min": "",
        "exam_entrance_time_setting": "no_limit",
        "exam_entrance_began_at": "",
        "exam_entrance_ended_at": "",
        "created_at": "2021-12-15T19:30:11.669+08:00",
        "updated_at": "2021-12-15T19:30:11.669+08:00"
      },
      {
        "id": 2,
        "creator_name": "王五",
        "name": "考场2",
        "written_pads_count": 1,
        "limit_exam_start_time": false,
        "exam_started_at": "",
        "exam_delayed_arrival_times_min": "",
        "exam_entrance_time_setting": "time_range",
        "exam_entrance_began_at": "2022-03-25T12:50:00.000+08:00",
        "exam_entrance_ended_at": "2022-04-22T12:50:00.000+08:00",
        "created_at": "2021-12-15T19:30:11.669+08:00",
        "updated_at": "2021-12-15T19:30:11.669+08:00"
      },
      {
        "id": 3,
        "creator_name": "张三",
        "name": "考场3",
        "written_pads_count": 1,
        "limit_exam_start_time": false,
        "exam_started_at": "2022-03-24T14:30:00.000+08:00",
        "exam_delayed_arrival_times_min": 5,
        "exam_entrance_time_setting": "time_at",
        "exam_entrance_began_at": "",
        "exam_entrance_ended_at": "",
        "created_at": "2021-12-15T19:30:11.669+08:00",
        "updated_at": "2021-12-15T19:30:11.669+08:00"
      }
    ]
  }
}

创建笔试

POST /open_api/v1/written_pads

请求参数：

返回结果（data中的内容）：

例：

{
  "errcode": 0,
  "errmsg": "成功",
  "data": {
    "uid": "ABSDHF",
    "url": "https://www.showmebug.com/xxxxxxxx",
    "interviewer_url": "https://www.showmebug.com/xxxxxxxx",
    "exam_started_at": "2022-01-29T10:00:00.000+08:00",
    "exam_entrance_ended_at": "2022-02-29T10:00:00.000+08:00"
  }
}

批量创建笔试

POST /open_api/v1/batch_written_pads

请求参数：(一次最大支持50条数据)

返回结果（data中的内容）：

例：

{
  "errcode": 0,
  "errmsg": "成功",
  "data": {
    "written_pads": [
      {
        "uid": "ABSDHF",
        "url": "https://www.showmebug.com/xxxxxxxx",
        "interviewer_url": "https://www.showmebug.com/xxxxxxxx",
        "candidate_uid": "C001",
        "candidate_name": "李四",
        "exam_started_at": "2022-01-29T10:00:00.000+08:00",
        "exam_entrance_ended_at": "2022-02-29T10:00:00.000+08:00"
      }
    ]
  }
}

获取笔试列表

GET /open_api/v1/written_pads

请求参数：

返回结果（data中的内容）：

例：

{
  "errcode": 0,
  "errmsg": "成功",
  "data": {
    "count": 2,
    "written_pads": [
      {
        "id": 1,
        "number": "ABCDEF",
        "name": "李某",
        "status": "write_ended",
        "creator_id": 1,
        "creator_name": "李四",
        "exam_id": 1,
        "exam_name": "测试卷一",
        "total_score": 100,
        "score": 80,
        "duration": 1800,
        "switch_screen_count": 1,
        "switch_screen_time_seconds": 5,
        "evaluation": "还不错，可以继续",
        "exam_started_at": "2020-10-01T16:30:00+08:00",
        "created_at": "2020-10-01T16:00:00+08:00",
        "write_started_at": "2020-10-01T17:00:00+08:00",
        "write_submitted_at": "2020-10-01T17:30:00+08:00",
        "write_abondoned_at": null,
        "write_review_at": "2020-10-01T19:00:00+08:00",
        "pad": {
          "id": 1,
          "number": "KASDJF",
          "status": "interview_drafted"
        }
      },
      {
        "id": 2,
        "number": "ABCDEG",
        "name": "王某",
        "status": "write_abondoned",
        "creator_id": 1,
        "creator_name": "李四",
        "exam_id": 1,
        "exam_name": "测试卷一",
        "total_score": 100,
        "score": null,
        "duration": 900,
        "switch_screen_count": 5,
        "switch_screen_time_seconds": 60,
        "evaluation": null,
        "exam_started_at": "2020-10-01T16:30:00+08:00",
        "created_at": "2020-10-01T16:00:00+08:00",
        "write_started_at": "2020-10-01T17:00:00+08:00",
        "write_submitted_at": null,
        "write_abondoned_at": "2020-10-01T17:15:00+08:00",
        "write_review_at": null
      }
    ]
  }
}

笔试详情

GET /open_api/v1/written_pads/:uid

返回结果（data中的内容）：

content_json 结构说明

question_type 为 choice 选择题时，content_json 结构如下所示

{
  "answer": [0, 1], // 候选人答案
  "options": [
    {
      "content": "这是选项A", // 选项内容
      "correctly": true,  // 是否为正确答案
    },
    {
      "content": "这是选项B",
      "correctly": true,
    },
    {
      "content": "这是选项C",
    },
  ]
}

question_type 为 programming 编程题时， content_json 结构如下所示

{
  "language": "java", // 编程语言，为空时不限语言
  "code_content": "public class ShowMeBug {}", // 默认代码片段
  "unit_content": "public class ShowMeBugTest {}", // 测试用例代码
  "answer": "public class ShowMeBug {}", // 候选人答案
  "answer_language_type": "java", // 候选人答题语言
  "testcase_running_status": "success" //测试用例运行状态 none drafted running success fail
}

question_type 为 video 音视频题时， content_json 结构如下所示

{
  "video_duration": 5, // 最大录制时长
  "video_category": "video" // 录制类型， video 音视频 | audio 仅音频
}

例：

{
  "errcode": 0,
  "errmsg": "成功",
  "data": {
    "id": 1,
    "number": "ABCDEF",
    "name": "李某",
    "status": "write_ended",
    "creator_id": 1,
    "creator_name": "李四",
    "exam_id": 1,
    "exam_name": "测试卷一",
    "exam_room_id": 2,
    "exam_room_name": "测试考场一",
    "total_score": 100,
    "score": 80,
    "duration": 1800,
    "switch_screen_count": 1,
    "switch_screen_time_seconds": 5,
    "evaluation": "还不错，可以继续",
    "exam_started_at": "2020-10-01T16:30:00+08:00",
    "created_at": "2020-10-01T16:00:00+08:00",
    "write_started_at": "2020-10-01T17:00:00+08:00",
    "write_submitted_at": "2020-10-01T17:30:00+08:00",
    "write_abondoned_at": null,
    "write_review_at": "2020-10-01T19:00:00+08:00",
    "pad": {
      "id": 1,
      "number": "ABCDEF",
      "status": "interview_ended"
    },
    "questions": [
      {
        "id": 1348,
        "question_type": "programming",
        "title": "不限题",
        "description": "元素按从大到小的顺序",
        "key": "",
        "position": 1,
        "score": 20,
        "system_score": null,
        "interviewer_score": 10,
        "actual_score": 10,
        "candidate_skipped": false,
        "candidate_answer": "% // ## 请在下方进行输入 ( 支持Markdown、插入公式，点击上方按钮“环境说明”查看详情 )\n\n% // 必须定义一个 包名为 `main` 的包，并实现 `main()` 函数。\n% package main\n% import \"fmt\"\n\n% func main() {\n%   fmt.Println(\"Hello, world\")\n% }\n\n% 必须将 Module 声明为`showmebug`，然后为它定义并导出一个 start 方法\n-module(showmebug).\n-export([start/0]).\n\nstart() ->\n  say_hello(3).\n\nsay_hello(0) ->\n  0;\nsay_hello(N) ->\n  io:format(\"Hello, World~n\"),\n  say_hello(N - 1).\n",
        "content_json": {
          "answer": "% // ## 请在下方进行输入 ( 支持Markdown、插入公式，点击上方按钮“环境说明”查看详情 )\n\n% // 必须定义一个 包名为 `main` 的包，并实现 `main()` 函数。\n% package main\n% import \"fmt\"\n\n% func main() {\n%   fmt.Println(\"Hello, world\")\n% }\n\n% 必须将 Module 声明为`showmebug`，然后为它定义并导出一个 start 方法\n-module(showmebug).\n-export([start/0]).\n\nstart() ->\n  say_hello(3).\n\nsay_hello(0) ->\n  0;\nsay_hello(N) ->\n  io:format(\"Hello, World~n\"),\n  say_hello(N - 1).\n",
          "language": "",
          "code_content": "",
          "unit_content": "",
          "answer_language_type": "erlang",
          "testcase_running_status": "none"
        },
        "write_started_at": "2020-10-01T17:00:00+08:00",
        "write_ended_at": "2020-10-01T17:10:00+08:00",
        "testcase_mode": false
      },
    ],
    "videos": [
      {
        "id": 1001,
        "started_at": "2020-10-01T17:00:00+08:00",
        "ended_at": "2020-10-01T17:10:00+08:00"
      }
    ]
  }
}

批量一键评卷

PUT /open_api/v1/exam_rooms/:exam_room_id/batch_written_pad_reviews

请求参数：(一次最大支持50条数据)

例：

{
  "numbers": ["AAAAA", "ZZZZZ"]
}

返回结果:

{
  "errcode": 0,
  "errmsg": "成功",
  "data": {}
}

批量分配评卷

POST /open_api/v1/exam_rooms/:exam_room_id/batch_written_pad_dispatch_reviewers

请求参数：(一次最大支持50条数据)

例：

{
  "reviewers": [1, 2, 3],
  "wpad_numbers": ["AAAAA", "ZZZZZ"]
}

返回结果:

{
  "errcode": 0,
  "errmsg": "成功",
  "data": "分配成功"
}

笔试收卷

PUT /open_api/v1/written_pad_force_submits/:uid

返回结果:

例：

{
  "errcode": 0,
  "errmsg": "请求成功"
}

删除笔试

DELETE /open_api/v1/written_pads/:uid

返回结果:

例：

{
  "errcode": 0,
  "errmsg": "成功"
}

获取视频播放地址

GET /open_api/v1/videos/:id

返回结果:

例：

{
  "errcode": 0,
  "errmsg": "成功",
  "data": {
    "url": "www.showmebug.com/xxxx/videos/xxxx.m3u8?_utoken=xxxxxxx",
    "expire_in": 7200
  }
}

获取笔试题能力维度列表

GET /open_api/v1/skill_dimensions

请求参数：

返回结果（data中的内容）：

例：

{
  "errcode": 0,
  "errmsg": "成功",
  "data": {
    "count": 2,
    "skill_dimensions": [
      {
        "id": 1,
        "name": "能力维度一"
      },
      {
        "id": 2,
        "name": "能力维度二"
      }
    ]
  }
}