UpdateQualificationType

Prev		Next

Description

The UpdateQualificationType operation modifies attributes of an existing Qualification type.

Most attributes of a Qualification type can be changed after the type has been created. The Name and Keywords fields cannot be modified. If you create a Qualification type and decide you do not wish to use it with its name or keywords as they were created, update the type with a new QualificationTypeStatus of Inactive, then create a new type using CreateQualificationType with the desired values.

You can update a Qualification type's test using this operation. The type's 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 both of the Test and TestDurationInSeconds parameters. The AnswerKey parameter is optional; omitting it specifies that the updated test does not have an answer key.

Note:

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.

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

Note:

A Qualification type cannot be configured with both a Test and an AutoGranted of true. Currently, there is no way to remove a test from a Qualification type that has one. A Qualification type with a test cannot be re-configured to use the auto-granting feature.

Only the owner of a Qualification type may modify its attributes.

Sample Request: Using UpdateQualificationType (REST)

The following example of a call to the UpdateQualificationType operation changes the QualificationTypeStatus of a Qualification type.

http://mechanicalturk.amazonaws.com/onca/xml?Service=AWSMechanicalTurkRequester
&AWSAccessKeyId=[the Requester's Access Key ID]
&Version=2006-10-31
&Operation=UpdateQualificationType
&Signature=[signature for this request]
&Timestamp=[your system's local time]
&QualificationTypeId=789RVWYBAZW00EXAMPLE
&QualificationTypeStatus=Inactive

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.

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

The following parameters are specific to the UpdateQualificationType operation:

Name Description Type Value

Operation

The operation to call. To access the UpdateQualificationType operation, set the Operation parameter to UpdateQualificationType.

Required

UpdateQualificationType

QualificationTypeId

The ID of the Qualification type to update.

Required

A valid Qualification type ID

RetryDelayInSeconds

An amount of time after requesting a Qualification of the Qualification type a user must wait before the user can request it again. A user may wish to request a Qualification multiple times if they were not granted the Qualification from a previous request, or if a Qualification test offers a gradient score and the user would like a better score.

If a Qualification type does not have a RetryDelayInSeconds, then retries are disabled. A user can request a Qualification of this type only once, even if the user has not been granted the Qualification.

Caution:

There is currently no way to disable retries once a retry delay is set. This feature is being considered for a future version.

Optional

A number of seconds, as a non-negative integer

QualificationTypeStatus

The new status of the Qualification type.

Optional

Active | Inactive

Description

The new description of the Qualification type.

Optional

A string

Test

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

The value of this parameter is an XML data structure. See the QuestionForm data structure for more information.

If omitted, the Qualification type's test is unchanged. If the Qualification type does not have a test and one is provided by an update, the type will henceforth have a test.

Note:

There is no way to remove a test from a Qualification type that has one.

Optional

XML data for the Qualification test, a QuestionForm data structure

AnswerKey

The answers to the Qualification test specified in the Test parameter.

If an answer key is provided for a test, Mechanical Turk will process requests for the Qualification automatically, assigning the user a Qualification with a value calculated from the answer key and the answers submitted by the user.

The value of this parameter is an XML data structure. See the AnswerKey data structure for more information.

If an updated Test is provided, but no AnswerKey is specified, the new test will not have an answer key. Requests for a Qualification whose type has a test but no answer key must be granted manually.

If you are updating the AnswerKey, you must provide the Test parameter, even if the test has not changed.

Optional

XML data for the answer key, an AnswerKey data structure

TestDurationInSeconds

An amount of time a user has from requesting the Qualification to complete the Qualification test. If the user does not submit test answers before this duration has elapsed after requesting the Qualification, the request is voided. The user must then wait for the RetryDelayInSeconds to elapse before requesting the Qualification again.

The TestDurationInSeconds parameter is required if the Test parameter is specified.

If you are updating the TestDurationInSeconds, you must provide the Test parameter, even if the test has not changed.

Optional

A number of seconds, as a positive integer

AutoGranted

If true, requests for the Qualification type will be granted immediately, without prompting the Worker with a Qualification test.

A Qualification type cannot have both a Test and an AutoGranted value of true.

Note:

There is currently no way to remove a Qualification test from a type. If the type already has a test, you will not be able to update it to be auto-granted.

Optional

A Boolean, either true or false

AutoGrantedValue

The Qualification value to use for automatically granted Qualifications, if AutoGranted is true.

If AutoGrantedValue is not specified and AutoGranted is true, Qualifications will be granted automatically with a value of "1".

Optional

An integer

Responses

A successful request for the UpdateQualificationType operation will have a QualificationType element in the response.

The QualificationType element contains a Qualification type data structure. For a description of this data structure, see the Qualification Type Data Structure.