|
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:
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 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 For support, contact requestor-apilegacydeprecation-support@amazon.com |
ApproveAssignment
Description
The ApproveAssignment operation approves the results of a
completed assignment.
Approving an assignment initiates two payments from the Requester's Amazon.com
account: the Worker who submitted the results is paid the reward specified in the HIT,
and Amazon Mechanical Turk fees are debited. If the Requester's account does not have
adequate funds for these payments, the call to ApproveAssignment
returns an exception, and the approval is not processed.
You can include an optional feedback message with the approval, which the Worker can see in the Status section of the web site.
Request Parameters
The ApproveAssignment operation accepts parameters common to all
operations. Some common parameters are required. See Common Parameters for more information.
The following parameters are specific to the ApproveAssignment
operation:
| Name | Description | Required |
|---|---|---|
|
|
The name of the operation Type: String Valid Values: ApproveAssignment Default: None |
Yes |
|
|
The ID of the assignment. This parameter must correspond to a HIT created by the Requester. Type: String Default: None |
Yes |
|
|
A message for the Worker, which the Worker can see in the Status section of the web site. Type: String Default: None Constraints: Can be up to 1024 characters (including multi-byte characters). The |
No |
Response Elements
A successful request for the ApproveAssignment operation returns
with no errors. The response includes the elements described in the following table. The
operation returns no other data.
| Name | Description |
|---|---|
|
|
Contains a |
Examples
The following example shows how to use the ApproveAssignment
operation.
Sample Request
The following example approves an assignment identified by its assignment ID.
https://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester &AWSAccessKeyId=[the Requester's Access Key ID]&Version=2017-01-17 &Operation=ApproveAssignment &Signature=[signature for this request]&Timestamp=[your system's local time]&AssignmentId=123RVWYBAZW00EXAMPLE456RVWYBAZW00EXAMPLE
Sample Response
The following is an example response.
<ApproveAssignmentResult> <Request> <IsValid>True</IsValid> </Request> </ApproveAssignmentResult>
