CreateQualificationType
Description
The CreateQualificationType operation creates a new Qualification type, which is represented by a QualificationType data structure.
Request Syntax
{ "Name":String, "Description":String, "Keywords":String, "RetryDelayInSeconds":Non-negative integer, "QualificationTypeStatus":String, "Test":String, "AnswerKey":String, "TestDurationInSeconds":Integer, "AutoGranted":Boolean, "AutoGrantedValue":Integer}
Request Parameters
The request accepts the following data in JSON format:
| Name | Description | Required |
|---|---|---|
|
|
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. It must be unique across all of your Qualification types. Type: String |
Yes |
|
|
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 Constraints: Must be less than or equal to 2000 characters |
Yes |
|
|
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 Constraints: Must be less than or equal to 1000 characters, including commas and spaces. |
No |
|
|
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 delete existing retry-enabled Qualification type and then create a new Qualification type with retries disabled. |
No |
|
|
The initial status of the Qualification type. Type: String Constraints: Valid values are: Active | Inactive |
Yes |
|
|
The questions for the Qualification test a Worker must answer correctly to obtain a Qualification of this type. If this parameter is specified, Type: String Constraints: Must not be longer than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot be specified if AutoGranted is true. Default: None. If not specified, the Worker may request the Qualification without answering any questions. |
No |
|
|
The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure. Type: String Constraints: Must not be longer than 65535 bytes. Default: None. If not specified, you must process Qualification requests manually. |
No |
|
|
The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification. Type: Integer |
Conditional: required when a Test is specified. |
|
|
Specifies whether requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test. Type: Boolean Constraints: If the Test parameter is specified, this parameter cannot be true. Default: False |
No |
|
|
The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true. Type: Integer Default: 1 when used with AutoGranted. None when AutoGranted is not specified. |
No |
Response Elements
A successful request for the CreateQualificationType operation returns a QualificationType data structure.
Example
The following example shows how to use the CreateQualificationType operation:
Sample Request
The following example creates a Qualification type.
POST / HTTP/1.1 Host: mturk-requester.us-east-1.amazonaws.com Content-Length: <PayloadSizeBytes> X-Amz-Date: <Date> { Name:"EnglishWritingAbility", Description:"The ability to write and edit in text in English", QualificationTypeStatus:"Active" }
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> { QualificationTypeId:"789RVWYBAZW00EXAMPLE951RVWYBAZW00EXAMPLE", Name:"EnglishWritingAbility", Description:"The ability to write and edit in text in English", QualificationTypeStatus:"Active" }
