DisableHIT

Description

The DisableHIT operation removes a HIT from the Amazon Mechanical Turk marketplace, approves all submitted assignments that have not already been approved or rejected, and disposes of the HIT and all assignment data.

Assignments for the HIT that have already been submitted, but not yet approved or rejected, are automatically approved. 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.

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

The DisableHIT operation completely disposes of the HIT and all submitted assignment data. Assignment results data cannot be retrieved for a HIT that has been disposed.

Only the Requester who created a 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:

Name Description Required

Name	Description	Required
`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

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.

Name	Description
`DisableHITResult`	Contains a `Request` element if the `Request` `ResposeGroup` 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.

http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
&AWSAccessKeyId=[the Requester's Access Key ID]
&Version=2008-08-02
&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>