GetHITsForQualificationType

Description

The GetHITsForQualificationType operation returns the HITs that use the given Qualification type for a Qualification requirement.

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

This operation returns only HITs that you created.

Note

For reasons internal to the service, there may be a delay between when a HIT is created and when the HIT will be returned from a call to GetHITsForQualificationType.

The operation divides the results into numbered pages and returns a single page of results. You can control pagination with parameters to the operation.

Request Parameters

The GetHITsForQualificationType 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 GetHITsForQualificationType operation:

Name	Description	Required
Operation	The name of the operation. Type: String Valid Values: GetHITsForQualificationType Default: None	Yes
QualificationTypeId	The ID of the Qualification type to use when querying HITs, as returned by the CreateQualificationType operation. The operation returns HITs that require that a Worker have a Qualification of this type. Type: String Default: None	Yes
PageSize	The number of HITs to include in a page of results. The complete results 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 HITs are divided into pages of size PageSize, the operation returns the page corresponding to the PageNumber. Type: positive integer Default: 1	No

Response Elements

A successful request for the GetHITsForQualificationType operation returns a GetHITsForQualificationTypeResult element in the response.

The GetHITsForQualificationTypeResult 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 returned by the query. Type: HIT data structure.

Examples

The following example shows how to use the GetHITsForQualificationType operation.

Sample Request

The following example returns HITs that use the specified Qualification type for a Qualification requirement.

https://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
&AWSAccessKeyId=[the Requester's Access Key ID]
&Version=2017-01-17
&Operation=GetHITsForQualificationType
&Signature=[signature for this request]
&Timestamp=[your system's local time]
&QualificationTypeId=789RVWYBAZW00EXAMPLE
       

Sample Response

The following is an example response.

<GetHITsForQualificationTypeResult>
  <Request>
    <IsValid>True</IsValid>
  </Request>
  <NumResults>1</NumResults>
  <TotalNumResults>1</TotalNumResults>
  <PageNumber>1</PageNumber>
  <HIT>
    <HITId>123RVWYBAZW00EXAMPLE</HITId>
    <HITTypeId>T100CN9P324W00EXAMPLE</HITTypeId>
    <CreationTime>2009-06-15T12:00:01</CreationTime>
    <HITStatus>Assignable</HITStatus>
    <MaxAssignments>5</MaxAssignments>
    <AutoApprovalDelayInSeconds>86400</AutoApprovalDelayInSeconds>
    <LifetimeInSeconds>86400</LifetimeInSeconds>
    <AssignmentDurationInSeconds>300</AssignmentDurationInSeconds>
    <Reward>
      <Amount>25</Amount>
      <CurrencyCode>USD</CurrencyCode>
      <FormattedPrice>$0.25</FormattedPrice>
    </Reward>
    <Title>Location and Photograph Identification</Title>
    <Description>Select the image that best represents...</Description>
    <Keywords>location, photograph, image, identification, opinion</Keywords>
    <Question>
      &lt;QuestionForm&gt;
      [XML-encoded Question data]
      &lt;/QuestionForm&gt;
    </Question>
    <QualificationRequirement>
      <QualificationTypeId>789RVWYBAZW00EXAMPLE</QualificationTypeId>
      <Comparator>GreaterThan</Comparator>
      <Value>18</Value>
    </QualificationRequirement>
  <HITReviewStatus>NotReviewed</HITReviewStatus>
</HIT>
</GetHITsForQualificationTypeResult>