Assessment

Assessments Assessment

Methods Supported:

• GET – feed is read only

Filters supported:

• ID – primary key

• Name – assessment name

Expansions supported:

• Results – expands the associated Results

The Assessments feed provides information about the assessment catalog. That is, all the assessments that have been published for delivery.

EntityType: Assessment

Assessment entities are drawn from S_Header_Ex in the data model but contains only a subset of the properties. They are read only in OData.

Entity Key: ID Edm.Int64 NOT NULL

The full ID of the assessment, see S_Header_Ex.Session_MID for details of the underlying representation in the data model.

Warning

when serialised to JSON format, 64-bit integers are converted to strings, even though they are still correctly identified as 64-bit integers in the metadata model. OData aware tools should correctly convert to a native integer type but if you are parsing the JSON directly then you should be aware that these strings differ from the string representation used for the same ID when used in QMWISe methods. For details see Assessment IDs.

Revision Edm.Int32 NOT NULL

See S_Header_Ex.Revision.

Name Edm.String

See S_Header_Ex.Session_Name.

Language Edm.String

See S_Header_Ex.Lang.

Description Edm.String

See S_Header_Ex.Description.

Author Edm.String

See S_Header_Ex.Author.

CreatedDateTime Edm.DateTime NOT NULL

See S_Header_Ex.Created_Date.

Editor Edm.String

See S_Header_Ex.Editor.

ModifiedDateTime Edm.DateTime NOT NULL

See S_Header_Ex.Modified_Date.

Base Edm.Boolean NOT NULL

See S_Header_Ex.Base.

TimeLimit Edm.Int32

See S_Header_Ex.Time_Limit.

New in version 2019.02.

IsSecure Edm.Boolean NOT NULL

A boolean indicating whether or not the author of the assessment has designated this assessment as for secure delivery only. Assessment entities with this flag set to True will not be available for scheduling (through the portal user interface) with a MonitoringType that does not require use of Questionmark Secure.

New in version 2020.08.

SaveAnswers Edm.Boolean NOT NULL

A boolean indicating whether or not this assessment is configured to save answers during delivery. Assessments with this flag set to False must not be used with the Schedule entity.

New in version 2020.08.

RulesOfConductID Edm.Int32

The ID of an associated RulesOfConduct entity. See Assessment.RulesOfConduct for more information.

New in version 2021.08.

Type Edm.Int16

Reserved for future use.

AssessmentOutcomes AssessmentOutcome Collection

Navigation property to the collection of AssessmentOutcomes possible for this Assessment.

New in version 2020.08.

AssessmentTranslations AssessmentTranslation Collection

Navigation property to the collection of AssessmentTranslations of this (base language) Assessment.

New in version 2018.12.

AssessmentSnapshots AssessmentSnapshot Collection

Navigation property to the collection of AssessmentSnapshots created from this Assessment.

New in version 2020.02.

Results Result Collection

Navigation property to the collection of result entities associated with this assessment.

Groups Group Collection

New in version 2017.11.

Navigation property to the collection of Group entities associated with this assessment. Assessments are associated with groups through the concept of “Scheduling Permissions” that are set on Published Assessments. By assigning a group to an assessment you enable (administrator) members of that group to create schedules for that assessment.

These associations are used by the QMWISe method GetAssessmentListByAdministrator to determine which assessments are returned. This constrasts with the author-centric associations returned by GetAssessmentTreeByAdministrator that are not available through OData.

This relationship is represented in the model by G_Session.

RulesOfConduct RulesOfConduct

Navigation property to an optional RulesOfConduct entity associated with this assessment. When scheduling this assessment the associated rules of conduct are used instead of the default rules defined by the MonitoringType used. These rules may themselves be overridden in the Schedule entity itself.

New in version 2021.08.

EntityType: AssessmentOutcome

An AssessmentOutcome is a defined score band associated with an assessment.

New in version 2020.08.

Entity Key: ID Edm.Int64 NOT NULL

The full ID of the assessment related to this outcome, see Assessment.ID for details.

Entity Key: ScoreBandNumber Edm.Int32 NOT NULL

The number of the outcome (score band), unique within each Assessment.

AssessmentName Edm.String

The name of the related Assessment.

ScoreBandTitle Edm.String

The title of this outcome, for example “Pass” or “Fail”.

Assessment Assessment NOT NULL

Navigation property to the Assessment.

EntityType: AssessmentTranslation

Entity Key: ID Edm.Int64 NOT NULL

The ID of the Assessment that this is a translation of.

Entity Key: Language Edm.String NOT NULL

The language this translation is represented by.

Revision Edm.Int32 NOT NULL

The revision of the Assessment that was translated.

Name Edm.String

The translated name of the Assessment.

Author Edm.String

The name of the user that created this translation.

CreatedDateTime Edm.DateTime NOT NULL

The date and time this translation was created.

Editor Edm.String

The name of the user that last modified this translation.

ModifiedDateTime Edm.DateTime NOT NULL

The date and time this translation was last modified.

TimeLimit Edm.Int32

Reserved for future use.

Assessment Assessment

A navigation property to the base language version of the assessment.