GetQualificationRequests

Description

The GetQualificationRequests 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 grants Qualifications based on the requests using the GrantQualification operation.

The GetQualificationRequests operation returns only those Qualifications that require the type owner's attention. The operation does not return requests awaiting Qualification test answers and requests that have already been granted.

Only the owner of the Qualification type can retrieve its requests.

The operation sorts the results, divides them into numbered pages, and returns a single page of results. You can control sorting and pagination with parameters to the operation.

Request Parameters

The GetQualificationRequests operation accepts parameters common to all operations. Some common parameters are required. See Common Parameters for more information.

The following parameters are specific to the GetQualificationRequests operation:

Name	Description	Required
Operation	The name of the operation. Type: String Valid Values: GetQualificationRequests Default: None	Yes
QualificationTypeId	The ID of the Qualification type, as returned by the CreateQualificationType operation. Type: String Default: None. If not specified, all requests for all of your Qualification types are considered for the results.	No
SortProperty	The field on which to sort the returned results. Type: String Valid Values: QualificationTypeId | SubmitTime Default: SubmitTime	No
SortDirection	The direction of the sort. Type: String Valid Values: Ascending | Descending Default: Ascending	No
PageSize	The number of Qualification requests to include in a page of results. The operation divides the complete sorted result set into pages of this many Qualification requests. Type: positive integer Valid Values: any number between 1 and 100 Default: 10	No
PageNumber	The page of results to return. When the operation has filtered the Qualification requests, sorted them, and divided them into pages of size PageSize, the operation returns the page corresponding to the PageNumber parameter. Type: positive integer Default: 1	No

Response Elements

A successful request for the GetQualificationRequests operation returns a GetQualificationRequestsResult element in the response.

The GetQualificationRequestsResult element contains the following elements:

Name	Description
NumResults	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. Type: non-negative integer
PageNumber	The number of this page in the filtered results list. Type: positive integer
TotalNumResults	The total number of Qualification requests in the filtered results list based on this call. Type: non-negative integer
QualificationRequest	The Qualification request. The response includes one QualificationRequest element for each Qualification request returned by the query. Type: a QualificationRequest data structure.

Examples

The following example shows how to use the GetQualificationRequests operation.

Sample Request

The following example retrieves Qualification requests for a specified Qualification type.

https://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
&AWSAccessKeyId=[the Requester's Access Key ID]
&Version=2017-01-17
&Operation=GetQualificationRequests
&Signature=[signature for this request]
&Timestamp=[your system's local time]
&QualificationTypeId=789RVWYBAZW00EXAMPLE
          

Sample Response

The following is an example response.

<GetQualificationRequestsResult>
  <Request>
    <IsValid>True</IsValid>
  </Request>
  <NumResults>1</NumResults>
  <TotalNumResults>1</TotalNumResults>
  <PageNumber>1</PageNumber>
  <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>
</GetQualificationRequestsResult>