Brillium Web API - Questions · Community Portal

Views:

Questions are objects related to a specific Topic. Each topic may contain any number of questions. Each question may have a number of related answers. Some question types do not have related answers, such as short answer and essay.

Question Object

Object Properties

Property	Type	Description
Keys
`Id`	Integer	The Id of the Question.
`AssessId`	String	The Assessment Id of the Question
`GroupId`	String	The Question's Topic Id
`OrigQuesId`	String	The Orignal Question Id for a copied Question
Scalar Properties
`AllowComments`	String	The “Allow Comments” property for the Question; Yes, No.
`AnswerPresentation`	String	The “Shuffle Answers” property of the Question; Sequential, Random.
`Answers`	Collection	The collection of the Question’s Answer objects, if any.
`AuthorsNotes`	String	The “Author’s Notes” property of the Question, if any
`CorrectExplanation`	String	The “Explanation (correct)” property of the Question, if any
`IncorrectExplaination`	String	The “Explanation (incorrect)” property of the Question, if any
`Points`	Integer	The number of points assigned to the question.
`ReferenceId`	String	The Question Reference Id
`ResourceUrl`	Integer	The URI for any resource associated with this Question
`Sequence`	Integer	The sequence number of the question within its Topic
`Tags`	Collection	The Question tags associated with the Question, if any
`Text`	String	The Question text
`Type`	String	The Question Type; Unknown, MultipleChoice, TrueFalse, MultipleSelect, Matching, FillIn, Essay, DropdownSelect, NumericFillIn, RankingOrdering, MultipleFillIn, WeightedMultipleChoic, BranchingMultipleChoic, ChooseOne, AgreeDisagree, ExcellentPoor, AllThatApply, ShortAnswer, Opinion, DropdownChoose, Matrix, NetPromoter, StackingNumericRating, StackingDualNumericRating, BranchingChooseOne, TextualContent
Navigation Properties
`Uri`	String	The fully qualified URI for this resource.
`RelatedUris`	String/String Dictionary	The list (dictionary) of related URI’s for this resource.

Question API Calls

Retrieving a Single Question

The following API call will retrieve a single Question by Id.

{brillium_base_uri}/api/Questions/{question_id}

Retrieving a Question’s Results

The following API call will retrieve a Question’s Results based on the Id provided.

{brillium_base_uri}/api/Questions/{question_id}/Results

Retrieving a Question’s Comments

The following API call will retrieve a Question’s Comments based on the Id provided.

{brillium_base_uri}/api/Questions/{question_id}/Comments

Sample – HTTP GET

GET https://subdomain.onlinetests.app/api/Questions/10271

Sample – JSON Response

{
		  "Questions": [
			{
			  "Id": 10271,
			  "AssessId": "COURSE1123",
			  "GroupId": 149,
			  "OrigQuesId": 0,
			  "ReferenceId": "0",
			  "Type": "MultipleChoice",
			  "Sequence": 2,
			  "Points": 1,
			  "ResourceUrl": "",
			  "AllowComments": "Yes",
			  "AnswerPresentation": "Sequential",
			  "Text": "What geographic regions<\/B> currently prohibit the 
					  sales<\/STRONG> of the \"No-Suds\" and \"Color Stay Bleach\"    
					  products?",
			  "CorrectExplanation": "North America.  Currently, the EPA is in the process of  
					  reviewing the chemical agents used in the products, for use in home septic     
					  systems.",
			  "IncorrectExplanation": "North America.  Currently, the EPA is in the process of  
					  reviewing the chemical agents used in the products, for use in home septic 
					  systems.",
			  "AuthorsNotes": "here are some author notes.",
			  "Tags": [
				"addition",
				"testing",
				"subtraction"
			  ],
			  "Answers": [
				
			  ],
			  "Uri": "http:\/\/supersuds.brillium.com\/api\/Questions\/10271",
			  "RelatedUris": {
				"Results": 
				   "http:\/\/supersuds.brillium.com\/api\/Questions\/10271\/Results",
				"Comments": 
				   "http:\/\/supersuds.brillium.com\/api\/Questions\/10271\/Comments"
			  }
			}
		  ],
		  "Page": 1,
		  "PageSize": 50,
		  "TotalCount": 1,
		  "HasMore": false
		}

Keywords: API, developer, reference, questions API

Brillium Web API - Questions