GetHITsForQualificationType

Prev		Next

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.

Only HITs that you created will be returned by the query.

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.

Results are divided into numbered "pages," and a single page of results is returned by the operation. Pagination can be controlled with parameters to the operation.

Sample Request: Using GetHITsForQualificationType (REST)

The following example of a call to the GetHITsForQualificationType operation returns HITs that use the given Qualification type for a Qualification requirement.

http://mechanicalturk.amazonaws.com/onca/xml?Service=AWSMechanicalTurkRequester
&AWSAccessKeyId=[the Requester's Access Key ID]
&Version=2006-10-31
&Operation=GetHITsForQualificationType
&Signature=[signature for this request]
&Timestamp=[your system's local time]
&QualificationTypeId=789RVWYBAZW00EXAMPLE

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.

GetHITsForQualificationType 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	Type	Value
`Operation`	The operation you would like to call. To access the `GetHITsForQualificationType` operation, set the `Operation` parameter to `GetHITsForQualificationType`.	Required	`GetHITsForQualificationType`
`QualificationTypeId`	The ID of the Qualification type to use when querying HITs. The operation will return HITs that require that a Worker have a Qualification of the type.	Required	A valid Qualification type ID, as returned by the `CreateQualificationType` operation
`PageSize`	The number of HITs to include in a "page" of results. The complete 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 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 GetHITsForQualificationType operation will have a GetHITsForQualificationTypeResult element in the response.

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