AWS Documentation » AWS Mechanical Turk » API Reference » Operations » SearchHITs	« Previous Next »
	Did this page help you? Yes \| No \| Tell us about it...

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 with the DisposeHIT operation.

Note

The SearchHITs operation does not accept any search parameters that filter the results.

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
`Operation`	The name of the operation Type: String Valid Values: SearchHITs Default: None	Yes
`SortProperty`	The field on which to sort the returned results Type: String Valid Values: Title \| Reward \| Expiration \| CreationTime \| Enumeration Default: CreationTime	No
`SortDirection`	The direction of the sort, used with the field specified by the `SortProperty` parameter. Type: String Valid Values: Ascending \| Descending Default: Ascending	No
`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. Type: positive integer Valid Values: any integer between 1 and 100 Default: 10	No
`PageNumber`	The page of results to return. After the operation sorts the HITs and divides them into pages of size `PageSize`, the operation returns the page corresponding to `PageNumber`. 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
`NumResults`	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
`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 the query returns. 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>

Document Conventions	« Previous Next »
Terms of Use	Did this page help you? Yes \| No \| Tell us about it...