quiz_extensions.json

{
  "apiVersion": "1.0",
  "swaggerVersion": "1.2",
  "basePath": "https://canvas.instructure.com/api",
  "resourcePath": "/quiz_extensions",
  "produces": [
    "application/json"
  ],
  "apis": [
    {
      "path": "/v1/courses/{course_id}/quizzes/{quiz_id}/extensions",
      "description": "<b>Responses</b>\n\n* <b>200 OK</b> if the request was successful\n* <b>403 Forbidden</b> if you are not allowed to extend quizzes for this course",
      "operations": [
        {
          "method": "POST",
          "summary": "Set extensions for student quiz submissions",
          "notes": "<b>Responses</b>\n\n* <b>200 OK</b> if the request was successful\n* <b>403 Forbidden</b> if you are not allowed to extend quizzes for this course",
          "nickname": "set_extensions_for_student_quiz_submissions",
          "parameters": [
            {
              "paramType": "path",
              "name": "course_id",
              "description": "ID",
              "type": "string",
              "format": null,
              "required": true
            },
            {
              "paramType": "path",
              "name": "quiz_id",
              "description": "ID",
              "type": "string",
              "format": null,
              "required": true
            },
            {
              "paramType": "form",
              "name": "user_id",
              "description": "The ID of the user we want to add quiz extensions for.",
              "type": "integer",
              "format": "int64",
              "required": true
            },
            {
              "paramType": "form",
              "name": "extra_attempts",
              "description": "Number of times the student is allowed to re-take the quiz over the\nmultiple-attempt limit. This is limited to 1000 attempts or less.",
              "type": "integer",
              "format": "int64",
              "required": false
            },
            {
              "paramType": "form",
              "name": "extra_time",
              "description": "The number of extra minutes to allow for all attempts. This will\nadd to the existing time limit on the submission. This is limited to\n10080 minutes (1 week)",
              "type": "integer",
              "format": "int64",
              "required": false
            },
            {
              "paramType": "form",
              "name": "manually_unlocked",
              "description": "Allow the student to take the quiz even if it's locked for\neveryone else.",
              "type": "boolean",
              "format": null,
              "required": false
            },
            {
              "paramType": "form",
              "name": "extend_from_now",
              "description": "The number of minutes to extend the quiz from the current time. This is\nmutually exclusive to extend_from_end_at. This is limited to 1440\nminutes (24 hours)",
              "type": "integer",
              "format": "int64",
              "required": false
            },
            {
              "paramType": "form",
              "name": "extend_from_end_at",
              "description": "The number of minutes to extend the quiz beyond the quiz's current\nending time. This is mutually exclusive to extend_from_now. This is\nlimited to 1440 minutes (24 hours)",
              "type": "integer",
              "format": "int64",
              "required": false
            }
          ],
          "type": "void"
        }
      ]
    }
  ],
  "models": {
    "QuizExtension": {
      "id": "QuizExtension",
      "description": "",
      "required": [
        "quiz_id",
        "user_id"
      ],
      "properties": {
        "quiz_id": {
          "description": "The ID of the Quiz the quiz extension belongs to.",
          "example": 2,
          "type": "integer",
          "format": "int64"
        },
        "user_id": {
          "description": "The ID of the Student that needs the quiz extension.",
          "example": 3,
          "type": "integer",
          "format": "int64"
        },
        "extra_attempts": {
          "description": "Number of times the student is allowed to re-take the quiz over the multiple-attempt limit.",
          "example": 1,
          "type": "integer",
          "format": "int64"
        },
        "extra_time": {
          "description": "Amount of extra time allowed for the quiz submission, in minutes.",
          "example": 60,
          "type": "integer",
          "format": "int64"
        },
        "manually_unlocked": {
          "description": "The student can take the quiz even if it's locked for everyone else",
          "example": true,
          "type": "boolean"
        },
        "end_at": {
          "description": "The time at which the quiz submission will be overdue, and be flagged as a late submission.",
          "example": "2013-11-07T13:16:18Z",
          "type": "string",
          "format": "date-time"
        }
      }
    }
  }
}