SearchHITs

Prev		Next

Description

The SearchHITs operation returns all of a Requester's HITs, on behalf of the Requester.

The operation returns HITs of any status, except for HITs that have been disposed with the DisposeHIT operation.

Note:

Currently, the SearchHITs operation does not accept any search parameters that filter the results. This operation may be extended with the ability to filter the results in a future version of the API.

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.

Sample Request: Using SearchHITs (REST)

The following example of a call to the SearchHITs operation queries all of the HITs for a Requester, using default values for sorting and pagination.

http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
&AWSAccessKeyId=[the Requester's Access Key ID]
&Operation=SearchHITs
&Signature=[signature for this request]
&Timestamp=[your system's local time]

Request Parameters

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.

SearchHITs accepts parameters common to all operations. Some common parameters are required. See Common Parameters for more information.

The following parameters are specific to the SearchHITs operation:

Name	Description	Type	Value
`Operation`	The operation you would like to call. To access the `SearchHITs` operation, set the `Operation` parameter to `SearchHITs`.	Required	`SearchHITs`
`SortProperty`	The field on which to sort the results returned by the operation. If `SortProptery` is not specified, the results are sorted by `CreationTime`.	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 ascending 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 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

Responses

A successful request for the SearchHITs operation will have a SearchHITsResult element in the response.

The SearchHITsResult 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.