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_GetReviewableHITsOperation.html ADDED
@@ -0,0 +1,155 @@
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>GetReviewableHITs</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_GetRequesterStatisticOperation.html" title="GetRequesterStatistic"><link rel="next" href="ApiReference_GrantBonusOperation.html" title="GrantBonus"><!--[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_GetRequesterStatisticOperation.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_GetReviewableHITsOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_GrantBonusOperation.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>GetReviewableHITs</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">GetReviewableHITs</h1></div></div></div><a class="indexterm" name="d0e8289"></a><a class="indexterm" name="d0e8292"></a><a class="indexterm" name="d0e8297"></a><a class="indexterm" name="d0e8300"></a><a class="indexterm" name="d0e8305"></a><a class="indexterm" name="d0e8310"></a><a class="indexterm" name="d0e8315"></a><a class="indexterm" name="d0e8320"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e8325">Description</h2></div></div></div><p> The <code class="function">GetReviewableHITs</code> operation retrieves the HITs with
7
+ <em class="parameter"><code>Status</code></em> equal to <span class="guilabel">Reviewable</span> or <em class="parameter"><code>Status</code></em> equal to <span class="guilabel">Reviewing</span> that belong to the
8
+ Requester calling the operation. </p><p> You can limit the query to HITs with a specified HIT type. </p><p> The operation sorts the results, divides them into numbered pages, and returns a
9
+ single page of results. You can control sorting and pagination can be controlled with
10
+ parameters to the operation. </p><p> When (<em class="parameter"><code>PageNumber</code></em> x <em class="parameter"><code>PageSize</code></em>) is less
11
+ than 100, you can get reliable results when you use any of the sort properties. If this
12
+ number is greater than 100, use the <strong class="userinput"><code>Enumeration</code></strong> sort property for
13
+ best results. The <strong class="userinput"><code>Enumeration</code></strong> sort property guarantees that the
14
+ operation returns all reviewable HITs with no duplicates, but not in any specific order.
15
+ </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e8363">Request Parameters</h2></div></div></div><p> The <code class="function">GetReviewableHITs</code> operation accepts parameters common to all
16
+ 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
17
+ information. </p><p> The following parameters are specific to the <code class="function">GetReviewableHITs</code>
18
+ 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>
19
+ <p class="simpara">
20
+ <em class="parameter"><code>Operation</code></em>
21
+ </p>
22
+ </td><td>
23
+ <p class="simpara">The name of the operation</p>
24
+ <p class="simpara">Type: String</p>
25
+ <p class="simpara">Valid Values: GetReviewableHITs</p>
26
+ <p class="simpara">Default: None</p>
27
+ </td><td>
28
+ <p class="simpara">Yes</p>
29
+ </td></tr><tr><td>
30
+ <p class="simpara">
31
+ <em class="parameter"><code>HITTypeId</code></em>
32
+ </p>
33
+ </td><td>
34
+ <p class="simpara"> The ID of the HIT type of the HITs to consider for the query. </p>
35
+ <p class="simpara">Type: String</p>
36
+ <p class="simpara">Default: None. If not specified, all of the Requester's HITs
37
+ are considered for the query.</p>
38
+ </td><td>
39
+ <p class="simpara">No</p>
40
+ </td></tr><tr><td>
41
+ <p class="simpara">
42
+ <em class="parameter"><code>Status</code></em>
43
+ </p>
44
+ </td><td>
45
+ <p class="simpara">The status of the HITs to return</p>
46
+ <p class="simpara">Type: String</p>
47
+ <p class="simpara">Valid Values: Reviewable | Reviewing</p>
48
+ <p class="simpara">Default: Reviewable</p>
49
+ <p class="simpara"> To query both <span class="guilabel">Reviewable</span> and <span class="guilabel">Reviewing</span> HITs, specify multiple <em class="parameter"><code>Status</code></em> parameters. </p>
50
+ </td><td>
51
+ <p class="simpara">No</p>
52
+ </td></tr><tr><td>
53
+ <p class="simpara">
54
+ <em class="parameter"><code>SortProperty</code></em>
55
+ </p>
56
+ </td><td>
57
+ <p class="simpara">The field on which to sort the results.</p>
58
+ <p class="simpara">Type: String</p>
59
+ <p class="simpara">Valid Values: Title | Reward | Expiration | CreationTime |
60
+ Enumeration</p>
61
+ <p class="simpara">Default: Expiration</p>
62
+ </td><td>
63
+ <p class="simpara">No</p>
64
+ </td></tr><tr><td>
65
+ <p class="simpara">
66
+ <em class="parameter"><code>SortDirection</code></em>
67
+ </p>
68
+ </td><td>
69
+ <p class="simpara"> The direction of the sort used with the field specified by the
70
+ <em class="parameter"><code>SortProperty</code></em> property. </p>
71
+ <p class="simpara">Type: String</p>
72
+ <p class="simpara">Valid Values: Ascending | Descending</p>
73
+ <p class="simpara">Default: Descending</p>
74
+ </td><td>
75
+ <p class="simpara">No</p>
76
+ </td></tr><tr><td>
77
+ <p class="simpara">
78
+ <em class="parameter"><code>PageSize</code></em>
79
+ </p>
80
+ </td><td>
81
+ <p class="simpara"> The number of HITs to include in a page of results. The
82
+ operation divides the complete sorted result set is divided into
83
+ pages of this many HITs. </p>
84
+ <p class="simpara">Type: positive integer</p>
85
+ <p class="simpara">Valid Values: any number between 1 and 100</p>
86
+ <p class="simpara">Default: 10</p>
87
+ </td><td>
88
+ <p class="simpara">No</p>
89
+ </td></tr><tr><td>
90
+ <p class="simpara">
91
+ <em class="parameter"><code>PageNumber</code></em>
92
+ </p>
93
+ </td><td>
94
+ <p class="simpara"> The page of results to return. After the operation filters,
95
+ sorts, and divides the HITs into pages of size <em class="parameter"><code>PageSize</code></em>, it returns the page corresponding to
96
+ <em class="parameter"><code>PageNumber</code></em> as the results of the
97
+ operation. </p>
98
+ <p class="simpara">Type: positive integer</p>
99
+ <p class="simpara">Default: 1</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><h2 class="title" style="clear: both" id="d0e8604">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">GetReviewableHITs</code> operation has a
103
+ <em class="parameter"><code>GetReviewableHITsResult</code></em> element in the response. </p><p> The <em class="parameter"><code>GetReviewableHITsResult</code></em> element contains the following
104
+ elements: </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>
105
+ <p class="simpara">
106
+ <em class="parameter"><code>NumResults</code></em>
107
+ </p>
108
+ </td><td>
109
+ <p class="simpara"> The number of HITs on this page in the filtered results list,
110
+ equivalent to the number of HITs this call returns. </p>
111
+ <p class="simpara">Type: non-negative integer</p>
112
+ </td></tr><tr><td><p class="simpara">
113
+ <em class="parameter"><code>PageNumber</code></em>
114
+ </p>
115
+ </td><td>
116
+ <p class="simpara">The number of this page in the filtered results list.</p>
117
+ <p class="simpara">Type: positive integer</p>
118
+ </td></tr><tr><td>
119
+ <p class="simpara">
120
+ <em class="parameter"><code>TotalNumResults</code></em>
121
+ </p>
122
+ </td><td>
123
+ <p class="simpara">The total number of HITs in the filtered results list based on
124
+ this call.</p>
125
+ <p class="simpara">Type: non-negative integer</p>
126
+ </td></tr><tr><td>
127
+ <p class="simpara">
128
+ <em class="parameter"><code>HIT</code></em>
129
+ </p>
130
+ </td><td>
131
+ <p class="simpara"> The HIT. The response includes one <em class="parameter"><code>HIT</code></em>
132
+ element for each HIT returned by the query. </p>
133
+ <p class="simpara">Type: a <a class="link" href="ApiReference_HITDataStructureArticle.html" title="HIT">HIT</a> data structure</p>
134
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e8704">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">GetReviewableHITs</code>
135
+ operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e8712">Sample Request</h3></div></div></div><p> The following example retrieves five of the Requester's reviewable HITs,
136
+ using the default values for the <em class="parameter"><code>SortProperty</code></em> and
137
+ <em class="parameter"><code>SortOrder</code></em> parameters (ExpirationDate, Ascending). </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
138
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
139
+ &amp;Version=2008-08-02
140
+ &amp;Operation=GetReviewableHITs
141
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
142
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
143
+ &amp;PageSize=5
144
+ &amp;PageNumber=1
145
+ </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e8734">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;GetReviewableHITsResult&gt;
146
+ &lt;Request&gt;
147
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
148
+ &lt;/Request&gt;
149
+ &lt;NumResults&gt;1&lt;/NumResults&gt;
150
+ &lt;TotalNumResults&gt;1&lt;/TotalNumResults&gt;
151
+ &lt;PageNumber&gt;1&lt;/PageNumber&gt;
152
+ &lt;HIT&gt;
153
+ &lt;HITId&gt;GBHZVQX3EHXZ2AYDY2T0&lt;/HITId&gt;
154
+ &lt;/HIT&gt;
155
+ &lt;/GetReviewableHITsResult&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_GetRequesterStatisticOperation.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_GetReviewableHITsOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_GrantBonusOperation.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_GrantBonusOperation.html ADDED
@@ -0,0 +1,95 @@
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>GrantBonus</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_GetReviewableHITsOperation.html" title="GetReviewableHITs"><link rel="next" href="ApiReference_GrantQualificationOperation.html" title="GrantQualification"><!--[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_GetReviewableHITsOperation.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_GrantBonusOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_GrantQualificationOperation.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>GrantBonus</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">GrantBonus</h1></div></div></div><a class="indexterm" name="d0e8745"></a><a class="indexterm" name="d0e8748"></a><a class="indexterm" name="d0e8751"></a><a class="indexterm" name="d0e8756"></a><a class="indexterm" name="d0e8761"></a><a class="indexterm" name="d0e8766"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e8771">Description</h2></div></div></div><p> The <code class="function">GrantBonus</code> operation issues a payment of money from your
7
+ account to a Worker. This payment happens separately from the reward you pay to the
8
+ Worker when you approve the Worker's assignment. </p><p> The <code class="function">GrantBonus</code> operation requires the Worker's ID and the
9
+ assignment ID as parameters to initiate payment of the bonus. </p><p> You must include a message that explains the reason for the bonus payment, as the
10
+ Worker may not be expecting the payment. </p><p> Amazon Mechanical Turk collects a fee for bonus payments, similar to the HIT listing
11
+ fee. This operation fails if your account does not have enough funds to pay for both the
12
+ bonus and the fees. </p><p> For information about Amazon Mechanical Turk pricing and fee amounts, see the <a class="ulink" href="http://aws.amazon.com/mturk" target="_blank">Amazon Mechanical Turk</a> site. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e8793">Request Parameters</h2></div></div></div><p> The <code class="function">GrantBonus</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">GrantBonus</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: GrantBonus</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 being paid the bonus, as returned in the
31
+ assignment data of the <a class="link" href="ApiReference_GetAssignmentsForHITOperation.html" title="GetAssignmentsForHIT">GetAssignmentsForHIT</a> operation. </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>AssignmentId</code></em>
39
+ </p>
40
+ </td><td>
41
+ <p class="simpara"> The ID of the assignment for which this bonus is paid, as
42
+ returned in the assignment data of the <a class="link" href="ApiReference_GetAssignmentsForHITOperation.html" title="GetAssignmentsForHIT">GetAssignmentsForHIT</a> operation. </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><tr><td>
48
+ <p class="simpara">
49
+ <em class="parameter"><code>BonusAmount</code></em>
50
+ </p>
51
+ </td><td>
52
+ <p class="simpara"> The bonus amount to pay. </p>
53
+ <p class="simpara"> Type: <a class="link" href="ApiReference_PriceDataStructureArticle.html" title="Price">Price</a>data structure </p>
54
+ <p class="simpara">Default: None</p>
55
+ </td><td>
56
+ <p class="simpara">Yes</p>
57
+ </td></tr><tr><td>
58
+ <p class="simpara">
59
+ <em class="parameter"><code>Reason</code></em>
60
+ </p>
61
+ </td><td>
62
+ <p class="simpara"> A message that explains the reason for the bonus payment. The
63
+ Worker receiving the bonus can see this message. </p>
64
+ <p class="simpara">Type: String</p>
65
+ <p class="simpara">Default: None</p>
66
+ </td><td>
67
+ <p class="simpara">Yes</p>
68
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e8959">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">GrantBonus</code> operation returns with
69
+ no errors. The response includes the elements described in the following table. The
70
+ 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>
71
+ <p class="simpara">
72
+ <em class="parameter"><code>GrantBonusResult</code></em>
73
+ </p>
74
+ </td><td>
75
+ <p class="simpara"> Contains a <em class="parameter"><code>Request</code></em> element if the
76
+ <strong class="userinput"><code>Request</code></strong>
77
+ <em class="parameter"><code>ResposeGroup</code></em> is specified. </p>
78
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e9001">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">GrantBonus</code>
79
+ operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e9009">Sample Request</h3></div></div></div><p> The following example of a call to the <code class="function">GrantBonus</code>
80
+ operation pays a bonus of $5 to a Worker. </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
81
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
82
+ &amp;Version=2008-08-02
83
+ &amp;Operation=GrantBonus
84
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
85
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
86
+ &amp;WorkerId=AZ3456EXAMPLE
87
+ &amp;AssignmentId=123RVWYBAZW00EXAMPLE456RVWYBAZW00EXAMPLE
88
+ &amp;BonusAmount.1.Amount=5
89
+ &amp;BonusAmount.1.CurrencyCode=USD
90
+ &amp;Reason=Thanks%20for%20doing%20great%20work!
91
+ </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e9028">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;GrantBonusResult&gt;
92
+ &lt;Request&gt;
93
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
94
+ &lt;/Request&gt;
95
+ &lt;/GrantBonusResult&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_GetReviewableHITsOperation.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_GrantBonusOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_GrantQualificationOperation.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_GrantQualificationOperation.html ADDED
@@ -0,0 +1,69 @@
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>GrantQualification</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_GrantBonusOperation.html" title="GrantBonus"><link rel="next" href="ApiReference_HelpOperation.html" title="Help"><!--[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_GrantBonusOperation.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_GrantQualificationOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_HelpOperation.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>GrantQualification</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">GrantQualification</h1></div></div></div><a class="indexterm" name="d0e9039"></a><a class="indexterm" name="d0e9042"></a><a class="indexterm" name="d0e9049"></a><a class="indexterm" name="d0e9054"></a><a class="indexterm" name="d0e9059"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e9064">Description</h2></div></div></div><p> The <code class="function">GrantQualification</code> operation grants a Worker's request for a
7
+ Qualification. </p><p> Only the owner of the Qualification type can grant a Qualification request for that
8
+ type. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e9074">Request Parameters</h2></div></div></div><p>
9
+ <code class="function">GrantQualification</code> accepts parameters common to all operations.
10
+ 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
11
+ information. </p><p> The following parameters are specific to the <code class="function">GrantQualification</code>
12
+ 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>
13
+ <p class="simpara">
14
+ <em class="parameter"><code>Operation</code></em>
15
+ </p>
16
+ </td><td>
17
+ <p class="simpara">The name of the operation</p>
18
+ <p class="simpara">Type: String</p>
19
+ <p class="simpara">Valid Values: GrantQualification</p>
20
+ <p class="simpara">Default: None</p>
21
+ </td><td>
22
+ <p class="simpara">Yes</p>
23
+ </td></tr><tr><td>
24
+ <p class="simpara">
25
+ <em class="parameter"><code>QualificationRequestId</code></em>
26
+ </p>
27
+ </td><td>
28
+ <p class="simpara"> The ID of the Qualification request, as returned by the <a class="link" href="ApiReference_GetQualificationRequestsOperation.html" title="GetQualificationRequests">GetQualificationRequests</a> operation. </p>
29
+ <p class="simpara">Type: String</p>
30
+ <p class="simpara">Default: None</p>
31
+ </td><td>
32
+ <p class="simpara">Yes</p>
33
+ </td></tr><tr><td>
34
+ <p class="simpara">
35
+ <em class="parameter"><code>IntegerValue</code></em>
36
+ </p>
37
+ </td><td>
38
+ <p class="simpara">The value of the Qualification</p>
39
+ <p class="simpara">Type: Integer</p>
40
+ <p class="simpara">Default: 1</p>
41
+ <p class="simpara"> Conditions: You can omit this value if you are using the
42
+ presence or absence of the Qualification as the basis for a HIT
43
+ requirement. </p>
44
+ </td><td>
45
+ <p class="simpara">Conditional</p>
46
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e9188">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">GrantQualification</code> operation
47
+ returns with no errors. The response includes the elements described in the following
48
+ 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>
49
+ <p class="simpara">
50
+ <em class="parameter"><code>GrantQualificationResult</code></em>
51
+ </p>
52
+ </td><td>
53
+ <p class="simpara"> Contains a <em class="parameter"><code>Request</code></em> element if the
54
+ <strong class="userinput"><code>Request</code></strong>
55
+ <em class="parameter"><code>ResposeGroup</code></em> is specified. </p>
56
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e9230">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">GrantQualification</code>
57
+ operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e9238">Sample Request</h3></div></div></div><p>The following example grants a Qualification to a user.</p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
58
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
59
+ &amp;Version=2008-08-02
60
+ &amp;Operation=GrantQualification
61
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
62
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
63
+ &amp;QualificationRequestId=789RVWYBAZW00EXAMPLE951RVWYBAZW00EXAMPLE
64
+ &amp;IntegerValue=95
65
+ </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e9254">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;GrantQualificationResult&gt;
66
+ &lt;Request&gt;
67
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
68
+ &lt;/Request&gt;
69
+ &lt;/GrantQualificationResult&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_GrantBonusOperation.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_GrantQualificationOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_HelpOperation.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_HITDataStructureArticle.html ADDED
@@ -0,0 +1,302 @@
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>HIT</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_DataStructuresArticle.html" title="Chapter&nbsp;6.&nbsp;Data Structures"><link rel="prev" href="ApiReference_AssignmentDataStructureArticle.html" title="Assignment"><link rel="next" href="ApiReference_LocaleDataStructureArticle.html" title="Locale"><!--[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_AssignmentDataStructureArticle.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_HITDataStructureArticle">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_LocaleDataStructureArticle.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_DataStructuresArticle.html">Data Structures</a> &raquo; <strong>HIT</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">HIT</h1></div></div></div><a class="indexterm" name="d0e14160"></a><a class="indexterm" name="d0e14163"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e14168">Description</h2></div></div></div><p> The HIT data structure represents a single HIT, including all the information necessary for a
7
+ Worker to accept and complete the HIT and claim the reward. </p><p> The HIT data structure is used as a response element for the following operations: </p><div class="itemizedlist"><ul type="disc"><li><p>
8
+ <a class="link" href="ApiReference_CreateHITOperation.html" title="CreateHIT">CreateHIT</a>
9
+ </p></li><li><p>
10
+ <a class="link" href="ApiReference_DisableHITOperation.html" title="DisableHIT">DisableHIT</a>
11
+ </p></li><li><p>
12
+ <a class="link" href="ApiReference_GetHITOperation.html" title="GetHIT">GetHIT</a>
13
+ </p></li><li><p>
14
+ <a class="link" href="ApiReference_GetReviewableHITsOperation.html" title="GetReviewableHITs">GetReviewableHITs</a>
15
+ </p></li><li><p>
16
+ <a class="link" href="ApiReference_SearchHITsOperation.html" title="SearchHITs">SearchHITs</a>
17
+ </p></li></ul></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e14206">HITs and Response Groups</h2></div></div></div><p> Operations that return a HIT data structure use response groups to determine how much
18
+ information to return. As described in <a class="link" href="ApiReference_CommonParametersArticle.html" title="Chapter&nbsp;4.&nbsp;Common Parameters">Common
19
+ Parameters</a>, the <em class="parameter"><code>ResponseGroup</code></em> parameter specifies which sets of
20
+ elements the service should return, as a set of named groups. For example, the
21
+ <strong class="userinput"><code>Request</code></strong> response group includes the contents of the operation request in
22
+ the response. </p><p> For the HIT data structure, the <strong class="userinput"><code>Minimal</code></strong> response group returns the
23
+ <em class="parameter"><code>HITId</code></em>. To also return the HIT's
24
+ <em class="parameter"><code>Question</code></em> data, include the <strong class="userinput"><code>HITQuestion</code></strong> response
25
+ group. To include the other properties of the HIT, specify the <strong class="userinput"><code>HITDetail</code></strong>
26
+ response group. Finally, specify the <strong class="userinput"><code>HITAssignmentSummary</code></strong> response group to
27
+ include information on the number of assignments that are available for Workers to accept,
28
+ accepted and pending submission of results, or completed. </p><p> The <code class="function">GetHIT</code> operation returns the <strong class="userinput"><code>HITDetail</code></strong>,
29
+ <strong class="userinput"><code>HITQuestion</code></strong> and <strong class="userinput"><code>Minimal</code></strong> response groups by
30
+ default. The <strong class="userinput"><code>HITAssignmentSummary</code></strong> response group is off by default. </p><p> The <code class="function">SearchHITs</code> operation includes <strong class="userinput"><code>HITDetail</code></strong>,
31
+ <strong class="userinput"><code>Minimal</code></strong>, and <strong class="userinput"><code>HITAssignmentSummary</code></strong> as default
32
+ response groups. You can also specify <strong class="userinput"><code>HITQuestion</code></strong> with
33
+ <code class="function">SearchHITs</code>. </p><p>
34
+ <code class="function">CreateHIT</code> and <code class="function">DisableHIT</code> can also return additional HIT
35
+ fields, but their default is <strong class="userinput"><code>Minimal</code></strong>. </p><p> Currently, the <code class="function">GetReviewableHITs</code> operation only supports the
36
+ <strong class="userinput"><code>Minimal</code></strong> response group. To retrieve additional HIT data for HITs
37
+ returned by this operation, use the HIT IDs in the results with <code class="function">GetHIT</code>.
38
+ </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e14299">Elements</h2></div></div></div><p> The HIT structure can contain the elements described in the following table. </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>
39
+ <p class="simpara">
40
+ <em class="parameter"><code>HITId</code></em>
41
+ </p>
42
+ </td><td>
43
+ <p class="simpara"> A unique identifier for the HIT. The <a class="link" href="ApiReference_CreateHITOperation.html" title="CreateHIT">CreateHIT</a> operation gives
44
+ a HIT the HIT ID and the HIT retains that ID forever. </p>
45
+ <p class="simpara">Type: String</p>
46
+ <p class="simpara">Default: None</p>
47
+ </td><td>
48
+ <p class="simpara">No</p>
49
+ </td></tr><tr><td>
50
+ <p class="simpara">
51
+ <em class="parameter"><code>HITTypeId</code></em>
52
+ </p>
53
+ </td><td>
54
+ <p class="simpara">The ID of the HIT type of this HIT</p>
55
+ <p class="simpara">Type: String</p>
56
+ <p class="simpara">Default: None</p>
57
+ </td><td>
58
+ <p class="simpara">No</p>
59
+ </td></tr><tr><td>
60
+ <p class="simpara">
61
+ <em class="parameter"><code>CreationTime</code></em>
62
+ </p>
63
+ </td><td>
64
+ <p class="simpara">The date and time the HIT was created</p>
65
+ <p class="simpara"> Type: a <a class="ulink" href="http://www.w3.org/TR/xmlschema-2/#dateTime" target="_blank">dateTime</a> structure in the Coordinated Universal Time (Greenwich Mean
66
+ Time) time zone, such as <strong class="userinput"><code>2005-01-31T23:59:59Z</code></strong>. </p>
67
+ <p class="simpara">Default: None</p>
68
+ </td><td>
69
+ <p class="simpara">No</p>
70
+ </td></tr><tr><td>
71
+ <p class="simpara">
72
+ <em class="parameter"><code>Title</code></em>
73
+ </p>
74
+ </td><td>
75
+ <p class="simpara">The title of the HIT</p>
76
+ <p class="simpara">Type: String</p>
77
+ <p class="simpara">Default: None</p>
78
+ </td><td>
79
+ <p class="simpara">No</p>
80
+ </td></tr><tr><td>
81
+ <p class="simpara">
82
+ <em class="parameter"><code>Description</code></em>
83
+ </p>
84
+ </td><td>
85
+ <p class="simpara">A general description of the HIT</p>
86
+ <p class="simpara">Type: String</p>
87
+ <p class="simpara">Default: None</p>
88
+ </td><td>
89
+ <p class="simpara">No</p>
90
+ </td></tr><tr><td>
91
+ <p class="simpara">
92
+ <em class="parameter"><code>Keywords</code></em>
93
+ </p>
94
+ </td><td>
95
+ <p class="simpara"> One or more words or phrases that describe the HIT, separated by commas.
96
+ Search terms similar to the keywords of a HIT are more likely to have the HIT
97
+ in the search results. </p>
98
+ <p class="simpara">Type: String</p>
99
+ <p class="simpara">Default: None</p>
100
+ </td><td>
101
+ <p class="simpara">No</p>
102
+ </td></tr><tr><td>
103
+ <p class="simpara">
104
+ <em class="parameter"><code>HITStatus</code></em>
105
+ </p>
106
+ </td><td>
107
+ <p class="simpara">The status of the HIT and its assignments</p>
108
+ <p class="simpara">Type: String</p>
109
+ <p class="simpara">Valid Values: Assignable | Unassignable | Reviewable | Reviewing |
110
+ Disposed</p>
111
+ <p class="simpara">Default: None</p>
112
+ </td><td>
113
+ <p class="simpara">No</p>
114
+ </td></tr><tr><td>
115
+ <p class="simpara">
116
+ <em class="parameter"><code>Reward</code></em>
117
+ </p>
118
+ </td><td>
119
+ <p class="simpara">The amount of money the Requester will pay a Worker for successfully
120
+ completing the HIT.</p>
121
+ <p class="simpara"> Type: a <a class="link" href="ApiReference_PriceDataStructureArticle.html" title="Price">Price</a> data structure </p>
122
+ <p class="simpara">Default: None</p>
123
+ </td><td>
124
+ <p class="simpara">No</p>
125
+ </td></tr><tr><td>
126
+ <p class="simpara">
127
+ <em class="parameter"><code>LifetimeInSeconds</code></em>
128
+ </p>
129
+ </td><td>
130
+ <p class="simpara"> The amount of time, in seconds, after which the HIT is no longer
131
+ available for users to accept. The HIT becomes unavailable even if the
132
+ requested number of assignments, specified by
133
+ <em class="parameter"><code>MaxAssignments</code></em>, has not been fulfilled. </p>
134
+ <p class="simpara">Type: positive integer</p>
135
+ <p class="simpara">Default: None</p>
136
+ </td><td>
137
+ <p class="simpara">No</p>
138
+ </td></tr><tr><td>
139
+ <p class="simpara">
140
+ <em class="parameter"><code>AssignmentDurationInSeconds</code></em>
141
+ </p>
142
+ </td><td>
143
+ <p class="simpara">The length of time, in seconds, that a Worker has to complete the HIT
144
+ after accepting it.</p>
145
+ <p class="simpara">Type: positive integer</p>
146
+ <p class="simpara">Default: None</p>
147
+ </td><td>
148
+ <p class="simpara">No</p>
149
+ </td></tr><tr><td>
150
+ <p class="simpara">
151
+ <em class="parameter"><code>MaxAssignments</code></em>
152
+ </p>
153
+ </td><td>
154
+ <p class="simpara"> The number of times the HIT can be accepted and completed before the HIT
155
+ becomes unavailable. </p>
156
+ <p class="simpara">Type: positive integer</p>
157
+ <p class="simpara">Default: 1</p>
158
+ </td><td>
159
+ <p class="simpara">No</p>
160
+ </td></tr><tr><td>
161
+ <p class="simpara">
162
+ <em class="parameter"><code>AutoApprovalDelayInSeconds</code></em>
163
+ </p>
164
+ </td><td>
165
+ <p class="simpara"> The amount of time, in seconds after the Worker submits an assignment
166
+ for the HIT that the results are automatically approved by the Requester. </p>
167
+ <p class="simpara">Type: positive integer</p>
168
+ <p class="simpara">Default: None</p>
169
+ </td><td>
170
+ <p class="simpara">No</p>
171
+ </td></tr><tr><td>
172
+ <p class="simpara">
173
+ <em class="parameter"><code>QualificationRequirement</code></em>
174
+ </p>
175
+ </td><td>
176
+ <p class="simpara"> A condition that a Worker's Qualifications must meet before the
177
+ Worker is allowed to accept the HIT. A HIT can have between zero and ten
178
+ Qualification requirements. All requirements must be met by a
179
+ Worker's Qualifications for the Worker to accept the HIT. </p>
180
+ <p class="simpara"> Type: a <a class="link" href="ApiReference_QualificationRequirementDataStructureArticle.html" title="QualificationRequirement">QualificationRequirement</a> data structure. </p>
181
+ <p class="simpara">Default: None</p>
182
+ </td><td>
183
+ <p class="simpara">No</p>
184
+ </td></tr><tr><td>
185
+ <p class="simpara">
186
+ <em class="parameter"><code>Question</code></em>
187
+ </p>
188
+ </td><td>
189
+ <p class="simpara">The data the Worker completing the HIT uses produce the results.</p>
190
+ <p class="simpara"> Type: either a <a class="link" href="ApiReference_QuestionFormDataStructureArticle.html" title="QuestionForm">QuestionForm</a> or an <a class="link" href="ApiReference_ExternalQuestionArticle.html" title="ExternalQuestion">ExternalQuestion </a>
191
+ data structure. </p>
192
+ <p class="simpara">Default: None</p>
193
+ </td><td>
194
+ <p class="simpara">No</p>
195
+ </td></tr><tr><td>
196
+ <p class="simpara">
197
+ <em class="parameter"><code>RequesterAnnotation</code></em>
198
+ </p>
199
+ </td><td>
200
+ <p class="simpara"> An arbitrary data field the Requester who created the HIT can use. This
201
+ field is visible only to the creator of the HIT. </p>
202
+ <p class="simpara">Type: String</p>
203
+ <p class="simpara">Default: None</p>
204
+ </td><td>
205
+ <p class="simpara">No</p>
206
+ </td></tr><tr><td>
207
+ <p class="simpara">
208
+ <em class="parameter"><code>NumberOfSimilarHITs</code></em>
209
+ </p>
210
+ </td><td>
211
+ <p class="simpara"> The number of HITs with fields identical to this HIT, other than the
212
+ <em class="parameter"><code>Question</code></em> field. </p>
213
+ <p class="simpara">Type: non-negative integer</p>
214
+ <p class="simpara">Default: None</p>
215
+ </td><td>
216
+ <p class="simpara">No</p>
217
+ </td></tr><tr><td>
218
+ <p class="simpara">
219
+ <em class="parameter"><code>HITReviewStatus</code></em>
220
+ </p>
221
+ </td><td>
222
+ <p class="simpara">Indicates the review status of the HIT.</p>
223
+ <p class="simpara">Type: String</p>
224
+ <p class="simpara">Valid Values: NotReviewed | MarkedForReview | ReviewedAppropriate |
225
+ ReviewedInappropriate </p>
226
+ <p class="simpara">Default: None</p>
227
+ </td><td>
228
+ <p class="simpara">No</p>
229
+ </td></tr><tr><td>
230
+ <p class="simpara">
231
+ <em class="parameter"><code>NumberofAssignmentsPending</code></em>
232
+ </p>
233
+ </td><td>
234
+ <p class="simpara"> The number of assignments for this HIT that have been accepted by
235
+ Workers, but have not yet been submitted, returned, abandoned. </p>
236
+ <p class="simpara">Type: non-negative integer</p>
237
+ <p class="simpara">Default: None</p>
238
+ <p class="simpara"> Conditions: This element is returned only if the
239
+ <em class="parameter"><code>HITAssignmentSummary</code></em> response group is specified.
240
+ </p>
241
+ </td><td>
242
+ <p class="simpara">Conditional</p>
243
+ </td></tr><tr><td>
244
+ <p class="simpara">
245
+ <em class="parameter"><code>NumberofAssignmentsAvailable</code></em>
246
+ </p>
247
+ </td><td>
248
+ <p class="simpara">The number of assignments for this HIT that are available for Workers to
249
+ accept</p>
250
+ <p class="simpara">Type: non-negative integer</p>
251
+ <p class="simpara">Default: None</p>
252
+ <p class="simpara"> Conditions: This element is returned only if the
253
+ <em class="parameter"><code>HITAssignmentSummary</code></em> response group is specified.
254
+ </p>
255
+ </td><td>
256
+ <p class="simpara">Conditional</p>
257
+ </td></tr><tr><td>
258
+ <p class="simpara">
259
+ <em class="parameter"><code>NumberofAssignmentsCompleted</code></em>
260
+ </p>
261
+ </td><td>
262
+ <p class="simpara">The number of assignments for this HIT that have been approved or
263
+ rejected.</p>
264
+ <p class="simpara">Type: non-negative integer</p>
265
+ <p class="simpara">Default: None</p>
266
+ <p class="simpara"> Conditions: This element is returned only if the
267
+ <em class="parameter"><code>HITAssignmentSummary</code></em> response group is specified.
268
+ </p>
269
+ </td><td>
270
+ <p class="simpara">Conditional</p>
271
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e14869">Example</h2></div></div></div><p> The following example shows a HIT data structure returned by the <a class="link" href="ApiReference_CreateHITOperation.html" title="CreateHIT">CreateHIT</a> operation. The <a class="link" href="ApiReference_CreateHITOperation.html" title="CreateHIT">CreateHIT</a> operation returns an element named
272
+ <strong class="userinput"><code>HIT</code></strong> that represents the HIT that was created by the call. </p><pre class="programlisting">
273
+ &lt;HIT&gt;
274
+ &lt;HITId&gt;123RVWYBAZW00EXAMPLE&lt;/HITId&gt;
275
+ &lt;HITTypeId&gt;T100CN9P324W00EXAMPLE&lt;/HITTypeId&gt;
276
+ &lt;CreationTime&gt;2005-06-30T23:59:59&lt;/CreationTime&gt;
277
+ &lt;HITStatus&gt;Assignable&lt;/HITStatus&gt;
278
+ &lt;MaxAssignments&gt;5&lt;/MaxAssignments&gt;
279
+ &lt;AutoApprovalDelayInSeconds&gt;86400&lt;/AutoApprovalDelayInSeconds&gt;
280
+ &lt;LifetimeInSeconds&gt;86400&lt;/LifetimeInSeconds&gt;
281
+ &lt;AssignmentDurationInSeconds&gt;300&lt;/AssignmentDurationInSeconds&gt;
282
+ &lt;Reward&gt;
283
+ &lt;Amount&gt;25&lt;/Amount&gt;
284
+ &lt;CurrencyCode&gt;USD&lt;/CurrencyCode&gt;
285
+ &lt;FormattedPrice&gt;$0.25&lt;/FormattedPrice&gt;
286
+ &lt;/Reward&gt;
287
+ &lt;Title&gt;Location and Photograph Identification&lt;/Title&gt;
288
+ &lt;Description&gt;Select the image that best represents...&lt;/Description&gt;
289
+ &lt;Keywords&gt;location, photograph, image, identification, opinion&lt;/Keywords&gt;
290
+ &lt;Question&gt;
291
+ &amp;lt;QuestionForm&amp;gt;
292
+ <em class="replaceable"><code>[XML-encoded Question data]</code></em>
293
+ &amp;lt;/QuestionForm&amp;gt;
294
+ &lt;/Question&gt;
295
+ &lt;QualificationRequirement&gt;
296
+ &lt;QualificationTypeId&gt;789RVWYBAZW00EXAMPLE&lt;/QualificationTypeId&gt;
297
+ &lt;Comparator&gt;GreaterThan&lt;/Comparator&gt;
298
+ &lt;Value&gt;18&lt;/Value&gt;
299
+ &lt;/QualificationRequirement&gt;
300
+ &lt;HITReviewStatus&gt;NotReviewed&lt;/HITReviewStatus&gt;
301
+ &lt;/HIT&gt;
302
+ </pre></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_AssignmentDataStructureArticle.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_HITDataStructureArticle">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_LocaleDataStructureArticle.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>