rturk 2.0.2 → 2.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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_CreateQualificationTypeOperation.html ADDED
@@ -0,0 +1,190 @@
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>CreateQualificationType</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_CreateHITOperation.html" title="CreateHIT"><link rel="next" href="ApiReference_DisableHITOperation.html" title="DisableHIT"><!--[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_CreateHITOperation.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_CreateQualificationTypeOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_DisableHITOperation.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>CreateQualificationType</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">CreateQualificationType</h1></div></div></div><a class="indexterm" name="d0e2947"></a><a class="indexterm" name="d0e2950"></a><a class="indexterm" name="d0e2955"></a><a class="indexterm" name="d0e2962"></a><a class="indexterm" name="d0e2967"></a><a class="indexterm" name="d0e2972"></a><a class="indexterm" name="d0e2977"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e2982">Description</h2></div></div></div><p> The <code class="function">CreateQualificationType</code> operation creates a new
7
+ Qualification type. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e2990">Request Parameters</h2></div></div></div><p>
8
+ <code class="function">CreateQualificationType</code> accepts parameters common to all
9
+ 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
10
+ information. </p><p> The following parameters are specific to the <code class="function">CreateQualificationType</code> 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>
11
+ <p class="simpara">
12
+ <em class="parameter"><code>Operation</code></em>
13
+ </p>
14
+ </td><td>
15
+ <p class="simpara">The name of the operation</p>
16
+ <p class="simpara">Type: String</p>
17
+ <p class="simpara">Valid Values: CreateQualificationType</p>
18
+ <p class="simpara">Default: None</p>
19
+ </td><td>
20
+ <p>Yes</p>
21
+ </td></tr><tr><td>
22
+ <p class="simpara">
23
+ <em class="parameter"><code>Name</code></em>
24
+ </p>
25
+ </td><td>
26
+ <p class="simpara"> The name you give to the Qualification type. The type name is
27
+ used to represent the Qualification to Workers, and to find the type
28
+ using a Qualification type search. </p>
29
+ <p class="simpara">Type: String</p>
30
+ <p class="simpara">Default: None</p>
31
+ <p class="simpara">Constraints: must be unique across all of your Qualification
32
+ types.</p>
33
+ </td><td>
34
+ <p>Yes</p>
35
+ </td></tr><tr><td>
36
+ <p class="simpara">
37
+ <em class="parameter"><code>Description</code></em>
38
+ </p>
39
+ </td><td>
40
+ <p class="simpara"> A long description for the Qualification type. On the Amazon
41
+ Mechanical Turk web site, the long description is displayed when a
42
+ user examines a Qualification type. </p>
43
+ <p class="simpara">Type: String</p>
44
+ <p class="simpara">Default: None</p>
45
+ <p class="simpara">Constraints: Must be less than or equal to 2000
46
+ characters.</p>
47
+ </td><td>
48
+ <p class="simpara">Yes</p>
49
+ </td></tr><tr><td>
50
+ <p class="simpara">
51
+ <em class="parameter"><code>Keywords</code></em>
52
+ </p>
53
+ </td><td>
54
+ <p class="simpara"> One or more words or phrases that describe the Qualification
55
+ type, separated by commas. The Keywords of a type make the type
56
+ easier to find during a search. </p>
57
+ <p class="simpara">Type: String</p>
58
+ <p class="simpara">Default: None</p>
59
+ <p class="simpara">Constraints: Must be less than or equal to 1000 characters,
60
+ including commas and spaces.</p>
61
+ </td><td>
62
+ <p class="simpara">No</p>
63
+ </td></tr><tr><td>
64
+ <p class="simpara">
65
+ <em class="parameter"><code>RetryDelayInSeconds</code></em>
66
+ </p>
67
+ </td><td>
68
+ <p class="simpara"> The number of seconds after requesting a Qualification of the
69
+ Qualification type that a user must wait before that user can
70
+ request it again. </p>
71
+ <p class="simpara">Type: non-negative integer</p>
72
+ <p class="simpara"> Default: None. If not specified, retrys are disabled and users
73
+ can request a Qualficiation of this type only once, even if the user
74
+ has not been granted the Qualification. </p>
75
+ </td><td>
76
+ <p class="simpara">No</p>
77
+ </td></tr><tr><td>
78
+ <p>
79
+ <em class="parameter"><code>QualificationTypeStatus</code></em>
80
+ </p>
81
+ </td><td>
82
+ <p class="simpara"> The initial status of the Qualification type. </p>
83
+ <p class="simpara">Type: String</p>
84
+ <p class="simpara">Valid Values: Active | Inactive</p>
85
+ <p class="simpara">Default: None</p>
86
+ </td><td>
87
+ <p class="simpara">Yes</p>
88
+ </td></tr><tr><td>
89
+ <p class="simpara">
90
+ <em class="parameter"><code>Test</code></em>
91
+ </p>
92
+ </td><td>
93
+ <p class="simpara"> The questions for the Qualification test a user must answer
94
+ correctly to obtain a Qualification of this type. </p>
95
+ <p class="simpara"> If this parameter is specified, <em class="parameter"><code>TestDurationInSeconds</code></em> must also be specified. </p>
96
+ <p class="simpara"> Type: String. </p>
97
+ <p class="simpara"> Default: None. If not specified, the user may request the
98
+ Qualification without answering any questions. </p>
99
+ <p class="simpara"> Constraints: must be a <a class="link" href="ApiReference_QuestionFormDataStructureArticle.html" title="QuestionForm">QuestionForm</a> data structure. This parameter cannot be
100
+ specified if <em class="parameter"><code>AutoGranted</code></em> is
101
+ <code class="code">true</code>. </p>
102
+ </td><td>
103
+ <p class="simpara">No</p>
104
+ </td></tr><tr><td>
105
+ <p class="simpara">
106
+ <em class="parameter"><code>AnswerKey</code></em>
107
+ </p>
108
+ </td><td>
109
+ <p class="simpara"> The answers to the Qualification test specified in the
110
+ <em class="parameter"><code>Test</code></em> parameter, in the form of an <a class="link" href="ApiReference_AnswerKeyDataStructureArticle.html" title="AnswerKey">AnswerKey</a> data structure. </p>
111
+ <p class="simpara"> Type: String </p>
112
+ <p class="simpara">Default: None. If not specified, you must process Qualification
113
+ requests manually.</p>
114
+ </td><td>
115
+ <p class="simpara">No</p>
116
+ </td></tr><tr><td>
117
+ <p class="simpara">
118
+ <em class="parameter"><code>TestDurationInSeconds</code></em>
119
+ </p>
120
+ </td><td>
121
+ <p class="simpara"> The number of seconds the user has to complete the
122
+ Qualification test, starting at the time the user requests the
123
+ Qualification. </p>
124
+ <p class="simpara">Type: Integer</p>
125
+ <p class="simpara">Valid Values: Positive integer</p>
126
+ <p class="simpara">Default: None</p>
127
+ <p class="simpara"> Conditions: Required if the <em class="parameter"><code>Test</code></em>
128
+ parameter is specified. </p>
129
+ </td><td>
130
+ <p class="simpara">Conditional</p>
131
+ </td></tr><tr><td>
132
+ <p class="simpara">
133
+ <em class="parameter"><code>AutoGranted</code></em>
134
+ </p>
135
+ </td><td>
136
+ <p class="simpara"> Specifies whether requests for the Qualification type are
137
+ granted immediately, without prompting the Worker with a
138
+ Qualification test.</p>
139
+ <p class="simpara">Type: Boolean</p>
140
+ <p class="simpara">Valid Values: <code class="code">true</code> | <code class="code">false</code></p>
141
+ <p class="simpara">Default: None</p>
142
+ <p class="simpara"> Constraints: If the <em class="parameter"><code>Test</code></em> parameter is
143
+ specified, this parameter cannot be <code class="code">true</code>. </p>
144
+ </td><td>
145
+ <p class="simpara">No</p>
146
+ </td></tr><tr><td>
147
+ <p class="simpara">
148
+ <em class="parameter"><code>AutoGrantedValue</code></em>
149
+ </p>
150
+ </td><td>
151
+ <p class="simpara"> The Qualification value to use for automatically granted
152
+ Qualifications. This parameter is used only if the <em class="parameter"><code>AutoGranted</code></em> parameter is <code class="code">true</code>. </p>
153
+ <p class="simpara">Type: Integer</p>
154
+ <p class="simpara">Default: 1</p>
155
+ </td><td>
156
+ <p class="simpara">No</p>
157
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e3366">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">CreateQualificaionType</code> operation
158
+ includes the elements found 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>
159
+ <p class="simpara">
160
+ <em class="parameter"><code>QualificationType</code></em>
161
+ </p>
162
+ </td><td>
163
+ <p class="simpara"> The created Qualification type. </p>
164
+ <p class="simpara"> Type: a <a class="link" href="ApiReference_QualificationTypeDataStructureArticle.html" title="QualificationType">QualificationType</a> data structure. </p>
165
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e3405">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">CreateQualificaionType</code>
166
+ operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e3413">Sample Request</h3></div></div></div><p>The following example creates a Qualification type.</p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
167
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
168
+ &amp;Version=2008-08-02
169
+ &amp;Operation=CreateQualificationType
170
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
171
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
172
+ &amp;Name=EnglishWritingAbility
173
+ &amp;Description=The%20ability%20to%20write%20and%20edit%20text...
174
+ &amp;QualificationTypeStatus=Active
175
+ </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e3429">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;CreateQualificationTypeResponse&gt;
176
+ &lt;OperationRequest&gt;
177
+ &lt;RequestId&gt;5218189c-1d7e-49a3-abbf-672fb5e77c66&lt;/RequestId&gt;
178
+ &lt;/OperationRequest&gt;
179
+ &lt;QualificationType&gt;
180
+ &lt;Request&gt;
181
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
182
+ &lt;/Request&gt;
183
+ &lt;QualificationTypeId&gt;ZSPJXD4F1SFZP7YNJWR0&lt;/QualificationTypeId&gt;
184
+ &lt;CreationTime&gt;2009-07-13T17:26:33Z&lt;/CreationTime&gt;
185
+ &lt;Name&gt;SampleQualificationTest&lt;/Name&gt;
186
+ &lt;Description&gt;Description of my qualification test.&lt;/Description&gt;
187
+ &lt;QualificationTypeStatus&gt;Active&lt;/QualificationTypeStatus&gt;
188
+ &lt;AutoGranted&gt;0&lt;/AutoGranted&gt;
189
+ &lt;/QualificationType&gt;
190
+ &lt;/CreateQualificationTypeResponse&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_CreateHITOperation.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_CreateQualificationTypeOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_DisableHITOperation.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_DataStructuresArticle.html ADDED
@@ -0,0 +1,7 @@
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;6.&nbsp;Data Structures</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_UpdateQualificationTypeOperation.html" title="UpdateQualificationType"><link rel="next" href="ApiReference_AssignmentDataStructureArticle.html" title="Assignment"><!--[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_UpdateQualificationTypeOperation.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_DataStructuresArticle">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_AssignmentDataStructureArticle.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>Data Structures</strong></div></div><div class="chapter" lang="en" id="ApiReference_DataStructuresArticle"><div class="titlepage"><div><div><h1 class="topictitle">Data Structures</h1></div></div></div><a class="indexterm" name="d0e13730"></a><div class="highlights"><p><strong>Topics</strong></p><ul><li><a href="ApiReference_AssignmentDataStructureArticle.html">Assignment</a></li><li><a href="ApiReference_HITDataStructureArticle.html">HIT</a></li><li><a href="ApiReference_LocaleDataStructureArticle.html">Locale</a></li><li><a href="ApiReference_PriceDataStructureArticle.html">Price</a></li><li><a href="ApiReference_QualificationDataStructureArticle.html">Qualification</a></li><li><a href="ApiReference_QualificationRequestDataStructureArticle.html">QualificationRequest</a></li><li><a href="ApiReference_QualificationRequirementDataStructureArticle.html">QualificationRequirement</a></li><li><a href="ApiReference_QualificationTypeDataStructureArticle.html">QualificationType</a></li><li><a href="ApiReference_NotificationDataStructureArticle.html">Notification</a></li></ul></div><p> The Amazon Mechanical Turk Service API uses several common data structures in its operation request and
7
+ response structures. For easy reference, these structures are documented in separate articles. For more information, refer to their corresponding operations.</p></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_UpdateQualificationTypeOperation.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_DataStructuresArticle">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_AssignmentDataStructureArticle.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_DisableHITOperation.html ADDED
@@ -0,0 +1,63 @@
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>DisableHIT</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_CreateQualificationTypeOperation.html" title="CreateQualificationType"><link rel="next" href="ApiReference_DisposeHITOperation.html" title="DisposeHIT"><!--[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_CreateQualificationTypeOperation.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_DisableHITOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_DisposeHITOperation.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>DisableHIT</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">DisableHIT</h1></div></div></div><a class="indexterm" name="d0e3440"></a><a class="indexterm" name="d0e3443"></a><a class="indexterm" name="d0e3448"></a><a class="indexterm" name="d0e3453"></a><a class="indexterm" name="d0e3458"></a><a class="indexterm" name="d0e3461"></a><a class="indexterm" name="d0e3464"></a><a class="indexterm" name="d0e3467"></a><a class="indexterm" name="d0e3472"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e3477">Description</h2></div></div></div><p> The <code class="function">DisableHIT</code> operation removes a HIT from the Amazon
7
+ Mechanical Turk marketplace, approves all submitted assignments that have not already
8
+ been approved or rejected, and disposes of the HIT and all assignment data. </p><p> Assignments for the HIT that have already been submitted, but not yet approved or
9
+ rejected, are automatically approved. Assignments in progress at the time of the call to
10
+ the <code class="function">DisableHIT</code> operation are approved once the assignments are
11
+ submitted. You will be charged for approval of these assignments. </p><div class="caution" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Caution"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="images/caution.png"></td><th align="left">Caution</th></tr><tr><td align="left" valign="top"><p> The <code class="function">DisableHIT</code> operation does not work on HITs in the
12
+ <span class="guilabel">Reviewable</span> state. For reviewable HITs, call the <a class="link" href="ApiReference_ApproveAssignmentOperation.html" title="ApproveAssignment">ApproveAssignment</a>
13
+ operation or the <a class="link" href="ApiReference_RejectAssignmentOperation.html" title="RejectAssignment">RejectAssignment</a> operation for each submitted assignment, if any. Then
14
+ call the <a class="link" href="ApiReference_DisposeHITOperation.html" title="DisposeHIT">DisposeHIT</a>
15
+ operation to dispose of the HIT. </p></td></tr></table></div><p> The <code class="function">DisableHIT</code> operation completely disposes of the HIT and all
16
+ submitted assignment data. Assignment results data cannot be retrieved for a HIT that
17
+ has been disposed. </p><p> Only the Requester who created a HIT can disable it. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e3515">Request Parameters</h2></div></div></div><p> The <code class="function">DisableHIT</code> operation accepts parameters common to all
18
+ 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">DisableHIT</code>
19
+ 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>
20
+ <p class="simpara">
21
+ <em class="parameter"><code>Operation</code></em>
22
+ </p>
23
+ </td><td>
24
+ <p class="simpara">The name of the operation</p>
25
+ <p class="simpara">Type: String</p>
26
+ <p class="simpara">Valid Values: DisableHIT</p>
27
+ <p class="simpara">Default: None</p>
28
+ </td><td>
29
+ <p class="simpara">Yes</p>
30
+ </td></tr><tr><td>
31
+ <p class="simpara">
32
+ <em class="parameter"><code>HITId</code></em>
33
+ </p>
34
+ </td><td>
35
+ <p class="simpara"> The ID of the HIT, as returned by the <a class="link" href="ApiReference_CreateHITOperation.html" title="CreateHIT">CreateHIT</a>
36
+ operation. </p>
37
+ <p class="simpara">Type: String</p>
38
+ <p class="simpara">Default: None</p>
39
+ </td><td>
40
+ <p class="simpara">Yes</p>
41
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e3600">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">DisableHIT</code> operation returns with
42
+ no errors. The response includes the elements in the following table. The operation
43
+ 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>
44
+ <p class="simpara">
45
+ <em class="parameter"><code>DisableHITResult</code></em>
46
+ </p>
47
+ </td><td>
48
+ <p class="simpara"> Contains a <em class="parameter"><code>Request</code></em> element if the
49
+ <strong class="userinput"><code>Request</code></strong>
50
+ <em class="parameter"><code>ResposeGroup</code></em> is specified. </p>
51
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e3642">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">DisableHIT</code>
52
+ operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e3650">Sample Request</h3></div></div></div><p> The following example disables a HIT with a specified HIT ID. </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
53
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
54
+ &amp;Version=2008-08-02
55
+ &amp;Operation=DisableHIT
56
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
57
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
58
+ &amp;HITId=123RVWYBAZW00EXAMPLE
59
+ </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e3666">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;DisableHITResult&gt;
60
+ &lt;Request&gt;
61
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
62
+ &lt;/Request&gt;
63
+ &lt;/DisableHITResult&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_CreateQualificationTypeOperation.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_DisableHITOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_DisposeHITOperation.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_DisposeHITOperation.html ADDED
@@ -0,0 +1,56 @@
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>DisposeHIT</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_DisableHITOperation.html" title="DisableHIT"><link rel="next" href="ApiReference_DisposeQualificationTypeOperation.html" title="DisposeQualificationType"><!--[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_DisableHITOperation.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_DisposeHITOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_DisposeQualificationTypeOperation.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>DisposeHIT</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">DisposeHIT</h1></div></div></div><a class="indexterm" name="d0e3677"></a><a class="indexterm" name="d0e3680"></a><a class="indexterm" name="d0e3685"></a><a class="indexterm" name="d0e3688"></a><a class="indexterm" name="d0e3693"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e3698">Description</h2></div></div></div><p> The <code class="function">DisposeHIT</code> operation disposes of a HIT that is no longer
7
+ needed. </p><p> You can dispose only HITs in the <span class="guilabel">Reviewable</span> state, with all
8
+ submitted assignments approved or rejected. If you call the <code class="function">DisposeHIT</code> operation on a HIT that is not <span class="guilabel">Reviewable</span> (that has not expired or has active assignments), or on a HIT
9
+ that is <span class="guilabel">Reviewable</span> but not all of the submitted assignments have
10
+ been approved or rejected, the service returns an error. </p><p> Only the Requester who created a HIT can dispose it. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e3722">Request Parameters</h2></div></div></div><p> The <code class="function">DisposeHIT</code> operation accepts parameters common to all
11
+ 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">DisposeHIT</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: DisposeHIT</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>HitId</code></em>
26
+ </p>
27
+ </td><td>
28
+ <p class="simpara"> The ID of the HIT, as returned by the <a class="link" href="ApiReference_CreateHITOperation.html" title="CreateHIT">CreateHIT</a>
29
+ operation. </p>
30
+ <p class="simpara">Type: String</p>
31
+ <p class="simpara">Default: None</p>
32
+ </td><td>
33
+ <p class="simpara">Yes</p>
34
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e3807">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">DisposeHIT</code> operation returns with
35
+ no errors. The response includes the elements described in the following table. The
36
+ 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>
37
+ <p class="simpara">
38
+ <em class="parameter"><code>DisposeHITResult</code></em>
39
+ </p>
40
+ </td><td>
41
+ <p class="simpara"> Contains a <em class="parameter"><code>Request</code></em> element if the
42
+ <strong class="userinput"><code>Request</code></strong>
43
+ <em class="parameter"><code>ResposeGroup</code></em> is specified. </p>
44
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e3849">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">DisposeHIT</code>
45
+ operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e3857">Sample Request</h3></div></div></div><p> The following example disposes of the HIT with the specified HIT ID. </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
46
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
47
+ &amp;Version=2008-08-02
48
+ &amp;Operation=DisposeHIT
49
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
50
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
51
+ &amp;HITId=123RVWYBAZW00EXAMPLE
52
+ </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e3873">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;DisposeHITResult&gt;
53
+ &lt;Request&gt;
54
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
55
+ &lt;/Request&gt;
56
+ &lt;/DisposeHITResult&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_DisableHITOperation.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_DisposeHITOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_DisposeQualificationTypeOperation.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_DisposeQualificationTypeOperation.html ADDED
@@ -0,0 +1,52 @@
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>DisposeQualificationType</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_DisposeHITOperation.html" title="DisposeHIT"><link rel="next" href="ApiReference_ExtendHITOperation.html" title="ExtendHIT"><!--[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_DisposeHITOperation.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_DisposeQualificationTypeOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_ExtendHITOperation.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>DisposeQualificationType</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">DisposeQualificationType</h1></div></div></div><a class="indexterm" name="d0e3884"></a><a class="indexterm" name="d0e3887"></a><a class="indexterm" name="d0e3894"></a><a class="indexterm" name="d0e3899"></a><a class="indexterm" name="d0e3904"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e3909">Description</h2></div></div></div><p> The <code class="function">DisposeQualificationType</code> operation disposes a Qualification
7
+ type and disposes any HIT types that are associated with the Qualifcation type. </p><p> This operation does not dispose Qualification types already assigned to Workers as
8
+ the Qualifications might be needed for active HITs. If there are any pending requests
9
+ for the Qualification type, Amazon Mechanical Turk rejects those requests. </p><p> Once you dispose a Qualification type, it cannot be used to create HITs or HIT types.
10
+ </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e3921">Request Parameters</h2></div></div></div><p> A request to the Amazon Mechanical Turk Service includes parameters that control its
11
+ behavior and the data it returns. Required parameters must be included for the request
12
+ to succeed. </p><p>
13
+ <code class="function">DisposeQualificationType</code> accepts parameters common to all
14
+ 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">DisposeQualificationType</code> 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
+ <em class="parameter"><code>Operation</code></em>
16
+ </td><td>
17
+ <p>The operation you want to call. To access the <code class="function">DisposeQualificationType</code> operation, set the
18
+ <em class="parameter"><code>Operation</code></em> parameter to <strong class="userinput"><code>DisposeQualificationType</code></strong>.</p>
19
+ <p class="simpara">Type: DisposeQualificationType</p>
20
+ <p class="simpara">Default: None</p>
21
+ </td><td class="requirement">
22
+ <p>Yes</p>
23
+ </td></tr><tr><td>
24
+ <em class="parameter"><code>QualificationTypeId</code></em>
25
+ </td><td>
26
+ <p>The ID of the Qualification to dispose.</p>
27
+ <p class="simpara">Type: String</p>
28
+ <p class="simpara">Default: None</p>
29
+ <p class="simpara">Constraint: A valid QualificationType ID</p>
30
+ </td><td class="requirement"> Yes </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e4005">Response Elements</h2></div></div></div><p>A successful request for the <code class="function">DisposeQualification</code> operation
31
+ returns with no errors. The response includes the elements described in the following
32
+ 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>
33
+ <p class="simpara">
34
+ <em class="parameter"><code>DisposeQualificationTypeResult</code></em>
35
+ </p>
36
+ </td><td>
37
+ <p class="simpara"> Contains a <em class="parameter"><code>Request</code></em> element if the
38
+ <strong class="userinput"><code>Request</code></strong>
39
+ <em class="parameter"><code>ResposeGroup</code></em> is specified. </p>
40
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e4047">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">DisposeQualification</code>
41
+ operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e4055">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
42
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
43
+ &amp;Version=2008-08-02
44
+ &amp;Operation=DisposeQualification
45
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
46
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
47
+ &amp;WorkerId=AZ3456EXAMPLE
48
+ &amp;Reason=After%20several%20warnings,%20he%20continued%20to%20submit%20answers%20without%20reading%20the%20instructions%20carefully.</pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e4071">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;DisposeQualificationResult&gt;
49
+ &lt;Request&gt;
50
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
51
+ &lt;/Request&gt;
52
+ &lt;/DisposeQualificationResult&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_DisposeHITOperation.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_DisposeQualificationTypeOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_ExtendHITOperation.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_ExtendHITOperation.html ADDED
@@ -0,0 +1,86 @@
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>ExtendHIT</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_DisposeQualificationTypeOperation.html" title="DisposeQualificationType"><link rel="next" href="ApiReference_ForceExpireHITOperation.html" title="ForceExpireHIT"><!--[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_DisposeQualificationTypeOperation.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_ExtendHITOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_ForceExpireHITOperation.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>ExtendHIT</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">ExtendHIT</h1></div></div></div><a class="indexterm" name="d0e4082"></a><a class="indexterm" name="d0e4085"></a><a class="indexterm" name="d0e4090"></a><a class="indexterm" name="d0e4095"></a><a class="indexterm" name="d0e4098"></a><a class="indexterm" name="d0e4103"></a><a class="indexterm" name="d0e4108"></a><a class="indexterm" name="d0e4113"></a><a class="indexterm" name="d0e4116"></a><a class="indexterm" name="d0e4121"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e4126">Description</h2></div></div></div><p> The <code class="function">ExtendHIT</code> operation increases the maximum number of
7
+ assignments, or extends the expiration date, of an existing HIT. </p><p> To extend the maximum number of assignments, specify the number of additional
8
+ assignments. </p><p> To extend the expiration date, specify an amount of time as a number of seconds. If
9
+ the HIT has not yet expired, the new expiration date is the existing date plus the
10
+ amount of time specified. If the HIT has already expired, the new expiration date is the
11
+ current time plus the amount of time specified. </p><p> Only the Requester who created a HIT can extend it. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e4140">Request Parameters</h2></div></div></div><p> The <code class="function">ExtendHIT</code> operation accepts parameters common to all
12
+ 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
13
+ information. </p><p> The following parameters are specific to the <code class="function">ExtendHIT</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: ExtendHIT</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 extend</p>
31
+ <p class="simpara">Type: String</p>
32
+ <p class="simpara">Default: None</p>
33
+ </td><td>
34
+ <p>Yes</p>
35
+ </td></tr><tr><td>
36
+ <p class="simpara">
37
+ <em class="parameter"><code>MaxAssignmentsIncrement</code></em>
38
+ </p>
39
+ </td><td>
40
+ <p class="simpara"> The number of assignments by which to increment the <em class="parameter"><code>MaxAssignments</code></em> parameter of the HIT. </p>
41
+ <p class="simpara">Type: positive integer</p>
42
+ <p class="simpara">Valid Values: any integer between 1 and 1000000000 (one
43
+ billion)</p>
44
+ <p class="simpara">Default: None</p>
45
+ </td><td>
46
+ <p class="simpara">No</p>
47
+ </td></tr><tr><td>
48
+ <p class="simpara">
49
+ <em class="parameter"><code>ExpirationIncrementInSeconds</code></em>
50
+ </p>
51
+ </td><td>
52
+ <p class="simpara"> The amount of time, in seconds, by which to extend the
53
+ expiration date. If the HIT has not yet expired, this amount is
54
+ added to the HIT's expiration date. If the HIT has expired, the new
55
+ expiration date is the current time plus this value. </p>
56
+ <p class="simpara">Type: positive integer</p>
57
+ <p class="simpara">Valid Values: any integer between 3600 (1 hour) and 31536000
58
+ (365 days)</p>
59
+ <p class="simpara">Default: None</p>
60
+ </td><td>
61
+ <p class="simpara">No</p>
62
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e4282">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">ExtendHIT</code> operation returns with no
63
+ errors. The response includes the elements described in the following table. The
64
+ 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>
65
+ <p class="simpara">
66
+ <em class="parameter"><code>ExtendHITResult</code></em>
67
+ </p>
68
+ </td><td>
69
+ <p class="simpara"> Contains a <em class="parameter"><code>Request</code></em> element if the
70
+ <strong class="userinput"><code>Request</code></strong>
71
+ <em class="parameter"><code>ResposeGroup</code></em> is specified. </p>
72
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e4324">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">ExtendHIT</code>
73
+ operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e4332">Sample Request</h3></div></div></div><p> The following example extends the expiration date of a HIT by 5 days (432,000
74
+ seconds). </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
75
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
76
+ &amp;Version=2008-08-02
77
+ &amp;Operation=ExtendHIT
78
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
79
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
80
+ &amp;HITId=123RVWYBAZW00EXAMPLE
81
+ &amp;ExpirationIncrementInSeconds=432000
82
+ </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e4348">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;ExtendHITResult&gt;
83
+ &lt;Request&gt;
84
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
85
+ &lt;/Request&gt;
86
+ &lt;/ExtendHITResult&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_DisposeQualificationTypeOperation.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_ExtendHITOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_ForceExpireHITOperation.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>