Website : rimsha.abasa.com
backdoor
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
var
/
canvas
/
public
/
doc
/
api
/
Filename :
poll_choices.json
back
Copy
{ "apiVersion": "1.0", "swaggerVersion": "1.2", "basePath": "https://canvas.managedclass.com/api", "resourcePath": "/poll_choices", "produces": [ "application/json" ], "apis": [ { "path": "/v1/polls/{poll_id}/poll_choices", "description": "Returns the paginated list of PollChoices in this poll.", "operations": [ { "method": "GET", "summary": "List poll choices in a poll", "notes": "Returns the paginated list of PollChoices in this poll.", "nickname": "list_poll_choices_in_poll", "parameters": [ { "paramType": "path", "name": "poll_id", "description": "ID", "type": "string", "format": null, "required": true, "deprecated": false } ], "response_fields": [], "deprecated": false, "deprecation_description": "", "type": "void" } ] }, { "path": "/v1/polls/{poll_id}/poll_choices/{id}", "description": "Returns the poll choice with the given id", "operations": [ { "method": "GET", "summary": "Get a single poll choice", "notes": "Returns the poll choice with the given id", "nickname": "get_single_poll_choice", "parameters": [ { "paramType": "path", "name": "poll_id", "description": "ID", "type": "string", "format": null, "required": true, "deprecated": false }, { "paramType": "path", "name": "id", "description": "ID", "type": "string", "format": null, "required": true, "deprecated": false } ], "response_fields": [], "deprecated": false, "deprecation_description": "", "type": "void" } ] }, { "path": "/v1/polls/{poll_id}/poll_choices", "description": "Create a new poll choice for this poll", "operations": [ { "method": "POST", "summary": "Create a single poll choice", "notes": "Create a new poll choice for this poll", "nickname": "create_single_poll_choice", "parameters": [ { "paramType": "path", "name": "poll_id", "description": "ID", "type": "string", "format": null, "required": true, "deprecated": false }, { "paramType": "form", "name": "poll_choices[text]", "description": "The descriptive text of the poll choice.", "type": "array", "format": null, "required": true, "deprecated": false, "items": { "type": "string" } }, { "paramType": "form", "name": "poll_choices[is_correct]", "description": "Whether this poll choice is considered correct or not. Defaults to false.", "type": "array", "format": null, "required": false, "deprecated": false, "items": { "type": "boolean" } }, { "paramType": "form", "name": "poll_choices[position]", "description": "The order this poll choice should be returned in the context it's sibling poll choices.", "type": "array", "format": "int64", "required": false, "deprecated": false, "items": { "type": "integer" } } ], "response_fields": [], "deprecated": false, "deprecation_description": "", "type": "void" } ] }, { "path": "/v1/polls/{poll_id}/poll_choices/{id}", "description": "Update an existing poll choice for this poll", "operations": [ { "method": "PUT", "summary": "Update a single poll choice", "notes": "Update an existing poll choice for this poll", "nickname": "update_single_poll_choice", "parameters": [ { "paramType": "path", "name": "poll_id", "description": "ID", "type": "string", "format": null, "required": true, "deprecated": false }, { "paramType": "path", "name": "id", "description": "ID", "type": "string", "format": null, "required": true, "deprecated": false }, { "paramType": "form", "name": "poll_choices[text]", "description": "The descriptive text of the poll choice.", "type": "array", "format": null, "required": true, "deprecated": false, "items": { "type": "string" } }, { "paramType": "form", "name": "poll_choices[is_correct]", "description": "Whether this poll choice is considered correct or not. Defaults to false.", "type": "array", "format": null, "required": false, "deprecated": false, "items": { "type": "boolean" } }, { "paramType": "form", "name": "poll_choices[position]", "description": "The order this poll choice should be returned in the context it's sibling poll choices.", "type": "array", "format": "int64", "required": false, "deprecated": false, "items": { "type": "integer" } } ], "response_fields": [], "deprecated": false, "deprecation_description": "", "type": "void" } ] }, { "path": "/v1/polls/{poll_id}/poll_choices/{id}", "description": "<b>204 No Content</b> response code is returned if the deletion was successful.", "operations": [ { "method": "DELETE", "summary": "Delete a poll choice", "notes": "<b>204 No Content</b> response code is returned if the deletion was successful.", "nickname": "delete_poll_choice", "parameters": [ { "paramType": "path", "name": "poll_id", "description": "ID", "type": "string", "format": null, "required": true, "deprecated": false }, { "paramType": "path", "name": "id", "description": "ID", "type": "string", "format": null, "required": true, "deprecated": false } ], "response_fields": [], "deprecated": false, "deprecation_description": "", "type": "void" } ] } ], "models": { "PollChoice": { "id": "PollChoice", "description": "", "required": [ "id", "poll_id", "text" ], "deprecated": false, "deprecation_description": null, "properties": { "id": { "description": "The unique identifier for the poll choice.", "example": 1023, "type": "integer" }, "poll_id": { "description": "The id of the poll this poll choice belongs to.", "example": 1779, "type": "integer" }, "is_correct": { "description": "Specifies whether or not this poll choice is a 'correct' choice.", "example": "true", "type": "boolean" }, "text": { "description": "The text of the poll choice.", "type": "string", "example": "Choice A" }, "position": { "description": "The order of the poll choice in relation to it's sibling poll choices.", "type": "integer", "example": 1 } } } } }