Menu
Amazon Mechanical Turk
API Reference (API Version 2017-01-17)

ListQualificationTypes

Description

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

Request Syntax

{ "Query": String, "MustBeRequestable": Boolean, "MustBeOwnedByCaller": Boolean, "NextToken": String, "MaxResults": Integer, }

Request Parameters

The request accepts the following data in JSON format:

Name Description Required

Query

A search term

Type: String

No

MustBeRequestable

Specifies that only Qualification types that a user can request through the Amazon Mechanical Turk web site, such as by taking a Qualification test, are returned as results of 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, are considered for the search.

Type: Boolean

Yes

MustBeOwnedByCaller

Specifies that only Qualification types that the Requester created are returned. If false, the operation returns all Qualification types.

Type: Boolean

Default: False

No

NextToken

Pagination token

Type: String

No

MaxResults

Type: Integer

No

Response Elements

A successful request returns a paginated list of Qualification Types.

Example

The following example shows how to use the ListQualificationTypes operation:

Sample Request

The following example performs a simple text query for Qualification types.

POST / HTTP/1.1 Host: mturk-requester.us-east-1.amazonaws.com Content-Length: <PayloadSizeBytes> X-Amz-Date: <Date> { Query:"LanguageSkill" }

Sample Response

The following is an example response:

HTTP/1.1 200 OK x-amzn-RequestId: <RequestId> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Date: <Date> { NextToken:PaginationToken, NumResults:10, QualificationType:[QualificationType] }