You are browsing the documentation for a deprecated version ('2014-08-15') of the Amazon Mechanical Turk Requester API. This version of the API will be deprecated and will be rendered unusable as of June 1st, 2019. If you request against a legacy API version (https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI-legacy/Welcome.html) on or after June 1, 2019, you will receive the following response:
The latest version of our API ('2017-01-17') provides you with additional tool choices and enables you to select from nine AWS Software Development Kits This version also updates naming conventions used in the API and adopts the AWS standard of Signature Version 4 to authenticate requests securely. The API uses REST requests and no longer requires that developers be familiar with SOAP protocol. These changes make the MTurk API consistent with AWS APIs, simplifying the on-boarding process for both new and existing AWS developers. The legacy MTurk Command Line Tools and .NET, Java, Ruby, and Perl SDKs were marked as deprecated in January 2018. We will be deprecating the legacy APIs as of June 1, 2019. If you are on a legacy API, you must migrate to the latest
version of our API. You can find documentation for the latest API here and the AWS SDKs here For support, contact requestor-apilegacydeprecation-support@amazon.com |
GetHIT
Description
The GetHIT
operation retrieves the details of the specified HIT.
Request Parameters
The GetHIT
accepts parameters common to all operations. Some
common parameters are required. See Common Parameters for more information.
The following parameters are specific to the GetHIT
operation:
Name | Description | Required |
---|---|---|
|
The name of the operation. Type: String Valid Values: GetHIT Default: None |
Yes |
|
The ID of the HIT to retrieve. Type: String Default: None |
Yes |
Response Elements
A successful request for the GetHIT
operation returns the
elements described in the following table in the response.
The HIT
element contains the requested HIT data. For a
description of the HIT data structure as it appears in responses, see the HIT data structure.
Name | Description |
---|---|
|
Contains the requested HIT data. Type: HIT Data Structure |
Examples
The following example shows how to use the GetHIT
operation.
Sample Request
The following example gets a HIT specified by a HIT ID.
https://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester &AWSAccessKeyId=
[the Requester's Access Key ID]
&Version=2017-01-17 &Operation=GetHIT &Signature=[signature for this request]
&Timestamp=[your system's local time]
&HITId=123RVWYBAZW00EXAMPLE
Sample Response
The following is an example response.
<HIT> <Request> <IsValid>True</IsValid> </Request> <HITId>ZZRZPTY4ERDZWJ868JCZ</HITId> <HITTypeId>NYVZTQ1QVKJZXCYZCZVZ</HITTypeId> <CreationTime>2009-07-07T00:56:40Z</CreationTime> <Title>Location</Title> <Description>Select the image that best represents</Description> <Question> <QuestionForm xmlns="http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2005-10-01/QuestionForm.xsd"> <Question> <QuestionIdentifier>Question100</QuestionIdentifier> <DisplayName>My Question</DisplayName> <IsRequired>true</IsRequired> <QuestionContent> <Binary> <MimeType> <Type>image</Type> <SubType>gif</SubType> </MimeType> <DataURL>http://tictactoe.amazon.com/game/01523/board.gif</DataURL> <AltText>The game board, with "X" to move.</AltText> </Binary> </QuestionContent> <AnswerSpecification><FreeTextAnswer/></AnswerSpecification> </Question> </QuestionForm> </Question> <HITStatus>Assignable</HITStatus> <MaxAssignments>1</MaxAssignments> <Reward> <Amount>5.00</Amount> <CurrencyCode>USD</CurrencyCode> <FormattedPrice>$5.00</FormattedPrice> </Reward> <AutoApprovalDelayInSeconds>2592000</AutoApprovalDelayInSeconds> <Expiration>2009-07-14T00:56:40Z</Expiration> <AssignmentDurationInSeconds>30</AssignmentDurationInSeconds> <HITReviewStatus>NotReviewed</HITReviewStatus> </HIT>