Bank API

API change history

List of APIs related to bank folder, shared questions and text editors.

Add Choice Question

Add Choice Question

Try it

Request

Request URL

Request headers

  • (optional)
    string
    Media type of the body sent to the API.
  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

choices question input. ResourceID is bank folder ID

{
  "type": "string",
  "recommendMarkingScheme": {},
  "negativeMarking": 0.0,
  "restrictSelection": 0,
  "otherOptionText": "string",
  "sortedOptions": [
    {
      "order": 0,
      "text": "string",
      "feedback": "string",
      "hint": "string",
      "isCorrect": true
    }
  ],
  "id": "string",
  "resourceID": "string",
  "parentID": "string",
  "forAssessment": true,
  "text": "string",
  "solution": "string",
  "publish": true,
  "mark": 0.0,
  "videoTimeStamp": 0.0,
  "createdDate": "string",
  "lastUpdatedBy": "string",
  "lastUpdatedDate": "string"
}
{
  "description": "input and output model for choice/selection based questions",
  "required": [
    "text"
  ],
  "type": "object",
  "properties": {
    "type": {
      "description": "type of the question: MCQ - Radiobutton list for selection, MRQ - checkbox list for selection, SEL - dropdown list for selection",
      "type": "string"
    },
    "recommendMarkingScheme": {
      "description": "recommented marking scheme, if the question is a MRQ question and it is used for assessment.\r\n\r\n0 - if user selected any of the incorrect answers, he/she will get 0 mark or negative marks.\r\n\r\n1 - user must select all the correct answers to get full marks, otherwise he/she will get 0 mark or negative marks\r\n\r\n2 - if user selected correct and incorrect answers, he/she will get partial marks = full-mark * number-of-selected-correct-option/total-number-of-correct options. used together with RestrictSelection\r\n\r\n3 - if user selected correct and incorrect answers, he/she will get partial marks = full-mark * (number-of-selected-correct-option - number-of-selected-incorrect-option)/total-number-of-correct options.",
      "allOf": [
        {
          "format": "int32",
          "description": "different marking scheme for check list selection",
          "enum": [
            0,
            1,
            2,
            3
          ],
          "type": "integer"
        }
      ]
    },
    "negativeMarking": {
      "format": "double",
      "description": "whether the question is allow negative marking,0 or null means negative marking is not set.",
      "maximum": 0,
      "minimum": -10000,
      "type": "number"
    },
    "restrictSelection": {
      "format": "int32",
      "description": "the maximum number of options can be selected by the user.",
      "maximum": 2147483647,
      "minimum": 1,
      "type": "integer"
    },
    "otherOptionText": {
      "description": "the instructional text for that additional text box, if any",
      "type": "string"
    },
    "sortedOptions": {
      "description": "the list of options for selection",
      "type": "array",
      "items": {
        "description": "option for selection",
        "required": [
          "text"
        ],
        "type": "object",
        "properties": {
          "order": {
            "format": "int32",
            "description": "option Order",
            "type": "integer"
          },
          "text": {
            "description": "option text",
            "type": "string"
          },
          "feedback": {
            "description": "feedback text when this option is selected, used in assessment",
            "type": "string"
          },
          "hint": {
            "description": "hint displayed for this option, used in assessment",
            "type": "string"
          },
          "isCorrect": {
            "description": "Indicate whether this option is a correct answer",
            "type": "boolean"
          }
        }
      }
    },
    "id": {
      "format": "uuid",
      "description": "Question ID",
      "type": "string"
    },
    "resourceID": {
      "format": "uuid",
      "description": "ID of the tool or folder which contains this question, could be survey id or module id",
      "type": "string"
    },
    "parentID": {
      "format": "uuid",
      "description": "parent of the question id, could be section id if it is different from question ID",
      "type": "string"
    },
    "forAssessment": {
      "description": "Whether the question created for assessment",
      "type": "boolean"
    },
    "text": {
      "description": "question text",
      "type": "string"
    },
    "solution": {
      "description": "question solution or feedback, used for assessment question, which displayed after student completed the assessment",
      "type": "string"
    },
    "publish": {
      "description": "indicate whether the question is published",
      "type": "boolean"
    },
    "mark": {
      "format": "double",
      "description": "question mark, if any",
      "maximum": 10000,
      "minimum": 0,
      "type": "number"
    },
    "videoTimeStamp": {
      "format": "float",
      "description": "the timestamp(in seconds) set for the in-video quiz",
      "maximum": 2147483647,
      "minimum": 0,
      "type": "number"
    },
    "createdDate": {
      "format": "date-time",
      "description": "time when this question is created.",
      "type": "string"
    },
    "lastUpdatedBy": {
      "description": "Name of the user who modified the question last time",
      "type": "string"
    },
    "lastUpdatedDate": {
      "format": "date-time",
      "description": "Last time this question is modified",
      "type": "string"
    }
  }
}
{
  "type": "string",
  "recommendMarkingScheme": {},
  "negativeMarking": 0.0,
  "restrictSelection": 0,
  "otherOptionText": "string",
  "sortedOptions": [
    {
      "order": 0,
      "text": "string",
      "feedback": "string",
      "hint": "string",
      "isCorrect": true
    }
  ],
  "id": "string",
  "resourceID": "string",
  "parentID": "string",
  "forAssessment": true,
  "text": "string",
  "solution": "string",
  "publish": true,
  "mark": 0.0,
  "videoTimeStamp": 0.0,
  "createdDate": "string",
  "lastUpdatedBy": "string",
  "lastUpdatedDate": "string"
}
{
  "description": "input and output model for choice/selection based questions",
  "required": [
    "text"
  ],
  "type": "object",
  "properties": {
    "type": {
      "description": "type of the question: MCQ - Radiobutton list for selection, MRQ - checkbox list for selection, SEL - dropdown list for selection",
      "type": "string"
    },
    "recommendMarkingScheme": {
      "description": "recommented marking scheme, if the question is a MRQ question and it is used for assessment.\r\n\r\n0 - if user selected any of the incorrect answers, he/she will get 0 mark or negative marks.\r\n\r\n1 - user must select all the correct answers to get full marks, otherwise he/she will get 0 mark or negative marks\r\n\r\n2 - if user selected correct and incorrect answers, he/she will get partial marks = full-mark * number-of-selected-correct-option/total-number-of-correct options. used together with RestrictSelection\r\n\r\n3 - if user selected correct and incorrect answers, he/she will get partial marks = full-mark * (number-of-selected-correct-option - number-of-selected-incorrect-option)/total-number-of-correct options.",
      "allOf": [
        {
          "format": "int32",
          "description": "different marking scheme for check list selection",
          "enum": [
            0,
            1,
            2,
            3
          ],
          "type": "integer"
        }
      ]
    },
    "negativeMarking": {
      "format": "double",
      "description": "whether the question is allow negative marking,0 or null means negative marking is not set.",
      "maximum": 0,
      "minimum": -10000,
      "type": "number"
    },
    "restrictSelection": {
      "format": "int32",
      "description": "the maximum number of options can be selected by the user.",
      "maximum": 2147483647,
      "minimum": 1,
      "type": "integer"
    },
    "otherOptionText": {
      "description": "the instructional text for that additional text box, if any",
      "type": "string"
    },
    "sortedOptions": {
      "description": "the list of options for selection",
      "type": "array",
      "items": {
        "description": "option for selection",
        "required": [
          "text"
        ],
        "type": "object",
        "properties": {
          "order": {
            "format": "int32",
            "description": "option Order",
            "type": "integer"
          },
          "text": {
            "description": "option text",
            "type": "string"
          },
          "feedback": {
            "description": "feedback text when this option is selected, used in assessment",
            "type": "string"
          },
          "hint": {
            "description": "hint displayed for this option, used in assessment",
            "type": "string"
          },
          "isCorrect": {
            "description": "Indicate whether this option is a correct answer",
            "type": "boolean"
          }
        }
      }
    },
    "id": {
      "format": "uuid",
      "description": "Question ID",
      "type": "string"
    },
    "resourceID": {
      "format": "uuid",
      "description": "ID of the tool or folder which contains this question, could be survey id or module id",
      "type": "string"
    },
    "parentID": {
      "format": "uuid",
      "description": "parent of the question id, could be section id if it is different from question ID",
      "type": "string"
    },
    "forAssessment": {
      "description": "Whether the question created for assessment",
      "type": "boolean"
    },
    "text": {
      "description": "question text",
      "type": "string"
    },
    "solution": {
      "description": "question solution or feedback, used for assessment question, which displayed after student completed the assessment",
      "type": "string"
    },
    "publish": {
      "description": "indicate whether the question is published",
      "type": "boolean"
    },
    "mark": {
      "format": "double",
      "description": "question mark, if any",
      "maximum": 10000,
      "minimum": 0,
      "type": "number"
    },
    "videoTimeStamp": {
      "format": "float",
      "description": "the timestamp(in seconds) set for the in-video quiz",
      "maximum": 2147483647,
      "minimum": 0,
      "type": "number"
    },
    "createdDate": {
      "format": "date-time",
      "description": "time when this question is created.",
      "type": "string"
    },
    "lastUpdatedBy": {
      "description": "Name of the user who modified the question last time",
      "type": "string"
    },
    "lastUpdatedDate": {
      "format": "date-time",
      "description": "Last time this question is modified",
      "type": "string"
    }
  }
}
{
  "type": "string",
  "recommendMarkingScheme": {},
  "negativeMarking": 0.0,
  "restrictSelection": 0,
  "otherOptionText": "string",
  "sortedOptions": [
    {
      "order": 0,
      "text": "string",
      "feedback": "string",
      "hint": "string",
      "isCorrect": true
    }
  ],
  "id": "string",
  "resourceID": "string",
  "parentID": "string",
  "forAssessment": true,
  "text": "string",
  "solution": "string",
  "publish": true,
  "mark": 0.0,
  "videoTimeStamp": 0.0,
  "createdDate": "string",
  "lastUpdatedBy": "string",
  "lastUpdatedDate": "string"
}
{
  "description": "input and output model for choice/selection based questions",
  "required": [
    "text"
  ],
  "type": "object",
  "properties": {
    "type": {
      "description": "type of the question: MCQ - Radiobutton list for selection, MRQ - checkbox list for selection, SEL - dropdown list for selection",
      "type": "string"
    },
    "recommendMarkingScheme": {
      "description": "recommented marking scheme, if the question is a MRQ question and it is used for assessment.\r\n\r\n0 - if user selected any of the incorrect answers, he/she will get 0 mark or negative marks.\r\n\r\n1 - user must select all the correct answers to get full marks, otherwise he/she will get 0 mark or negative marks\r\n\r\n2 - if user selected correct and incorrect answers, he/she will get partial marks = full-mark * number-of-selected-correct-option/total-number-of-correct options. used together with RestrictSelection\r\n\r\n3 - if user selected correct and incorrect answers, he/she will get partial marks = full-mark * (number-of-selected-correct-option - number-of-selected-incorrect-option)/total-number-of-correct options.",
      "allOf": [
        {
          "format": "int32",
          "description": "different marking scheme for check list selection",
          "enum": [
            0,
            1,
            2,
            3
          ],
          "type": "integer"
        }
      ]
    },
    "negativeMarking": {
      "format": "double",
      "description": "whether the question is allow negative marking,0 or null means negative marking is not set.",
      "maximum": 0,
      "minimum": -10000,
      "type": "number"
    },
    "restrictSelection": {
      "format": "int32",
      "description": "the maximum number of options can be selected by the user.",
      "maximum": 2147483647,
      "minimum": 1,
      "type": "integer"
    },
    "otherOptionText": {
      "description": "the instructional text for that additional text box, if any",
      "type": "string"
    },
    "sortedOptions": {
      "description": "the list of options for selection",
      "type": "array",
      "items": {
        "description": "option for selection",
        "required": [
          "text"
        ],
        "type": "object",
        "properties": {
          "order": {
            "format": "int32",
            "description": "option Order",
            "type": "integer"
          },
          "text": {
            "description": "option text",
            "type": "string"
          },
          "feedback": {
            "description": "feedback text when this option is selected, used in assessment",
            "type": "string"
          },
          "hint": {
            "description": "hint displayed for this option, used in assessment",
            "type": "string"
          },
          "isCorrect": {
            "description": "Indicate whether this option is a correct answer",
            "type": "boolean"
          }
        }
      }
    },
    "id": {
      "format": "uuid",
      "description": "Question ID",
      "type": "string"
    },
    "resourceID": {
      "format": "uuid",
      "description": "ID of the tool or folder which contains this question, could be survey id or module id",
      "type": "string"
    },
    "parentID": {
      "format": "uuid",
      "description": "parent of the question id, could be section id if it is different from question ID",
      "type": "string"
    },
    "forAssessment": {
      "description": "Whether the question created for assessment",
      "type": "boolean"
    },
    "text": {
      "description": "question text",
      "type": "string"
    },
    "solution": {
      "description": "question solution or feedback, used for assessment question, which displayed after student completed the assessment",
      "type": "string"
    },
    "publish": {
      "description": "indicate whether the question is published",
      "type": "boolean"
    },
    "mark": {
      "format": "double",
      "description": "question mark, if any",
      "maximum": 10000,
      "minimum": 0,
      "type": "number"
    },
    "videoTimeStamp": {
      "format": "float",
      "description": "the timestamp(in seconds) set for the in-video quiz",
      "maximum": 2147483647,
      "minimum": 0,
      "type": "number"
    },
    "createdDate": {
      "format": "date-time",
      "description": "time when this question is created.",
      "type": "string"
    },
    "lastUpdatedBy": {
      "description": "Name of the user who modified the question last time",
      "type": "string"
    },
    "lastUpdatedDate": {
      "format": "date-time",
      "description": "Last time this question is modified",
      "type": "string"
    }
  }
}
{
  "type": "string",
  "recommendMarkingScheme": {},
  "negativeMarking": 0.0,
  "restrictSelection": 0,
  "otherOptionText": "string",
  "sortedOptions": [
    {
      "order": 0,
      "text": "string",
      "feedback": "string",
      "hint": "string",
      "isCorrect": true
    }
  ],
  "id": "string",
  "resourceID": "string",
  "parentID": "string",
  "forAssessment": true,
  "text": "string",
  "solution": "string",
  "publish": true,
  "mark": 0.0,
  "videoTimeStamp": 0.0,
  "createdDate": "string",
  "lastUpdatedBy": "string",
  "lastUpdatedDate": "string"
}
{
  "description": "input and output model for choice/selection based questions",
  "required": [
    "text"
  ],
  "type": "object",
  "properties": {
    "type": {
      "description": "type of the question: MCQ - Radiobutton list for selection, MRQ - checkbox list for selection, SEL - dropdown list for selection",
      "type": "string"
    },
    "recommendMarkingScheme": {
      "description": "recommented marking scheme, if the question is a MRQ question and it is used for assessment.\r\n\r\n0 - if user selected any of the incorrect answers, he/she will get 0 mark or negative marks.\r\n\r\n1 - user must select all the correct answers to get full marks, otherwise he/she will get 0 mark or negative marks\r\n\r\n2 - if user selected correct and incorrect answers, he/she will get partial marks = full-mark * number-of-selected-correct-option/total-number-of-correct options. used together with RestrictSelection\r\n\r\n3 - if user selected correct and incorrect answers, he/she will get partial marks = full-mark * (number-of-selected-correct-option - number-of-selected-incorrect-option)/total-number-of-correct options.",
      "allOf": [
        {
          "format": "int32",
          "description": "different marking scheme for check list selection",
          "enum": [
            0,
            1,
            2,
            3
          ],
          "type": "integer"
        }
      ]
    },
    "negativeMarking": {
      "format": "double",
      "description": "whether the question is allow negative marking,0 or null means negative marking is not set.",
      "maximum": 0,
      "minimum": -10000,
      "type": "number"
    },
    "restrictSelection": {
      "format": "int32",
      "description": "the maximum number of options can be selected by the user.",
      "maximum": 2147483647,
      "minimum": 1,
      "type": "integer"
    },
    "otherOptionText": {
      "description": "the instructional text for that additional text box, if any",
      "type": "string"
    },
    "sortedOptions": {
      "description": "the list of options for selection",
      "type": "array",
      "items": {
        "description": "option for selection",
        "required": [
          "text"
        ],
        "type": "object",
        "properties": {
          "order": {
            "format": "int32",
            "description": "option Order",
            "type": "integer"
          },
          "text": {
            "description": "option text",
            "type": "string"
          },
          "feedback": {
            "description": "feedback text when this option is selected, used in assessment",
            "type": "string"
          },
          "hint": {
            "description": "hint displayed for this option, used in assessment",
            "type": "string"
          },
          "isCorrect": {
            "description": "Indicate whether this option is a correct answer",
            "type": "boolean"
          }
        }
      }
    },
    "id": {
      "format": "uuid",
      "description": "Question ID",
      "type": "string"
    },
    "resourceID": {
      "format": "uuid",
      "description": "ID of the tool or folder which contains this question, could be survey id or module id",
      "type": "string"
    },
    "parentID": {
      "format": "uuid",
      "description": "parent of the question id, could be section id if it is different from question ID",
      "type": "string"
    },
    "forAssessment": {
      "description": "Whether the question created for assessment",
      "type": "boolean"
    },
    "text": {
      "description": "question text",
      "type": "string"
    },
    "solution": {
      "description": "question solution or feedback, used for assessment question, which displayed after student completed the assessment",
      "type": "string"
    },
    "publish": {
      "description": "indicate whether the question is published",
      "type": "boolean"
    },
    "mark": {
      "format": "double",
      "description": "question mark, if any",
      "maximum": 10000,
      "minimum": 0,
      "type": "number"
    },
    "videoTimeStamp": {
      "format": "float",
      "description": "the timestamp(in seconds) set for the in-video quiz",
      "maximum": 2147483647,
      "minimum": 0,
      "type": "number"
    },
    "createdDate": {
      "format": "date-time",
      "description": "time when this question is created.",
      "type": "string"
    },
    "lastUpdatedBy": {
      "description": "Name of the user who modified the question last time",
      "type": "string"
    },
    "lastUpdatedDate": {
      "format": "date-time",
      "description": "Last time this question is modified",
      "type": "string"
    }
  }
}

