|
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 |
GetBlockedWorkers
Description
The GetBlockedWorkers operation retrieves a list of Workers who are blocked
from working on your HITs.
Request Parameters
The GetBlockedWorkers operation accepts parameters that are common to all
operations. Some common parameters are required. For more information, see Common Parameters.
The following parameters are specific to the GetBlockedWorkers operation:
| Name | Description | Required |
|---|---|---|
|
|
The name of the operation. Type: String Valid Values: GetBlockedWorkers Default: None |
Yes |
|
|
The page of results to return. Once the assignments have been filtered, sorted, and
divided into pages of size Type: Positive integer Default: 1 |
No |
|
|
The number of assignments to include in a page of results. The complete sorted result set is divided into pages of this many assignments. Type: Positive integer Valid Values: Any integer between 1 and 65535 Default: 10
|
No |
Response Elements
A successful request for the GetBlockedWorkers operation has a
GetBlockedWorkersResult element in the response.
The GetBlockedWorkersResult element contains the elements described in the following table:
| Name | Description |
|---|---|
|
|
This element is present only if the Request
|
|
The number of the page in the filtered results list being returned. Type: Positive integer |
|
|
The number of assignments on the page in the filtered results list, equivalent to the number of assignments returned by this call. Type: Non-negative integer |
|
|
The total number of HITs in the filtered results list based on this call. Type: Positive integer |
|
|
The workers who have been blocked, along with the reason for the block. The response includes one WorkerBlock element for each worker. Type: A WorkerBlock data structure |
Examples
The following example shows how to use the GetBlockedWorkers operation.
Sample Request
The following example blocks a Worker from working on your HITs.
https://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester &AWSAccessKeyId=[the Requester's Access Key ID]&Version=2017-01-17 &Operation=GetBlockedWorkers &Signature=[signature for this request]&Timestamp=[your system's local time]&PageNumber=1 &PageSize=10
Sample Response
The following is an example response.
<GetBlockedWorkersResult> <Request> <IsValid>True</IsValid> </Request> <PageNumber>1</PageNumber> <NumResults>2</NumResults> <TotalNumResults>2</TotalNumResults> <WorkerBlock> <WorkerId>A2QWESAMPLE1</WorkerId> <Reason>Poor quality work</Reason> </WorkerBlock> <WorkerBlock> <WorkerId>A2QWESAMPLE2</WorkerId> <Reason>Poor quality work</Reason> </WorkerBlock> </GetBlockedWorkersResult>
Related Operations
To unblock a Worker, use the UnblockWorker operation.
