Amazon Mechanical Turk
API Reference (API Version 2012-03-25)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Did this page help you?  Yes | No |  Tell us about it...

SetHITAsReviewing

Description

The SetHITAsReviewing operation updates the status of a HIT. If the status is Reviewable, this operation updates the status to Reviewing, or reverts a Reviewing HIT back to the Reviewable status.

You can update only HITs with status Reviewable to status Reviewing. Similarly, you can revert only Reviewing HITs back to status Reviewable.

Note

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.

Request Parameters

The SetHITAsReviewing operation 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:

NameDescriptionRequired

Operation

The name of the operation

Type: String

ValidValues: SetHITAsReviewing

Default: None

Yes

HITId

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

Type: String

Default: None

Yes

Revert

Specifies whether to update the HIT Status from Reviewing to Reviewable.

Type: Boolean

Valid Values: true | false

Default: false; the operation promotes the HIT from Reviewable to Reviewing.

No

Response Elements

A successful request for the SetHITAsReviewing operation returns with no errors. The response includes the elements described in the following table. The operation returns no other data.

NameDescription

SetHITAsReviewingResult

Contains a Request element if the Request ResponseGroup is specified.

Examples

The following example shows how to use the SetHITAsReviewingResult operation.

Sample Request

The following example updates a HIT with Reviewable status to Reviewing status.

https://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
&AWSAccessKeyId=[the Requester's Access Key ID]
&Version=2012-03-25
&Operation=SetHITAsReviewing
&Signature=[signature for this request]
&Timestamp=[your system's local time]
&HITId=123RVWYBAZW00EXAMPLE
          

Sample Response

The following is an example response.

<SetHITAsReviewingResult>
  <Request>
    <IsValid>True</IsValid>
  </Request>
</SetHITAsReviewingResult>