Quiz API

batch_show

get

/api/banks/batch_show

Query parameters

idsstring[]

Example: ["160","161"]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/banks/batch_show'

404

404

{
  "error": "Unknown host",
  "errors": [
    {
      "error_type": "ActiveRecord::RecordNotFound",
      "message": "Unknown host"
    }
  ]
}

returns nothing when none of the banks belong to authorized user

create

post

/api/content_exports

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/content_exports'

404

404

{
  "error": "Unknown host",
  "errors": [
    {
      "error_type": "ActiveRecord::RecordNotFound",
      "message": "Unknown host"
    }
  ]
}

populates the export_settings field with the given export_settings param

create

post

/api/courses

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/courses'

404

404

{
  "error": "Unknown host",
  "errors": [
    {
      "error_type": "ActiveRecord::RecordNotFound",
      "message": "Unknown host"
    }
  ]
}

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

destroy

delete

/api/courses/{canvas_id}

Path parameters

canvas_idintegerrequired

Example: 9999

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/courses/{canvas_id}'

404

404

{
  "error": "Unknown host",
  "errors": [
    {
      "error_type": "ActiveRecord::RecordNotFound",
      "message": "Unknown host"
    }
  ]
}

is expected to be not found

update

put

/api/courses/{canvas_id}

Path parameters

canvas_idintegerrequired

Example: 201

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/courses/{canvas_id}'

404

404

{
  "error": "Unknown host",
  "errors": [
    {
      "error_type": "ActiveRecord::RecordNotFound",
      "message": "Unknown host"
    }
  ]
}

is expected to be not found

associate_courses

patch

/api/courses/{canvas_id}/associate_courses

Path parameters

canvas_idintegerrequired

Example: 196

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/api/courses/{canvas_id}/associate_courses'

404

404

{
  "error": "Unknown host",
  "errors": [
    {
      "error_type": "ActiveRecord::RecordNotFound",
      "message": "Unknown host"
    }
  ]
}

associates courses which have previously been archived

associate_quizzes

patch

/api/courses/{canvas_id}/associate_quizzes

Path parameters

canvas_idintegerrequired

Example: 550000000000154

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/api/courses/{canvas_id}/associate_quizzes'

404

404

{
  "error": "Unknown host",
  "errors": [
    {
      "error_type": "ActiveRecord::RecordNotFound",
      "message": "Unknown host"
    }
  ]
}

replaces the local canvas_id with the global canavs_id

check_shareability

post

/api/items/check_shareability

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/items/check_shareability'

404

404

{
  "error": "Unknown host",
  "errors": [
    {
      "error_type": "ActiveRecord::RecordNotFound",
      "message": "Unknown host"
    }
  ]
}

is expected to be bad request

create_batch

post

/api/quiz_clone_jobs/create_batch

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/quiz_clone_jobs/create_batch'

404

404

{
  "error": "Unknown host",
  "errors": [
    {
      "error_type": "ActiveRecord::RecordNotFound",
      "message": "Unknown host"
    }
  ]
}

is expected to be unprocessable

index

get

/api/quiz_sessions

Query parameters

idsstring[]

Example: ["1674","1675","1676","1677","1678","1679","1680","1681","1682","1683","1684","1685","1686","1687","1688","1689","1690","1691","1692","1693","1694","1695","1696","1697","1698","1699","1700","1701","1702","1703","1704","1705","1706","1707","1708","1709","1710","1711","1712","1713","1714","1715","1716","1717","1718","1719","1720","1721","1722","1723","1724"]

quiz_idinteger

Example: 3499

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/quiz_sessions'

404

404

{
  "error": "Unknown host",
  "errors": [
    {
      "error_type": "ActiveRecord::RecordNotFound",
      "message": "Unknown host"
    }
  ]
}

returns all the quiz sessions without paginating

show

get

/api/quiz_sessions/{id}

Path parameters

idintegerrequired

Example: 1764

Query parameters

disable_ac_invalidationstring

Example: true

idinteger

Example: 1764

quiz_idinteger

Example: 3533

quiz_session_idinteger

Example: 1436

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/quiz_sessions/{id}'

404

404

{
  "error": "Unknown host",
  "errors": [
    {
      "error_type": "ActiveRecord::RecordNotFound",
      "message": "Unknown host"
    }
  ]
}

does not invalidate the student access code

time

get

/api/quiz_sessions/{id}/time

Path parameters

idintegerrequired

Example: 145

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/quiz_sessions/{id}/time'

200

200

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

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

index

get

/api/quiz_sessions/{quiz_session_id}/quiz_session_response_events

Path parameters

quiz_session_idintegerrequired

Example: 146

Query parameters

formatstring

Example: json

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/quiz_sessions/{quiz_session_id}/quiz_session_response_events'

200

200

[]

then the assignment will autosubmit and cannot be resumed

index

get

/api/quiz_sessions/{quiz_session_id}/session_item_responses

Path parameters

quiz_session_idintegerrequired

Example: 160

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/quiz_sessions/{quiz_session_id}/session_item_responses'

200

200

[
  {
    "attempt": 1,
    "position": 1,
    "item_id": "877",
    "user_response": {
      "value": [
        "dbf5d3e1-e92e-45ba-8151-5f67095d8add",
        "b3227f8d-47ac-48cc-a2df-ce7768dc6d93"
      ]
    }
  },
  {
    "attempt": 1,
    "position": 2,
    "item_id": "878",
    "user_response": {
      "value": "b2d93c86-caaa-4fdc-b32f-7ed692384ffa"
    }
  }
]

should not modify the session response data

create_batch

post

/api/quiz_sync_jobs/create_batch

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/quiz_sync_jobs/create_batch'

404

404

{
  "error": "Unknown host",
  "errors": [
    {
      "error_type": "ActiveRecord::RecordNotFound",
      "message": "Unknown host"
    }
  ]
}

returns created: false

index

get

/api/quizzes

Query parameters

context_idinteger

Example: 2462

formatstring

Example: json

quiz_idsstring[]

Example: ["2762","2764"]

versioninteger

Example: 1

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/quizzes'

401

404

401

{
  "error": "Nil JSON web token",
  "errors": [
    {
      "error_type": "JWT::DecodeError",
      "message": "Nil JSON web token"
    }
  ]
}

uses v1 endpoints by default

create

post

/api/quizzes/{quiz_id}/quiz_clone_jobs

Path parameters

quiz_idintegerrequired

Example: 1461

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/quizzes/{quiz_id}/quiz_clone_jobs'

404

404

{
  "error": "Unknown host",
  "errors": [
    {
      "error_type": "ActiveRecord::RecordNotFound",
      "message": "Unknown host"
    }
  ]
}

does not create a bank share job

check_shareability

post

/api/stimuli/check_shareability

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/stimuli/check_shareability'

404

404

{
  "error": "Unknown host",
  "errors": [
    {
      "error_type": "ActiveRecord::RecordNotFound",
      "message": "Unknown host"
    }
  ]
}

indicates the content is shareable

index

get

/api/tags

Query parameters

filterstring

Example: a

pageinteger

Example: 1

per_pageinteger

Example: 1

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/tags'

404

404

{
  "error": "Unknown host",
  "errors": [
    {
      "error_type": "ActiveRecord::RecordNotFound",
      "message": "Unknown host"
    }
  ]
}

paginates properly