Participants feed
The Participants feed returns participant data to the client. The Participants feed includes a connection to related Results and TopicScores.
This page includes the following sections:
Properties
The Participants feed includes the following eight properties:
|
Property |
Description |
Example value |
|---|---|---|
|
ParticipantKey |
...is the primary identifier for a participant. |
804 |
|
ParticipantName |
...is the participant name as displayed and used in Questionmark. |
incandenza_h |
|
ParticipantFirstName |
...is the participant's actual first name. |
Hal |
|
ParticipantMiddleName |
...is the participant's actual middle name, if entered. |
James |
|
ParticipantLastName |
...is the participant's actual last name. |
Incandenza |
|
ParticipantDetails |
...are the details about the participant as entered in Questionmark. |
Brother of Mario and Orin |
|
ParticipantRegisteredDate |
...is the date that the participant was registered in Questionmark. |
2011-06-16T05:28:49 |
|
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 Participants feed includes two relationships: a participant can be linked to zero-or-more results and to zero-or-more topic scores.
This allows the client to see all results and topic scores for a given participant.
Atom attributes
The Atom field <title> is populated with the participant name.
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 Participants feed include:
$filter
$filter=ParticipantName eq '<participant name>'
...where <participant name> is the name of a participant you want to filter by.
(As shown in the chart here, 'eq' means 'equal.')
$orderby
$orderby=ParticipantName
$orderby=ParticipantRegisteredDate
$orderby=ParticipantLastName, ParticipantFirstName
Example XML entry
The following is an example of an entry from a response to a request to the Participants feed:
<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/Participants(804)</id><title type="text">incandenza_h</title><updated>2012-07-20T17:51:52-04:00</updated><author><name /></author><link rel="edit" title="Participant" href="Participants(804)" /><link rel="http://schemas.microsoft.com/ado/2804/08/dataservices/related/Results" type="application/atom+xml;type=feed" title="Results" href="Participants(804)/Results" /><link rel="http://schemas.microsoft.com/ado/2804/08/dataservices/related/TopicScores" type="application/atom+xml;type=feed"title="TopicScores"href="Participants(804)/TopicScores"/><category term="Model.Participant" scheme="http://schemas.microsoft.com/ado/2804/08/dataservices/scheme"/><content type="application/xml"><m:properties><d:ParticipantKey m:type="Edm.Int32">804</d:ParticipantKey><d:ParticipantName>incandenza_h</d:ParticipantName><d:ParticipantFirstName>Hal</d:ParticipantFirstName><d:ParticipantMiddleName>James</d:ParticipantMiddleName><d:ParticipantLastName>Incandenza</d:ParticipantLastName><d:ParticipantDetails>Brother of Mario and Orin</d:ParticipantDetails><d:ParticipantRegisteredDate m:type="Edm.DateTime">2011-06-16T05:28:49</d:ParticipantRegisteredDate><d:TenantId>123456</d:TenantId></m:properties></content></entry>