The GetReviewableHITs operation retrieves the HITs that have a status of Reviewable that belong to the Requester calling the operation.
You can use this operation to determine which of your HITs have results, then retrieve those results with the GetAssignmentsForHIT operation. Once a HIT's results have been retrieved and the assignments have been approved or rejected (with ApproveAssignment or RejectAssignment), you can call DisposeHIT to remove the HIT from the results of a call to GetReviewableHITs.
Results are sorted and divided into numbered "pages," and a single page of results is returned by the operation. Sorting and pagination can be controlled with parameters to the operation.
Using GetReviewableHITs (REST)
The following example of a call to the GetReviewableHITs operation retrieves five of the Requester's reviewable HITs, using the default sort order (expiration date, ascending).
http://mechanicalturk.amazonaws.com/onca/xml?Service=AWSMechanicalTurkRequester &AWSAccessKeyId=[the Requester's Access Key ID] &Operation=GetReviewableHITs &Signature=[signature for this request] &Timestamp=[your system's local time] &PageSize=5 &PageNumber=1
A request to the Mechanical Turk Service includes parameters that control its behavior and the data it returns. Required parameters must be included for the request to succeed.
GetReviewableHITs accepts parameters common to all operations. Some common parameters are required. See Common Parameters for more information.
The following parameters are specific to the GetReviewableHITs operation:
| Name | Description | Type | Value |
|---|---|---|---|
| Operation |
The operation to call. To access the GetReviewableHITs operation, set the Operation parameter to GetReviewableHITs. |
Required |
GetReviewableHITs |
| SortProperty |
The field on which to sort the results returned by the operation. If SortProperty is not specified, the set of HITs is sorted by Expiration. |
Optional |
Title | Reward | Expiration | CreationTime |
| SortDirection |
The direction of the sort used with the field specified by SortProperty. If SortDirection is not specified, the results will be sorted by the field in descending order. |
Optional |
Ascending | Descending |
| PageSize |
The number of HITs to include in a "page" of results. The complete sorted result set is divided into pages of this many HITs. PageSize must be a number between 1 and 100. If the PageSize parameter is not specified, a default size of 10 elements is used. |
Optional |
A positive integer |
| PageNumber |
The page of results to return. Once the HITs have been filtered, sorted, and divided into pages of size PageSize, the page corresponding to PageNumber is returned as the results of the operation. If the PageNumber parameter is not specified, a default page number of 1 will be used. |
Optional |
A positive integer |
A successful request for the GetReviewableHITs operation will have a GetReviewableHITsResult element in the response.
The GetReviewableHITsResult element contains the following elements:
| Name | Description | Value |
|---|---|---|
| NumResults |
The number of HITs on this page in the filtered results list, equivalent to the number of HITs being returned by this call. |
A non-negative integer |
| PageNumber |
The number of this page in the filtered results list. |
A positive integer |
| TotalNumResults |
The total number of HITs in the filtered results list based on this call. |
A non-negative integer |
| HIT |
The HIT. The response will include one HIT element for each HIT returned by the query. |
A HIT data structure. For more information on the data structure of a HIT, see the HIT Data Structure. |