Assessments

This part of the guide is under development. Please refer to the Assessments section of the old guide for more information.

Assessment Methods

method GetAssessment (Assessment_ID string) returns Assessment
method GetAssessmentList () returns AssessmentList
method GetAssessmentListByAdministrator (Administrator_ID string) returns AssessmentList
method GetAssessmentListByGroup (Group_ID string) returns AssessmentList
method GetAssessmentReportedTopics (Assessment_ID string) returns TopicList

Returns a list with the full details of all the topics that are reported on in this assessment.

method DeleteAssessment (Assessment_ID string)

Assessment Folders

method CreateAssessmentFolder (AssessmentFolder AssessmentFolder) returns string
method GetAssessmentTreeByAdministrator (Administrator_ID string, Parent_ID string, OnlyRunFromIntegration int) returns AssessmentTreeItemList

Assessment Definitions

method CreateAssessmentDefinition (AssessmentDefinition AssessmentDefinition) returns string
method GetAssessmentDefinition (Assessment_ID string) returns AssessmentDefinition
method SetAssessmentDefinition (AssessmentDefinition AssessmentDefinition)

Misc Methods

method ConfirmAssessmentDownload (Schedule_ID string) returns int

Assessment Types

complexType Assessment
Assessment_ID string optional
Revision int required
Session_Name string optional
Author string optional
Save_Answers boolean required
Save_Answer_Data boolean required
Open_Session boolean required
Session_Password string optional
Session_Timed boolean required
Time_Limit int required
Template_Name string optional
When_Feedback int required
End_Feedback int required
Exclude_Unscored boolean required
Folder_ID int optional
Lang string optional
Description string optional
Monitored int required
Editor string optional
Version string optional
Permit_External_Call boolean required
Created_Date string optional
Modified_Date string optional
complexType AssessmentList

Element containing a list of Assessment elements.

Assessment Assessment unbounded optional
complexType AssessmentDefinition
Assessment Assessment optional
AssessmentBlockList AssessmentBlockList optional
AssessmentOutcomeList AssessmentOutcomeList optional
complexType AssessmentBlock
Block_Name string optional
Feedback boolean required
Shuffle_Questions boolean required
Suspend_Time_Limit boolean required
Use_Template_File boolean required
Template_Name string optional
Introduction_Text string optional
ItemList ItemList optional
complexType AssessmentBlockList
AssessmentBlock AssessmentBlock unbounded optional
complexType Item
Method int required
Include_Sub_Topics boolean required
Topic_ID string optional
Number_Of_Questions int required
Question_ID string optional
complexType ItemList
Item Item unbounded optional
complexType AssessmentOutcome
Outcome_Name string optional
Session_Score boolean required
Topic_Scores boolean required
Topic_Feedback boolean required
Branch int required
Assessment_ID string optional
Destination string optional
Message string optional
Min_Percent int required
Max_Percent int required
complexType AssessmentOutcomeList
AssessmentOutcome AssessmentOutcome unbounded optional
complexType AssessmentFolder
ID string optional
Name string optional
Description string optional
Parent_ID string optional
complexType AssessmentTreeItem
ID string optional
Type int required
Name string optional
Parent_ID string optional
complexType AssessmentTreeItemList
AssessmentTreeItem AssessmentTreeItem unbounded optional
complexType Topic

The XML datatype representing a Topic.

In most cases the fields returned are simply the values from associated record in the Q_Topic_Ex table in the underlying data model.

Topic_ID string optional

See Q_Topic_Ex.Topic_ID.

Parent_ID string optional

See Q_Topic_Ex.Parent_ID.

Topic_Name string optional

See Q_Topic_Ex.Name.

Topic_Description string optional

See Q_Topic_Ex.Description.

ScoreBandList ScoreBandList optional

Information expanded from the related Q_ScoreBand_Ex.

complexType TopicList

Element that contains a list of Topics.

Topic Topic unbounded optional
complexType ScoreBandList

Element containing a list of ScoreBand elements.

ScoreBand ScoreBand unbounded optional
complexType ScoreBand

The XML datatype representing a ScoreBand.

In most cases the fields returned are simply the values from the associated record in the Q_ScoreBand_Ex table in the underlying data model.

Name string optional

See Q_ScoreBand_Ex.Name.

Min_Score double required

See Q_ScoreBand_Ex.Min_Score.

Max_Score double required

See Q_ScoreBand_Ex.Max_Score.

Message string optional

See Q_ScoreBand_Ex.Message.