Assessments are the objects in Brillium that represents tests, quizzes, exams, and surveys. They are grouped within a Workspace, much like a file folder, to apply common settings, but may be viewed and accessed by users working within other Workspaces when they have appropriate privileges.
Each assessment may have any number of Topics, but requires a minimum of one.
| Property | Type | Description |
| Keys | ||
Id | String | The unique identifier for an assessment. It may be a maximum of 25 characters in length. |
AccountId | String | The Id of the Workspace the assessment resides within. |
| Scalar Properties | ||
Active | String | The availability state of the assessment; Enabled, Disabled or Archived. |
AllowPrintCopy | String | The “Allow Printing Copy Before Start” property for the assessment. |
AllowRetakes | String | The “Retakes Allowed” property for the assessment. |
AllowSaveInfo | String | The “Show Save Login Information Checkbox” property for the assessment. |
Anonymous | String | The “Anonymous” property for an Assessment; No, YesWithoutCustomFields, YesWithCustomFields |
AnswersRequired | String | The “Require Respondents to Answer” property for the assessment; None, SurveyTypeQuestions, TestTypeQuestions, AllQuestions. |
AppIntegration | String | The application integration set for the assessment; None, FormPOST, QueryString, CourseModule, AICCPassFail, SCORM |
CertificateId | Integer | The Id for the certificate being issued for the assessment, if any. |
CertificateIssued | String | The “Certificate Presentation” setting for the Assessment; None, DisplayIfPassed, EmailIfPassed, DisplayEmailIfPassed, Display, Email, DisplayEmail |
DateCreated | Date | The date the assessment was created. |
DateEnd | Date | The end date for the assessment availability window. |
DateModified | Date | The date the assessment was last modified. |
DateStart | Date | The start date for the assessment availability window |
ExplanationLabel | String | The text used for the explanation header label for the assessment. |
GroupPresentation | String | The “Topic Presentation” property for the assessment; Sequential, Random, RandomTotalQuestions |
HoursBetweenRetakes | Integer | The “Minimum Hours Between Retakes” property for the assessment. |
LogoUrl | String | The URI for the logo of the account the assessment belongs to. |
LogoutButtonLabel | String | The text used for the logout button label for the assessment. |
MaxRetakes | The “Maximum Retakes” property for the assessment. | |
MD5Password | String | The MD5 password on the assessment, if any. |
Mode | String | The presentation mode for the assessment; Normal, ForwardOnly, InstructionalReview, NormalNoMarking, BranchingForwardOnly |
Name | String | The name of the assessment. It may be a maximum length of 100 characters. |
NotifyNewResults | String | The “Notify Administrators of New Results” property for the assessment; Yes, No. |
PassingScore | Integer | The passing score for the assessment. |
Password | String | The assessment’s password. It may be a maximum length of 100 characters. |
PostLinkUrl | String | The URI used as the “Link After Assessment” for the assessment. |
ProctorRequired | String | Whether or not a proctor is required for the assessment; Yes, No. |
QuestionCount | Integer | The number of questions in the assessment. |
QuestionsPerPage | Integer | The “Number of Questions Per Page” property for the assessment. |
RespondentCount | Integer | The number of respondents for the assessment. |
ResultSendMethod | String | The “Result Send Method” set for the assessment; None, BlindPost, or PostAndReturn. |
ResultSendUrl | String | The “Result Send URL” set for the assessment. |
ScalePoints | Integer | The number of points set to scale the assessment. |
TimeAllowed | Integer | The “Time Allowed” property for the assessment in seconds. |
ViewEmailResults | String | The “Allow Emailing Results to Respondent” property for the assessment; Yes, No. |
ViewScore | String | The “Show Grade/Score After Assessment” property for the assessment; None, AllScores, FinalScore, GroupScores. NOTE: GroupSCores refers to Topic Scores |
ViewReview | String | The “Show Review After Assessment” property for the assessment; Yes, No, YesIfPassed. |
ViewReviewAnswers | String | The “On the Review Show Answers” property for the assessment; QuestionsExplanations, QuestionsAnswersExplanations, Explanations. |
ViewReviewQuestions | String | The “On the Review Show Answers” property for the assessment; IncorrectQuestions, TestTypeQuestions, SurveyTypeQuestions, AllQuestions. |
| 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. |
Assessment API Calls
Retrieving a Single Assessment
The following API call will retrieve a single Assessment based on the Id provided.
{brillium_base_uri}/api/Assessments/{assessment_id}Retrieving All Assessments for an Tenant
The following API call will retrieve all Assessments for an Brillium Tenant.
{brillium_base_uri}/api/AssessmentsRetrieving All Questions for an Assessment
The following API call will retrieve all Questions for an Assessment.
{brillium_base_uri}/api/Assessments/{assessment_id}/QuestionsRetrieving All Question Groups for an Assessment
The following API call will retrieve all Question Groups for an Assessment.
{brillium_base_uri}/api/Assessments/{assessment_id}/QuestionGroupsRetrieving All Respondents for an Assessment
The following API call will retrieve all Respondents for an Assessment.
{brillium_base_uri}/api/Assessments/{assessment_id}/RespondentsRetrieving a Single Respondent by Primary Key for an Assessment
The following API call will retrieve a single Respondent for an Assessment, using the primary key.
{brillium_base_uri}/api/Assessments/{assessment_id}/Respondents/{primary_key}Retrieving All Incomplete Respondents for an Assessment
The following API call will retrieve all incomplete Respondents for an Assessment.
{brillium_base_uri}/api/Assessments/{assessment_id}/IncompletesRetrieving All Invitations for an Assessment
The following API call will retrieve all Invitations for an Assessment.
{brillium_base_uri}/api/Assessments/{assessment_id}/InvitationsRetrieving All Invitations for a given Email Address for an Assessment
The following API call will retrieve all Invitations for a given email address for an Assessment.
{brillium_base_uri}/api/Assessments/{assessment_id}/Invitations/{email_address}Sample – HTTP GET
GET https://supersuds.brillium.com/api/AssessmentsSample – JSON Response
{
"Assessments": [
{
"Id": "COURSE1123",
"AccountId": "SUPERSUDS",
"Name": "COURSE 1123 EXAM",
"Password": "******",
"Anonymous": "No",
"Mode": "Normal",
"Active": "Enabled",
"DateStart": "2000-01-01T04:00:00-05:00",
"DateEnd": "3000-12-31T16:59:59-05:00",
"QuestionCount": 14,
"RespondentCount": 44,
"PassingScore": 60,
"ScalePoints": 0,
"LogoUrl": "images\/BrilliumLogo_Demonstration.gif",
"PostLinkUrl": "",
"ResultSendMethod": "None",
"ResultSendUrl": "",
"AppIntegration": "None",
"MD5Password": "",
"LogoutButtonLabel": "Logout",
"ExplanationLabel": "Reference",
"ViewScore": "AllScores",
"ViewReview": "Yes",
"ViewReviewQuestions": "AllQuestions",
"ViewReviewAnswers": "QuestionsAnswersExplanations",
"ViewEmailResults": "Yes",
"AllowRetakes": "YesToMaximum",
"MaxRetakes": 999,
"HoursBetweenRetakes": 0,
"NotifyNewResults": "Yes",
"GroupPresentation": "Sequential",
"QuestionsPerPage": 1,
"AnswersRequired": "SurveyTypeQuestions",
"AllowSaveInfo": "Yes",
"AllowPrintCopy": "Yes",
"TimeAllowed": 0,
"ProctorRequired": "No",
"CertificateIssued": 0,
"CertificateId": 0,
"DateCreated": "2002-02-21T14:30:32-05:00",
"DateModified": "2009-02-11T14:58:20-05:00",
"Uri": "https:\/\/supersuds.brillium.com\/api\/Assessments\/COURSE1123",
"RelatedUris": {
"QuestionGroups":
"https:\/\/supersuds.brillium.com\/api\/Assessments\/COURSE1123\/QuestionGroups",
"Questions":
"https:\/\/supersuds.brillium.com\/api\/Assessments\/COURSE1123\/Questions",
"Respondents":
"https:\/\/supersuds.brillium.com\/api\/Assessments\/COURSE1123\/Respondents",
"Incompletes":
"https:\/\/supersuds.brillium.com\/api\/Assessments\/COURSE1123\/Incompletes",
"Invitations":
"https:\/\/supersuds.brillium.com\/api\/Assessments\/COURSE1123\/Invitations"
}
}
],
"Page": 1,
"PageSize": 50,
"TotalCount": 1,
"HasMore": false
}