GET Studies/{StudyKey}
Get a Study
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| StudyKey |
The key of the desired Study, which must be an integer value. |
integer |
Required |
Body Parameters
None.
Response Information
Get a Study
| Name | Description | Type | Additional information |
|---|---|---|---|
| key |
The key of the Study. |
integer |
Required |
| quota |
The quota for the Study |
integer |
None. |
| id |
The id of the Study. |
string |
Required |
| name |
A user-friendly display name of the Study. |
string |
None. |
| description |
A description of the Study. |
string |
None. |
| status |
A one-character string which specifies the status of the Study:
|
string |
Required |
| supervisorKey |
The key of the Person who will do revision of coding work |
integer |
None. |
| clientCompanyKey |
The Company to which this Study is assigned, or null if the Study is not assigned to a Company. |
integer |
None. |
| endCompanyKey |
The key of the Company for which this coding work is being performed |
integer |
None. |
| help |
Information to coders to assist in coding this Study. |
string |
None. |
| createDateUtc |
The UTC date/time the Study was created. |
date |
Required |
| startDateUtc |
UTC date/time the Study was started. |
date |
None. |
| dueDateUtc |
UTC date/time the Study was completed. |
date |
None. |
| countQuestions |
The number of Questions in the Study. |
integer |
Required |
| countResponses |
The sum of the number of Responses in each Question in the Study. |
integer |
Required |
| countResponsesCoded |
The sum of the number of Responses to which at least one Code has been assigned in each Question in the Study. |
integer |
Required |
| countTransactions |
The number of transactions used by this Study. Transactions are tokens of work performed on the Study. |
decimal number |
Required |
| errors |
If null the request was processed without error. If not null errors occurred while processing the request. The array contains the error messages. |
Collection of string |
None. |