SetHITAsReviewing

Prev		Next

Description

The SetHITAsReviewing operation updates a HIT with a status of Reviewable to have a status of Reviewing, or reverts a Reviewing HIT back to the Reviewable status.

The Reviewable and Reviewing status values for a HIT control which HITs are returned by the GetReviewableHITs operation. A HIT's status is also returned with a HIT's data, such as by a call to the GetHIT operation. Your application can manipulate and query these status values as part of the HIT review process. For example, if verification for a HIT's results is pending further information, the HIT can be moved to the Reviewing status to prevent it from being returned by subsequent calls to GetReviewableHITs.

Only HITs with a status of Reviewable can be updated with a status of Reviewing. Similarly, only Reviewing HITs can be reverted back to a status of Reviewable.

Note:

By design, the SetHITAsReviewing operation does not toggle the status value. The default behavior is to promote a HIT from Reviewable to Reviewing. To revert a Reviewing HIT back to Reviewable, specify the Revert parameter with a value of true.

When a Reviewable or Reviewing HIT is extended to add more assignments or extend the HIT's lifetime (with the ExtendHIT operation), the HIT's status changes back to Assignable. When the extended HIT's new assignments are completed, or when the HIT's new lifetime has expired, the HIT returns to the Reviewable status, regardless of its status prior to being extended.

Sample Request: Using SetHITAsReviewing (REST)

The following example of a call to the SetHITAsReviewing operation updates a HIT with a status of Reviewable to have a status of Reviewing.

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

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.

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

The following parameters are specific to the SetHITAsReviewing operation:

Name Description Type Value

Name	Description	Type	Value
`Operation`	The operation you would like to call. To access the `SetHITAsReviewing` operation, set the `Operation` parameter to `SetHITAsReviewing`.	Required	`SetHITAsReviewing`
`HITId`	The ID of the HIT whose status is to be updated.	Required	A valid HIT ID
`Revert`	If true, update the HIT to have a status of `Reviewable`. The default behavior is to update the HIT to have a status of `Reviewing`.	Optional	A Boolean, `true` or `false`

Operation

The operation you would like to call. To access the SetHITAsReviewing operation, set the Operation parameter to SetHITAsReviewing.

Required

SetHITAsReviewing

HITId

The ID of the HIT whose status is to be updated.

Required

A valid HIT ID

Revert

If true, update the HIT to have a status of Reviewable.

The default behavior is to update the HIT to have a status of Reviewing.

Optional

A Boolean, true or false

Responses

A successful request for the SetHITAsReviewing operation will return with no errors. The response will include a SetHITAsReviewingResult element, which contains the Request (if the Request response group is specified). The operation returns no other data.