QualificationRequest - Amazon Mechanical Turk

WARNING

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:

This Requester API is no longer supported. Please use the latest API using the official AWS SDK. https://aws.amazon.com/getting-started/tools-sdks

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 (SDKs) that have been widely adopted across the AWS community. This API can be accessed using the following AWS SDKs: Python/Boto (Boto3), Javascript (NodeJS or Browser), Java, .NET, Go, Ruby, PHP or C++. This version also makes it easier for customers to connect MTurk with other AWS services like S3, Lambda, Step Functions, Lex, Polly, Rekognition, Amazon SageMaker, AWS Batch, EC2, and more.

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. Please check whether you need to migrate and review the technical migration guide.

For support, contact requestor-apilegacydeprecation-support@amazon.com.

 

QualificationRequest

Description

The QualificationRequest data structure represents a request a Worker has made for a Qualification.

The QualificationRequest data structure is used as a response element for the following operations:

Elements

The QualificationRequest structure can contain the elements described in the following table:

Name Description Required

QualificationRequestId

The ID of the Qualification request, a unique identifier generated when the request was submitted.

Type: String

Default: None

No

QualificationTypeId

The ID of the Qualification type the Worker is requesting, as returned by the CreateQualificationType operation.

Type: String

Default: None

No

SubjectId

The ID of the Worker requesting the Qualification. This ID corresponds to the WorkerId returned with assignment results when the Worker performs a HIT.

Type: String

Default: None

No

Test

The contents of the Qualification test that was presented to the Worker, if the type has a test and the Worker has submitted answers. This value is identical to the QuestionForm associated with the Qualification type at the time the Worker requests the Qualification.

Type: a QuestionForm data structure

Default: None

No

Answer

The Worker's answers for the Qualification type's test contained in a QuestionFormAnswers document, if the type has a test and the Worker has submitted answers. If the Worker does not provide any answers, Answer may be empty.

Type: a QuestionFormAnswers data structure

Default: None

No

SubmitTime

The date and time the Qualification request had a status of Submitted. This is either the time the Worker submitted answers for a Qualification test, or the time the Worker requested the Qualification if the Qualification type does not have a test.

Type: a dateTime structure in the Coordinated Universal Time (Greenwich Mean Time) time zone, such as 2005-01-31T23:59:59Z

Default: None

No

Example

The following example shows a QualificationRequest data structure returned by the GetQualificationRequests operation. This operation returns the requests for Qualifications of a Qualification type to the owner of the type.

<QualificationRequest> <QualificationRequestId>789RVWYBAZW00EXAMPLE951RVWYBAZW00EXAMPLE</QualificationRequestId> <QualificationTypeId>789RVWYBAZW00EXAMPLE</QualificationTypeId> <SubjectId>AZ3456EXAMPLE</SubjectId> <Test> &lt;QuestionForm&gt; [XML-encoded question data] &lt;/QuestionForm&gt; </Test> <Answer> &lt;QuestionFormAnswers&gt; [XML-encoded answer data] &lt;/QuestionFormAnswers&gt; </Answer> <SubmitTime>2005-12-01T23:59:59Z</SubmitTime> </QualificationRequest>