GetQualificationsForQualificationType

Prev		Next

Description

The GetQualificationsForQualificationType operation returns all of the Qualifications granted to Workers for a given Qualification type.

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 GetQualificationsForQualificationType (REST)

The following example of a call to the GetQualificationsForQualificationType operation returns the Qualifications assigned to Workers for the given Qualification type.

http://mechanicalturk.amazonaws.com/onca/xml?Service=AWSMechanicalTurkRequester
&AWSAccessKeyId=[the Requester's Access Key ID]
&Version=2006-08-23
&Operation=GetQualificationsForQualificationType
&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.

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

The following parameters are specific to the GetQualificationsForQualificationType operation:

Name	Description	Type	Value
`Operation`	The operation you would like to call. To access the `GetQualificationsForQualificationType` operation, set the `Operation` parameter to `GetQualificationsForQualificationType`.	Required	`GetQualificationsForQualificationType`
`QualificationTypeId`	The ID of the Qualification type of the Qualifications to return.	Required	A valid Qualification type ID, as returned by the `CreateQualificationType` operation
`Status`	The status of the Qualifications to return, either `Granted` or `Revoked`. The default is `Granted`.	Optional	`Granted` \| `Revoked`
`PageSize`	The number of Qualifications to include in a "page" of results. The complete result set is divided into pages of this many Qualifications. `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 Qualifications 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 GetQualificationsForQualificationType operation will have a GetQualificationsForQualificationTypeResult element in the response.

The GetQualificationsForQualificationTypeResult element contains the following elements:

Name	Description	Value
`PageNumber`	The page of results to return. Once the Qualifications 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.	A positive integer
`NumResults`	The number of Qualifications on this page in the filtered results list, equivalent to the number of Qualifications being returned by this call.	A non-negative integer
`TotalNumResults`	The total number of Qualifications in the filtered results list based on this call.	A non-negative integer
`Qualification`	The Qualification. The response will include one `Qualification` element for each Qualification returned by the query.	A Qualification data structure. For more information on the data structure of a Qualification, see the Qualification Data Structure.