Brillium Web API - Assessments – Brillium Support Community

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`.
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/Assessments

Retrieving All Questions for an Assessment

The following API call will retrieve all Questions for an Assessment.

{brillium_base_uri}/api/Assessments/{assessment_id}/Questions

Retrieving 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}/QuestionGroups

Retrieving All Respondents for an Assessment

The following API call will retrieve all Respondents for an Assessment.

{brillium_base_uri}/api/Assessments/{assessment_id}/Respondents

Retrieving 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}/Incompletes

Retrieving All Invitations for an Assessment

The following API call will retrieve all Invitations for an Assessment.

{brillium_base_uri}/api/Assessments/{assessment_id}/Invitations

Retrieving 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/Assessments

Sample – JSON Response

{

  "Assessments": [

    {

      "Id": "COURSE1123",

      "AccountId": "SUPERSUDS",

      "Name": "COURSE 1123 EXAM",

      "Password": "******"

    }

  ],

  "Page": 1,

  "PageSize": 50,

  "TotalCount": 1,

  "HasMore": false

}

Related to