GetQualificationRequests: Get Qualification Requests

In pyMTurkR: A Client for the 'MTurk' Requester API

Get Qualification Requests

Description

Retrieve workers' requests for a QualificationType.

Usage

GetQualificationRequests(
  qual = NULL,
  results = as.integer(100),
  pagetoken = NULL,
  verbose = getOption("pyMTurkR.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.
results	An optional character string indicating how many results to fetch per page. Must be between 1 and 100. Most users can ignore this.
pagetoken	An optional character string indicating which page of search results to start at. Most users can ignore this.
verbose	Optionally print the results of the API request to the standard output. Default is taken from getOption('pyMTurkR.verbose', TRUE).

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() and ListQualificationRequests() are aliases.

Value

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

Author(s)

Tyler Burleigh, Thomas J. Leeper

References

API Reference

See Also

GrantQualification

RejectQualification

Examples

## Not run: 
GetQualificationRequests()

# Search for qualifications you own, then get requests for one of the quals
SearchQualificationTypes(must.be.owner = TRUE, verbose = FALSE) -> quals
quals$QualificationTypeId[[1]] -> qual1
GetQualificationRequests(qual1)

## End(Not run)

pyMTurkR documentation built on May 29, 2024, 6:13 a.m.