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

UpdateQualificationType

Description

The UpdateQualificationType operation modifies the attributes of an existing Qualification type, which is represented by a QualificationType data structure. Only the owner of a Qualification type can modify its attributes.

Most attributes of a Qualification type can be changed after the type has been created. However, the Name and Keywords fields cannot be modified. The RetryDelayInSeconds parameter can be modified or added to change the delay or to enable retries, but RetryDelayInSeconds cannot be used to disable retries.

You can use this operation to update the test for a Qualification type. The test is updated based on the values specified for the Test, TestDurationInSeconds and AnswerKey parameters. All three parameters specify the updated test. If you are updating the test for a type, you must specify the Test and TestDurationInSeconds parameters. The AnswerKey parameter is optional; omitting it specifies that the updated test does not have an answer key.

If you omit the Test parameter, the test for the Qualification type is unchanged. There is no way to remove a test from a Qualification type that has one. If the type already has a test, you cannot update it to be AutoGranted. If the Qualification type does not have a test and one is provided by an update, the type will henceforth have a test.

If you want to update the test duration or answer key for an existing test without changing the questions, you must specify a Test parameter with the original questions, along with the updated values.

If you provide an updated Test but no AnswerKey, the new test will not have an answer key. Requests for such Qualifications must be granted manually.

You can also update the AutoGranted and AutoGrantedValue attributes of the Qualification type.

Request Syntax

Copy
{ "QualificationTypeId": String, "RetryDelayInSeconds": Integer, "QualificationTypeStatus": String, "Description": 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

QualificationTypeId

The ID of the Qualification type to update.

Type: String

Yes

RetryDelayInSeconds

The amount of time, in seconds, that Workers must wait after requesting a Qualification of the specified Qualification type before they can retry the Qualification request. 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 using CreateQualificationType.

Type: Integer

No

QualificationTypeStatus

The new status of the Qualification type - Active | Inactive

Type: String

No

Description

The new description of the Qualification type.

Type: String

No

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

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

AnswerKey

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

TestDurationInSeconds

The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification. This is required if the Test parameter is specified.

Type: Integer

Conditional

AutoGranted

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

AutoGrantedValue

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

Type: Integer

Default: If AutoGranted is true, AutoGrantedValue is set to 1.

No

Response Elements

A successful request returns a QualificationType data structure.

Example

The following example shows how to use the UpdateQualificationType operation:

Sample Request

The following example changes the QualificationTypeStatus of a Qualification type.

Copy
POST / HTTP/1.1 Host: mturk-requester.us-east-1.amazonaws.com Content-Length: <PayloadSizeBytes> X-Amz-Date: <Date> { QualificationTypeId:"789RVWYBAZW00EXAMPLE", QualificationTypeStatus:"Inactive" }

Sample Response

The following is an example response:

Copy
HTTP/1.1 200 OK x-amzn-RequestId: <RequestId> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Date: <Date> { QualificationTypeId:"789RVWYBAZW00EXAMPLE", Name:"EnglishWritingAbility", Description:"The ability to write and edit in text in English", QualificationTypeStatus:"Inactive" }