MTurk / Client / list_qualification_requests

list_qualification_requests#

MTurk.Client.list_qualification_requests(**kwargs)#

The ListQualificationRequests operation retrieves requests for Qualifications of a particular Qualification type. The owner of the Qualification type calls this operation to poll for pending requests, and accepts them using the AcceptQualification operation.

See also: AWS API Documentation

Request Syntax

response = client.list_qualification_requests(
    QualificationTypeId='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • QualificationTypeId (string) – The ID of the QualificationType.

  • NextToken (string) – If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

  • MaxResults (integer) – The maximum number of results to return in a single call.

Return type:

dict

Returns:

Response Syntax

{
    'NumResults': 123,
    'NextToken': 'string',
    'QualificationRequests': [
        {
            'QualificationRequestId': 'string',
            'QualificationTypeId': 'string',
            'WorkerId': 'string',
            'Test': 'string',
            'Answer': 'string',
            'SubmitTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

    • NumResults (integer) –

      The number of Qualification requests on this page in the filtered results list, equivalent to the number of Qualification requests being returned by this call.

    • NextToken (string) –

      If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

    • QualificationRequests (list) –

      The Qualification request. The response includes one QualificationRequest element for each Qualification request returned by the query.

      • (dict) –

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

        • QualificationRequestId (string) –

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

        • QualificationTypeId (string) –

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

        • WorkerId (string) –

          The ID of the Worker requesting the Qualification.

        • Test (string) –

          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.

        • Answer (string) –

          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.

        • SubmitTime (datetime) –

          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.

Exceptions

  • MTurk.Client.exceptions.ServiceFault

  • MTurk.Client.exceptions.RequestError