GetReviewableHITs

Description

The GetReviewableHITs operation retrieves the HITs with Status equal to Reviewable or Status equal to Reviewing that belong to the Requester calling the operation.

You can limit the query to HITs with a specified HIT type.

The operation sorts the results, divides them into numbered pages, and returns a single page of results. You can control sorting and pagination can be controlled with parameters to the operation.

When (PageNumber x PageSize) is less than 100, you can get reliable results when you use any of the sort properties. If this number is greater than 100, use the Enumeration sort property for best results. The Enumeration sort property guarantees that the operation returns all reviewable HITs with no duplicates, but not in any specific order.

Request Parameters

The GetReviewableHITs operation 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	Required
`Operation`	The name of the operation Type: String Valid Values: GetReviewableHITs Default: None	Yes
`HITTypeId`	The ID of the HIT type of the HITs to consider for the query. Type: String Default: None. If not specified, all of the Requester's HITs are considered for the query.	No
`Status`	The status of the HITs to return Type: String Valid Values: Reviewable \| Reviewing Default: Reviewable To query both Reviewable and Reviewing HITs, specify multiple `Status` parameters.	No
`SortProperty`	The field on which to sort the results. Type: String Valid Values: Title \| Reward \| Expiration \| CreationTime \| Enumeration Default: Expiration	No
`SortDirection`	The direction of the sort used with the field specified by the `SortProperty` property. Type: String Valid Values: Ascending \| Descending Default: Descending	No
`PageSize`	The number of HITs to include in a page of results. The operation divides the complete sorted result set is divided into pages of this many HITs. Type: positive integer Valid Values: any number between 1 and 100 Default: 10	No
`PageNumber`	The page of results to return. After the operation filters, sorts, and divides the HITs into pages of size `PageSize`, it returns the page corresponding to `PageNumber` as the results of the operation. Type: positive integer Default: 1	No

Response Elements

A successful request for the GetReviewableHITs operation has a GetReviewableHITsResult element in the response.

The GetReviewableHITsResult element contains the following elements:

Name	Description
`NumResults`	The number of HITs on this page in the filtered results list, equivalent to the number of HITs this call returns. Type: non-negative integer
`PageNumber`	The number of this page in the filtered results list. Type: positive integer
`TotalNumResults`	The total number of HITs in the filtered results list based on this call. Type: non-negative integer
`HIT`	The HIT. The response includes one `HIT` element for each HIT returned by the query. Type: a HIT data structure

Examples

The following example shows how to use the GetReviewableHITs operation.

Sample Request

The following example retrieves five of the Requester's reviewable HITs, using the default values for the SortProperty and SortOrder parameters (ExpirationDate, Ascending).

http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
&AWSAccessKeyId=[the Requester's Access Key ID]
&Version=2008-08-02
&Operation=GetReviewableHITs
&Signature=[signature for this request]
&Timestamp=[your system's local time]
&PageSize=5
&PageNumber=1

Sample Response

The following is an example response.

<GetReviewableHITsResult>
  <Request>
    <IsValid>True</IsValid>
  </Request>
  <NumResults>1</NumResults>
  <TotalNumResults>1</TotalNumResults>
  <PageNumber>1</PageNumber>
  <HIT>
    <HITId>GBHZVQX3EHXZ2AYDY2T0</HITId>
  </HIT>
</GetReviewableHITsResult>