 | Feedback |  |
The GrantBonus operation issues a payment
of money from your account to a Worker. To be eligible for a
bonus, the Worker must have submitted results for one of your
HITs, and have had those results approved or rejected. This
payment happens separately from the reward you pay to the Worker
when you approve the Worker's assignment.
You can grant a bonus to any Worker who has submitted an
assignment for one of your HITs. You must first approve or
reject the assignment before granting the bonus.
GrantBonus requires the Worker's ID and the
assignment ID as parameters to initiate payment of the bonus.
You can grant the bonus any time after you approve or reject the assignment, until the HIT has been disposed.
You must include a message that explains the reason for the bonus payment, as the Worker may not be expecting the payment.
Mechanical Turk collects a fee for bonus payments, similar to the HIT listing fee. For information about Mechanical Turk pricing and fee amounts, see the Mechanical Turk site at Amazon Web Services.
The call to GrantBonus will fail if your
account does not have enough funds to pay for both the bonus and
the fees.
The following example of a call to the GrantBonus operation pays a bonus of $5 to a Worker.
http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester &AWSAccessKeyId=[the Requester's Access Key ID]&Version=2008-04-01 &Operation=GrantBonus &Signature=[signature for this request]&Timestamp=[your system's local time]&WorkerId=AZ3456EXAMPLE &AssignmentId=123RVWYBAZW00EXAMPLE456RVWYBAZW00EXAMPLE &BonusAmount.1.Amount=5 &BonusAmount.1.CurrencyCode=USD &Reason=Thanks%20for%20doing%20great%20work!
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.
GrantBonus accepts parameters common to all
operations. Some common parameters are required. See
Common Parameters
for more information.
The following parameters are specific to the
GrantBonus operation:
| Name | Description | Type | Value |
|---|---|---|---|
Operation
|
The operation you would like to call. To access the
| Required |
|
WorkerId
|
The ID of the Worker being paid the bonus. The Worker ID is included in the assignment data returned by a call to the | Required |
A valid Worker ID |
AssignmentId
|
The ID of the assignment this bonus payment is regarding. The assignment ID is included in the assignment data returned by a call to the | Required |
A valid assignment ID |
BonusAmount
|
The amount of the bonus to pay. The value is a Price data structure. For more information, see the Price Data Structure. | Required |
A Price data structure |
Reason
|
A message explaining the reason for the bonus payment. This message may be seen by the Worker receiving the bonus. This message cannot contain ASCII characters 0-8, 11,12, or 14-31. If these characters are present, the operation throws an InvalidParameterValue error.
| Required |
A string |
A successful request for the GrantBonus operation
will return with no errors. The response will include an
GrantBonusResult element, which contains the
Request (if the Request response group is specified). The
operation returns no other data.
