Topics feed | Questionmark

Topics feed

Applies to the following products: 
Questionmark OnDemand
Questionmark Perception
Applies to the following Perception versions: 
Perception 5.7

The Topics feed returns topic data to the client. The Topics feed includes a connection to related TopicScores and Answers.

This page includes the following sections:

Properties

The Topics feed includes the following five properties:

Property

Description

Example value

TopicKey

...is the unique identifier for the record.

18

PerceptionTopicId

...is the Questionmark identifier for the record.

364195446

TopicName

...is the name of the topic.

ARKY 201 course materials

TopicDescription

...is the description of the topic.

Relevant course materials for the B2 section of Archaeology 201

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

TopicPath

...is the topic's folder path.

Archaelogy\Materials\First semester

Relationships to other feeds

The Topics feed includes two relationships: a topic can be linked to zero-or-more topic scores and to zero-or-more answers.

This allows the client to see all topic scores and answer data for a given topic.

Atom attributes

The Atom field <title> is populated with the name of the topic.

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:

OData: URI Conventions

Typical OData commands and examples of these commands that can be applied to the Topics feed include:

$filter

$filter=TopicName eq '[some assessment topic name]'

(As shown in the chart here, 'eq' means 'equal.')

$orderby

$orderby=TopicName

$expand

$expand=TopicScores

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/Topics(18)</id>
<title type="text">ARKY 201 course materials</title>
<updated>2012-06-27T16:56:30Z</updated>
<author>
<name />
</author>
<link rel="edit" title="Topic" href="Topics(18)" />
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/TopicScores" type="application/atom+xml;type=feed" title="TopicScores"
href="Topics(18)/TopicScores" />
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Answers" type="application/atom+xml;type=feed" title="Answers"
href="Topics(18)/Answers" />
<category term="Model.Topic" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<content type="application/xml">
<m:properties>
<d:TopicKey m:type="Edm.Int32">18</d:TopicKey>
<d:PerceptionTopicId m:type="Edm.Int32">364195446</d:PerceptionTopicId>
<d:TopicName>ARKY 201 course materials</d:TopicName>
<d:TopicDescription>Relevant course materials for the B2 section of Archaeology 201</d:TopicDescription>
<d:TenantId>123456</d:TenantId>
<d:TopicPath>Archaelogy\Materials\First semester</d:TopicPath>
</m:properties>
</content>
</entry>