Responses

201 Created

The question information created

Representations

{
  "description": "input and output model for choice/selection based questions",
  "required": [
    "text"
  ],
  "type": "object",
  "properties": {
    "type": {
      "description": "type of the question: MCQ - Radiobutton list for selection, MRQ - checkbox list for selection, SEL - dropdown list for selection",
      "type": "string"
    },
    "recommendMarkingScheme": {
      "description": "recommented marking scheme, if the question is a MRQ question and it is used for assessment.\r\n\r\n0 - if user selected any of the incorrect answers, he/she will get 0 mark or negative marks.\r\n\r\n1 - user must select all the correct answers to get full marks, otherwise he/she will get 0 mark or negative marks\r\n\r\n2 - if user selected correct and incorrect answers, he/she will get partial marks = full-mark * number-of-selected-correct-option/total-number-of-correct options. used together with RestrictSelection\r\n\r\n3 - if user selected correct and incorrect answers, he/she will get partial marks = full-mark * (number-of-selected-correct-option - number-of-selected-incorrect-option)/total-number-of-correct options.",
      "allOf": [
        {
          "format": "int32",
          "description": "different marking scheme for check list selection",
          "enum": [
            0,
            1,
            2,
            3
          ],
          "type": "integer"
        }
      ]
    },
    "negativeMarking": {
      "format": "double",
      "description": "whether the question is allow negative marking,0 or null means negative marking is not set.",
      "maximum": 0,
      "minimum": -10000,
      "type": "number"
    },
    "restrictSelection": {
      "format": "int32",
      "description": "the maximum number of options can be selected by the user.",
      "maximum": 2147483647,
      "minimum": 1,
      "type": "integer"
    },
    "otherOptionText": {
      "description": "the instructional text for that additional text box, if any",
      "type": "string"
    },
    "sortedOptions": {
      "description": "the list of options for selection",
      "type": "array",
      "items": {
        "description": "option for selection",
        "required": [
          "text"
        ],
        "type": "object",
        "properties": {
          "order": {
            "format": "int32",
            "description": "option Order",
            "type": "integer"
          },
          "text": {
            "description": "option text",
            "type": "string"
          },
          "feedback": {
            "description": "feedback text when this option is selected, used in assessment",
            "type": "string"
          },
          "hint": {
            "description": "hint displayed for this option, used in assessment",
            "type": "string"
          },
          "isCorrect": {
            "description": "Indicate whether this option is a correct answer",
            "type": "boolean"
          }
        }
      }
    },
    "id": {
      "format": "uuid",
      "description": "Question ID",
      "type": "string"
    },
    "resourceID": {
      "format": "uuid",
      "description": "ID of the tool or folder which contains this question, could be survey id or module id",
      "type": "string"
    },
    "parentID": {
      "format": "uuid",
      "description": "parent of the question id, could be section id if it is different from question ID",
      "type": "string"
    },
    "forAssessment": {
      "description": "Whether the question created for assessment",
      "type": "boolean"
    },
    "text": {
      "description": "question text",
      "type": "string"
    },
    "solution": {
      "description": "question solution or feedback, used for assessment question, which displayed after student completed the assessment",
      "type": "string"
    },
    "publish": {
      "description": "indicate whether the question is published",
      "type": "boolean"
    },
    "mark": {
      "format": "double",
      "description": "question mark, if any",
      "maximum": 10000,
      "minimum": 0,
      "type": "number"
    },
    "videoTimeStamp": {
      "format": "float",
      "description": "the timestamp(in seconds) set for the in-video quiz",
      "maximum": 2147483647,
      "minimum": 0,
      "type": "number"
    },
    "createdDate": {
      "format": "date-time",
      "description": "time when this question is created.",
      "type": "string"
    },
    "lastUpdatedBy": {
      "description": "Name of the user who modified the question last time",
      "type": "string"
    },
    "lastUpdatedDate": {
      "format": "date-time",
      "description": "Last time this question is modified",
      "type": "string"
    }
  }
}
{
  "type": "string",
  "recommendMarkingScheme": {},
  "negativeMarking": 0.0,
  "restrictSelection": 0,
  "otherOptionText": "string",
  "sortedOptions": [
    {
      "order": 0,
      "text": "string",
      "feedback": "string",
      "hint": "string",
      "isCorrect": true
    }
  ],
  "id": "string",
  "resourceID": "string",
  "parentID": "string",
  "forAssessment": true,
  "text": "string",
  "solution": "string",
  "publish": true,
  "mark": 0.0,
  "videoTimeStamp": 0.0,
  "createdDate": "string",
  "lastUpdatedBy": "string",
  "lastUpdatedDate": "string"
}
{
  "description": "input and output model for choice/selection based questions",
  "required": [
    "text"
  ],
  "type": "object",
  "properties": {
    "type": {
      "description": "type of the question: MCQ - Radiobutton list for selection, MRQ - checkbox list for selection, SEL - dropdown list for selection",
      "type": "string"
    },
    "recommendMarkingScheme": {
      "description": "recommented marking scheme, if the question is a MRQ question and it is used for assessment.\r\n\r\n0 - if user selected any of the incorrect answers, he/she will get 0 mark or negative marks.\r\n\r\n1 - user must select all the correct answers to get full marks, otherwise he/she will get 0 mark or negative marks\r\n\r\n2 - if user selected correct and incorrect answers, he/she will get partial marks = full-mark * number-of-selected-correct-option/total-number-of-correct options. used together with RestrictSelection\r\n\r\n3 - if user selected correct and incorrect answers, he/she will get partial marks = full-mark * (number-of-selected-correct-option - number-of-selected-incorrect-option)/total-number-of-correct options.",
      "allOf": [
        {
          "format": "int32",
          "description": "different marking scheme for check list selection",
          "enum": [
            0,
            1,
            2,
            3
          ],
          "type": "integer"
        }
      ]
    },
    "negativeMarking": {
      "format": "double",
      "description": "whether the question is allow negative marking,0 or null means negative marking is not set.",
      "maximum": 0,
      "minimum": -10000,
      "type": "number"
    },
    "restrictSelection": {
      "format": "int32",
      "description": "the maximum number of options can be selected by the user.",
      "maximum": 2147483647,
      "minimum": 1,
      "type": "integer"
    },
    "otherOptionText": {
      "description": "the instructional text for that additional text box, if any",
      "type": "string"
    },
    "sortedOptions": {
      "description": "the list of options for selection",
      "type": "array",
      "items": {
        "description": "option for selection",
        "required": [
          "text"
        ],
        "type": "object",
        "properties": {
          "order": {
            "format": "int32",
            "description": "option Order",
            "type": "integer"
          },
          "text": {
            "description": "option text",
            "type": "string"
          },
          "feedback": {
            "description": "feedback text when this option is selected, used in assessment",
            "type": "string"
          },
          "hint": {
            "description": "hint displayed for this option, used in assessment",
            "type": "string"
          },
          "isCorrect": {
            "description": "Indicate whether this option is a correct answer",
            "type": "boolean"
          }
        }
      }
    },
    "id": {
      "format": "uuid",
      "description": "Question ID",
      "type": "string"
    },
    "resourceID": {
      "format": "uuid",
      "description": "ID of the tool or folder which contains this question, could be survey id or module id",
      "type": "string"
    },
    "parentID": {
      "format": "uuid",
      "description": "parent of the question id, could be section id if it is different from question ID",
      "type": "string"
    },
    "forAssessment": {
      "description": "Whether the question created for assessment",
      "type": "boolean"
    },
    "text": {
      "description": "question text",
      "type": "string"
    },
    "solution": {
      "description": "question solution or feedback, used for assessment question, which displayed after student completed the assessment",
      "type": "string"
    },
    "publish": {
      "description": "indicate whether the question is published",
      "type": "boolean"
    },
    "mark": {
      "format": "double",
      "description": "question mark, if any",
      "maximum": 10000,
      "minimum": 0,
      "type": "number"
    },
    "videoTimeStamp": {
      "format": "float",
      "description": "the timestamp(in seconds) set for the in-video quiz",
      "maximum": 2147483647,
      "minimum": 0,
      "type": "number"
    },
    "createdDate": {
      "format": "date-time",
      "description": "time when this question is created.",
      "type": "string"
    },
    "lastUpdatedBy": {
      "description": "Name of the user who modified the question last time",
      "type": "string"
    },
    "lastUpdatedDate": {
      "format": "date-time",
      "description": "Last time this question is modified",
      "type": "string"
    }
  }
}
{
  "type": "string",
  "recommendMarkingScheme": {},
  "negativeMarking": 0.0,
  "restrictSelection": 0,
  "otherOptionText": "string",
  "sortedOptions": [
    {
      "order": 0,
      "text": "string",
      "feedback": "string",
      "hint": "string",
      "isCorrect": true
    }
  ],
  "id": "string",
  "resourceID": "string",
  "parentID": "string",
  "forAssessment": true,
  "text": "string",
  "solution": "string",
  "publish": true,
  "mark": 0.0,
  "videoTimeStamp": 0.0,
  "createdDate": "string",
  "lastUpdatedBy": "string",
  "lastUpdatedDate": "string"
}
{
  "description": "input and output model for choice/selection based questions",
  "required": [
    "text"
  ],
  "type": "object",
  "properties": {
    "type": {
      "description": "type of the question: MCQ - Radiobutton list for selection, MRQ - checkbox list for selection, SEL - dropdown list for selection",
      "type": "string"
    },
    "recommendMarkingScheme": {
      "description": "recommented marking scheme, if the question is a MRQ question and it is used for assessment.\r\n\r\n0 - if user selected any of the incorrect answers, he/she will get 0 mark or negative marks.\r\n\r\n1 - user must select all the correct answers to get full marks, otherwise he/she will get 0 mark or negative marks\r\n\r\n2 - if user selected correct and incorrect answers, he/she will get partial marks = full-mark * number-of-selected-correct-option/total-number-of-correct options. used together with RestrictSelection\r\n\r\n3 - if user selected correct and incorrect answers, he/she will get partial marks = full-mark * (number-of-selected-correct-option - number-of-selected-incorrect-option)/total-number-of-correct options.",
      "allOf": [
        {
          "format": "int32",
          "description": "different marking scheme for check list selection",
          "enum": [
            0,
            1,
            2,
            3
          ],
          "type": "integer"
        }
      ]
    },
    "negativeMarking": {
      "format": "double",
      "description": "whether the question is allow negative marking,0 or null means negative marking is not set.",
      "maximum": 0,
      "minimum": -10000,
      "type": "number"
    },
    "restrictSelection": {
      "format": "int32",
      "description": "the maximum number of options can be selected by the user.",
      "maximum": 2147483647,
      "minimum": 1,
      "type": "integer"
    },
    "otherOptionText": {
      "description": "the instructional text for that additional text box, if any",
      "type": "string"
    },
    "sortedOptions": {
      "description": "the list of options for selection",
      "type": "array",
      "items": {
        "description": "option for selection",
        "required": [
          "text"
        ],
        "type": "object",
        "properties": {
          "order": {
            "format": "int32",
            "description": "option Order",
            "type": "integer"
          },
          "text": {
            "description": "option text",
            "type": "string"
          },
          "feedback": {
            "description": "feedback text when this option is selected, used in assessment",
            "type": "string"
          },
          "hint": {
            "description": "hint displayed for this option, used in assessment",
            "type": "string"
          },
          "isCorrect": {
            "description": "Indicate whether this option is a correct answer",
            "type": "boolean"
          }
        }
      }
    },
    "id": {
      "format": "uuid",
      "description": "Question ID",
      "type": "string"
    },
    "resourceID": {
      "format": "uuid",
      "description": "ID of the tool or folder which contains this question, could be survey id or module id",
      "type": "string"
    },
    "parentID": {
      "format": "uuid",
      "description": "parent of the question id, could be section id if it is different from question ID",
      "type": "string"
    },
    "forAssessment": {
      "description": "Whether the question created for assessment",
      "type": "boolean"
    },
    "text": {
      "description": "question text",
      "type": "string"
    },
    "solution": {
      "description": "question solution or feedback, used for assessment question, which displayed after student completed the assessment",
      "type": "string"
    },
    "publish": {
      "description": "indicate whether the question is published",
      "type": "boolean"
    },
    "mark": {
      "format": "double",
      "description": "question mark, if any",
      "maximum": 10000,
      "minimum": 0,
      "type": "number"
    },
    "videoTimeStamp": {
      "format": "float",
      "description": "the timestamp(in seconds) set for the in-video quiz",
      "maximum": 2147483647,
      "minimum": 0,
      "type": "number"
    },
    "createdDate": {
      "format": "date-time",
      "description": "time when this question is created.",
      "type": "string"
    },
    "lastUpdatedBy": {
      "description": "Name of the user who modified the question last time",
      "type": "string"
    },
    "lastUpdatedDate": {
      "format": "date-time",
      "description": "Last time this question is modified",
      "type": "string"
    }
  }
}

