GrantQualification - Amazon Mechanical Turk
DescriptionRequest ParametersResponse ElementsExamples

WARNING

You are browsing the documentation for a deprecated version ('2014-08-15') of the Amazon Mechanical Turk Requester API. This version of the API will be deprecated and will be rendered unusable as of June 1st, 2019.

If you request against a legacy API version (https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI-legacy/Welcome.html) on or after June 1, 2019, you will receive the following response:

This Requester API is no longer supported. Please use the latest API using the official AWS SDK. https://aws.amazon.com/getting-started/tools-sdks

The latest version of our API ('2017-01-17') provides you with additional tool choices and enables you to select from nine AWS Software Development Kits (SDKs) that have been widely adopted across the AWS community. This API can be accessed using the following AWS SDKs: Python/Boto (Boto3), Javascript (NodeJS or Browser), Java, .NET, Go, Ruby, PHP or C++. This version also makes it easier for customers to connect MTurk with other AWS services like S3, Lambda, Step Functions, Lex, Polly, Rekognition, Amazon SageMaker, AWS Batch, EC2, and more.

This version also updates naming conventions used in the API and adopts the AWS standard of Signature Version 4 to authenticate requests securely. The API uses REST requests and no longer requires that developers be familiar with SOAP protocol. These changes make the MTurk API consistent with AWS APIs, simplifying the on-boarding process for both new and existing AWS developers. The legacy MTurk Command Line Tools and .NET, Java, Ruby, and Perl SDKs were marked as deprecated in January 2018. We will be deprecating the legacy APIs as of June 1, 2019.

If you are on a legacy API, you must migrate to the latest version of our API. You can find documentation for the latest API here and the AWS SDKs here. Please check whether you need to migrate and review the technical migration guide.

For support, contact requestor-apilegacydeprecation-support@amazon.com.

 

GrantQualification

Description

The GrantQualification operation grants a Worker's request for a Qualification.

Only the owner of the Qualification type can grant a Qualification request for that type.

Request Parameters

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

The following parameters are specific to the GrantQualification operation:

Name Description Required

Operation

The name of the operation

Type: String

Valid Values: GrantQualification

Default: None

Yes

QualificationRequestId

The ID of the Qualification request, as returned by the GetQualificationRequests operation.

Type: String

Default: None

Yes

IntegerValue

The value of the Qualification

Type: Integer

Default: 1

Conditions: You can omit this value if you are using the presence or absence of the Qualification as the basis for a HIT requirement.

Conditional

Response Elements

A successful request for the GrantQualification operation returns with no errors. The response includes the elements described in the following table. The operation returns no other data.

Name Description

GrantQualificationResult

Contains a Request element if the Request ResponseGroup is specified.

Examples

The following example shows how to use the GrantQualification operation.

Sample Request

The following example grants a Qualification to a user.

https://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
&AWSAccessKeyId=[the Requester's Access Key ID]
&Version=2017-01-17
&Operation=GrantQualification
&Signature=[signature for this request]
&Timestamp=[your system's local time]
&QualificationRequestId=789RVWYBAZW00EXAMPLE951RVWYBAZW00EXAMPLE
&IntegerValue=95

Sample Response

The following is an example response.

<GrantQualificationResult>
  <Request>
    <IsValid>True</IsValid>
  </Request>
</GrantQualificationResult>