You are browsing the documentation for a deprecated version ('2014-08-15') of the Amazon Mechanical Turk Requester API. This version of the API will be deprecated and will be rendered unusable as of June 1st, 2019. If you request against a legacy API version (https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI-legacy/Welcome.html) on or after June 1, 2019, you will receive the following response:
The latest version of our API ('2017-01-17') provides you with additional tool choices and enables you to select from nine AWS Software Development Kits This version also updates naming conventions used in the API and adopts the AWS standard of Signature Version 4 to authenticate requests securely. The API uses REST requests and no longer requires that developers be familiar with SOAP protocol. These changes make the MTurk API consistent with AWS APIs, simplifying the on-boarding process for both new and existing AWS developers. The legacy MTurk Command Line Tools and .NET, Java, Ruby, and Perl SDKs were marked as deprecated in January 2018. We will be deprecating the legacy APIs as of June 1, 2019. If you are on a legacy API, you must migrate to the latest
version of our API. You can find documentation for the latest API here and the AWS SDKs here For support, contact requestor-apilegacydeprecation-support@amazon.com |
SearchHITs
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 of with the DisposeHIT operation or that have been auto-disposed.
Note
The SearchHITs
operation does not accept any search
parameters that filter the results.
HITs are auto-disposed after 120 days and do not appear in SearchHITs
responses after that time.
The operation sorts the results and divides them into numbered pages. The operation returns a single page of results. You can control sorting and pagination 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 all
HITs are returned with no duplicates, but not in any specific order.
Request Parameters
The SearchHITs
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 SearchHITs
operation:
Name | Description | Required |
---|---|---|
|
The name of the operation Type: String Valid Values: SearchHITs Default: None |
Yes |
|
The field on which to sort the returned results Type: String Valid Values: Title | Reward | Expiration | CreationTime | Enumeration Default: CreationTime |
No |
|
The direction of the sort, used with the field specified by
the Type: String Valid Values: Ascending | Descending Default: Ascending |
No |
|
The number of HITs to include in a page of results. The complete sorted result set is divided into pages of this many HITs. Type: positive integer Valid Values: any integer between 1 and 100 Default: 10 |
No |
|
The page of results to return. After the operation sorts the
HITs and divides them into pages of size Type: positive integer Default: 1 |
No |
Response Elements
A successful request for the SearchHITs
operation will have a
SearchHITsResult
element in the response.
The SearchHITsResult
element contains the following elements:
Name | Description |
---|---|
|
The number of HITs on this page in the filtered results list, equivalent to the number of HITs being returned by this call. Type: non-negative integer |
|
The number of this page in the filtered results list. Type: positive integer |
|
The total number of HITs in the filtered results list based on this call. Type: non-negative integer |
|
The HIT. The response includes one Type: a HIT data structure. |
Examples
The following example shows how to use the GetHITsForQualificationType
operation.
Sample Request
The following example queries all of the HITs for a Requester. The example uses default values for sorting and pagination.
https://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]
Sample Response
The following is an example response.
<SearchHITsResult> <Request> <IsValid>True</IsValid> </Request> <NumResults>2</NumResults> <TotalNumResults>2</TotalNumResults> <PageNumber>1</PageNumber> <HIT> <HITId>GBHZVQX3EHXZ2AYDY2T0</HITId> <HITTypeId>NYVZTQ1QVKJZXCYZCZVZ</HITTypeId> <CreationTime>2009-04-22T00:17:32Z</CreationTime> <Title>Location</Title> <Description>Select the image that best represents</Description> <HITStatus>Reviewable</HITStatus> <MaxAssignments>1</MaxAssignments> <Reward> <Amount>5.00</Amount> <CurrencyCode>USD</CurrencyCode> <FormattedPrice>$5.00</FormattedPrice> </Reward> <AutoApprovalDelayInSeconds>2592000</AutoApprovalDelayInSeconds> <Expiration>2009-04-29T00:17:32Z</Expiration> <AssignmentDurationInSeconds>30</AssignmentDurationInSeconds> <NumberOfAssignmentsPending>0</NumberOfAssignmentsPending> <NumberOfAssignmentsAvailable>0</NumberOfAssignmentsAvailable> <NumberOfAssignmentsCompleted>1</NumberOfAssignmentsCompleted> </HIT> <HIT> <HITId>ZZRZPTY4ERDZWJ868JCZ</HITId> <HITTypeId>NYVZTQ1QVKJZXCYZCZVZ</HITTypeId> <CreationTime>2009-07-07T00:56:40Z</CreationTime> <Title>Location</Title> <Description>Select the image that best represents</Description> <HITStatus>Assignable</HITStatus> <MaxAssignments>1</MaxAssignments> <Reward> <Amount>5.00</Amount> <CurrencyCode>USD</CurrencyCode> <FormattedPrice>$5.00</FormattedPrice> </Reward> <AutoApprovalDelayInSeconds>2592000</AutoApprovalDelayInSeconds> <Expiration>2009-07-14T00:56:40Z</Expiration> <AssignmentDurationInSeconds>30</AssignmentDurationInSeconds> <NumberOfAssignmentsPending>0</NumberOfAssignmentsPending> <NumberOfAssignmentsAvailable>1</NumberOfAssignmentsAvailable> <NumberOfAssignmentsCompleted>0</NumberOfAssignmentsCompleted> </HIT> </SearchHITsResult>