Amazon Mechanical Turk
API Reference (API Version 2012-03-25)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Did this page help you?  Yes | No |  Tell us about it...

CreateQualificationType

Description

The CreateQualificationType operation creates a new Qualification type, which is represented by a QualificationType data structure.

Request Parameters

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

The following parameters are specific to the CreateQualificationType operation:

NameDescriptionRequired

Operation

The name of the operation.

Type: String

Valid Values: CreateQualificationType

Default: None

Yes

Name

The name you give to the Qualification type. The type name is used to represent the Qualification to Workers, and to find the type using a Qualification type search.

Type: String

Default: None

Constraints: Must be unique across all of your Qualification types.

Yes

Description

A long description for the Qualification type. On the Amazon Mechanical Turk website, the long description is displayed when a Worker examines a Qualification type.

Type: String

Default: None

Constraints: Must be less than or equal to 2000 characters.

Yes

Keywords

One or more words or phrases that describe the Qualification type, separated by commas. The keywords of a type make the type easier to find during a search.

Type: String

Default: None

Constraints: Must be less than or equal to 1000 characters, including commas and spaces.

No

RetryDelayInSeconds

The number of seconds that a Worker must wait after requesting a Qualification of the Qualification type before the worker can retry the Qualification request.

Type: Non-negative integer

Default: None. If not specified, retries are disabled and Workers can request a Qualification of this type only once, even if the Worker has not been granted the Qualification.

It is not possible to disable retries for a Qualification type after it has been created with retries enabled. If you want to disable retries, you must dispose of the existing retry-enabled Qualification type using DisposeQualificationType and then create a new Qualification type with retries disabled.

No

QualificationTypeStatus

The initial status of the Qualification type.

Type: String

Valid Values: Active | Inactive

Default: None

Yes

Test

The questions for the Qualification test a Worker must answer correctly to obtain a Qualification of this type.

If this parameter is specified, TestDurationInSeconds must also be specified.

Type: String

Default: None. If not specified, the Worker may request the Qualification without answering any questions.

Constraints: Must be a QuestionForm data structure. This parameter cannot be specified if AutoGranted is true.

No

AnswerKey

The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure.

Type: String

Default: None. If not specified, you must process Qualification requests manually.

No

TestDurationInSeconds

The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification.

Type: Integer

Valid Values: Positive integer

Default: None

Conditions: Required if the Test parameter is specified.

Conditional

AutoGranted

Specifies whether requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test.

Type: Boolean

Valid Values: true | false

Default: None

Constraints: If the Test parameter is specified, this parameter cannot be true.

No

AutoGrantedValue

The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true.

Type: Integer

Default: 1

No

Response Elements

A successful request for the CreateQualificationType operation includes the elements found in the following table:

NameDescription

QualificationType

The created Qualification type.

Type: A QualificationType data structure.

Examples

The following example shows how to use the CreateQualificationType operation.

Sample Request

The following example creates a Qualification type.

https://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
&AWSAccessKeyId=[the Requester's Access Key ID]
&Version=2012-03-25
&Operation=CreateQualificationType
&Signature=[signature for this request]
&Timestamp=[your system's local time]
&Name=EnglishWritingAbility
&Description=The%20ability%20to%20write%20and%20edit%20text...
&QualificationTypeStatus=Active
            

Sample Response

The following is an example response.

<CreateQualificationTypeResponse>
  <OperationRequest>
    <RequestId>5218189c-1d7e-49a3-abbf-672fb5e77c66</RequestId>
  </OperationRequest>
  <QualificationType>
    <Request>
      <IsValid>True</IsValid>
    </Request>
    <QualificationTypeId>ZSPJXD4F1SFZP7YNJWR0</QualificationTypeId>
    <CreationTime>2009-07-13T17:26:33Z</CreationTime>
    <Name>SampleQualificationTest</Name>
    <Description>Description of my qualification test.</Description>
    <QualificationTypeStatus>Active</QualificationTypeStatus>
    <AutoGranted>0</AutoGranted>
  </QualificationType>
</CreateQualificationTypeResponse>