| « PreviousNext » | |
  | Did this page help you? Yes | No | Tell us about it... |
GetBonusPayments
Description
The GetBonusPayments operation retrieves the amounts of bonuses
you have paid to Workers for a given HIT or assignment.
Request Parameters
The GetBonusPayments 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 GetBonusPayments
operation:
| Name | Description | Required |
|---|---|---|
|
|
The name of the operation Type: String Valid Values: GetBonusPayments Default: None |
Yes |
|
|
The ID of the HIT associated with the bonus payments to retrieve. If not specified, all bonus payments for all assignments for the given HIT are returned. Type: String Default: None Conditions: Either the |
Conditional |
|
|
The ID of the assignment associated with the bonus payments to retrieve. If specified, only bonus payments for the given assignment are returned. Type: String Default: None Conditions: Either the |
Conditional |
|
|
The number of bonus payments to include in a page of results. The complete result set is divided into pages of this many bonus payments. Type: positive integer Valid Values: any integer between 1 and 100 Default: 10 |
No |
|
|
The page of results to return. Once the list of bonus payments
has been divided into pages of size Type: positive integer Default: 1 |
No |
Response Elements
A successful request for the GetBonusPayments operation has a
GetBonusPaymentsResult element in the response.
The GetBonusPaymentsResult element contains the following
elements:
| Name | Description |
|---|---|
|
PageNumber |
The page of results to return. Once the list of bonus payments
has been divided into pages of size Type: positive integer |
|
NumResults |
The number of bonus payments on this page in the filtered results list, equivalent to the number of bonus payments being returned by this call. Type: non-negative integer |
|
TotalNumResults |
The total number of bonus payments in the filtered results list based on this call. Type: non-negative integer |
|
BonusPayment |
A bonus payment. The response includes one Type: A BonusPayment data structure, described in the next table. |
Each BonusPayment is a data structure with the following
elements:
| Name | Description | |
|---|---|---|
|
|
The ID of the Worker to whom the bonus was paid. Type: String | |
|
|
The amount of the bonus payment. Type: A Price data structure | |
|
|
The ID of the assignment associated with this bonus payment Type: String | |
|
|
The Reason text given when the bonus was granted, if any. Type: String | |
|
|
The date and time of when the bonus was granted. Type: A dateTime structure in the Coordinated Universal Time
(Greenwich Mean Time) time zone, such as |
Examples
The following example shows how to use the GetBonusPayments
operation.
Sample Request
The following example retrieves all bonus payments associated with the specified HIT.
https://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester &AWSAccessKeyId=[the Requester's Access Key ID]&Version=2012-03-25 &Operation=GetBonusPayments &Signature=[signature for this request]&Timestamp=[your system's local time]&HITId=123RVWYBAZW00EXAMPLE
Sample Response
The following is an example response.
<GetBonusPaymentsResult>
<Request>
<IsValid>True</IsValid>
</Request>
<NumResults>0</NumResults>
<TotalNumResults>0</TotalNumResults>
<PageNumber>1</PageNumber>
</GetBonusPaymentsResult>
