Results feed
The Results feed returns result data to the client. The Results feed includes a connection to related Participants, Groups, Answers, and Assessments.
This page includes the following sections:
Properties
The Results feed includes the following twenty-eight properties:
|
Property |
Description |
Example value |
|---|---|---|
|
DataSourceKey |
...is part one of the primary identifier for a result. |
1 |
|
AssessmentKey |
...is part two of the primary identifier for a result. |
-1 |
|
ParticipantKey |
...is part three of the primary identifier for a result. |
60 |
|
AssessmentAttemptNumber |
...is part four of the primary identifier for a result. |
1 |
|
PerceptionResultID |
...is the Questionmark result ID associated with a result. |
2107850872 |
|
ResultTotalScore |
...is the total score the participant received for this attempt at this assessment. |
7 |
|
ResultPercentageScore |
...is the total score expressed as a percentage. |
87.5 |
|
ResultResponseTimeSecond |
...is the total time (in seconds) it took for this participant to complete this attempt at this assessment. |
99 |
|
GroupGroupKey |
...is the field connecting this result to a group that the participant was part of when they took this attempt at this assessment. |
-1 |
|
AssessmentName |
...is the name of the assessment. |
Canadian provinces test |
|
ResultStatus |
...is whether the result represents a completed assessment or not. |
Finished OK |
|
ScorebandName |
...is the name of the scoreband that this result falls in. The scoreband name typically has words like "failed," "passed," and so on in it. |
Passed |
|
ScorebandUpperLimit |
...is the upper score band limit for the result. |
100 |
|
ScorebandLowerLimit |
...is the lower score band limit for the result, and indicates the score required for the result to fall in the scoreband. |
50 |
|
ResultStartUtc |
...is when the participant started this attempt for this assessment, recorded in the UTC timezone. |
2012-02-29T00:11:42 |
|
ResultFinishedUtc |
...is when the participant ended this attempt for this assessment, recorded in the UTC timezone. |
2012-02-29T00:13:21 |
|
ResultStartLocal |
...is when the participant started this attempt for this assessment, recorded in the participant's local timezone. |
2012-02-29T05:11:42 |
|
ResultFinishedLocal |
...is when the participant ended this attempt for this assessment, recorded in the participant's local timezone. |
2012-02-29T05:13:21 |
|
SpecialField1 |
...is the user-defined data field 1. |
British Columbia |
|
SpecialField2 |
...is the user-defined data field 2. |
Alberta |
|
SpecialField3 |
...is the user-defined data field 3. |
Saskatchewan |
|
SpecialField4 |
...is the user-defined data field 4. |
Manitoba |
|
SpecialField5 |
...is the user-defined data field 5. |
Ontario |
|
SpecialField6 |
...is the user-defined data field 6. |
Quebec |
|
SpecialField7 |
...is the user-defined data field 7. |
Newfoundland |
|
SpecialField8 |
...is the user-defined data field 8. |
P.E.I. |
|
SpecialField9 |
...is the user-defined data field 9. |
Nova Scotia |
|
SpecialField10 |
...is the user-defined data field 10. |
New Brunswick |
|
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 |
|
FolderPath |
...is the assessment's folder path associated with a result. |
Tests\Quizzes\First Semester |
Relationships to other feeds
The Results feed includes four relationships: a result can be linked to zero-or-one participants, one assessment, one answer, and to zero-or-one groups.
This allows the client to see the participant, assessment, and group details for a given result.
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 Results feed include:
$filter
$filter=Group/GroupName eq '<group name>'
...where <group name> is the name of a group you want to filter by.
$filter=AssessmentName eq '<assessment name>'
$filter=SpecialField1 eq '<some value>'
$filter=ResultPercentageScore ge <some value>
(As shown in the chart here, 'eq' means 'equal,' and 'ge' means 'greater than or equal.')
$orderby
$orderby=Participant/ParticipantName,AssessmentAttemptNumber
$orderby=AssessmentName,Participant/ParticipantName,AssessmentAttemptNumber
$expand
$expand=Participant
$expand=Group
Example XML entry
The following is an example of an entry from a response to a request to the Results feed:
<entry xml:base="https://ondemand.questionmark.com/123456/odata/" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom"><id>https://ondemand.questionmark.com/123456/odata/Results(2107850872)</id><title type="text" /><updated>2011-06-24T15:20:27-04:00</updated><author><name /></author><link rel="edit" title="Result" href="Results(2107850872)"/><link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Group" type="application/atom+xml;type=entry" title="Group" href="Results(2107850872)/Group" /><link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Participant" type="application/atom+xml;type=entry" title="Participant" href="Results(2107850872)" /><link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Assessment" type="application/atom+xml;type=entry" title="Assessment" href="Results(2107850872)/Assessment" /><link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Answers" type="application/atom+xml;type=entry" title="Answers" href="Results(2107850872)/Answers" /><category term="Model.Result" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme"/><content type="application/xml"><m:properties><d:DataSourceKey m:type="Edm.Int16">1</d:DataSourceKey><d:AssessmentKey m:type="Edm.Int32">-1</d:AssessmentKey><d:ParticipantKey m:type="Edm.Int32">60</d:ParticipantKey><d:AssessmentAttemptNumber m:type="Edm.Int32">1</d:AssessmentAttemptNumber><d:PerceptionResultId m:type="Edm.Int32">21078508721</d:PerceptionResultId><d:ResultTotalScore m:type="Edm.Int32">7</d:ResultTotalScore><d:ResultPercentageScore m:type="Edm.Double">87.5</d:ResultPercentageScore><d:ResultResponseTimeSeconds m:type="Edm.Int32">99</d:ResultResponseTimeSeconds><d:GroupGroupKey m:type="Edm.Int32">-1</d:GroupGroupKey><d:AssessmentName>Canadian provinces test</d:AssessmentName><d:ResultStatus>Finished OK</d:ResultStatus><d:ScorebandName>Passed</d:ScorebandName><d:ScorebandUpperLimit m:type="Edm.Double">100</d:ScorebandUpperLimit><d:ScorebandLowerLimit m:type="Edm.Double">50</d:ScorebandLowerLimit><d:ResultStartUtc m:type="Edm.DateTime">2012-02-29T00:11:42</d:ResultStartUtc><d:ResultFinishedUtc m:type="Edm.DateTime">2012-02-29T00:13:21</d:ResultFinishedUtc><d:ResultStartLocal m:type="Edm.DateTime">2012-02-29T05:11:42</d:ResultStartLocal><d:ResultFinishedLocal m:type="Edm.DateTime">2012-02-29T05:13:21</d:ResultFinishedLocal><d:SpecialField1>British Columbia</d:SpecialField1><d:SpecialField2>Alberta</d:SpecialField2><d:SpecialField3>Saskatchewan</d:SpecialField3><d:SpecialField4>Manitoba</d:SpecialField4><d:SpecialField5>Ontario</d:SpecialField5><d:SpecialField6>Quebec</d:SpecialField6><d:SpecialField7>Newfoundland</d:SpecialField7><d:SpecialField8>P.E.I.</d:SpecialField8><d:SpecialField9>Nova Scotia</d:SpecialField9><d:SpecialField10>New Brunwsick</d:SpecialField10><d:TenantId>123456</d:TenantId><d:FolderPath>Tests\Quizzes\First semester</d:FolderPath></m:properties></content></entry>