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 |
Assignment
Description
The Assignment data structure represents a single assignment of a HIT to a Worker. The assignment tracks the Worker's efforts to complete the HIT, and contains the results for later retrieval.
The Assignment data structure is used as a response element for the following operations:
Elements
The Assignment structure can contain the following elements.
Name | Description | Required |
---|---|---|
|
A unique identifier for the assignment Type: String Default: None |
No |
|
The ID of the Worker who accepted the HIT. Type: String Default: None |
No |
|
The ID of the HIT Type: String Default: None |
No |
|
The status of the assignment Type: String Valid Values: Submitted | Approved | Rejected Default: None |
No |
|
If results have been submitted, Type: a dateTime Default: None |
No |
|
The date and time the Worker accepted the assignment. Type: a dateTime Default: None |
No |
|
If the Worker has submitted results, Type: a dateTime Default: None |
No |
|
If the Worker has submitted results and the Requester has approved the
results, Type: a dateTime Default: None |
No |
|
If the Worker has submitted results and the Requester has rejected the
results, Type: a dateTime Default: None. This value is omitted from the assignment if the Requester has not yet rejected the results. |
No |
|
The date and time of the deadline for the assignment. This value is derived from the deadline specification for the HIT and the date and time the Worker accepted the HIT. Type: a dateTime Default: None |
No |
|
The Worker's answers submitted for the HIT contained in a Type: a QuestionFormAnswers data structure Default: None |
No |
|
The feedback string included with the call to the ApproveAssignment operation or the RejectAssignment operation, if the Requester approved or rejected the assignment and specified feedback. Type: String Default: None. This field is not returned with assignment data by
default. To request this field, specify a response group of
|
No |
Example
The following example shows an Assignment data structure returned by the GetAssignmentsForHIT operation.
The GetAssignmentsForHIT
operation returns zero or more Assignment
elements for a
Reviewable HIT.
<Assignment> <AssignmentId>123RVWYBAZW00EXAMPLE456RVWYBAZW00EXAMPLE</AssignmentId> <WorkerId>AZ3456EXAMPLE</WorkerId> <HITId>123RVWYBAZW00EXAMPLE</HITId> <AssignmentStatus>Submitted</AssignmentStatus> <Deadline>2005-12-01T23:59:59Z</Deadline> <AcceptTime>2005-12-01T12:00:00Z</AcceptTime> <SubmitTime>2005-12-07T23:59:59Z</SubmitTime> <Answer> <QuestionFormAnswers>
[XML-encoded Answer data]
</QuestionFormAnswers> </Answer> </Assignment>