Brillium Web API - Respondents

Views:

Respondents are the people that complete exam, test, quiz, and surveys (i.e. they respond to the questions asked). Each assessment may have any number of respondents. Each respondent may start (begin answering questions) and complete (reach the end of assessment summary screen) an assessment. Respondents associated with an assessment include both incomplete (started but not finished) and complete (started and finished) status.

Respondent Object

Object Properties

Property	Type	Description
Keys
`Id`	Integer	The unique Id for the Respondent
`AssessId`	String	The Assessment Id of the Topic
`ProctorId`	String	The unique Id for the Proctor used in this attempt
Scalar Properties
`Attempt`	Integer	Represents the Respondent assessment attempt
`CourseItemResultId`	Integer	The Course Id related to the result, if any. This only applies to assessments being delivered with the Brillium course module (formerly Brillium Connect).
`CreditUsed`	Boolean	(Deprecated) Usage metric
`Current`	Boolean	Identifies the most recent attempt by the respondent
`Custom[1–20]`	String	The values of the 20 available Respondent fields for the Workspace that the Assessment and Assessment Result resides within. Each Respondent field is precedewd by "Custom" for compatibility across releases. Use “Custom1”, “Custom2”, etc.
`DateFinished`	Date	The date and time the respondent finished the assessment
`DateReStarted`	Date	The date and time the respondent restarted the assessment
`DateStarted`	Date	The date and time the respondent started the assessment
`DemoMode`	Boolean	Indicates that this attempt launched by the Author/Administrator from the Authoring console - “Demo Mode”
`EarnedPoints`	Integer	Total number of points earned by the Respondent on all questions.
`Email`	String	Respondent email address (if applicable)
`EssayCount`	Integer	The number of essays in the assessment for this Respondent.
`EssayPoints`	Integer	Total number of points available for all essay questions appearing on this respondent’s assessment attempt
`FinalScore`	Integer	Respondent’s final score
`FirstName`	String	Respondent first name
`Guid`	String	Respondent unique global identifier.
`LastName`	String	Respondent last name
`Page`	Integer	The current page (or the last page before exiting the assessment if incomplete)
`PassFail`	String	Pass/Fail status
`RawScore`	Integer	Raw score
`ScalePoints`	Integer	The assesment-wide scale score points applied
`StatusCode`	Integer	The current assessment stage (login, confirmation, answering questions, etc.)
`TimesTaken`	Integer	The accumulated number of Respondent attempts
`TimeUsed`	Integer	The Total amount of time for the attempt in seconds
`TotalPages`	Integer	Total number of pages for this attempt
`TotalPoints`	Integer	Total number of achievable points for all assessment questions in this attempt
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.

Respondent API Calls

Retrieving a Single Respondent by Id

The following API call will retrieve a single Respondent Id.

{brillium_base_uri}/api/Respondents/{respondent_id}

Retrieving the Results for a Single Respondent by Id

The following API call will retrieve the results for a single Respondent Id.

{brillium_base_uri}/api/Respondents/{respondent_id}/Results

Retrieving all the Comments for a Single Respondent by Id

The following API call will retrieve the comments for a single Respondent Id

{brillium_base_uri}/api/Respondents/{respondent_id}/Comments

Retrieving the Comments for a particular Question for a Single Respondent Id

The following API call will retrieve the comments for a question ID by Respondent Id.

{brillium_base_uri}/api/Respondents/{respondent_id}/Comments/{question_id}

Retrieving a Single Respondent by GUID

The following API call will retrieve the GUID for a single Respondent based on the Id provided.

{brillium_base_uri}/api/Respondents/{respondent_guid}/Guid

Retrieving all Respondents

The following API call will retrieve all Respondents for a Workspace and all child Workspaces (accessible by the user).

{brillium_base_uri}/api/Respondents

Sample – HTTP GET

GET https://supersuds.brillium.com/api/Respondents/1476

Sample – JSON Response

{
		  "Respondents": [
			{
			  "Id": 1476,
			  "AssessId": "COURSE1123",
			  "FirstName": "JOHN",
			  "LastName": "DOE",
			  "Email": "jdoe1@email.com",
			  "Custom1": "11223344",
			  "Custom2": "Boston",
			  "Custom3": "Joel Wood",
			  "Custom4": "Jane Smith",
			  "Custom5": "",
			  "Custom6": "",
			  "Custom7": "",
			  "Custom8": "",
			  "Custom9": "",
			  "Custom10": "",
			  "Custom11": "",
			  "Custom12": "",
			  "Custom13": "",
			  "Custom14": "",
			  "Custom15": "",
			  "Guid": "2EFEBC6852FF42388E51D12CF8127A0F",
			  "RawScore": 57,
			  "ScalePoints": 23,
			  "FinalScore": 80,
			  "PassFail": "Pass",
			  "StatusCode": 50,
			  "TimesTaken": 2,
			  "TimeUsed": 916,
			  "DateStarted": "2003-10-08T13:56:15-04:00",
			  "DateFinished": "2003-10-08T14:11:31-04:00",
			  "DateRestarted": "1900-01-01T00:00:00-05:00",
			  "EssayCount": 1,
			  "EssayPoints": 1,
			  "TotalPoints": 7,
			  "EarnedPoints": 4,
			  "DemoMode": false,
			  "CreditUsed": true,
			  "ProctorId": "",
			  "CourseItemResultId": 0,
			  "Attempt": 2,
			  "Current": true,
			  "Page": 3,
			  "TotalPages": 3,
			  "Uri": "http:\/\/supersuds.brillium.com\/api\/Respondents\/1476",
			  "RelatedUris": {
				"Results": 
				   "http:\/\/supersuds.brillium.com\/api\/Respondents\/1476\/Results",
				"Comments": 
				   "http:\/\/supersuds.brillium.com\/api\/Respondents\/1476\/Comments"
			  }
			}
		  ],
		  "Page": 1,
		  "PageSize": 50,
		  "TotalCount": 1,
		  "HasMore": false
		}

Keywords: API, developer, reference, respondents API