ScoringTask, ScoringResult and DimensionScore

For a worked example of using these entities to set scores for unscored responses please refer to Subjective Scoring.

ScoringTasks ScoringTask
Methods Supported:

  • GET – for reading scoring tasks

  • PUT – for updating the status of a scoring task

Filters supported:

  • QuestionID – the question being answered

  • ResultID – the result that generated the scoring task

  • Status – the status of the scoring task

Expansions supported:

  • Assessment – expands the assessment that was being taken

  • Question – expands the question that was answered

  • Result – expands the result that generated the scoring task

  • Answer – expands the answer that generated the scoring task

  • Group – expands the optional Group related to this task

  • ScoringResult – use with caution, see ScoringTask.ScoringResult for details

The ScoringTasks feed contains one entity for each Answer that requires subjective scoring. The scores actually awarded are in the associated ScoringResult.

ScoringResults ScoringResult
Methods Supported:

  • GET – for reading scoring results

  • PUT – for updating the score

Filters supported:

  • QuestionID – the question being answered

  • ResultID – the result that generated the scoring task

Expansions supported:

  • ScoringTask – the task

  • Rubric – the scoring rules

  • DimensionScores – the individual dimension scores

The Scoring Results feed contains the scores awarded by subjective marking. ScoringResults are associated with ScoringTasks.

DimensionScores DimensionScore
Methods Supported:

  • GET – for reading individual scores

  • PUT – for updating the scores

Filters supported:

  • QuestionID – note that ordering is not supported

  • Order – supports $orderby only, cannot be used as a filter

Expansions supported:

  • Rubric – expands the associated Rubric

  • Dimension – expands the Dimension of the Rubric

The DimensionScores feed contains information about the actual scores awarded to an answer by a subjective marking process on a per-dimension basis.

EntityType: ScoringTask

A ScoringTask is created each time a participant submits an answer to an unscored question.

ScoringTasks are keyed on a tuple of (QuestionID, ResultID). On their own these values are insufficient to identify an answer record uniquely because a participant may answer the same question multiple times in a single assessment (but not twice in the same block). The lack of an Answer.BlockNumber property means that, for the purposes of subjective scoring, an assessment must contain no more than one instance of each unscored question. Assessments that do not satisfy this constraint cannot be subjectively marked. In practice, this is not a significant limitation.

Entity Key: QuestionID Edm.Int64 NOT NULL

The identifier of the question that the participant’s answer was a response to. The Question navigation property provides a more convenient way to obtain the associated question entity.

Entity Key: ResultID Edm.Int32 NOT NULL

The identifier of the result record that contains the answer. The Result navigation property provides a more convenient way to obtain the associated result entity.

Status Edm.Int32 NOT NULL

The status of this task:

0 Unscored

1 Locked: in this state the task cannot be scored in the

native scoring tool in Enterprise Manager

2 Saved: indicates that some scores have been recorded but

the scoring process is not yet complete.

3 Scored: indicates that the scores have been finalised

for this task.

The value of this property can be updated using the PUT method on the entity.

Question Question

A navigation property to the question the participant answered.

Result Result

A navigation property to the result associated with the participant’s answer.

Group Group

A navigation property to the optional group that provides a context for the participant’s result. For example, if the result was generated from an assessment scheduled to a group of participants the group will be available here.

Assessment Assessment

A navigation property to the assessment the participant was taking when they answered the question.

ScoringResult ScoringResult Collection

A navigation property to the entity representing the scores awarded to the participant by the external marking process. Although this navigation property yields a collection there can be at most one scoring result associated with a scoring task.

The ScoringResult is created automatically the first time this collection is retrieved.

Warning

if you expand this navigation property the API will yield an empty collection if the ScoringResult has not yet been created. To ensure that the entity is created you must load this collection directly, e.g.:

deliveryodata/123456/ScoringTask(...)/ScoringResult

The brackets would contain the key identifying the ScoringTask entity and have been omitted in the example to improve readability.

The Question that generated the answer MUST be associated with a rubric before any ScoringResults can be created. Failure to obtain a ScoringResult entity for a ScoringTask usually indicates that the Question has not yet been associated with a Rubric.

Answer Answer Collection

A navigation property to the entity representing the participant’s answer. Although defined as a collection there will always be a single Answer entity associated with each ScoringTask.

EntityType: ScoringResult

Results are scored using ScoringResult entities. These entities are created automatically as required when the navigation collection of the associated ScoringTask is retrieved. See ScoringTask.ScoringResult for details.

The data exposed by this entity is stored in the ST_RUBRICSCORES table in the data model.

Entity Key: QuestionID Edm.Int64 NOT NULL

The identifier of the question - used as part of the key required to identify the associated ScoringTask.

Entity Key: ResultID Edm.Int32 NOT NULL

The identifier of the result - used as part of the key required to identify the associated ScoringTask.

Entity Key: RubricID Edm.Int32 NOT NULL

The identifier of the Rubric that defines the rules for scoring the participants response. This property is part of the key of the entity and, hence, the question that generated a ScoringTask must have an associated rubric before a ScoringResult entity can be created to score it.

Score Edm.Int32

The total score for the question awarded to the participant. This property can be updated using the PUT method on the entity. The score must be calculated externally and should be equal to the sum of the individual DimensionScores. This constraint is not checked by the API, it is recommended that when updating scores you use the PUT method to update individual DimensionScores first and then calculate the total and update this property of the ScoringTask.

When the ScoringTask is finalised (status is set to Scored) then this is the value that is used to update the score in the Answer entity and the corresponding result.

Comments Edm.String

A text string containing comments from the person or system doing the scoring.

Annotated Edm.String

An annotated version of the participant’s answer as an HTML fragment. See ST_RUBRICSCORES.ST_ANNOTATED for more information about this field.

CreatedDateTime Edm.DateTime NOT NULL

A time stamp of when the entity was created. Set automatically, it cannot be modified.

ModifiedDateTime Edm.DateTime NOT NULL

A time stamp of when the entity was last modified.

Note

when updating the score, you must PUT the updated entity with the same ModifiedDateTime value as you received when you retrieved the entity. If the ModifiedDateTime date on the server has changed, then you’ll get a contention error and the update will fail (with a 400 series error). In that case you’ll have to retrieve the record again and compare the current values to determine whether to retry or abort. This procedure replaces the concept of “locking” a result for scoring with a form of optimistic concurrency control.

ScoringTask ScoringTask

The ScoringTask that this entity is providing scores for.

Rubric Rubric

The Rubric used to score the participant’s answer.

DimensionScores DimensionScore Collection

A collection of DimensionScores, one per dimension defined by the Rubric.

EntityType: DimensionScore

A DimensionScore is an instance of a score for a specific participant’s result. The entity is created automatically with the associated ScoringResult.

Entity Key: QuestionID Edm.Int64 NOT NULL

The identifier of the question that this score relates to.

Entity Key: ResultID Edm.Int32 NOT NULL

The identifier of the result that was being scored. Together with the QuestionID this identifies the ScoringTask associated with this score.

Entity Key: RubricID Edm.Int32 NOT NULL

The identifier of the rubric containing the dimension being scored.

Entity Key: Order Edm.Int32 NOT NULL

The order number of the dimension being scored within the defining rubric. Together with the RubricID this uniquely identifies the Dimension being scored.

Score Edm.Int16

The score being awarded to this participant for this dimension. This value can be updated using the PUT method on the entity.

Comment Edm.String
ScoringResult Edm.ScoringResult
Dimension Edm.Dimension