SearchQualificationTypes

Prev		Next

Description

The SearchQualificationTypes operation searches for Qualification types using the specified search query, and returns a list of Qualification types.

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

Sample Request: Using SearchQualificationTypes (REST)

The following example of a call to the SearchQualificationTypes operation performs a simple text query for Qualification types.

http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
&AWSAccessKeyId=[the Requester's Access Key ID]
&Version=2007-03-12
&Operation=SearchQualificationTypes
&Signature=[signature for this request]
&Timestamp=[your system's local time]
&Query=English

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.

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

The following parameters are specific to the SearchQualificationTypes operation:

Name	Description	Type	Value
`Operation`	The operation to call. To access the `SearchQualificationTypes` operation, set the `Operation` parameter to `SearchQualificationTypes`.	Required	`SearchQualificationTypes`
`Query`	A text query against all of the searchable attributes of Qualification types. If `Query` is not specified, the complete set of all Qualification types is considered for the results.	Optional	A string
`SortProperty`	The field on which to sort the results returned by the operation. There is only one possible value for `SortProperty` for Qualification types: `Name`. This is the default.	Optional	`Name`
`SortDirection`	The direction of the sort used with the field specified by `SortProperty`. If `SortDirection` is not specified, the results will be sorted by the field in descending order.	Optional	`Ascending` \| `Descending`
`PageSize`	The number of Qualification types to include in a "page" of results. The complete sorted result set is divided into pages of this many Qualification types. `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 Qualification types have been filtered, sorted, and 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
`MustBeRequestable`	If `true`, only Qualification types that a user can request through the Mechanical Turk web site, such as by taking a Qualification test, will be returned as results for the search. Some Qualification types, such as those assigned automatically by the system, cannot be requested directly by users. If `false`, all Qualification types, including those managed by the system, will be considered for the search.	Required	A Boolean, `true` or `false`

Responses

A successful request for the SearchQualificationTypes operation will have a SearchQualificationTypesResult element in the response.

The SearchQualificationTypesResult element contains the following elements:

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