400 Bad Request

Bad Request

Representations

{
  "type": "string"
}
string
{
  "type": "string"
}
string
{
  "type": "string"
}

403 Forbidden

Login user not authorized to perform this action

Representations

{
  "type": "string"
}
string
{
  "type": "string"
}
string
{
  "type": "string"
}

404 Not Found

Not Found

Representations

{
  "type": "string"
}
string
{
  "type": "string"
}
string
{
  "type": "string"
}

500 Internal Server Error

Server Error

Representations

{
  "type": "string"
}
string
{
  "type": "string"
}
string
{
  "type": "string"
}

Code samples

@ECHO OFF

curl -v -X POST "https://luminus.azure-api.net/bank/Question/Choice"
-H "Content-Type: application/json-patch+json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://luminus.azure-api.net/bank/Question/Choice?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://luminus.azure-api.net/bank/Question/Choice");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json-patch+json");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://luminus.azure-api.net/bank/Question/Choice?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json-patch+json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://luminus.azure-api.net/bank/Question/Choice";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json-patch+json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://luminus.azure-api.net/bank/Question/Choice');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('luminus.azure-api.net')
    conn.request("POST", "/bank/Question/Choice?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('luminus.azure-api.net')
    conn.request("POST", "/bank/Question/Choice?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://luminus.azure-api.net/bank/Question/Choice')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json-patch+json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body