ListAssignmentsForHIT
Description
The ListAssignmentsForHIT
operation retrieves completed assignments for a HIT. You can use this operation to retrieve the results for a HIT.
You can get assignments for a HIT at any time, even if the HIT is not yet Reviewable. If a HIT requested multiple assignments, and has received some results but has not yet become Reviewable, you can still retrieve the partial results with this operation.
Use the AssignmentStatuses parameter to control which set of assignments for a HIT are returned. The GetAssignmentsForHIT operation can return submitted assignments awaiting approval, or it can return assignments that have already been approved or rejected. You can set AssignmentStatuses=Approved,Rejected to get assignments that have already been approved and rejected together in one result set.
Only the Requester who created the HIT can retrieve the assignments for that HIT.
Results are sorted and divided into numbered pages and the operation returns a single page of results. You can use the parameters of the operation to control sorting and pagination.
Request Syntax
{ "HITId":
String
, "AssignmentStatuses":String
, "NextToken":String
, "MaxResults":Integer
}
Request Parameters
The request accepts the following data in JSON format:
Name | Description | Required |
---|---|---|
|
The ID of the HIT. Type: String |
Yes |
|
The status of the assignments to return: Submitted | Approved | Rejected Type: String |
No |
|
Pagination token Type: String |
No |
|
Type: Integer |
No |
Response Elements
A successful request returns a paginated list of Assignment data structures submitted for the HIT.
Example
The following example shows how to use the ListAssignmentsForHIT
operation:
Sample Request
POST / HTTP/1.1 Host: mturk-requester.us-east-1.amazonaws.com Content-Length: <PayloadSizeBytes> X-Amz-Date: <Date> { }
Sample Response
The following is an example response:
HTTP/1.1 200 OK x-amzn-RequestId: <RequestId> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Date: <Date> { NextToken:
PaginationToken
, NumResults:10, Assignments:[Assignment] }