qualification_requests

Creates, updates, deletes, gets or lists a qualification_requests resource.

Overview

Name	qualification_requests
Type	Resource
Id	aws.mturk.qualification_requests

Fields

The following fields are returned by SELECT queries:

list_qualification_requests

Name	Datatype	Description
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.
qualification_request_id	string	The ID of the Qualification request, a unique identifier generated when the request was submitted.
qualification_type_id	string	The ID of the Qualification type the Worker is requesting, as returned by the CreateQualificationType operation. (pattern: <code>^[A-Z0-9]+$</code>)
submit_time	string (date-time)	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.
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.
worker_id	string	The ID of the Worker requesting the Qualification. (pattern: <code>^A[A-Z0-9]+$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_qualification_requests	select	region		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.
accept_qualification_request	exec	region, QualificationRequestId		The AcceptQualificationRequest operation approves a Worker's request for a Qualification. Only the owner of the Qualification type can grant a Qualification request for that type. A successful request for the AcceptQualificationRequest operation returns with no errors and an empty body.
reject_qualification_request	exec	region, QualificationRequestId		The RejectQualificationRequest operation rejects a user's request for a Qualification. You can provide a text message explaining why the request was rejected. The Worker who made the request can see this message.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_qualification_requests

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.

SELECT
answer,
qualification_request_id,
qualification_type_id,
submit_time,
test,
worker_id
FROM aws.mturk.qualification_requests
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

accept_qualification_request

The AcceptQualificationRequest operation approves a Worker's request for a Qualification. Only the owner of the Qualification type can grant a Qualification request for that type. A successful request for the AcceptQualificationRequest operation returns with no errors and an empty body.

EXEC aws.mturk.qualification_requests.accept_qualification_request 
@region='{{ region }}' --required 
@@json=
'{
"QualificationRequestId": "{{ QualificationRequestId }}", 
"IntegerValue": {{ IntegerValue }}
}'
;

reject_qualification_request

The RejectQualificationRequest operation rejects a user's request for a Qualification. You can provide a text message explaining why the request was rejected. The Worker who made the request can see this message.

EXEC aws.mturk.qualification_requests.reject_qualification_request 
@region='{{ region }}' --required 
@@json=
'{
"QualificationRequestId": "{{ QualificationRequestId }}", 
"Reason": "{{ Reason }}"
}'
;