GetQualificationRequests: Get Qualification Requests

In MTurkR: R Client for the MTurk Requester API

Description

Retrieve workers' requests for a QualificationType.

Usage

GetQualificationRequests(qual = NULL, return.all = TRUE, 
                        pagenumber = "1", pagesize = "10", 
                        sortproperty = "SubmitTime", sortdirection = "Ascending", 
                        return.qual.dataframe = TRUE,
                        verbose = getOption('MTurkR.verbose', TRUE), ...)

Arguments

qual	An optional character string containing a QualificationTypeId to which the search should be restricted. If none is supplied, requests made for all QualificationTypes are returned.
return.all	A logical indicating whether all QualificationRequestss (as opposed to a specified page of the search results) should be returned. Default is TRUE.
pagenumber	An optional character string indicating which page of search results should be returned. Most users can ignore this.
pagesize	An optional character string indicating how many search results should be returned by each request, between 1 and 100. Most users can ignore this.
sortproperty	Either “SubmitTime” or “QualificationTypeId”. Ignored if return.all=TRUE. Most users can ignore this.
sortdirection	Either “Ascending” or “Descending”. Ignored if return.all=TRUE. Most users can ignore this.
return.qual.dataframe	A logical indicating whether the QualificationTypes should be returned as a data frame. Default is TRUE.
verbose	Optionally print the results of the API request to the standard output. Default is taken from getOption('MTurkR.verbose', TRUE).
...	Additional arguments passed to request.

Details

A function to retrieve pending Qualification Requests made by workers, either for a specified QualificationType or all QualificationTypes. Specifically, all active, custom QualificationTypes are visible to workers, and workers can request a QualificationType (e.g., when a HIT requires one they do not have). This function retrieves those requests so that they can be granted (with GrantQualification) or rejected (with RejectQualification).

qualrequests() is an alias.

Value

A data frame containing the QualificationRequestId, WorkerId, and other information (e.g., Qualification Test results) for each request.

Author(s)

Thomas J. Leeper

References

API Reference

See Also

GrantQualification

RejectQualification

Examples

## Not run: 
GetQualificationRequests()
GetQualificationRequests("2YCIA0RYNJ9262B1D82MPTUEXAMPLE")

## End(Not run)

MTurkR documentation built on May 29, 2017, 11:09 p.m.