rturk 2.0.2 → 2.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (122) hide show
  1. data/README.markdown +3 -2
  2. data/Rakefile +10 -4
  3. data/VERSION +1 -1
  4. data/aws_docs/ApiReference_AnswerKeyDataStructureArticle.html +98 -0
  5. data/aws_docs/ApiReference_ApproveAssignmentOperation.html +75 -0
  6. data/aws_docs/ApiReference_AssignQualificationOperation.html +107 -0
  7. data/aws_docs/ApiReference_AssignmentDataStructureArticle.html +171 -0
  8. data/aws_docs/ApiReference_BlockWorkerOperation.html +70 -0
  9. data/aws_docs/ApiReference_ChangeHITTypeOfHITOperation.html +68 -0
  10. data/aws_docs/ApiReference_CommonParametersArticle.html +119 -0
  11. data/aws_docs/ApiReference_CreateHITOperation.html +330 -0
  12. data/aws_docs/ApiReference_CreateQualificationTypeOperation.html +190 -0
  13. data/aws_docs/ApiReference_DataStructuresArticle.html +7 -0
  14. data/aws_docs/ApiReference_DisableHITOperation.html +63 -0
  15. data/aws_docs/ApiReference_DisposeHITOperation.html +56 -0
  16. data/aws_docs/ApiReference_DisposeQualificationTypeOperation.html +52 -0
  17. data/aws_docs/ApiReference_ExtendHITOperation.html +86 -0
  18. data/aws_docs/ApiReference_ExternalQuestionArticle.html +125 -0
  19. data/aws_docs/ApiReference_ForceExpireHITOperation.html +61 -0
  20. data/aws_docs/ApiReference_FormattedContentXHTMLArticle.html +289 -0
  21. data/aws_docs/ApiReference_GetAccountBalanceOperation.html +51 -0
  22. data/aws_docs/ApiReference_GetAssignmentsForHITOperation.html +166 -0
  23. data/aws_docs/ApiReference_GetBonusPaymentsOperation.html +160 -0
  24. data/aws_docs/ApiReference_GetFileUploadURLOperation.html +75 -0
  25. data/aws_docs/ApiReference_GetHITOperation.html +89 -0
  26. data/aws_docs/ApiReference_GetHITsForQualificationTypeOperation.html +137 -0
  27. data/aws_docs/ApiReference_GetQualificationRequestsOperation.html +155 -0
  28. data/aws_docs/ApiReference_GetQualificationScoreOperation.html +68 -0
  29. data/aws_docs/ApiReference_GetQualificationTypeOperation.html +57 -0
  30. data/aws_docs/ApiReference_GetQualificationsForQualificationTypeOperation.html +134 -0
  31. data/aws_docs/ApiReference_GetRequesterStatisticOperation.html +315 -0
  32. data/aws_docs/ApiReference_GetReviewableHITsOperation.html +155 -0
  33. data/aws_docs/ApiReference_GrantBonusOperation.html +95 -0
  34. data/aws_docs/ApiReference_GrantQualificationOperation.html +69 -0
  35. data/aws_docs/ApiReference_HITDataStructureArticle.html +302 -0
  36. data/aws_docs/ApiReference_HelpOperation.html +125 -0
  37. data/aws_docs/ApiReference_LocaleDataStructureArticle.html +29 -0
  38. data/aws_docs/ApiReference_NotificationAPI_BuildingANotificationReceptor.html +36 -0
  39. data/aws_docs/ApiReference_NotificationAPI_ElementsOfANotification.html +40 -0
  40. data/aws_docs/ApiReference_NotificationDataStructureArticle.html +73 -0
  41. data/aws_docs/ApiReference_NotificationReceptorAPIArticle.html +9 -0
  42. data/aws_docs/ApiReference_NotificationReceptorAPI_RESTTransportArticle.html +39 -0
  43. data/aws_docs/ApiReference_NotificationReceptorAPI_SOAPTransportArticle.html +45 -0
  44. data/aws_docs/ApiReference_NotifyWorkersOperation.html +82 -0
  45. data/aws_docs/ApiReference_OperationsArticle.html +8 -0
  46. data/aws_docs/ApiReference_PriceDataStructureArticle.html +65 -0
  47. data/aws_docs/ApiReference_QualificationDataStructureArticle.html +89 -0
  48. data/aws_docs/ApiReference_QualificationRequestDataStructureArticle.html +102 -0
  49. data/aws_docs/ApiReference_QualificationRequirementDataStructureArticle.html +176 -0
  50. data/aws_docs/ApiReference_QualificationTypeDataStructureArticle.html +198 -0
  51. data/aws_docs/ApiReference_QuestionAnswerDataArticle.html +8 -0
  52. data/aws_docs/ApiReference_QuestionFormAnswersDataStructureArticle.html +54 -0
  53. data/aws_docs/ApiReference_QuestionFormDataStructureArticle.html +796 -0
  54. data/aws_docs/ApiReference_RegisterHITTypeOperation.html +149 -0
  55. data/aws_docs/ApiReference_RejectAssignmentOperation.html +66 -0
  56. data/aws_docs/ApiReference_RejectQualificationRequestOperation.html +61 -0
  57. data/aws_docs/ApiReference_RevokeQualificationOperation.html +78 -0
  58. data/aws_docs/ApiReference_SearchHITsOperation.html +164 -0
  59. data/aws_docs/ApiReference_SearchQualificationTypesOperation.html +211 -0
  60. data/aws_docs/ApiReference_SendTestEventNotificationOperation.html +78 -0
  61. data/aws_docs/ApiReference_SetHITAsReviewingOperation.html +73 -0
  62. data/aws_docs/ApiReference_SetHITTypeNotificationOperation.html +99 -0
  63. data/aws_docs/ApiReference_UnblockWorkerOperation.html +67 -0
  64. data/aws_docs/ApiReference_UpdateQualificationScoreOperation.html +77 -0
  65. data/aws_docs/ApiReference_UpdateQualificationTypeOperation.html +180 -0
  66. data/aws_docs/ApiReference_WsdlLocationArticle.html +95 -0
  67. data/aws_docs/ApiReference_XMLParameterValuesArticle.html +37 -0
  68. data/aws_docs/Welcome.html +125 -0
  69. data/aws_docs/WhatsNew.html +16 -0
  70. data/aws_docs/_title.html +28 -0
  71. data/aws_docs/_toc.html +749 -0
  72. data/aws_docs/aws-docs-IE.css +419 -0
  73. data/aws_docs/aws-docs.css +455 -0
  74. data/aws_docs/copyrightinfo.html +14 -0
  75. data/aws_docs/frameset.js +12 -0
  76. data/aws_docs/images/Feedback_link.gif +0 -0
  77. data/aws_docs/images/caution.png +0 -0
  78. data/aws_docs/images/home.gif +0 -0
  79. data/aws_docs/images/important.png +0 -0
  80. data/aws_docs/images/next.gif +0 -0
  81. data/aws_docs/images/note.png +0 -0
  82. data/aws_docs/images/prev.gif +0 -0
  83. data/aws_docs/images/tip.png +0 -0
  84. data/aws_docs/images/title-swoosh-logo.gif +0 -0
  85. data/aws_docs/images/toc_bullet.gif +0 -0
  86. data/aws_docs/images/toc_plus.gif +0 -0
  87. data/aws_docs/index.html +18 -0
  88. data/aws_docs/toc.js +84 -0
  89. data/lib/rturk.rb +2 -2
  90. data/lib/rturk/adapter.rb +11 -0
  91. data/lib/rturk/adapters/assignment.rb +13 -50
  92. data/lib/rturk/adapters/hit.rb +21 -9
  93. data/lib/rturk/adapters/worker.rb +23 -0
  94. data/lib/rturk/operation.rb +1 -1
  95. data/lib/rturk/operations/create_hit.rb +10 -54
  96. data/lib/rturk/operations/register_hit_type.rb +68 -0
  97. data/lib/rturk/operations/search_hits.rb +44 -0
  98. data/lib/rturk/parser.rb +8 -0
  99. data/lib/rturk/parsers/answer_parser.rb +29 -0
  100. data/lib/rturk/parsers/assignment_parser.rb +49 -0
  101. data/lib/rturk/parsers/hit_parser.rb +50 -0
  102. data/lib/rturk/{response.rb → parsers/response.rb} +7 -2
  103. data/lib/rturk/{responses → parsers/responses}/create_hit_response.rb +2 -2
  104. data/lib/rturk/{responses → parsers/responses}/get_account_balance_response.rb +0 -0
  105. data/lib/rturk/{responses → parsers/responses}/get_assignments_for_hit_response.rb +3 -3
  106. data/lib/rturk/{responses → parsers/responses}/get_hit_response.rb +9 -16
  107. data/lib/rturk/{responses → parsers/responses}/get_reviewable_hits_response.rb +3 -5
  108. data/lib/rturk/parsers/responses/register_hit_type_response.rb +17 -0
  109. data/lib/rturk/parsers/responses/search_hits_response.rb +65 -0
  110. data/lib/rturk/xml_utilities.rb +14 -3
  111. data/rturk.gemspec +112 -12
  112. data/spec/adapters/hit_spec.rb +10 -0
  113. data/spec/fake_responses/register_hit_type.xml +6 -0
  114. data/spec/fake_responses/search_hits.xml +50 -0
  115. data/spec/operations/create_hit_spec.rb +2 -2
  116. data/spec/operations/get_hit_spec.rb +1 -1
  117. data/spec/operations/register_hit_type_spec.rb +24 -0
  118. data/spec/{adapters/answers_spec.rb → parsers/answer_parser_spec.rb} +2 -2
  119. data/spec/parsers/hit_parser_spec.rb +41 -0
  120. data/spec/xml_parse_spec.rb +2 -2
  121. metadata +111 -11
  122. data/lib/rturk/adapters/answers.rb +0 -38
