GetQualificationRequests

Prev		Next

Description

The GetQualificationRequests operation retrieves requests for Qualifications of a particular Qualification type. The Qualification type author calls this operation to poll for pending requests, and grants Qualifications based on the requests using the GrantQualification operation.

Only requests for Qualifications that require the author's attention are returned by GetQualificationRequests. Requests awaiting Qualification test answers, and requests that have already been granted, are not returned.

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

Results are sorted and divided into numbered "pages," and a single page of results is returned by the operation. Sorting and pagination can be controlled with parameters to the operation.

Sample Request: Using GetQualificationRequests (REST)

The following example of a call to the GetQualificationRequests operation retrieves Qualification requests for a particular Qualification type.

http://mechanicalturk.amazonaws.com/onca/xml?Service=AWSMechanicalTurkRequester
&AWSAccessKeyId=[the Requester's Access Key ID]
&Version=2006-08-23
&Operation=GetQualificationRequests
&Signature=[signature for this request]
&Timestamp=[your system's local time]
&QualificationTypeId=789RVWYBAZW00EXAMPLE

Request Parameters

A request to the Mechanical Turk Service includes parameters that control its behavior and the data it returns. Required parameters must be included for the request to succeed.

GetQualificationRequests 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	Type	Value
`Operation`	The operation to call. To access the `GetQualificationRequests` operation, set the `Operation` parameter to `GetQualificationRequests`.	Required	`GetQualificationRequests`
`QualificationTypeId`	The ID of the Qualification type, as returned by the `CreateQualificationType` operation. If not specified, all requests for all of the author's Qualification types will be considered for the results.	Optional	A valid Qualification type ID
`SortProperty`	The field on which to sort the results returned by the operation. If `SortProperty` is not specified, the set of Qualification requests is sorted by `SubmitTime`.	Optional	`QualificationTypeId` \| `SubmitTime`
`SortDirection`	The direction of the sort used with the field specified by `SortProperty`. If `SortDirection` is not specified, the results will be sorted by the field in ascending order.	Optional	`Ascending` \| `Descending`
`PageSize`	The number of Qualification requests to include in a "page" of results. The complete sorted result set is divided into pages of this many Qualification requests. `PageSize` must be a number between `1` and `100`. If the `PageSize` parameter is not specified, a default size of `10` elements is used.	Optional	A positive integer
`PageNumber`	The page of results to return. Once the Qualification requests have been filtered, sorted, and divided into pages of size `PageSize`, the page corresponding to `PageNumber` is returned as the results of the operation. If the `PageNumber` parameter is not specified, a default page number of 1 will be used.	Optional	A positive integer

Responses

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

The GetQualificationRequestsResult element contains the following elements:

Name	Description	Value
`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.	A non-negative integer
`PageNumber`	The number of this page in the filtered results list.	A positive integer
`TotalNumResults`	The total number of Qualification requests in the filtered results list based on this call.	A non-negative integer
`QualificationRequest`	The Qualification request. The response will include one `QualificationRequest` element for each Qualification request returned by the query.	A Qualification request data structure. For more information, see the Qualification Request Data Structure.