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_SearchQualificationTypesOperation.html ADDED
@@ -0,0 +1,211 @@
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>SearchQualificationTypes</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_SearchHITsOperation.html" title="SearchHITs"><link rel="next" href="ApiReference_SendTestEventNotificationOperation.html" title="SendTestEventNotification"><!--[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_SearchHITsOperation.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_SearchQualificationTypesOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_SendTestEventNotificationOperation.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>SearchQualificationTypes</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">SearchQualificationTypes</h1></div></div></div><a class="indexterm" name="d0e11416"></a><a class="indexterm" name="d0e11419"></a><a class="indexterm" name="d0e11426"></a><a class="indexterm" name="d0e11431"></a><a class="indexterm" name="d0e11436"></a><a class="indexterm" name="d0e11441"></a><a class="indexterm" name="d0e11446"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e11451">Description</h2></div></div></div><p> The <code class="function">SearchQualificationTypes</code> operation searches for
7
+ Qualification types using the specified search query, and returns a list of
8
+ Qualification types. </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 with parameters to the
10
+ operation. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e11461">Request Parameters</h2></div></div></div><p>
11
+ <code class="function">SearchQualificationTypes</code> 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">SearchQualificationTypes</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>
14
+ <p class="simpara">
15
+ <em class="parameter"><code>Operation</code></em>
16
+ </p>
17
+ </td><td>
18
+ <p class="simpara">The name of the operation</p>
19
+ <p class="simpara">Type: String</p>
20
+ <p class="simpara">Valid Values: SearchQualificationTypes</p>
21
+ <p class="simpara">Default: None</p>
22
+ </td><td>
23
+ <p class="simpara">Yes</p>
24
+ </td></tr><tr><td>
25
+ <p class="simpara">
26
+ <em class="parameter"><code>Query</code></em>
27
+ </p>
28
+ </td><td>
29
+ <p class="simpara"> A text query against all of the searchable attributes of
30
+ Qualification types. </p>
31
+ <p class="simpara">Type: String</p>
32
+ <p class="simpara"> Default: None. If not specified, the complete set of all
33
+ Qualification types is considered for the results. </p>
34
+ </td><td>
35
+ <p class="simpara">No</p>
36
+ </td></tr><tr><td>
37
+ <p class="simpara">
38
+ <em class="parameter"><code>SortProperty</code></em>
39
+ </p>
40
+ </td><td>
41
+ <p class="simpara">The field on which to sort the results returned by the
42
+ operation.</p>
43
+ <p class="simpara">Type: String</p>
44
+ <p class="simpara">Valid Values: Name</p>
45
+ <p class="simpara">Default: Name</p>
46
+ </td><td>
47
+ <p class="simpara">No</p>
48
+ </td></tr><tr><td>
49
+ <p class="simpara">
50
+ <em class="parameter"><code>SortDirection</code></em>
51
+ </p>
52
+ </td><td>
53
+ <p class="simpara"> The direction of the sort used with the field specified by
54
+ <em class="parameter"><code>SortProperty</code></em>. </p>
55
+ <p class="simpara">Type: String</p>
56
+ <p class="simpara">Valid Values: Ascending | Descending</p>
57
+ <p class="simpara">Default: Descending</p>
58
+ </td><td>
59
+ <p class="simpara">No</p>
60
+ </td></tr><tr><td>
61
+ <p class="simpara">
62
+ <em class="parameter"><code>PageSize</code></em>
63
+ </p>
64
+ </td><td>
65
+ <p class="simpara"> The number of Qualification types to include in a page of
66
+ results. The operation divides the complete sorted result set into
67
+ pages of this many Qualification types. </p>
68
+ <p class="simpara">Type: positive integer</p>
69
+ <p class="simpara">Valid Values: any integer between 1 and 100.</p>
70
+ <p class="simpara">Default: 10</p>
71
+ </td><td>
72
+ <p class="simpara">No</p>
73
+ </td></tr><tr><td>
74
+ <p class="simpara">
75
+ <em class="parameter"><code>PageNumber</code></em>
76
+ </p>
77
+ </td><td>
78
+ <p class="simpara"> The page of results to return. After the operation filters,
79
+ sorts, and divides the Qualification types into pages of size
80
+ <em class="parameter"><code>PageSize</code></em>, it returns page corresponding
81
+ to <em class="parameter"><code>PageNumber</code></em> as the results of the
82
+ operation. </p>
83
+ <p class="simpara">Type: positive integer</p>
84
+ <p class="simpara">Default: 1</p>
85
+ </td><td>
86
+ <p class="simpara">No</p>
87
+ </td></tr><tr><td>
88
+ <p class="simpara">
89
+ <em class="parameter"><code>MustBeRequestable</code></em>
90
+ </p>
91
+ </td><td>
92
+ <p class="simpara"> Specifies that only Qualification types that a user can
93
+ request through the Amazon Mechanical Turk web site, such as by
94
+ taking a Qualification test, are returned as results of the search.
95
+ Some Qualification types, such as those assigned automatically by
96
+ the system, cannot be requested directly by users. If
97
+ <code class="code">false</code>, all Qualification types, including those
98
+ managed by the system, are considered for the search. </p>
99
+ <p class="simpara">Type: Boolean</p>
100
+ <p class="simpara">Valid Values: true | false</p>
101
+ <p class="simpara">Default: None</p>
102
+ </td><td>
103
+ <p class="simpara">Yes</p>
104
+ </td></tr><tr><td>
105
+ <p class="simpara">
106
+ <em class="parameter"><code>MustBeOwnedByCaller</code></em>
107
+ </p>
108
+ </td><td>
109
+ <p class="simpara"> Specifies that only Qualification types that the Requester
110
+ created are returned. If <code class="code">false</code>, the operation returns
111
+ all Qualification types. </p>
112
+ </td><td>
113
+ <p class="simpara">No</p>
114
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e11715">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">SearchQualificationTypes</code> operation
115
+ has a <em class="parameter"><code>SearchQualificationTypesResult</code></em> element in the response. </p><p> The <em class="parameter"><code>SearchQualificationTypesResult</code></em> element contains the
116
+ elements described in the following table: </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>
117
+ <p class="simpara">
118
+ <em class="parameter"><code>NumResults</code></em>
119
+ </p>
120
+ </td><td>
121
+ <p class="simpara"> The number of Qualification types on this page in the filtered
122
+ results list, equivalent to the number of types this operation
123
+ returns. </p>
124
+ <p class="simpara">Type: non-negative integer</p>
125
+ </td></tr><tr><td>
126
+ <p class="simpara">
127
+ <em class="parameter"><code>PageNumber</code></em>
128
+ </p>
129
+ </td><td>
130
+ <p class="simpara">The number of this page in the filtered results list.</p>
131
+ <p class="simpara">Type: positive integer</p>
132
+ </td></tr><tr><td>
133
+ <p class="simpara">
134
+ <em class="parameter"><code>TotalNumResults</code></em>
135
+ </p>
136
+ </td><td>
137
+ <p class="simpara"> The total number of Qualification types in the filtered
138
+ results list based on this call. </p>
139
+ <p class="simpara">Type: non-negative integer</p>
140
+ </td></tr><tr><td>
141
+ <p class="simpara">
142
+ <em class="parameter"><code>QualificationType</code></em>
143
+ </p>
144
+ </td><td>
145
+ <p class="simpara"> The Qualification type. The response includes one <em class="parameter"><code>QualificationType</code></em> element for each Qualification
146
+ type the query returns. </p>
147
+ <p class="simpara"> Type: a <a class="link" href="ApiReference_QualificationTypeDataStructureArticle.html" title="QualificationType">QualificationType</a> data structure. </p>
148
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e11816">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">SearchQualificationTypes</code> operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e11824">Sample Request</h3></div></div></div><p> The following example performs a simple text query for Qualification types. </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
149
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
150
+ &amp;Version=2008-08-02
151
+ &amp;Operation=SearchQualificationTypes
152
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
153
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
154
+ &amp;Query=English
155
+ </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e11840">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;SearchQualificationTypesResult&gt;
156
+ &lt;Request&gt;
157
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
158
+ &lt;/Request&gt;
159
+ &lt;NumResults&gt;10&lt;/NumResults&gt;
160
+ &lt;TotalNumResults&gt;5813&lt;/TotalNumResults&gt;
161
+ &lt;QualificationType&gt;
162
+ &lt;QualificationTypeId&gt;WKAZMYZDCYCZP412TZEZ&lt;/QualificationTypeId&gt;
163
+ &lt;CreationTime&gt;2009-05-17T10:05:15Z&lt;/CreationTime&gt;
164
+ &lt;Name&gt; WebReviews Qualification Master Test&lt;/Name&gt;
165
+ &lt;Description&gt;
166
+ This qualification will allow you to earn more on the WebReviews HITs.
167
+ &lt;/Description&gt;
168
+ &lt;Keywords&gt;WebReviews, webreviews, web reviews&lt;/Keywords&gt;
169
+ &lt;QualificationTypeStatus&gt;Active&lt;/QualificationTypeStatus&gt;
170
+ &lt;Test&gt;
171
+ &lt;QuestionForm xmlns="http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2005-10-01/QuestionForm.xsd"&gt;
172
+ &lt;Overview&gt;
173
+ &lt;Title&gt;WebReviews Survey&lt;/Title&gt;
174
+ &lt;Text&gt;
175
+ After you have filled out this survey you will be assigned one or more qualifications...
176
+ &lt;/Text&gt;
177
+ &lt;/Overview&gt;
178
+ &lt;Question&gt;
179
+ &lt;QuestionIdentifier&gt;age&lt;/QuestionIdentifier&gt;
180
+ &lt;DisplayName&gt;What is your age?&lt;/DisplayName&gt;
181
+ &lt;IsRequired&gt;true&lt;/IsRequired&gt;
182
+ &lt;QuestionContent&gt;
183
+ &lt;Text&gt;
184
+ Please choose the age group you belong to.
185
+ &lt;/Text&gt;
186
+ &lt;/QuestionContent&gt;
187
+ &lt;AnswerSpecification&gt;
188
+ &lt;SelectionAnswer&gt;
189
+ &lt;StyleSuggestion&gt;radiobutton&lt;/StyleSuggestion&gt;
190
+ &lt;Selections&gt;
191
+ &lt;Selection&gt;
192
+ &lt;SelectionIdentifier&gt;0018&lt;/SelectionIdentifier&gt;
193
+ &lt;Text&gt;-18&lt;/Text&gt;
194
+ &lt;/Selection&gt;
195
+ &lt;Selection&gt;
196
+ &lt;SelectionIdentifier&gt;5160&lt;/SelectionIdentifier&gt;
197
+ &lt;Text&gt;51-60&lt;/Text&gt;
198
+ &lt;/Selection&gt;
199
+ &lt;Selection&gt;
200
+ &lt;SelectionIdentifier&gt;6000&lt;/SelectionIdentifier&gt;
201
+ &lt;Text&gt;60+&lt;/Text&gt;
202
+ &lt;/Selection&gt;
203
+ &lt;/Selections&gt;
204
+ &lt;/SelectionAnswer&gt;
205
+ &lt;/AnswerSpecification&gt;
206
+ &lt;/Question&gt;
207
+ &lt;/QuestionForm&gt;
208
+ &lt;/Test&gt;
209
+ &lt;TestDurationInSeconds&gt;1200&lt;/TestDurationInSeconds&gt;
210
+ &lt;/QualificationType&gt;
211
+ &lt;/SearchQualificationTypesResult&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_SearchHITsOperation.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_SearchQualificationTypesOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_SendTestEventNotificationOperation.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_SendTestEventNotificationOperation.html ADDED
@@ -0,0 +1,78 @@
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>SendTestEventNotification</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_SearchQualificationTypesOperation.html" title="SearchQualificationTypes"><link rel="next" href="ApiReference_SetHITAsReviewingOperation.html" title="SetHITAsReviewing"><!--[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_SearchQualificationTypesOperation.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_SendTestEventNotificationOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_SetHITAsReviewingOperation.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>SendTestEventNotification</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">SendTestEventNotification</h1></div></div></div><a class="indexterm" name="d0e11851"></a><a class="indexterm" name="d0e11854"></a><a class="indexterm" name="d0e11859"></a><a class="indexterm" name="d0e11862"></a><a class="indexterm" name="d0e11867"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e11872">Description</h2></div></div></div><p> The <code class="function">SendTestEventNotification</code> operation causes Amazon Mechanical
7
+ Turk to send a notification message as if a HIT event occurred, according to the
8
+ provided notification specification. This allows you to test your notification receptor
9
+ logic without setting up notifications for a real HIT type and trying to trigger them
10
+ using the web site. </p><p> When you call this operation, the service sends the test notification immediately. If
11
+ the destination of your test notification is a web service, Amazon Mechanical Turk waits
12
+ until your web service has responded, then returns a status report as its response to
13
+ this operaton. Amazon Amazon Mechanical Turk returns an appropriate error message if
14
+ your web service could not be contacted using the notification specification you
15
+ provided. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e11882">Request Parameters</h2></div></div></div><p> The <code class="function">SendTestEventNotification</code> operation accepts parameters
16
+ common to all operations. Some common parameters are required. See <a class="link" href="ApiReference_CommonParametersArticle.html" title="Chapter&nbsp;4.&nbsp;Common Parameters">Common Parameters</a> for more
17
+ information. </p><p> The following parameters are specific to the <code class="function">SendTestEventNotification</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>
18
+ <p class="simpara">
19
+ <em class="parameter"><code>Operation</code></em>
20
+ </p>
21
+ </td><td>
22
+ <p class="simpara">The name of the operation</p>
23
+ <p class="simpara">Type: String</p>
24
+ <p class="simpara">Valid Values: SendTestEventNotification</p>
25
+ <p class="simpara">Default: None</p>
26
+ </td><td>
27
+ <p class="simpara">Yes</p>
28
+ </td></tr><tr><td>
29
+ <p class="simpara">
30
+ <em class="parameter"><code>Notification</code></em>
31
+ </p>
32
+ </td><td>
33
+ <p class="simpara"> The notification specification to test. This value is
34
+ identical to the value you would provide to the <a class="link" href="ApiReference_SetHITTypeNotificationOperation.html" title="SetHITTypeNotification">SetHITTypeNotification</a> operation when you establish the
35
+ notification specification for a HIT type. </p>
36
+ <p class="simpara">Type: a <a class="link" href="ApiReference_NotificationDataStructureArticle.html" title="Notification">Notification</a> data structure</p>
37
+ <p class="simpara">Default: None</p>
38
+ </td><td>
39
+ <p class="simpara">Yes</p>
40
+ </td></tr><tr><td>
41
+ <p class="simpara">
42
+ <em class="parameter"><code>TestEventType</code></em>
43
+ </p>
44
+ </td><td>
45
+ <p class="simpara"> The event to simulate to test the notification specification.
46
+ This event is included in the test message even if the notification
47
+ specification does not include the event type. The notification
48
+ specification does not filter out the test event. </p>
49
+ <p class="simpara"> Type: an <em class="parameter"><code>EventType</code></em> element of the <a class="link" href="ApiReference_NotificationDataStructureArticle.html" title="Notification">Notification</a> data structure. </p>
50
+ <p class="simpara">Default: None</p>
51
+ </td><td>
52
+ <p class="simpara">Yes</p>
53
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e12002">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">SendTestEventNotification</code> operation
54
+ returns with no errors. The response includes the elements described in the following
55
+ 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>
56
+ <p class="simpara">
57
+ <em class="parameter"><code>SendTestEventNotificationResult</code></em>
58
+ </p>
59
+ </td><td>
60
+ <p class="simpara"> Contains a <em class="parameter"><code>Request</code></em> element if the
61
+ <strong class="userinput"><code>Request</code></strong>
62
+ <em class="parameter"><code>ResposeGroup</code></em> is specified. </p>
63
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e12044">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">SendTestEventNotification</code> operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e12052">Sample Request</h3></div></div></div><p> The following example sends a notification message for a simulated <em class="parameter"><code>AssignmentSubmitted</code></em> event to be sent to a web service using the
64
+ REST transport. </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
65
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
66
+ &amp;Operation=SendTestEventNotification
67
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
68
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
69
+ &amp;Notification.1.Destination=http://example.com:80/mt/notifications.cgi
70
+ &amp;Notification.1.Transport=REST
71
+ &amp;Notification.1.Version=2006-05-05
72
+ &amp;Notification.1.EventType=AssignmentSubmitted
73
+ &amp;TestEventType=AssignmentSubmitted
74
+ </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e12071">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;SendTestEventNotificationResult&gt;
75
+ &lt;Request&gt;
76
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
77
+ &lt;/Request&gt;
78
+ &lt;/SendTestEventNotificationResult&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_SearchQualificationTypesOperation.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_SendTestEventNotificationOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_SetHITAsReviewingOperation.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_SetHITAsReviewingOperation.html ADDED
@@ -0,0 +1,73 @@
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>SetHITAsReviewing</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_SendTestEventNotificationOperation.html" title="SendTestEventNotification"><link rel="next" href="ApiReference_SetHITTypeNotificationOperation.html" title="SetHITTypeNotification"><!--[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_SendTestEventNotificationOperation.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_SetHITAsReviewingOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_SetHITTypeNotificationOperation.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>SetHITAsReviewing</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">SetHITAsReviewing</h1></div></div></div><a class="indexterm" name="d0e12082"></a><a class="indexterm" name="d0e12085"></a><a class="indexterm" name="d0e12090"></a><a class="indexterm" name="d0e12095"></a><a class="indexterm" name="d0e12098"></a><a class="indexterm" name="d0e12101"></a><a class="indexterm" name="d0e12106"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e12111">Description</h2></div></div></div><p> The <code class="function">SetHITAsReviewing</code> operation updates the status of a HIT. If
7
+ the status is <strong class="userinput"><code>Reviewable</code></strong>, this operation updates the status to
8
+ <strong class="userinput"><code>Reviewing</code></strong>, or reverts a <strong class="userinput"><code>Reviewing</code></strong> HIT
9
+ back to the <strong class="userinput"><code>Reviewable</code></strong> status. </p><p> You can update only HITs with status <strong class="userinput"><code>Reviewable</code></strong> to status
10
+ <strong class="userinput"><code>Reviewing</code></strong>. Similarly, you can revert only <strong class="userinput"><code>Reviewing</code></strong> HITs back to status <strong class="userinput"><code>Reviewable</code></strong>. </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/note.png"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p> The <code class="function">SetHITAsReviewing</code> operation does
11
+ <span class="emphasis"><em>not</em></span> toggle the status value. The default behavior is to
12
+ promote a HIT from <strong class="userinput"><code>Reviewable</code></strong> to <strong class="userinput"><code>Reviewing</code></strong>. To revert a <strong class="userinput"><code>Reviewing</code></strong> HIT back to
13
+ <strong class="userinput"><code>Reviewable</code></strong>, specify the <em class="parameter"><code>Revert</code></em>
14
+ parameter with a value of <strong class="userinput"><code>true</code></strong>. </p></td></tr></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e12172">Request Parameters</h2></div></div></div><p> The <code class="function">SetHITAsReviewing</code> operation accepts parameters common to all
15
+ 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
16
+ information. </p><p> The following parameters are specific to the <code class="function">SetHITAsReviewing</code>
17
+ 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>
18
+ <p class="simpara">
19
+ <em class="parameter"><code>Operation</code></em>
20
+ </p>
21
+ </td><td>
22
+ <p class="simpara">The name of the operation</p>
23
+ <p class="simpara">Type: String</p>
24
+ <p class="simpara">ValidValues: SetHITAsReviewing</p>
25
+ <p class="simpara">Default: None</p>
26
+ </td><td>
27
+ <p class="simpara">Yes</p>
28
+ </td></tr><tr><td>
29
+ <p class="simpara">
30
+ <em class="parameter"><code>HITId</code></em>
31
+ </p>
32
+ </td><td>
33
+ <p class="simpara">The ID of the HIT whose status is to be updated.</p>
34
+ <p class="simpara">Type: String</p>
35
+ <p class="simpara">Default: None</p>
36
+ </td><td>
37
+ <p class="simpara">Yes</p>
38
+ </td></tr><tr><td>
39
+ <p class="simpara">
40
+ <em class="parameter"><code>Revert</code></em>
41
+ </p>
42
+ </td><td>
43
+ <p class="simpara"> Specifies whether to update the HIT <em class="parameter"><code>Status</code></em> from <strong class="userinput"><code>Reviewing</code></strong> to
44
+ <strong class="userinput"><code>Reviewable</code></strong>. </p>
45
+ <p class="simpara">Type: Boolean</p>
46
+ <p class="simpara">Valid Values: true | false</p>
47
+ <p class="simpara"> Default: false; the operation promotes the HIT from <strong class="userinput"><code>Reviewable</code></strong> to <strong class="userinput"><code>Reviewing</code></strong>.
48
+ </p>
49
+ </td><td>
50
+ <p class="simpara">No</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="d0e12298">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">SetHITAsReviewing</code> operation returns
52
+ with no errors. The response includes the elements described in the following table. The
53
+ 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>
54
+ <p class="simpara">
55
+ <em class="parameter"><code>SetHITAsReviewingResult</code></em>
56
+ </p>
57
+ </td><td>
58
+ <p class="simpara">Contains a <em class="parameter"><code>Request</code></em> element if the
59
+ <strong class="userinput"><code>Request</code></strong>
60
+ <em class="parameter"><code>ResposeGroup</code></em> is specified. </p>
61
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e12340">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">SetHITAsReviewingResult</code> operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e12348">Sample Request</h3></div></div></div><p>The following example updates a HIT with <strong class="userinput"><code>Reviewable</code></strong> status
62
+ to <strong class="userinput"><code>Reviewing</code></strong> status. </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
63
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
64
+ &amp;Version=2008-08-02
65
+ &amp;Operation=SetHITAsReviewing
66
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
67
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
68
+ &amp;HITId=123RVWYBAZW00EXAMPLE
69
+ </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e12370">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;SetHITAsReviewingResult&gt;
70
+ &lt;Request&gt;
71
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
72
+ &lt;/Request&gt;
73
+ &lt;/SetHITAsReviewingResult&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_SendTestEventNotificationOperation.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_SetHITAsReviewingOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_SetHITTypeNotificationOperation.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_SetHITTypeNotificationOperation.html ADDED
@@ -0,0 +1,99 @@
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>SetHITTypeNotification</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_SetHITAsReviewingOperation.html" title="SetHITAsReviewing"><link rel="next" href="ApiReference_UnblockWorkerOperation.html" title="UnblockWorker"><!--[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_SetHITAsReviewingOperation.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_SetHITTypeNotificationOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_UnblockWorkerOperation.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>SetHITTypeNotification</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">SetHITTypeNotification</h1></div></div></div><a class="indexterm" name="d0e12381"></a><a class="indexterm" name="d0e12384"></a><a class="indexterm" name="d0e12389"></a><a class="indexterm" name="d0e12394"></a><a class="indexterm" name="d0e12401"></a><a class="indexterm" name="d0e12406"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e12411">Description</h2></div></div></div><p> The <code class="function">SetHITTypeNotification</code> operation creates, updates, disables
7
+ or re-enables notifications for a HIT type. </p><p> If you call the <code class="function">SetHITTypeNotification</code> operation for a HIT type
8
+ that already has a notification specification, the operation replaces the old
9
+ specification with a new one. </p><p>Every time you change your secret access key ID (using the Access Identifiers section
10
+ of Your Account at <a class="ulink" href="http://aws.amazon.com/account" target="_blank">http://aws.amazon.com/account</a>) you need to reset each of your HITType
11
+ notifications. When you do, Amazon Mechanical Turk uses your new secret access key ID to
12
+ sign all notifications for the specified HITType going forward. Until you reset your
13
+ HITType notifications, Amazon Mechanical Turk will keep signing notifications using your
14
+ old secret access key ID. </p><div class="important" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Important"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="images/important.png"></td><th align="left">Important</th></tr><tr><td align="left" valign="top"><p>If you deactivate or delete a secret access key ID used by a HITType notification,
15
+ you will start receiving unsigned notifications for that HITType.</p></td></tr></table></div><p> You can call the <code class="function">SetHITTypeNotification</code> operation to enable or
16
+ disable notifications for the HIT type, without having to modify the notification
17
+ specification itself. </p><p> You can call this operation at any time to change the value of the of the <em class="parameter"><code>Active</code></em> parameter of a HIT type. You can specify changes to the
18
+ <em class="parameter"><code>Active</code></em> status without specifying a new notification
19
+ specification (the <em class="parameter"><code>Notification</code></em> parameter). </p><p> To change the <em class="parameter"><code>Active</code></em> status of a HIT type's notifications, the
20
+ HIT type must already have a notification specification, or one must be provided in the
21
+ same call to <code class="function">SetHITTypeNotification</code>. </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/note.png"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p> After you make the call to <code class="function">SetHITTypeNotification</code>, it can
22
+ take up to five minutes for changes to a HIT type's notification specification to
23
+ take effect. </p></td></tr></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e12462">Request Parameters</h2></div></div></div><p> The <code class="function">SetHITTypeNotification</code> operation accepts parameters common
24
+ to all operations. Some common parameters are required. See <a class="link" href="ApiReference_CommonParametersArticle.html" title="Chapter&nbsp;4.&nbsp;Common Parameters">Common Parameters</a> for more
25
+ information. </p><p> The following parameters are specific to the <code class="function">SetHITTypeNotification</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>
26
+ <p class="simpara">
27
+ <em class="parameter"><code>Operation</code></em>
28
+ </p>
29
+ </td><td>
30
+ <p class="simpara">The name of the operation</p>
31
+ <p class="simpara">Type: String</p>
32
+ <p class="simpara">Valid Values: SetHITTypeNotification</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>HITTypeId</code></em>
39
+ </p>
40
+ </td><td>
41
+ <p class="simpara"> The ID of the HIT type whose notification specification is
42
+ being updated, as returned by the <a class="link" href="ApiReference_RegisterHITTypeOperation.html" title="RegisterHITType">RegisterHITType</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>Notification</code></em>
50
+ </p>
51
+ </td><td>
52
+ <p class="simpara">The notification specification for the HIT type.</p>
53
+ <p class="simpara"> Type: a <a class="link" href="ApiReference_NotificationDataStructureArticle.html" title="Notification">Notification</a> data structure. </p>
54
+ <p class="simpara"> Default: None.</p>
55
+ <p class="simpara"> Constraint: You must specify either the <em class="parameter"><code>Notification</code></em> parameter or the <em class="parameter"><code>Active</code></em> parameter for the call to <code class="function">SetHITTypeNotification</code> to succeed. </p>
56
+ </td><td>
57
+ <p class="simpara">Yes</p>
58
+ </td></tr><tr><td>
59
+ <p class="simpara">
60
+ <em class="parameter"><code>Active</code></em>
61
+ </p>
62
+ </td><td>
63
+ <p class="simpara"> Specifies whether notifications are sent for HITs of this HIT
64
+ type, according to the notification specification. </p>
65
+ <p class="simpara">Type: Boolean</p>
66
+ <p class="simpara">Valid Values: true | false</p>
67
+ <p class="simpara">Default: None. If omitted, the active status of the HIT type's
68
+ notification specification is unchanged</p>
69
+ <p class="simpara"> Constraint: You must specify either the <em class="parameter"><code>Notification</code></em> parameter or the <em class="parameter"><code>Active</code></em> parameter for the call to <code class="function">SetHITTypeNotification</code> to succeed. </p>
70
+ </td><td>
71
+ <p class="simpara">No</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="d0e12628">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">SetHITTypeNotification</code> operation
73
+ returns with no errors. The response includes the elements described in the following
74
+ 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>
75
+ <p class="simpara">
76
+ <em class="parameter"><code>SetHITTypeNotificationResult</code></em>
77
+ </p>
78
+ </td><td>
79
+ <p class="simpara"> Contains a <em class="parameter"><code>Request</code></em> element if the
80
+ <strong class="userinput"><code>Request</code></strong>
81
+ <em class="parameter"><code>ResposeGroup</code></em> is specified. </p>
82
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e12670">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">SetHITTypeNotification</code>
83
+ operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e12678">Sample Request</h3></div></div></div><p> The following example sets the notification specification for a HIT type to send
84
+ the Requester an e-mail whenever a Worker submits an assignment for a HIT of the
85
+ specified type. </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
86
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
87
+ &amp;Operation=SetHITTypeNotification
88
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
89
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
90
+ &amp;HITTypeId=T100CN9P324W00EXAMPLE
91
+ &amp;Notification.1.Destination=requester-email@example.com
92
+ &amp;Notification.1.Transport=Email
93
+ &amp;Notification.1.Version=2006-05-05
94
+ &amp;Notification.1.EventType=AssignmentSubmitted
95
+ </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e12694">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;SetHITTypeNotificationResult&gt;
96
+ &lt;Request&gt;
97
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
98
+ &lt;/Request&gt;
99
+ &lt;/SetHITTypeNotificationResult&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_SetHITAsReviewingOperation.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_SetHITTypeNotificationOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_UnblockWorkerOperation.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>