data/aws_docs/ApiReference_BlockWorkerOperation.html ADDED
@@ -0,0 +1,70 @@
1
+ <html xmlns:fo="http://www.w3.org/1999/XSL/Format"><head>
2
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3
+ <title>BlockWorker</title><link rel="stylesheet" href="aws-docs-IE.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><link rel="home" href="#top" title="Amazon Mechanical Turk"><link rel="up" href="ApiReference_OperationsArticle.html" title="Chapter&nbsp;5.&nbsp;Operations"><link rel="prev" href="ApiReference_AssignQualificationOperation.html" title="AssignQualification"><link rel="next" href="ApiReference_ChangeHITTypeOfHITOperation.html" title="ChangeHITTypeOfHIT"><!--[if !IE]>--><link rel="stylesheet" href="aws-docs.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><!--<![endif]--><meta xmlns="http://www.w3.org/1999/xhtml" http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><script src="/urchin.js" type="text/javascript"></script><script type="text/javascript">
4
+ urchinTracker();
5
+ </script><script xmlns="http://www.w3.org/1999/xhtml" type="text/javascript" src="frameset.js"> //
6
+ </script></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header" cellspacing="0" cellpadding="2"><tr><td width="30%" align="left"><a accesskey="p" href="ApiReference_AssignQualificationOperation.html"><img src="images/prev.gif" alt="Prev"></a> </td><td width="40%" align="center"><a href="http://survey.amazonwebservices.com/survey/s?s=559&amp;opdata_page=Mturk_API_2008-08-02_ApiReference_BlockWorkerOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_ChangeHITTypeOfHITOperation.html"><img src="images/next.gif" alt="Next"></a></td></tr></table><div class="breadcrumb"><a href="Welcome.html">Welcome</a><a href=""></a> &raquo; <a href="ApiReference_OperationsArticle.html">Operations</a> &raquo; <strong>BlockWorker</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">BlockWorker</h1></div></div></div><a class="indexterm" name="d0e1682"></a><a class="indexterm" name="d0e1685"></a><a class="indexterm" name="d0e1690"></a><a class="indexterm" name="d0e1693"></a><a class="indexterm" name="d0e1696"></a><a class="indexterm" name="d0e1701"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e1706">Description</h2></div></div></div><p> The <code class="function">BlockWorker</code> operation allows you to prevent a Worker from
7
+ working on your HITs. For example, you can block a Worker who is producing poor quality
8
+ work. You can block up to 100,000 Workers. </p><p> You need the Worker ID to use this operation. You can get the Worker ID in the
9
+ assignment data returned by a call to the <a class="link" href="ApiReference_GetAssignmentsForHITOperation.html" title="GetAssignmentsForHIT">GetAssignmentsForHIT</a>
10
+ operation. If the Worker ID is missing or invalid, this operation returns with the
11
+ failure message "WorkerId is invalid." If the Worker is already blocked, this operation
12
+ returns successfully. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e1719">Request Parameters</h2></div></div></div><p> The <code class="function">BlockWorker</code> operation accepts parameters common to all
13
+ operations. Some common parameters are required. See <a class="link" href="ApiReference_CommonParametersArticle.html" title="Chapter&nbsp;4.&nbsp;Common Parameters">Common Parameters</a> for more information. </p><p> The following parameters are specific to the <code class="function">BlockWorker</code>
14
+ operation: </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col><col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>
15
+ <p class="simpara">
16
+ <em class="parameter"><code>Operation</code></em>
17
+ </p>
18
+ </td><td>
19
+ <p class="simpara">The name of the operation</p>
20
+ <p class="simpara">Type: String</p>
21
+ <p class="simpara">Valid Values: BlockWorker</p>
22
+ <p class="simpara">Default: None</p>
23
+ </td><td>
24
+ <p class="simpara">Yes</p>
25
+ </td></tr><tr><td>
26
+ <p class="simpara">
27
+ <em class="parameter"><code>WorkerId</code></em>
28
+ </p>
29
+ </td><td>
30
+ <p class="simpara"> The ID of the Worker to block. </p>
31
+ <p class="simpara">Type: String</p>
32
+ <p class="simpara">Default: None</p>
33
+ </td><td>
34
+ <p class="simpara">Yes</p>
35
+ </td></tr><tr><td>
36
+ <p class="simpara">
37
+ <em class="parameter"><code>Reason</code></em>
38
+ </p>
39
+ </td><td>
40
+ <p class="simpara"> A message explaining the reason for blocking the Worker. This
41
+ parameter enables you to keep track of your Workers. The Worker does
42
+ not see this message. </p>
43
+ <p class="simpara">Type: String</p>
44
+ <p class="simpara">Default: None</p>
45
+ </td><td>
46
+ <p class="simpara">Yes</p>
47
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e1826">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">BlockWorker</code> operation returns with
48
+ no errors. The response includes the elements described in the following table. The
49
+ operation returns no other data. </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>
50
+ <p class="simpara">
51
+ <em class="parameter"><code>BlockWorkerResult</code></em>
52
+ </p>
53
+ </td><td>
54
+ <p class="simpara"> Contains a <em class="parameter"><code>Request</code></em> element if the
55
+ <strong class="userinput"><code>Request</code></strong>
56
+ <em class="parameter"><code>ResposeGroup</code></em> is specified. </p>
57
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e1868">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">BlockWorker</code>
58
+ operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e1876">Sample Request </h3></div></div></div><p>The following example blocks a Worker from working on your HITs.</p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
59
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
60
+ &amp;Version=2008-08-02
61
+ &amp;Operation=BlockWorker
62
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
63
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
64
+ &amp;WorkerId=AZ3456EXAMPLE
65
+ &amp;Reason=After%20several%20warnings,%20he%20continued%20to%20submit%20answers%20without%20reading%20the%20instructions%20carefully.
66
+ </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e1892">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;BlockWorkerResult&gt;
67
+ &lt;Request&gt;
68
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
69
+ &lt;/Request&gt;
70
+ &lt;/BlockWorkerResult&gt;</pre></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e1899">Related Operations </h2></div></div></div><p> To unblock a Worker use the <a class="link" href="ApiReference_UnblockWorkerOperation.html" title="UnblockWorker">UnblockWorker</a> operation. </p></div></div><div class="navfooter"><table width="100%" summary="Navigation footer" cellspacing="0" cellpadding="2"><tr><td width="30%" align="left"><a accesskey="p" href="ApiReference_AssignQualificationOperation.html"><img src="images/prev.gif" alt="Prev"></a> </td><td width="40%" align="center"><a href="http://survey.amazonwebservices.com/survey/s?s=559&amp;opdata_page=Mturk_API_2008-08-02_ApiReference_BlockWorkerOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_ChangeHITTypeOfHITOperation.html"><img src="images/next.gif" alt="Next"></a></td></tr><tr><td width="30%" align="left" valign="top">&nbsp;</td><td width="40%" align="center"><a accesskey="h" href="#top"><img src="images/home.gif" alt="Home"></a></td><td width="30%" align="right" valign="top">&nbsp;</td></tr></table></div></body></html>
data/aws_docs/ApiReference_ChangeHITTypeOfHITOperation.html ADDED
@@ -0,0 +1,68 @@
1
+ <html xmlns:fo="http://www.w3.org/1999/XSL/Format"><head>
2
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3
+ <title>ChangeHITTypeOfHIT</title><link rel="stylesheet" href="aws-docs-IE.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><link rel="home" href="#top" title="Amazon Mechanical Turk"><link rel="up" href="ApiReference_OperationsArticle.html" title="Chapter&nbsp;5.&nbsp;Operations"><link rel="prev" href="ApiReference_BlockWorkerOperation.html" title="BlockWorker"><link rel="next" href="ApiReference_CreateHITOperation.html" title="CreateHIT"><!--[if !IE]>--><link rel="stylesheet" href="aws-docs.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><!--<![endif]--><meta xmlns="http://www.w3.org/1999/xhtml" http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><script src="/urchin.js" type="text/javascript"></script><script type="text/javascript">
4
+ urchinTracker();
5
+ </script><script xmlns="http://www.w3.org/1999/xhtml" type="text/javascript" src="frameset.js"> //
6
+ </script></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header" cellspacing="0" cellpadding="2"><tr><td width="30%" align="left"><a accesskey="p" href="ApiReference_BlockWorkerOperation.html"><img src="images/prev.gif" alt="Prev"></a> </td><td width="40%" align="center"><a href="http://survey.amazonwebservices.com/survey/s?s=559&amp;opdata_page=Mturk_API_2008-08-02_ApiReference_ChangeHITTypeOfHITOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_CreateHITOperation.html"><img src="images/next.gif" alt="Next"></a></td></tr></table><div class="breadcrumb"><a href="Welcome.html">Welcome</a><a href=""></a> &raquo; <a href="ApiReference_OperationsArticle.html">Operations</a> &raquo; <strong>ChangeHITTypeOfHIT</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">ChangeHITTypeOfHIT</h1></div></div></div><a class="indexterm" name="d0e1911"></a><a class="indexterm" name="d0e1914"></a><a class="indexterm" name="d0e1919"></a><a class="indexterm" name="d0e1924"></a><a class="indexterm" name="d0e1929"></a><a class="indexterm" name="d0e1934"></a><a class="indexterm" name="d0e1941"></a><a class="indexterm" name="d0e1944"></a><a class="indexterm" name="d0e1949"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e1954">Description</h2></div></div></div><p> The <code class="function">ChangeHITTypeOfHIT</code> operation allows you to change the
7
+ <em class="parameter"><code>HITType</code></em> properties of a HIT. This operation disassociates the
8
+ HIT from its old <em class="parameter"><code>HITType</code></em> properties and associates it with the
9
+ new <em class="parameter"><code>HITType</code></em> properties. The HIT takes on the properties of the
10
+ new <em class="parameter"><code>HITType</code></em> in place of the old ones. For more information about
11
+ HIT types, see
12
+ <a class="ulink" href="http://docs.amazonwebservices.com/AWSMechTurk/2008-08-02/DG/index.html?Concepts_HITTypesArticle.html" target="_blank">HIT Types</a>. </p><p> You can use <code class="function">ChangeHITTypeOfHIT</code> to update any of the <em class="parameter"><code>HITType</code></em> properties of a HIT. All properties except for <em class="parameter"><code>Reward</code></em> can be updated at any time. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e1988">Request Parameters</h2></div></div></div><p> The <code class="function">ChangeHITTypeOfHIT</code> operation accepts parameters common to
13
+ all operations. Some common parameters are required. See <a class="link" href="ApiReference_CommonParametersArticle.html" title="Chapter&nbsp;4.&nbsp;Common Parameters">Common Parameters</a> for more information. </p><p> The following parameters are specific to the <code class="function">ChangeHITTypeOfHIT</code>
14
+ operation: </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col><col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>
15
+ <p class="simpara">
16
+ <em class="parameter"><code>Operation</code></em>
17
+ </p>
18
+ </td><td>
19
+ <p class="simpara">The name of the operation</p>
20
+ <p class="simpara">Type: String</p>
21
+ <p class="simpara">Valid Values: ChangeHITTypeOfHIT</p>
22
+ <p class="simpara">Default: None</p>
23
+ </td><td>
24
+ <p class="simpara">Yes</p>
25
+ </td></tr><tr><td>
26
+ <p class="simpara">
27
+ <em class="parameter"><code>HITId</code></em>
28
+ </p>
29
+ </td><td>
30
+ <p class="simpara">The ID of the HIT to change</p>
31
+ <p class="simpara">Type: String</p>
32
+ <p class="simpara">Default: None</p>
33
+ </td><td>
34
+ <p class="simpara">Yes</p>
35
+ </td></tr><tr><td>
36
+ <p class="simpara">
37
+ <em class="parameter"><code>HITTypeId</code></em>
38
+ </p>
39
+ </td><td>
40
+ <p class="simpara">The ID of the new HIT type</p>
41
+ <p class="simpara">Type: String</p>
42
+ <p class="simpara">Default: None</p>
43
+ </td><td>
44
+ <p class="simpara">Yes</p>
45
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e2095">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">ChangeHITTypeOfHIT</code> operation
46
+ returns with no errors. The response includes the elements described in the following
47
+ table. The operation returns no other data. </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>
48
+ <p class="simpara">
49
+ <em class="parameter"><code>ChangeHITTypeOfHITResult</code></em>
50
+ </p>
51
+ </td><td>
52
+ <p class="simpara"> Contains a <em class="parameter"><code>Request</code></em> element if the
53
+ <strong class="userinput"><code>Request</code></strong>
54
+ <em class="parameter"><code>ResposeGroup</code></em> is specified. </p>
55
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e2137">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">ChangeHITTypeOfHIT</code>
56
+ operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e2145">Sample Request</h3></div></div></div><p>The following example changes the HIT type.</p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
57
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
58
+ &amp;Version=2008-08-02
59
+ &amp;Operation=ChangeHITTypeOfHIT
60
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
61
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
62
+ &amp;HITId=123RVWYBAZW00EXAMPLE
63
+ &amp;HITTypeId=T100CN9P324W00EXAMPLE
64
+ </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e2161">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;ChangeHITTypeOfHITResult&gt;
65
+ &lt;Request&gt;
66
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
67
+ &lt;/Request&gt;
68
+ &lt;/ChangeHITTypeOfHITResult&gt;</pre></div></div></div><div class="navfooter"><table width="100%" summary="Navigation footer" cellspacing="0" cellpadding="2"><tr><td width="30%" align="left"><a accesskey="p" href="ApiReference_BlockWorkerOperation.html"><img src="images/prev.gif" alt="Prev"></a> </td><td width="40%" align="center"><a href="http://survey.amazonwebservices.com/survey/s?s=559&amp;opdata_page=Mturk_API_2008-08-02_ApiReference_ChangeHITTypeOfHITOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_CreateHITOperation.html"><img src="images/next.gif" alt="Next"></a></td></tr><tr><td width="30%" align="left" valign="top">&nbsp;</td><td width="40%" align="center"><a accesskey="h" href="#top"><img src="images/home.gif" alt="Home"></a></td><td width="30%" align="right" valign="top">&nbsp;</td></tr></table></div></body></html>
data/aws_docs/ApiReference_CommonParametersArticle.html ADDED
@@ -0,0 +1,119 @@
1
+ <html xmlns:fo="http://www.w3.org/1999/XSL/Format"><head>
2
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3
+ <title>Chapter&nbsp;4.&nbsp;Common Parameters</title><link rel="stylesheet" href="aws-docs-IE.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><link rel="home" href="#top" title="Amazon Mechanical Turk"><link rel="up" href="#top" title="Amazon Mechanical Turk"><link rel="prev" href="ApiReference_WsdlLocationArticle.html" title="Chapter&nbsp;3.&nbsp;WSDL and Schema Locations"><link rel="next" href="ApiReference_OperationsArticle.html" title="Chapter&nbsp;5.&nbsp;Operations"><!--[if !IE]>--><link rel="stylesheet" href="aws-docs.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><!--<![endif]--><meta xmlns="http://www.w3.org/1999/xhtml" http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><script src="/urchin.js" type="text/javascript"></script><script type="text/javascript">
4
+ urchinTracker();
5
+ </script><script xmlns="http://www.w3.org/1999/xhtml" type="text/javascript" src="frameset.js"> //
6
+ </script></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header" cellspacing="0" cellpadding="2"><tr><td width="30%" align="left"><a accesskey="p" href="ApiReference_WsdlLocationArticle.html"><img src="images/prev.gif" alt="Prev"></a> </td><td width="40%" align="center"><a href="http://survey.amazonwebservices.com/survey/s?s=559&amp;opdata_page=Mturk_API_2008-08-02_ApiReference_CommonParametersArticle">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_OperationsArticle.html"><img src="images/next.gif" alt="Next"></a></td></tr></table><div class="breadcrumb"><a href="Welcome.html">Welcome</a><a href=""></a> &raquo; <strong>Common Parameters</strong></div></div><div class="chapter" lang="en" id="ApiReference_CommonParametersArticle"><div class="titlepage"><div><div><h1 class="topictitle">Common Parameters</h1></div></div></div><a class="indexterm" name="d0e693"></a><a class="indexterm" name="d0e698"></a><a class="indexterm" name="d0e701"></a><a class="indexterm" name="d0e704"></a><a class="indexterm" name="d0e707"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e710">Introduction</h2></div></div></div><p> The Amazon Mechanical Turk Service accepts a set of parameters in the request common to every
7
+ operation. Each required parameter must be included in a request for the request to be successful. </p><p> Parameters common to all operations are explained here. For more information about the
8
+ parameters for a specific operation, see the description of the operation in the <a class="link" href="ApiReference_OperationsArticle.html" title="Chapter&nbsp;5.&nbsp;Operations">Operations</a>
9
+ section of this reference. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e719">Common Request Parameters</h2></div></div></div><p> Requests to the Amazon Mechanical Turk service can include the parameters described in the
10
+ following table. Required parameters must be included with each request for the request to
11
+ succeed. </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col><col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>
12
+ <p class="simpara">
13
+ <em class="parameter"><code>AWSAccessKeyId</code></em>
14
+ </p>
15
+ </td><td>
16
+ <p class="simpara"> The Requester's Access Key ID, a unique identifier that corresponds to a
17
+ Secret Access Key and an Amazon.com account. </p>
18
+ <p class="simpara">Type: String</p>
19
+ <p class="simpara">Default: None</p>
20
+ </td><td>
21
+ <p class="simpara">Yes</p>
22
+ </td></tr><tr><td>
23
+ <p class="simpara">
24
+ <em class="parameter"><code>Service</code></em>
25
+ </p>
26
+ </td><td>
27
+ <p class="simpara">The name of the Amazon Web Services service.</p>
28
+ <p class="simpara">Type: String</p>
29
+ <p class="simpara">Valid Values: AWSMechanicalTurkRequester</p>
30
+ <p class="simpara">Default: None</p>
31
+ <p class="simpara">Constraints: For REST requests only.</p>
32
+ <p class="simpara"> For SOAP requests the name of the service is part of the SOAP entry
33
+ point, and does not need to bespecified in the request. </p>
34
+ </td><td>
35
+ <p class="simpara">Yes</p>
36
+ </td></tr><tr><td>
37
+ <p class="simpara">
38
+ <em class="parameter"><code>Operation</code></em>
39
+ </p>
40
+ </td><td>
41
+ <p class="simpara">The name of the operation</p>
42
+ <p class="simpara">Type: String</p>
43
+ <p class="simpara">Default: None</p>
44
+ <p class="simpara">Contraints: For REST requests only</p>
45
+ <p class="simpara"> For SOAP requests, the operation name is part of the SOAP message
46
+ structure provided by your SOAP toolkit, and is not part of the request.
47
+ </p>
48
+ </td><td>
49
+ <p class="simpara">Yes</p>
50
+ </td></tr><tr><td>
51
+ <p class="simpara">
52
+ <em class="parameter"><code>Signature</code></em>
53
+ </p>
54
+ </td><td>
55
+ <p class="simpara"> The signature for this request, an encrypted string calculated from
56
+ elements of the request and the AWS access key that corresponds to your AWS
57
+ Access Key ID. For information about how to calculate a
58
+ <em class="parameter"><code>Signature</code></em>, see MakingRequests_RequestAuthenticationArticle. </p>
59
+ <p class="simpara">Type: String</p>
60
+ <p class="simpara">Default: None</p>
61
+ </td><td>
62
+ <p class="simpara">Yes</p>
63
+ </td></tr><tr><td>
64
+ <p class="simpara">
65
+ <em class="parameter"><code>Timestamp</code></em>
66
+ </p>
67
+ </td><td>
68
+ <p class="simpara"> The current time on your system. This value is included to validate
69
+ against the <em class="parameter"><code>Signature</code></em> parameter. </p>
70
+ <p class="simpara"> Type: a <a class="ulink" href="http://www.w3.org/TR/xmlschema-2/#dateTime" target="_blank">dateTime</a> in the Coordinated Universal Time (Greenwich Mean Time) time
71
+ zone, such as <strong class="userinput"><code>2005-01-31T23:59:59Z</code></strong>. </p>
72
+ <p class="simpara">Default: None</p>
73
+ </td><td>
74
+ <p class="simpara">Yes</p>
75
+ </td></tr><tr><td>
76
+ <p class="simpara">
77
+ <em class="parameter"><code>ResponseGroup</code></em>
78
+ </p>
79
+ </td><td>
80
+ <p class="simpara">A list of response groups</p>
81
+ <p class="simpara">Type: String</p>
82
+ <p class="simpara">Default: None</p>
83
+ </td><td>
84
+ <p class="simpara">Yes</p>
85
+ </td></tr><tr><td>
86
+ <p class="simpara">
87
+ <em class="parameter"><code>Version</code></em>
88
+ </p>
89
+ </td><td>
90
+ <p class="simpara">Specifies what version of the API to use.</p>
91
+ <p class="simpara">Type: String</p>
92
+ <p class="simpara">Default: None. If not specified, the latest version of the API is used.</p>
93
+ <p class="simpara">Constraints: Used only for REST requests</p>
94
+ </td><td>
95
+ <p class="simpara">No</p>
96
+ </td></tr><tr><td>
97
+ <p class="simpara">
98
+ <em class="parameter"><code>Validate</code></em>
99
+ </p>
100
+ </td><td>
101
+ <p class="simpara"> If specified, instructs the service to <span class="emphasis"><em>not</em></span> perform
102
+ the operation, and only return information about whether or not the request is
103
+ valid. </p>
104
+ <p class="simpara">Type: String</p>
105
+ <p class="simpara">Default: None. If not specified, the service executes the requested
106
+ operation.</p>
107
+ </td><td>
108
+ <p class="simpara">No</p>
109
+ </td></tr><tr><td>
110
+ <p class="simpara">
111
+ <em class="parameter"><code>Credential</code></em>
112
+ </p>
113
+ </td><td>
114
+ <p class="simpara">This parameter is reserved for future use.</p>
115
+ <p class="simpara">Type: None</p>
116
+ <p class="simpara">Default: None</p>
117
+ </td><td>
118
+ <p class="simpara">Not used</p>
119
+ </td></tr></tbody></table></div></div></div><div class="navfooter"><table width="100%" summary="Navigation footer" cellspacing="0" cellpadding="2"><tr><td width="30%" align="left"><a accesskey="p" href="ApiReference_WsdlLocationArticle.html"><img src="images/prev.gif" alt="Prev"></a> </td><td width="40%" align="center"><a href="http://survey.amazonwebservices.com/survey/s?s=559&amp;opdata_page=Mturk_API_2008-08-02_ApiReference_CommonParametersArticle">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_OperationsArticle.html"><img src="images/next.gif" alt="Next"></a></td></tr><tr><td width="30%" align="left" valign="top">&nbsp;</td><td width="40%" align="center"><a accesskey="h" href="#top"><img src="images/home.gif" alt="Home"></a></td><td width="30%" align="right" valign="top">&nbsp;</td></tr></table></div></body></html>
data/aws_docs/ApiReference_CreateHITOperation.html ADDED
@@ -0,0 +1,330 @@
1
+ <html xmlns:fo="http://www.w3.org/1999/XSL/Format"><head>
2
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3
+ <title>CreateHIT</title><link rel="stylesheet" href="aws-docs-IE.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><link rel="home" href="#top" title="Amazon Mechanical Turk"><link rel="up" href="ApiReference_OperationsArticle.html" title="Chapter&nbsp;5.&nbsp;Operations"><link rel="prev" href="ApiReference_ChangeHITTypeOfHITOperation.html" title="ChangeHITTypeOfHIT"><link rel="next" href="ApiReference_CreateQualificationTypeOperation.html" title="CreateQualificationType"><!--[if !IE]>--><link rel="stylesheet" href="aws-docs.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><!--<![endif]--><meta xmlns="http://www.w3.org/1999/xhtml" http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><script src="/urchin.js" type="text/javascript"></script><script type="text/javascript">
4
+ urchinTracker();
5
+ </script><script xmlns="http://www.w3.org/1999/xhtml" type="text/javascript" src="frameset.js"> //
6
+ </script></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header" cellspacing="0" cellpadding="2"><tr><td width="30%" align="left"><a accesskey="p" href="ApiReference_ChangeHITTypeOfHITOperation.html"><img src="images/prev.gif" alt="Prev"></a> </td><td width="40%" align="center"><a href="http://survey.amazonwebservices.com/survey/s?s=559&amp;opdata_page=Mturk_API_2008-08-02_ApiReference_CreateHITOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_CreateQualificationTypeOperation.html"><img src="images/next.gif" alt="Next"></a></td></tr></table><div class="breadcrumb"><a href="Welcome.html">Welcome</a><a href=""></a> &raquo; <a href="ApiReference_OperationsArticle.html">Operations</a> &raquo; <strong>CreateHIT</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">CreateHIT</h1></div></div></div><a class="indexterm" name="d0e2172"></a><a class="indexterm" name="d0e2175"></a><a class="indexterm" name="d0e2180"></a><a class="indexterm" name="d0e2185"></a><a class="indexterm" name="d0e2190"></a><a class="indexterm" name="d0e2193"></a><a class="indexterm" name="d0e2198"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e2203">Description</h2></div></div></div><p> The <code class="function">CreateHIT</code> operation creates a new HIT. The new HIT is made
7
+ available for Workers to find and accept on the Amazon Mechanical Turk web site. </p><p> There are two ways to call the <code class="function">CreateHIT</code> operation: with the HIT
8
+ type ID, or with the common property values. If the <em class="parameter"><code>HITTypeId</code></em>
9
+ parameter is specified, the <code class="function">CreateHIT</code> operation assumes the syntax
10
+ with a HIT type ID is what you intended. If you accidentally provide both a HIT type ID
11
+ and values for the common properties, the common property values will be ignored.
12
+ </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e2222">Request Parameters</h2></div></div></div><p> The <code class="function">CreateHIT</code> operation accepts parameters common to all
13
+ operations. Some common parameters are required. See <a class="link" href="ApiReference_CommonParametersArticle.html" title="Chapter&nbsp;4.&nbsp;Common Parameters">Common Parameters</a> for more
14
+ information. </p><p> The following tables describe the additonal parameters required to call the <code class="function">CreateHIT</code> operation with an explicit HIT type ID and without a HIT type
15
+ ID. </p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e2238">Calling <code class="function">CreateHIT</code> with a HIT Type ID</h3></div></div></div><p> The following parameters are specific to calling the <code class="function">CreateHIT</code> operation with an explicit HIT type ID: </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col><col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>
16
+ <p class="simpara">
17
+ <em class="parameter"><code>Operation</code></em>
18
+ </p>
19
+ </td><td>
20
+ <p class="simpara">The name of the operation</p>
21
+ <p class="simpara">Type: String</p>
22
+ <p class="simpara">Valid Values: CreateHIT</p>
23
+ <p class="simpara">Default: None</p>
24
+ </td><td>
25
+ <p class="simpara">Yes</p>
26
+ </td></tr><tr><td>
27
+ <p class="simpara">
28
+ <em class="parameter"><code>HITTypeId</code></em>
29
+ </p>
30
+ </td><td>
31
+ <p class="simpara">The HIT type ID</p>
32
+ <p class="simpara">Type: String</p>
33
+ <p class="simpara">Default: None</p>
34
+ </td><td>
35
+ <p class="simpara">Yes</p>
36
+ </td></tr><tr><td>
37
+ <p class="simpara">
38
+ <em class="parameter"><code>Question</code></em>
39
+ </p>
40
+ </td><td>
41
+ <p class="simpara"> The data the person completing the HIT uses to produce the
42
+ results. </p>
43
+ <p class="simpara">Type: String</p>
44
+ <p class="simpara">Default: None</p>
45
+ <p class="simpara"> Constraints: must be a <a class="link" href="ApiReference_QuestionFormDataStructureArticle.html" title="QuestionForm">
46
+ QuestionForm</a> data structure or an <a class="link" href="ApiReference_ExternalQuestionArticle.html" title="ExternalQuestion">
47
+ ExternalQuestion</a> data structure. The XML Question
48
+ data must not be larger than 64 kilobytes (65,535 bytes) in
49
+ size, including whitespace. </p>
50
+ </td><td>
51
+ <p class="simpara">Yes</p>
52
+ </td></tr><tr><td>
53
+ <p class="simpara">
54
+ <em class="parameter"><code>LifetimeInSeconds</code></em>
55
+ </p>
56
+ </td><td>
57
+ <p class="simpara"> The number of seconds after which the HIT is no longer
58
+ available for users to accept. After the lifetime of the HIT has
59
+ elapsed, the HIT no longer appears in HIT searches, even if not
60
+ all of the HIT's assignments have been accepted. </p>
61
+ <p class="simpara">Type: positive integer</p>
62
+ <p class="simpara"> Valid Values: any integer between 30 (30 seconds) and
63
+ 31536000 (365 days). </p>
64
+ <p class="simpara">Default: None</p>
65
+ </td><td>
66
+ <p class="simpara">Yes</p>
67
+ </td></tr><tr><td>
68
+ <p class="simpara">
69
+ <em class="parameter"><code>MaxAssignments</code></em>
70
+ </p>
71
+ </td><td>
72
+ <p class="simpara"> The number of times the HIT can be accepted and completed
73
+ before the HIT becomes unavailable. </p>
74
+ <p class="simpara">Type: positive integer</p>
75
+ <p class="simpara"> Valid Values: any integer between 1 and 1000000000 (1
76
+ billion). </p>
77
+ <p class="simpara">Default: 1</p>
78
+ </td><td>
79
+ <p class="simpara">No</p>
80
+ </td></tr><tr><td>
81
+ <p class="simpara">
82
+ <em class="parameter"><code>RequesterAnnotation</code></em>
83
+ </p>
84
+ </td><td>
85
+ <p class="simpara"> An arbitrary data field. The <em class="parameter"><code>RequesterAnnotation</code></em> parameter lets your
86
+ application attach arbitrary data to the HIT for tracking
87
+ purposes. For example, this parameter could be an identifier
88
+ internal to the Requester's application that corresponds with
89
+ the HIT. </p>
90
+ <p class="simpara"> The <em class="parameter"><code>RequesterAnnotation</code></em> parameter
91
+ for a HIT is only visible to the Requester who created the HIT.
92
+ It is not shown to the Worker, or any other Requester. </p>
93
+ <p class="simpara"> The <em class="parameter"><code>RequesterAnnotation</code></em> paramter
94
+ may be different for each HIT you submit. It does not affect how
95
+ your HITs are grouped. </p>
96
+ <p class="simpara">Type: String</p>
97
+ <p class="simpara">Default: None</p>
98
+ <p class="simpara">Constraints: must not be longer than 255
99
+ characters</p>
100
+ </td><td>
101
+ <p class="simpara">No</p>
102
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e2449">Calling <code class="function">CreateHIT</code> Without a HIT Type ID</h3></div></div></div><p> The following parameters are specific to calling the <code class="function">CreateHIT</code> operation without a HIT type ID, letting Amazon Mechanical
103
+ Turk determine the HIT type from the property values: </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col><col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>
104
+ <p class="simpara">
105
+ <em class="parameter"><code>Operation</code></em>
106
+ </p>
107
+ </td><td>
108
+ <p class="simpara">The name of the operation</p>
109
+ <p class="simpara">Type: String</p>
110
+ <p class="simpara">Valid Values: CreateHIT</p>
111
+ <p class="simpara">Default: None</p>
112
+ </td><td>
113
+ <p class="simpara">Yes</p>
114
+ </td></tr><tr><td>
115
+ <p class="simpara">
116
+ <em class="parameter"><code>Title</code></em>
117
+ </p>
118
+ </td><td>
119
+ <p class="simpara"> The title of the HIT. A title should be short and
120
+ descriptive about the kind of task the HIT contains. On the
121
+ Amazon Mechanical Turk web site, the HIT title appears in search
122
+ results, and everywhere the HIT is mentioned. </p>
123
+ <p class="simpara">Type: String</p>
124
+ <p class="simpara">Default: None</p>
125
+ <p class="simpara">Constraints: must not be more than 128 characters</p>
126
+ </td><td>
127
+ <p class="simpara">Yes</p>
128
+ </td></tr><tr><td>
129
+ <p class="simpara">
130
+ <em class="parameter"><code>Description</code></em>
131
+ </p>
132
+ </td><td>
133
+ <p class="simpara"> A general description of the HIT. A description includes
134
+ detailed information about the kind of task the HIT contains. On
135
+ the Amazon Mechanical Turk web site, the HIT description appears
136
+ in the expanded view of search results, and in the HIT and
137
+ assignment screens. A good description gives the user enough
138
+ information to evaluate the HIT before accepting it. </p>
139
+ <p class="simpara">Type: String</p>
140
+ <p class="simpara">Default: None</p>
141
+ <p class="simpara">Constraints: cannot be more than 2,000 characters in
142
+ length</p>
143
+ </td><td>
144
+ <p class="simpara">Yes</p>
145
+ </td></tr><tr><td>
146
+ <p class="simpara">
147
+ <em class="parameter"><code>Question</code></em>
148
+ </p>
149
+ </td><td>
150
+ <p class="simpara"> The data the person completing the HIT uses to produce the
151
+ results. </p>
152
+ <p class="simpara">Type: String</p>
153
+ <p class="simpara">Default: None</p>
154
+ <p class="simpara"> Constraints: Must be a <a class="link" href="ApiReference_QuestionFormDataStructureArticle.html" title="QuestionForm">
155
+ QuestionForm</a> data structure or an <a class="link" href="ApiReference_ExternalQuestionArticle.html" title="ExternalQuestion">
156
+ ExternalQuestion</a> data structure. The XML Question
157
+ data must not be larger than 64 kilobytes (65,535 bytes) in
158
+ size, including whitespace. </p>
159
+ </td><td>
160
+ <p class="simpara">Yes</p>
161
+ </td></tr><tr><td>
162
+ <p class="simpara">
163
+ <em class="parameter"><code>Reward</code></em>
164
+ </p>
165
+ </td><td>
166
+ <p class="simpara"> The amount of money the Requester will pay a Worker for
167
+ successfully completing the HIT. </p>
168
+ <p class="simpara"> Type: <a class="link" href="ApiReference_PriceDataStructureArticle.html" title="Price">Price</a> data structure. </p>
169
+ <p class="simpara">Default: None</p>
170
+ </td><td>
171
+ <p class="simpara">Yes</p>
172
+ </td></tr><tr><td>
173
+ <p class="simpara">
174
+ <em class="parameter"><code>AssignmentDurationInSeconds</code></em>
175
+ </p>
176
+ </td><td>
177
+ <p class="simpara"> The amount of time, in seconds, that a Worker has to
178
+ complete the HIT after accepting it. If a Worker does not
179
+ complete the assignment within the specified duration, the
180
+ assignment is considered abandoned. If the HIT is still active
181
+ (that is, its lifetime has not elapsed), the assignment becomes
182
+ available for other users to find and accept. </p>
183
+ <p class="simpara">Type: positive integer</p>
184
+ <p class="simpara"> Valid Values: any integer between 30 (30 seconds) and
185
+ 31536000 (365 days). </p>
186
+ <p class="simpara">Default: None</p>
187
+ </td><td>
188
+ <p class="simpara">Yes</p>
189
+ </td></tr><tr><td>
190
+ <p class="simpara">
191
+ <em class="parameter"><code>LifetimeInSeconds</code></em>
192
+ </p>
193
+ </td><td>
194
+ <p class="simpara"> An amount of time, in seconds, after which the HIT is no
195
+ longer available for users to accept. After the lifetime of the
196
+ HIT elapses, the HIT no longer appears in HIT searches, even if
197
+ not all of the assignments for the HIT have been accepted. </p>
198
+ <p class="simpara">Type: positive integer</p>
199
+ <p class="simpara"> Valid Values: any integer between 30 (30 seconds) and
200
+ 31536000 (365 days). </p>
201
+ <p class="simpara">Default: None</p>
202
+ </td><td>
203
+ <p class="simpara">Yes</p>
204
+ </td></tr><tr><td>
205
+ <p class="simpara">
206
+ <em class="parameter"><code>Keywords</code></em>
207
+ </p>
208
+ </td><td>
209
+ <p class="simpara"> One or more words or phrases that describe the HIT,
210
+ separated by commas. These words are used in searches to find
211
+ HITs. </p>
212
+ <p class="simpara">Type: String</p>
213
+ <p class="simpara">Default: None</p>
214
+ <p class="simpara"> Constraints: The complete string of keywords, including
215
+ commas and spaces, canot be more than 1,000 characters.
216
+ </p>
217
+ </td><td>
218
+ <p class="simpara">No</p>
219
+ </td></tr><tr><td>
220
+ <p class="simpara">
221
+ <em class="parameter"><code>MaxAssignments</code></em>
222
+ </p>
223
+ </td><td>
224
+ <p class="simpara"> The number of times the HIT can be accepted and completed
225
+ before the HIT becomes unavailable. </p>
226
+ <p class="simpara">Type: positive integer</p>
227
+ <p class="simpara">Valid Values: any integer between 1 and 1000000000 (1
228
+ billion).</p>
229
+ <p class="simpara">Default: 1</p>
230
+ </td><td>
231
+ <p class="simpara">No</p>
232
+ </td></tr><tr><td>
233
+ <p class="simpara">
234
+ <em class="parameter"><code>AutoApprovalDelayInSeconds</code></em>
235
+ </p>
236
+ </td><td>
237
+ <p class="simpara"> The number of seconds after an assignment for the HIT has
238
+ been submitted, after which the assignment is considered
239
+ <span class="guilabel">Approved</span> automatically unless the
240
+ Requester explicitly rejects it. </p>
241
+ <p class="simpara">Type: non-negative integer</p>
242
+ <p class="simpara"> Valid Values: any integer between 0 (auto-approve results
243
+ as soon as they are submitted) and 2592000 (30 days). </p>
244
+ <p class="simpara">Default: 2592000 (30 days)</p>
245
+ </td><td>
246
+ <p class="simpara">No</p>
247
+ </td></tr><tr><td>
248
+ <p class="simpara">
249
+ <em class="parameter"><code>QualificationRequirement</code></em>
250
+ </p>
251
+ </td><td>
252
+ <p class="simpara"> A condition that a Worker's Qualifications must meet
253
+ before the Worker is allowed to accept and complete the HIT. </p>
254
+ <p class="simpara"> Type: a <a class="link" href="ApiReference_QualificationRequirementDataStructureArticle.html" title="QualificationRequirement">QualificationRequirement</a> data structure. </p>
255
+ <p class="simpara">Default: None</p>
256
+ <p class="simpara"> Constraints: there can be no more than 10 <em class="parameter"><code>QualificationRequirement</code></em> data structures for
257
+ each HIT. </p>
258
+ </td><td>
259
+ <p class="simpara">No</p>
260
+ </td></tr><tr><td>
261
+ <p class="simpara">
262
+ <em class="parameter"><code>RequesterAnnotation</code></em>
263
+ </p>
264
+ </td><td>
265
+ <p class="simpara"> An arbitrary data field. The <em class="parameter"><code>RequesterAnnotation</code></em> parameter lets your
266
+ application attach arbitrary data to the HIT for tracking
267
+ purposes. For example, the <em class="parameter"><code>RequesterAnnotation</code></em> parameter could be an
268
+ identifier internal to the Requester's application that
269
+ corresponds with the HIT. </p>
270
+ <p class="simpara">Type: String</p>
271
+ <p class="simpara">Default: None</p>
272
+ <p class="simpara">Constraints: must not be longer than 255
273
+ characters</p>
274
+ </td><td>
275
+ <p class="simpara">No</p>
276
+ </td></tr></tbody></table></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e2831">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">CreateHIT</code> operation includes the
277
+ elements described in the following table. </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>
278
+ <p class="simpara">
279
+ <em class="parameter"><code>HIT</code></em>
280
+ </p>
281
+ </td><td>
282
+ <p class="simpara"> Contains the newly created HIT data. For a description of the
283
+ HIT data structure as it appears in responses, see the <a class="link" href="ApiReference_HITDataStructureArticle.html" title="HIT"> HIT Data
284
+ Structure</a>. </p>
285
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e2867">Examples</h2></div></div></div><p>The following examples show how to use the <code class="function">CreateHIT</code>
286
+ operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e2875">Sample Request</h3></div></div></div><p>The following are examples of REST requests. </p><div class="example"><a name="d0e2880"></a><p class="title"><b>Example Request (Query) Using CreateHIT with a HIT Type ID</b></p><div class="example-contents"><p> The following example creates a simple HIT, using an explicit HIT type ID.
287
+ The <em class="parameter"><code>Question</code></em> parameter takes a block of XML data as its
288
+ value. See the <a class="link" href="ApiReference_QuestionFormDataStructureArticle.html" title="QuestionForm">
289
+ QuestionForm</a> data structure and the<a class="link" href="ApiReference_ExternalQuestionArticle.html" title="ExternalQuestion"> ExternalQuestion</a> data
290
+ structure for more information. </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
291
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
292
+ &amp;Version=2008-08-02
293
+ &amp;Operation=CreateHIT
294
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
295
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
296
+ &amp;HITTypeId=T100CN9P324W00EXAMPLE
297
+ &amp;Question=<em class="replaceable"><code>[URL-encoded question data]</code></em>
298
+ &amp;LifetimeInSeconds=604800
299
+ </pre></div></div><br class="example-break"><div class="example"><a name="d0e2908"></a><p class="title"><b>Example Request (Query) Using CreateHIT Without a HIT Type ID</b></p><div class="example-contents"><p> The following example creates a simple HIT with some properties, letting
300
+ Amazon Mechanical Turk determine the HIT type ID from the property values. The
301
+ <em class="parameter"><code>Question</code></em> parameter takes a block of XML data as its
302
+ value. See the <a class="link" href="ApiReference_QuestionFormDataStructureArticle.html" title="QuestionForm">
303
+ QuestionForm</a> data structure and the<a class="link" href="ApiReference_ExternalQuestionArticle.html" title="ExternalQuestion"> ExternalQuestion</a> data
304
+ structure for more information. </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
305
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
306
+ &amp;Version=2008-08-02
307
+ &amp;Operation=CreateHIT
308
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
309
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
310
+ &amp;Title=Location%20and%20Photograph%20Identification
311
+ &amp;Description=Select%20the%20image%20that%20best%20represents...
312
+ &amp;Reward.1.Amount=5
313
+ &amp;Reward.1.CurrencyCode=USD
314
+ &amp;Question=<em class="replaceable"><code>[URL-encoded question data]</code></em>
315
+ &amp;AssignmentDurationInSeconds=30
316
+ &amp;LifetimeInSeconds=604800
317
+ &amp;Keywords=location,%20photograph,%20image,%20identification,%20opinion
318
+ </pre></div></div><br class="example-break"></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e2936">Sample Response</h3></div></div></div><p>Amazon Mechanical Turk might return the following response for either of the preceeding requests.</p><pre class="programlisting">&lt;CreateHITResponse&gt;
319
+ &lt;OperationRequest&gt;
320
+ &lt;RequestId&gt;ece2785b-6292-4b12-a60e-4c34847a7916&lt;/RequestId&gt;
321
+ &lt;/OperationRequest&gt;
322
+ &lt;HIT&gt;
323
+ &lt;Request&gt;
324
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
325
+ &lt;/Request&gt;
326
+ &lt;HITId&gt;GBHZVQX3EHXZ2AYDY2T0&lt;/HITId&gt;
327
+ &lt;HITTypeId&gt;NYVZTQ1QVKJZXCYZCZVZ&lt;/HITTypeId&gt;
328
+ &lt;/HIT&gt;
329
+ &lt;/CreateHITResponse&gt;
330
+ </pre></div></div></div><div class="navfooter"><table width="100%" summary="Navigation footer" cellspacing="0" cellpadding="2"><tr><td width="30%" align="left"><a accesskey="p" href="ApiReference_ChangeHITTypeOfHITOperation.html"><img src="images/prev.gif" alt="Prev"></a> </td><td width="40%" align="center"><a href="http://survey.amazonwebservices.com/survey/s?s=559&amp;opdata_page=Mturk_API_2008-08-02_ApiReference_CreateHITOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_CreateQualificationTypeOperation.html"><img src="images/next.gif" alt="Next"></a></td></tr><tr><td width="30%" align="left" valign="top">&nbsp;</td><td width="40%" align="center"><a accesskey="h" href="#top"><img src="images/home.gif" alt="Home"></a></td><td width="30%" align="right" valign="top">&nbsp;</td></tr></table></div></body></html>