HIT

Description

The HIT data structure represents a single HIT, including all the information necessary for a Worker to accept and complete the HIT and claim the reward.

The HIT data structure is used as a response element for the following operations:

HITs and Response Groups

Operations that return a HIT data structure use response groups to determine how much information to return. As described in Common Parameters, the ResponseGroup parameter specifies which sets of elements the service should return, as a set of named groups. For example, the Request response group includes the contents of the operation request in the response.

For the HIT data structure, the Minimal response group returns the HITId. To also return the HIT's Question data, include the HITQuestion response group. To include the other properties of the HIT, specify the HITDetail response group. Finally, specify the HITAssignmentSummary response group to include information on the number of assignments that are available for Workers to accept, accepted and pending submission of results, or completed.

The GetHIT operation returns the HITDetail, HITQuestion and Minimal response groups by default. The HITAssignmentSummary response group is off by default.

The SearchHITs operation includes HITDetail, Minimal, and HITAssignmentSummary as default response groups. You can also specify HITQuestion with SearchHITs.

CreateHIT and DisableHIT can also return additional HIT fields, but their default is Minimal.

Currently, the GetReviewableHITs operation only supports the Minimal response group. To retrieve additional HIT data for HITs returned by this operation, use the HIT IDs in the results with GetHIT.

Elements

The HIT structure can contain the elements described in the following table.

Name	Description	Required
`HITId`	A unique identifier for the HIT. The CreateHIT operation gives a HIT the HIT ID and the HIT retains that ID forever. Type: String Default: None	No
`HITTypeId`	The ID of the HIT type of this HIT Type: String Default: None	No
`CreationTime`	The date and time the HIT was created Type: a dateTime structure in the Coordinated Universal Time (Greenwich Mean Time) time zone, such as `2005-01-31T23:59:59Z`. Default: None	No
`Title`	The title of the HIT Type: String Default: None	No
`Description`	A general description of the HIT Type: String Default: None	No
`Keywords`	One or more words or phrases that describe the HIT, separated by commas. Search terms similar to the keywords of a HIT are more likely to have the HIT in the search results. Type: String Default: None	No
`HITStatus`	The status of the HIT and its assignments Type: String Valid Values: Assignable \| Unassignable \| Reviewable \| Reviewing \| Disposed Default: None	No
`Reward`	The amount of money the Requester will pay a Worker for successfully completing the HIT. Type: a Price data structure Default: None	No
`LifetimeInSeconds`	The amount of time, in seconds, after which the HIT is no longer available for users to accept. The HIT becomes unavailable even if the requested number of assignments, specified by `MaxAssignments`, has not been fulfilled. Type: positive integer Default: None	No
`AssignmentDurationInSeconds`	The length of time, in seconds, that a Worker has to complete the HIT after accepting it. Type: positive integer Default: None	No
`MaxAssignments`	The number of times the HIT can be accepted and completed before the HIT becomes unavailable. Type: positive integer Default: 1	No
`AutoApprovalDelayInSeconds`	The amount of time, in seconds after the Worker submits an assignment for the HIT that the results are automatically approved by the Requester. Type: positive integer Default: None	No
`QualificationRequirement`	A condition that a Worker's Qualifications must meet before the Worker is allowed to accept the HIT. A HIT can have between zero and ten Qualification requirements. All requirements must be met by a Worker's Qualifications for the Worker to accept the HIT. Type: a QualificationRequirement data structure. Default: None	No
`Question`	The data the Worker completing the HIT uses produce the results. Type: either a QuestionForm or an ExternalQuestion data structure. Default: None	No
`RequesterAnnotation`	An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT. Type: String Default: None	No
`NumberOfSimilarHITs`	The number of HITs with fields identical to this HIT, other than the `Question` field. Type: non-negative integer Default: None	No
`HITReviewStatus`	Indicates the review status of the HIT. Type: String Valid Values: NotReviewed \| MarkedForReview \| ReviewedAppropriate \| ReviewedInappropriate Default: None	No
`NumberofAssignmentsPending`	The number of assignments for this HIT that have been accepted by Workers, but have not yet been submitted, returned, abandoned. Type: non-negative integer Default: None Conditions: This element is returned only if the `HITAssignmentSummary` response group is specified.	Conditional
`NumberofAssignmentsAvailable`	The number of assignments for this HIT that are available for Workers to accept Type: non-negative integer Default: None Conditions: This element is returned only if the `HITAssignmentSummary` response group is specified.	Conditional
`NumberofAssignmentsCompleted`	The number of assignments for this HIT that have been approved or rejected. Type: non-negative integer Default: None Conditions: This element is returned only if the `HITAssignmentSummary` response group is specified.	Conditional

Example

The following example shows a HIT data structure returned by the CreateHIT operation. The CreateHIT operation returns an element named HIT that represents the HIT that was created by the call.

<HIT>
  <HITId>123RVWYBAZW00EXAMPLE</HITId>
  <HITTypeId>T100CN9P324W00EXAMPLE</HITTypeId>
  <CreationTime>2005-06-30T23:59:59</CreationTime>
  <HITStatus>Assignable</HITStatus>
  <MaxAssignments>5</MaxAssignments>
  <AutoApprovalDelayInSeconds>86400</AutoApprovalDelayInSeconds>
  <LifetimeInSeconds>86400</LifetimeInSeconds>
  <AssignmentDurationInSeconds>300</AssignmentDurationInSeconds>
  <Reward>
    <Amount>25</Amount>
    <CurrencyCode>USD</CurrencyCode>
    <FormattedPrice>$0.25</FormattedPrice>
  </Reward>
  <Title>Location and Photograph Identification</Title>
  <Description>Select the image that best represents...</Description>
  <Keywords>location, photograph, image, identification, opinion</Keywords>
  <Question>
    &lt;QuestionForm&gt;
      [XML-encoded Question data]
    &lt;/QuestionForm&gt;
  </Question>
  <QualificationRequirement>
    <QualificationTypeId>789RVWYBAZW00EXAMPLE</QualificationTypeId>
    <Comparator>GreaterThan</Comparator>
    <Value>18</Value>
  </QualificationRequirement>
  <HITReviewStatus>NotReviewed</HITReviewStatus>
</HIT>