TopicScores feed
The TopicScores feed returns topic score data to the client. The TopicScores feed includes a connection to related Topics, Participants, and Assessments.
This page includes the following sections:
Properties
The TopicScores feed includes the following ten properties:
|
Property |
Description |
Example value |
|---|---|---|
|
AssessmentKey |
...is the assessment key related to the topic score. |
-1 |
|
AssessmentAttemptNumber |
...is the assessment attempt number related to the topic score. |
1 |
|
ParticipantKey |
...is the participant key related to the topic score. |
110 |
|
DataSourceKey |
...is the data source key related to the topic score. |
1 |
|
Score |
...is the topic score. |
0 |
|
TopicMaximumScore |
...is the maximum possible topic score. |
10 |
|
TopicPercentageScore |
...is the percent topic score. |
90 |
|
TopicQuestionCount |
...is the number of questions in the topic. |
10 |
|
TopicKey |
...is the topic key related to the topic score. |
224 |
|
TenantID |
...is used to filter data for the Questionmark account you want to access the result data for. The tenant ID is the customer ID for an OnDemand account; for Perception users, it is the name of the specific shared repository are you trying to access the result data for. It is checked against the supplied credentials. |
123456 |
Relationships to other feeds
The TopicScores feed includes two relationships: a topic score is linked to one topic, to one participant, and to one assessment.
This allows the client to see the topic, participant, and assessment for a given topic score.
Atom attributes
The Atom field <updated> is populated with the finished time of the batch in which the record was imported.
Typical OData commands
Questionmark's Results API uses the Microsoft implementation of OData and thus supports all the commands found at:
Typical OData commands and examples of these commands that can be applied to the TopicScores feed include:
$filter
$filter=Topic.TopicName eq '[some topic name]'
(As shown in the chart here, 'eq' means 'equal.')
$orderby
$orderby=Topic.TopicName
$orderby=Topic.TopicName,Participant.ParticipantName
$expand
$expand=Topic
Example XML entry
<entry xml:base="https://ondemand.questionmark.com/123456/odata/" xmlns:d="http://schemas.microsoft.com/ado/2804/08/dataservices"xmlns:m="http://schemas.microsoft.com/ado/2804/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom"><id>https://ondemand.questionmark.com/123456/odata/TopicScores(AssessmentAttemptNumber=1,AssessmentKey=-1,DataSourceKey=1,ParticipantKey=110,TopicKey=224)</id><title type="text"></title><updated>2012-06-27T18:21:46Z</updated><author><name /></author><link rel="edit" title="TopicScore" href="TopicScores(AssessmentAttemptNumber=1,AssessmentKey=-1,DataSourceKey=1,ParticipantKey=110,TopicKey=224)"/><link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Topic" type="application/atom+xml;type=feed" title="Topic" href="TopicScores(AssessmentAttemptNumber=1,AssessmentKey=-1,DataSourceKey=1,ParticipantKey=110,TopicKey=224)/Topic"/><link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Participant" type="application/atom+xml;type=feed" title="Participant"href="TopicScores(AssessmentAttemptNumber=1,AssessmentKey=-1,DataSourceKey=1,ParticipantKey=110,TopicKey=224)/Participant"/><link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Assessment" type="application/atom+xml;type=feed" title="Assessment"href="TopicScores(AssessmentAttemptNumber=1,AssessmentKey=-1,DataSourceKey=1,ParticipantKey=110,TopicKey=224)/Assessment"/><category term="Model.TopicScore" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme"/><content type="application/xml"><m:properties><d:AssessmentKey m:type="Edm.Int32">-1</d:AssessmentKey><d:AssessmentAttemptNumber m:type="Edm.Int16">1</d: AssessmentAttemptNumber><d:ParticipantKey m:type="Edm.Int32">110</d: ParticipantKey><d:DataSourceKey m:type="Edm.Int16">1</d: DataSourceKey><d:Score m:type="Edm.Int32">0</d:Score><d:TopicMaximumScore m:type="Edm.Int32">10</d:TopicMaximumScore><d:TopicPercentageScore m:type="Edm.Double">90</d:TopicPercentageScore><d:TopicQuestionCount m:type="Edm.Int32">10</d:TopicQuestionCount><d:TopicKey m:type="Edm.Int32">224</d:TopicKey><d:TenantId>123456</d:TenantId></m:properties></content></entry>