Choices feed
The Choices feed is related to the Questions feed. It returns choice data to the client.
This page includes the following sections:
Properties
The Choices feed includes the following five properties:
|
Property |
Description |
Example value |
|---|---|---|
|
ChoiceKey |
...is the internal choice key. |
1 |
|
ChoiceNumber |
...is the choice number. |
1 |
|
QuestionKey |
...is the internal question key. |
562 |
|
ChoiceText |
...is the text of the choice. |
Strongly Agree |
|
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 Choices feed includes a single relationship: a choice is linked back to the one question to which it refers.
This allows the client to see question data for a given choice.
Atom attributes
The Atom field <title> is populated with the choice text.
The Atom field <updated> is populated with the finished time of the batch in which the record was imported.
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/Choices(ChoiceKey=1,QuestionKey=562)</id><title type="text">Strongly Agree</title><updated>2012-05-18T20:41:21Z</updated><author><name /></author><link rel="edit" title="Choice" href="Choices(ChoiceKey=1,QuestionKey=562)"/><link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Question" type="application/atom+xml;type=entry" title="Question"href="Choices(ChoiceKey=1,QuestionKey=562)/Question" /><category term="Model.Choice" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme"/><content type="application/xml"><m:properties><d:QuestionKey m:type="Edm.Int32">562</d:QuestionKey><d:ChoiceKey m:type="Edm.Int32">1</d:ChoiceKey><d:ChoiceNumber m:type="Edm.Int32">1</d:ChoiceNumber><d:ChoiceText>Strongly Agree</d:ChoiceText><d:TenantId>123456</d:TenantId></m:properties></content></entry>Default rows
The Choices feed include default rows that are used in instances when data from certain records does not have an assigned value. These default rows will appear for questions that don't have applicable choices. To filter out these default rows from any reports you generate, filter to only include records that contain a ChoiceKey with a value greater than 0.
<d:QuestionKey m:type="Edm.Int32">2181</d:QuestionKey><d:ChoiceKey m:type="Edm.Int32">-2</d:ChoiceKey><d:ChoiceNumber m:type="Edm.Int32">1</d:ChoiceNumber><d:ChoiceText><Not applicable></d:ChoiceText><d:TenantId>v5services</d:TenantId>