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...

DisableHIT

Description

The DisableHIT operation removes a HIT from the Amazon Mechanical Turk marketplace, approves any submitted assignments pending approval or rejection, and disposes of the HIT and all assignment data. Assignment results data cannot be retrieved for a HIT that has been disposed.

Assignments in progress at the time of the call to the DisableHIT operation are approved once the assignments are submitted. You will be charged for approval of these assignments.

When either all of the HIT's assignments have been submitted by Workers, or the HIT has expired and all assignments have either been submitted, returned or abandoned, the HIT is considered Reviewable. For more information about the Reviewable state, see Creating and Managing Assignments.

The DisableHIT operation does not work on HITs in the Reviewable state. For HITs in the Reviewable state, call the ApproveAssignment or the RejectAssignment operation for each submitted assignment for the HIT. Then call the DisposeHIT operation to dispose of the HIT.

Only the Requester who created the HIT can disable it.

Request Parameters

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

NameDescriptionRequired

Operation

The name of the operation

Type: String

Valid Values: DisableHIT

Default: None

Yes

HITId

The ID of the HIT, as returned by the CreateHIT operation.

Type: String

Default: None

Yes

Response Elements

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

NameDescription

DisableHITResult

Contains a Request element if the Request ResponseGroup is specified.

Examples

The following example shows how to use the DisableHIT operation.

Sample Request

The following example disables a HIT with a specified HIT ID.

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

Sample Response

The following is an example response.

<DisableHITResult>
  <Request>
  <IsValid>True</IsValid>
  </Request>
</DisableHITResult>