List of users who have or haven't submitted for a quiz.
A QuizSubmissionUserList object looks like:
{
"meta": {
"$ref": "QuizSubmissionUserListMeta",
"description": "contains meta information (such as pagination) for the list of users"
},
"users": {
"$ref": "User",
"description": "list of users that match the query"
}
}
A QuizSubmissionUserListMeta object looks like:
{
"pagination": {
"$ref": "JSONAPIPagination",
"description": "contains pagination information for the list of users"
}
}
A JSONAPIPagination object looks like:
{
"per_page": {
"type": "integer",
"description": "number of results per page",
"example": 10
},
"page": {
"type": "integer",
"description": "the current page passed as the ?page= parameter",
"example": 1
},
"template": {
"type": "string",
"description": "URL template for building out other paged URLs for this endpoint",
"example": "https://example.instructure.com/api/v1/courses/1/quizzes/1/submission_users?page={page}"
},
"page_count": {
"type": "integer",
"description": "number of pages for this collection",
"example": 10
},
"count": {
"type": "integer",
"description": "total number of items in this collection",
"example": 100
}
}
POST /api/v1/courses/:course_id/quizzes/:id/submission_users/message
"body": {
"type": "string",
"description": "message body of the conversation to be created",
"example": "Please take the quiz."
},
"recipients": {
"type": "string",
"description": "Who to send the message to. May be either 'submitted' or 'unsubmitted'",
"example": "submitted"
},
"subject": {
"type": "string",
"description": "Subject of the new Conversation created",
"example": "ATTN: Quiz 101 Students"
}
