Quiz API

batch_show

GET/api/banks/batch_show

Query parameters

Response

404

returns nothing when none of the banks belong to authorized user

Body

application/json

error*string

errors*array of object

Request

JavaScriptCurlPython

const response = await fetch('/api/banks/batch_show', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

404

{
  "error": "text",
  "errors": [
    {
      "error_type": "text",
      "message": "text"
    }
  ]
}

create

POST/api/content_exports

Response

404

populates the export_settings field with the given export_settings param

Body

application/json

error*string

errors*array of object

Request

JavaScriptCurlPython

const response = await fetch('/api/content_exports', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

404

{
  "error": "text",
  "errors": [
    {
      "error_type": "text",
      "message": "text"
    }
  ]
}

create

POST/api/courses

Response

404

example at ./spec/requests/api/v1/courses_controller_spec.rb:208

Body

application/json

error*string

errors*array of object

Request

JavaScriptCurlPython

const response = await fetch('/api/courses', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

404

{
  "error": "text",
  "errors": [
    {
      "error_type": "text",
      "message": "text"
    }
  ]
}

destroy

DELETE/api/courses/{canvas_id}

Path parameters

canvas_id*integer

Example: 9999

Response

404

is expected to be not found

Body

application/json

error*string

errors*array of object

Request

JavaScriptCurlPython

const response = await fetch('/api/courses/{canvas_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

404

{
  "error": "text",
  "errors": [
    {
      "error_type": "text",
      "message": "text"
    }
  ]
}

update

PUT/api/courses/{canvas_id}

Path parameters

canvas_id*integer

Example: 201

Response

404

is expected to be not found

Body

application/json

error*string

errors*array of object

Request

JavaScriptCurlPython

const response = await fetch('/api/courses/{canvas_id}', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

404

{
  "error": "text",
  "errors": [
    {
      "error_type": "text",
      "message": "text"
    }
  ]
}

associate_courses

PATCH/api/courses/{canvas_id}/associate_courses

Path parameters

canvas_id*integer

Example: 196

Response

404

associates courses which have previously been archived

Body

application/json

error*string

errors*array of object

Request

JavaScriptCurlPython

const response = await fetch('/api/courses/{canvas_id}/associate_courses', {
    method: 'PATCH',
    headers: {},
});
const data = await response.json();

Response

404

{
  "error": "text",
  "errors": [
    {
      "error_type": "text",
      "message": "text"
    }
  ]
}

associate_quizzes

PATCH/api/courses/{canvas_id}/associate_quizzes

Path parameters

canvas_id*integer

Example: 550000000000154

Response

404

replaces the local canvas_id with the global canavs_id

Body

application/json

error*string

errors*array of object

Request

JavaScriptCurlPython

const response = await fetch('/api/courses/{canvas_id}/associate_quizzes', {
    method: 'PATCH',
    headers: {},
});
const data = await response.json();

Response

404

{
  "error": "text",
  "errors": [
    {
      "error_type": "text",
      "message": "text"
    }
  ]
}

check_shareability

POST/api/items/check_shareability

Response

404

is expected to be bad request

Body

application/json

error*string

errors*array of object

Request

JavaScriptCurlPython

const response = await fetch('/api/items/check_shareability', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

404

{
  "error": "text",
  "errors": [
    {
      "error_type": "text",
      "message": "text"
    }
  ]
}

create_batch

POST/api/quiz_clone_jobs/create_batch

Response

404

is expected to be unprocessable

Body

application/json

error*string

errors*array of object

Request

JavaScriptCurlPython

const response = await fetch('/api/quiz_clone_jobs/create_batch', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

404

{
  "error": "text",
  "errors": [
    {
      "error_type": "text",
      "message": "text"
    }
  ]
}

index

GET/api/quiz_sessions

Query parameters

Response

404

returns all the quiz sessions without paginating

Body

application/json

error*string

errors*array of object

Request

JavaScriptCurlPython

const response = await fetch('/api/quiz_sessions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

404

{
  "error": "text",
  "errors": [
    {
      "error_type": "text",
      "message": "text"
    }
  ]
}

show

GET/api/quiz_sessions/{id}

Path parameters

id*integer

Example: 1764

Query parameters

Response

404

does not invalidate the student access code

Body

application/json

error*string

errors*array of object

Request

JavaScriptCurlPython

const response = await fetch('/api/quiz_sessions/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

404

{
  "error": "text",
  "errors": [
    {
      "error_type": "text",
      "message": "text"
    }
  ]
}

time

GET/api/quiz_sessions/{id}/time

Path parameters

id*integer

Example: 145

Response

200

then the elapsed time should be the sum of the previous and current attempt

Body

application/json

timer_running*boolean

time_left_in_seconds*integer

Request

JavaScriptCurlPython

const response = await fetch('/api/quiz_sessions/{id}/time', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "timer_running": false,
  "time_left_in_seconds": 0
}

index

GET/api/quiz_sessions/{quiz_session_id}/quiz_session_response_events

Path parameters

quiz_session_id*integer

Example: 146

Query parameters

Response

200

then the assignment will autosubmit and cannot be resumed

Body

application/json

itemsany

Request

JavaScriptCurlPython

const response = await fetch('/api/quiz_sessions/{quiz_session_id}/quiz_session_response_events', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[]

index

GET/api/quiz_sessions/{quiz_session_id}/session_item_responses

Path parameters

quiz_session_id*integer

Example: 160

Response

200

should not modify the session response data

Body

application/json

attempt*integer

position*integer

item_id*string

user_response*object

Request

JavaScriptCurlPython

const response = await fetch('/api/quiz_sessions/{quiz_session_id}/session_item_responses', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "attempt": 0,
    "position": 0,
    "item_id": "text",
    "user_response": {
      "value": [
        "text"
      ]
    }
  }
]

create_batch

POST/api/quiz_sync_jobs/create_batch

Response

404

returns created: false

Body

application/json

error*string

errors*array of object

Request

JavaScriptCurlPython

const response = await fetch('/api/quiz_sync_jobs/create_batch', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

404

{
  "error": "text",
  "errors": [
    {
      "error_type": "text",
      "message": "text"
    }
  ]
}

index

GET/api/quizzes

Query parameters

Response

401404

uses v1 endpoints by default

Body

application/json

error*string

errors*array of object

Request

JavaScriptCurlPython

const response = await fetch('/api/quizzes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

401404

{
  "error": "text",
  "errors": [
    {
      "error_type": "text",
      "message": "text"
    }
  ]
}

create

POST/api/quizzes/{quiz_id}/quiz_clone_jobs

Path parameters

quiz_id*integer

Example: 1461

Response

404

does not create a bank share job

Body

application/json

error*string

errors*array of object

Request

JavaScriptCurlPython

const response = await fetch('/api/quizzes/{quiz_id}/quiz_clone_jobs', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

404

{
  "error": "text",
  "errors": [
    {
      "error_type": "text",
      "message": "text"
    }
  ]
}

check_shareability

POST/api/stimuli/check_shareability

Response

404

indicates the content is shareable

Body

application/json

error*string

errors*array of object

Request

JavaScriptCurlPython

const response = await fetch('/api/stimuli/check_shareability', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

404

{
  "error": "text",
  "errors": [
    {
      "error_type": "text",
      "message": "text"
    }
  ]
}

index

GET/api/tags

Query parameters

Response

404

paginates properly

Body

application/json

error*string

errors*array of object

Request

JavaScriptCurlPython

const response = await fetch('/api/tags', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

404

{
  "error": "text",
  "errors": [
    {
      "error_type": "text",
      "message": "text"
    }
  ]
}