rturk 2.0.2 → 2.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (122) hide show
  1. data/README.markdown +3 -2
  2. data/Rakefile +10 -4
  3. data/VERSION +1 -1
  4. data/aws_docs/ApiReference_AnswerKeyDataStructureArticle.html +98 -0
  5. data/aws_docs/ApiReference_ApproveAssignmentOperation.html +75 -0
  6. data/aws_docs/ApiReference_AssignQualificationOperation.html +107 -0
  7. data/aws_docs/ApiReference_AssignmentDataStructureArticle.html +171 -0
  8. data/aws_docs/ApiReference_BlockWorkerOperation.html +70 -0
  9. data/aws_docs/ApiReference_ChangeHITTypeOfHITOperation.html +68 -0
  10. data/aws_docs/ApiReference_CommonParametersArticle.html +119 -0
  11. data/aws_docs/ApiReference_CreateHITOperation.html +330 -0
  12. data/aws_docs/ApiReference_CreateQualificationTypeOperation.html +190 -0
  13. data/aws_docs/ApiReference_DataStructuresArticle.html +7 -0
  14. data/aws_docs/ApiReference_DisableHITOperation.html +63 -0
  15. data/aws_docs/ApiReference_DisposeHITOperation.html +56 -0
  16. data/aws_docs/ApiReference_DisposeQualificationTypeOperation.html +52 -0
  17. data/aws_docs/ApiReference_ExtendHITOperation.html +86 -0
  18. data/aws_docs/ApiReference_ExternalQuestionArticle.html +125 -0
  19. data/aws_docs/ApiReference_ForceExpireHITOperation.html +61 -0
  20. data/aws_docs/ApiReference_FormattedContentXHTMLArticle.html +289 -0
  21. data/aws_docs/ApiReference_GetAccountBalanceOperation.html +51 -0
  22. data/aws_docs/ApiReference_GetAssignmentsForHITOperation.html +166 -0
  23. data/aws_docs/ApiReference_GetBonusPaymentsOperation.html +160 -0
  24. data/aws_docs/ApiReference_GetFileUploadURLOperation.html +75 -0
  25. data/aws_docs/ApiReference_GetHITOperation.html +89 -0
  26. data/aws_docs/ApiReference_GetHITsForQualificationTypeOperation.html +137 -0
  27. data/aws_docs/ApiReference_GetQualificationRequestsOperation.html +155 -0
  28. data/aws_docs/ApiReference_GetQualificationScoreOperation.html +68 -0
  29. data/aws_docs/ApiReference_GetQualificationTypeOperation.html +57 -0
  30. data/aws_docs/ApiReference_GetQualificationsForQualificationTypeOperation.html +134 -0
  31. data/aws_docs/ApiReference_GetRequesterStatisticOperation.html +315 -0
  32. data/aws_docs/ApiReference_GetReviewableHITsOperation.html +155 -0
  33. data/aws_docs/ApiReference_GrantBonusOperation.html +95 -0
  34. data/aws_docs/ApiReference_GrantQualificationOperation.html +69 -0
  35. data/aws_docs/ApiReference_HITDataStructureArticle.html +302 -0
  36. data/aws_docs/ApiReference_HelpOperation.html +125 -0
  37. data/aws_docs/ApiReference_LocaleDataStructureArticle.html +29 -0
  38. data/aws_docs/ApiReference_NotificationAPI_BuildingANotificationReceptor.html +36 -0
  39. data/aws_docs/ApiReference_NotificationAPI_ElementsOfANotification.html +40 -0
  40. data/aws_docs/ApiReference_NotificationDataStructureArticle.html +73 -0
  41. data/aws_docs/ApiReference_NotificationReceptorAPIArticle.html +9 -0
  42. data/aws_docs/ApiReference_NotificationReceptorAPI_RESTTransportArticle.html +39 -0
  43. data/aws_docs/ApiReference_NotificationReceptorAPI_SOAPTransportArticle.html +45 -0
  44. data/aws_docs/ApiReference_NotifyWorkersOperation.html +82 -0
  45. data/aws_docs/ApiReference_OperationsArticle.html +8 -0
  46. data/aws_docs/ApiReference_PriceDataStructureArticle.html +65 -0
  47. data/aws_docs/ApiReference_QualificationDataStructureArticle.html +89 -0
  48. data/aws_docs/ApiReference_QualificationRequestDataStructureArticle.html +102 -0
  49. data/aws_docs/ApiReference_QualificationRequirementDataStructureArticle.html +176 -0
  50. data/aws_docs/ApiReference_QualificationTypeDataStructureArticle.html +198 -0
  51. data/aws_docs/ApiReference_QuestionAnswerDataArticle.html +8 -0
  52. data/aws_docs/ApiReference_QuestionFormAnswersDataStructureArticle.html +54 -0
  53. data/aws_docs/ApiReference_QuestionFormDataStructureArticle.html +796 -0
  54. data/aws_docs/ApiReference_RegisterHITTypeOperation.html +149 -0
  55. data/aws_docs/ApiReference_RejectAssignmentOperation.html +66 -0
  56. data/aws_docs/ApiReference_RejectQualificationRequestOperation.html +61 -0
  57. data/aws_docs/ApiReference_RevokeQualificationOperation.html +78 -0
  58. data/aws_docs/ApiReference_SearchHITsOperation.html +164 -0
  59. data/aws_docs/ApiReference_SearchQualificationTypesOperation.html +211 -0
  60. data/aws_docs/ApiReference_SendTestEventNotificationOperation.html +78 -0
  61. data/aws_docs/ApiReference_SetHITAsReviewingOperation.html +73 -0
  62. data/aws_docs/ApiReference_SetHITTypeNotificationOperation.html +99 -0
  63. data/aws_docs/ApiReference_UnblockWorkerOperation.html +67 -0
  64. data/aws_docs/ApiReference_UpdateQualificationScoreOperation.html +77 -0
  65. data/aws_docs/ApiReference_UpdateQualificationTypeOperation.html +180 -0
  66. data/aws_docs/ApiReference_WsdlLocationArticle.html +95 -0
  67. data/aws_docs/ApiReference_XMLParameterValuesArticle.html +37 -0
  68. data/aws_docs/Welcome.html +125 -0
  69. data/aws_docs/WhatsNew.html +16 -0
  70. data/aws_docs/_title.html +28 -0
  71. data/aws_docs/_toc.html +749 -0
  72. data/aws_docs/aws-docs-IE.css +419 -0
  73. data/aws_docs/aws-docs.css +455 -0
  74. data/aws_docs/copyrightinfo.html +14 -0
  75. data/aws_docs/frameset.js +12 -0
  76. data/aws_docs/images/Feedback_link.gif +0 -0
  77. data/aws_docs/images/caution.png +0 -0
  78. data/aws_docs/images/home.gif +0 -0
  79. data/aws_docs/images/important.png +0 -0
  80. data/aws_docs/images/next.gif +0 -0
  81. data/aws_docs/images/note.png +0 -0
  82. data/aws_docs/images/prev.gif +0 -0
  83. data/aws_docs/images/tip.png +0 -0
  84. data/aws_docs/images/title-swoosh-logo.gif +0 -0
  85. data/aws_docs/images/toc_bullet.gif +0 -0
  86. data/aws_docs/images/toc_plus.gif +0 -0
  87. data/aws_docs/index.html +18 -0
  88. data/aws_docs/toc.js +84 -0
  89. data/lib/rturk.rb +2 -2
  90. data/lib/rturk/adapter.rb +11 -0
  91. data/lib/rturk/adapters/assignment.rb +13 -50
  92. data/lib/rturk/adapters/hit.rb +21 -9
  93. data/lib/rturk/adapters/worker.rb +23 -0
  94. data/lib/rturk/operation.rb +1 -1
  95. data/lib/rturk/operations/create_hit.rb +10 -54
  96. data/lib/rturk/operations/register_hit_type.rb +68 -0
  97. data/lib/rturk/operations/search_hits.rb +44 -0
  98. data/lib/rturk/parser.rb +8 -0
  99. data/lib/rturk/parsers/answer_parser.rb +29 -0
  100. data/lib/rturk/parsers/assignment_parser.rb +49 -0
  101. data/lib/rturk/parsers/hit_parser.rb +50 -0
  102. data/lib/rturk/{response.rb → parsers/response.rb} +7 -2
  103. data/lib/rturk/{responses → parsers/responses}/create_hit_response.rb +2 -2
  104. data/lib/rturk/{responses → parsers/responses}/get_account_balance_response.rb +0 -0
  105. data/lib/rturk/{responses → parsers/responses}/get_assignments_for_hit_response.rb +3 -3
  106. data/lib/rturk/{responses → parsers/responses}/get_hit_response.rb +9 -16
  107. data/lib/rturk/{responses → parsers/responses}/get_reviewable_hits_response.rb +3 -5
  108. data/lib/rturk/parsers/responses/register_hit_type_response.rb +17 -0
  109. data/lib/rturk/parsers/responses/search_hits_response.rb +65 -0
  110. data/lib/rturk/xml_utilities.rb +14 -3
  111. data/rturk.gemspec +112 -12
  112. data/spec/adapters/hit_spec.rb +10 -0
  113. data/spec/fake_responses/register_hit_type.xml +6 -0
  114. data/spec/fake_responses/search_hits.xml +50 -0
  115. data/spec/operations/create_hit_spec.rb +2 -2
  116. data/spec/operations/get_hit_spec.rb +1 -1
  117. data/spec/operations/register_hit_type_spec.rb +24 -0
  118. data/spec/{adapters/answers_spec.rb → parsers/answer_parser_spec.rb} +2 -2
  119. data/spec/parsers/hit_parser_spec.rb +41 -0
  120. data/spec/xml_parse_spec.rb +2 -2
  121. metadata +111 -11
  122. data/lib/rturk/adapters/answers.rb +0 -38
data/aws_docs/ApiReference_HelpOperation.html ADDED
@@ -0,0 +1,125 @@
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>Help</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_GrantQualificationOperation.html" title="GrantQualification"><link rel="next" href="ApiReference_NotifyWorkersOperation.html" title="NotifyWorkers"><!--[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_GrantQualificationOperation.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_HelpOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_NotifyWorkersOperation.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>Help</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">Help</h1></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e9265">Description</h2></div></div></div><p> The <code class="function">Help</code> operation returns information about the Amazon
7
+ Mechanical Turk Service operations and response groups. You can use it to facilitate
8
+ development and documentation of your web site and tools. It is similar to the <code class="function">Help</code> operation found in other AWS web services. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e9276">Request Parameters</h2></div></div></div><p> The <code class="function">Help</code> operation accepts parameters common to all operations.
9
+ 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">Help</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"><em class="parameter"><code>Operation</code></em></p>
12
+ </td><td>
13
+ <p class="simpara">The name of the operation</p>
14
+ <p class="simpara">Type: String</p>
15
+ <p class="simpara">Valid Values: Help</p>
16
+ <p class="simpara">Default: None</p>
17
+ </td><td>
18
+ <p class="simpara">Yes</p>
19
+ </td></tr><tr><td>
20
+ <p class="simpara"><em class="parameter"><code>HelpType</code></em></p>
21
+ </td><td>
22
+ <p class="simpara"> Specifies whether you want help with an operation or with a
23
+ response group. </p>
24
+ <p class="simpara">Type: String</p>
25
+ <p class="simpara">Valid Values: Operation | ResponseGroup</p>
26
+ <p class="simpara">Default: None</p>
27
+ </td><td>
28
+ <p class="simpara">Yes</p>
29
+ </td></tr><tr><td>
30
+ <p class="simpara"><em class="parameter"><code>About</code></em></p>
31
+ </td><td>
32
+ <p class="simpara"> The name of the operation or response group for which to
33
+ return help. </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></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e9381">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">Help</code> operation has an <em class="parameter"><code>Information</code></em> element in the response. The <em class="parameter"><code>Information</code></em> element contains either an <em class="parameter"><code>OperationInformation</code></em> element or a <em class="parameter"><code>ResponseGroup</code></em>
39
+ element, depending on the <em class="parameter"><code>HelpType</code></em> requested. </p><p> The <em class="parameter"><code>OperationInformation</code></em> element contains the elements
40
+ 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>
41
+ <p class="simpara"><em class="parameter"><code>Name</code></em></p>
42
+ </td><td>
43
+ <p class="simpara">The name of the operation</p>
44
+ <p class="simpara">Type: String</p>
45
+ </td></tr><tr><td>
46
+ <p class="simpara"><em class="parameter"><code>Description</code></em></p>
47
+ </td><td>
48
+ <p class="simpara">A description of the operation result.</p>
49
+ <p class="simpara">Type: String</p>
50
+ </td></tr><tr><td>
51
+ <p class="simpara"><em class="parameter"><code>RequiredParameters</code></em></p>
52
+ </td><td>
53
+ <p class="simpara">A list of required parameters for the operation. </p>
54
+ <p class="simpara"> Type: a list of <em class="parameter"><code>Parameter</code></em> elements. The
55
+ <em class="parameter"><code>Parameter</code></em> element is a string. </p>
56
+ </td></tr><tr><td>
57
+ <p class="simpara"><em class="parameter"><code>AvailableParameters</code></em></p>
58
+ </td><td>
59
+ <p class="simpara">A list of optional parameters for the operation. </p>
60
+ <p class="simpara"> Type: a list of <em class="parameter"><code>Parameter</code></em> elements. The
61
+ <em class="parameter"><code>Parameter</code></em> element is a string. </p>
62
+ </td></tr><tr><td>
63
+ <p class="simpara">DefaultResponseGroups</p>
64
+ </td><td>
65
+ <p class="simpara">A list of default <em class="parameter"><code>ResponseGroup</code></em>s for the
66
+ operation. </p>
67
+ <p class="simpara"> Type: a list of <em class="parameter"><code>ResponseGroup</code></em> elements.
68
+ The <em class="parameter"><code>ResponseGroup</code></em> element is a string.
69
+ </p>
70
+ </td></tr><tr><td>
71
+ <p class="simpara">AvailableResponseGroups</p>
72
+ </td><td>
73
+ <p class="simpara">A list of optional <em class="parameter"><code>ResponseGroup</code></em>s for
74
+ the operation. </p>
75
+ <p class="simpara"> Type: a list of <em class="parameter"><code>ResponseGroup</code></em> elements.
76
+ The <em class="parameter"><code>ResponseGroup</code></em> element is a string.
77
+ </p>
78
+ </td></tr></tbody></table></div><p> The <em class="parameter"><code>ResponseGroupInformation</code></em> element contains the elements
79
+ 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>
80
+ <p class="simpara"><em class="parameter"><code>Name</code></em></p>
81
+ </td><td>
82
+ <p class="simpara">The name of the response group</p>
83
+ <p class="simpara">Type: String</p>
84
+ </td></tr><tr><td>
85
+ <p class="simpara"><em class="parameter"><code>CreationDate</code></em></p>
86
+ </td><td>
87
+ <p class="simpara">The date the response group was created</p>
88
+ <p class="simpara">Type: String</p>
89
+ </td></tr><tr><td>
90
+ <p class="simpara"><em class="parameter"><code>ValidOperations</code></em></p>
91
+ </td><td>
92
+ <p class="simpara">A list of the <em class="parameter"><code>Operation</code></em> elements that
93
+ return data for the response group.</p>
94
+ <p class="simpara"> Type: a list <em class="parameter"><code>Operation</code></em> elements. The
95
+ <em class="parameter"><code>Operation</code></em> element is a string. </p>
96
+ </td></tr><tr><td>
97
+ <p class="simpara"><em class="parameter"><code>Elements</code></em></p>
98
+ </td><td>
99
+ <p class="simpara">A list of the <em class="parameter"><code>Elements</code></em> elements for the
100
+ response group.</p>
101
+ <p class="simpara"> Type: a list <em class="parameter"><code>Elements</code></em> elements. The
102
+ <em class="parameter"><code>Elements</code></em> element is a string. </p>
103
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e9632">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">Help</code> operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e9640">Sample Request</h3></div></div></div><p>The following example of a <code class="function">Help</code> operation returns
104
+ information about the <code class="function">GetReviewableHITs</code> operation. </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
105
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
106
+ &amp;Version=2008-08-02
107
+ &amp;Operation=Help
108
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
109
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
110
+ &amp;HelpType=Operation
111
+ &amp;About=GetReviewableHITs
112
+ </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e9662">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;Information&gt;
113
+ &lt;Request&gt;
114
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
115
+ &lt;HelpRequest&gt;
116
+ &lt;Operation&gt;Help&lt;/Operation&gt;
117
+ &lt;/HelpRequest&gt;
118
+ &lt;/Request&gt;
119
+ &lt;OperationInformation&gt;
120
+ &lt;Name&gt;
121
+ Please see our online documentation at
122
+ http://developer.amazonwebservices.com/connect/kbcategory.jspa?categoryID=28
123
+ &lt;/Name&gt;
124
+ &lt;/OperationInformation&gt;
125
+ &lt;/Information&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_GrantQualificationOperation.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_HelpOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_NotifyWorkersOperation.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_LocaleDataStructureArticle.html ADDED
@@ -0,0 +1,29 @@
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>Locale</title><link rel="stylesheet" href="aws-docs-IE.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><link rel="home" href="#top" title="Amazon Mechanical Turk"><link rel="up" href="ApiReference_DataStructuresArticle.html" title="Chapter&nbsp;6.&nbsp;Data Structures"><link rel="prev" href="ApiReference_HITDataStructureArticle.html" title="HIT"><link rel="next" href="ApiReference_PriceDataStructureArticle.html" title="Price"><!--[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_HITDataStructureArticle.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_LocaleDataStructureArticle">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_PriceDataStructureArticle.html"><img src="images/next.gif" alt="Next"></a></td></tr></table><div class="breadcrumb"><a href="Welcome.html">Welcome</a><a href=""></a> &raquo; <a href="ApiReference_DataStructuresArticle.html">Data Structures</a> &raquo; <strong>Locale</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">Locale</h1></div></div></div><a class="indexterm" name="d0e14892"></a><a class="indexterm" name="d0e14895"></a><a class="indexterm" name="d0e14898"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e14903">Description</h2></div></div></div><p> The Locale data structure represents a geographical region or location. </p><p> The Locale data structure is used as part of the <a class="link" href="ApiReference_QualificationRequirementDataStructureArticle.html" title="QualificationRequirement">
7
+ QualificationRequirement</a> data structure when you specify a requirement based on the locale
8
+ Qualification, and as part of the <a class="link" href="ApiReference_QualificationDataStructureArticle.html" title="Qualification">Qualification</a> data structure that describes the value of a locale Qualification. </p><p> When used in a QualificationRequirement, the Locale data structure only needs to contain as
9
+ much of the locale as the Worker needs to match to meet the requirement. For example, a
10
+ requirement that the Worker be living anywhere in the United States would have only the
11
+ <em class="parameter"><code>Country</code></em> field. </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> Currently, a Locale data structure only supports the <em class="parameter"><code>Country</code></em> field.
12
+ </p></td></tr></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e14927">Elements</h2></div></div></div><p> The Locale structure can contain the elements described in the following table. When the
13
+ structure is used in a request, elements described as <span class="guilabel">Required</span> must be
14
+ included for the request to succeed. </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col><col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>
15
+ <p class="simpara">
16
+ <em class="parameter"><code>Country</code></em>
17
+ </p>
18
+ </td><td>
19
+ <p class="simpara">The country of the locale</p>
20
+ <p class="simpara"> Type: a <a class="ulink" href="http://www.iso.org/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html" target="_blank"> ISO 3166 country code</a>. For example, the code
21
+ <strong class="userinput"><code>US</code></strong> refers to the United States of America. </p>
22
+ <p class="simpara">Default: none</p>
23
+ </td><td>
24
+ <p class="simpara">Yes</p>
25
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e14980">Example</h2></div></div></div><p> The following code sample indicates a locale in the United States. </p><pre class="programlisting">
26
+ &lt;LocaleValue&gt;
27
+ &lt;Country&gt;US&lt;/Country&gt;
28
+ &lt;/LocaleValue&gt;
29
+ </pre></div></div><div class="navfooter"><table width="100%" summary="Navigation footer" cellspacing="0" cellpadding="2"><tr><td width="30%" align="left"><a accesskey="p" href="ApiReference_HITDataStructureArticle.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_LocaleDataStructureArticle">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_PriceDataStructureArticle.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_NotificationAPI_BuildingANotificationReceptor.html ADDED
@@ -0,0 +1,36 @@
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>Building A Notification Receptor</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_NotificationReceptorAPIArticle.html" title="Chapter&nbsp;8.&nbsp;The Notification Receptor API"><link rel="prev" href="ApiReference_NotificationReceptorAPIArticle.html" title="Chapter&nbsp;8.&nbsp;The Notification Receptor API"><link rel="next" href="ApiReference_NotificationAPI_ElementsOfANotification.html" title="Elements of a Notification Message"><!--[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_NotificationReceptorAPIArticle.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_NotificationAPI_BuildingANotificationReceptor">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_NotificationAPI_ElementsOfANotification.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_NotificationReceptorAPIArticle.html">The Notification Receptor API</a> &raquo; <strong>Building A
7
+ Notification Receptor</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">Building A
8
+ Notification Receptor</h1></div></div></div><p> You can tell Amazon Mechanical Turk to notify you whenever certain events occur that regard your HITs.
9
+ Amazon Mechanical Turk can notify you when a Worker accepts, abandons, returns, or submits an assignment,
10
+ when a HIT becomes "reviewable", or when a HIT expires, for any HIT of a given HIT type. To set up
11
+ notifications for a HIT type, you call the <code class="function">SetHITTypeNotification</code> operation with
12
+ a HIT type ID and a <a class="link" href="ApiReference_NotificationDataStructureArticle.html" title="Notification">notification
13
+ specification</a>. </p><p> Amazon Mechanical Turk can send a notification using one of several "transports". The simplest transport
14
+ is a human-readable e-mail message sent to an e-mail address that you specify in the notification
15
+ specification. </p><p> The other notification transports let Amazon Mechanical Turk contact your Requester application directly:
16
+ The REST transport sends an HTTP request to a URL you specify containing the notification data as
17
+ key-value pairs. The SOAP transport sends a SOAP web services request, an HTTP request with XML data
18
+ in SOAP-standard envelope, to an "end-point" (URL) that you specify. </p><p> To use the REST or SOAP transports, you will need to build an application that can accept HTTP
19
+ connections, and collect and process notification messages. This notification receptor application
20
+ will need to be operational any time a notification message might be sent in order to receive the
21
+ message. </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> Notification messages are only sent once. Notifications are not sent again, even if the HTTP
22
+ request returns with an error code or fails for any reason. Your application will need to tolerate
23
+ missing some notification messages. </p></td></tr></table></div><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> Only ports 80 and 443 are supported for receiving notification messages. </p></td></tr></table></div><p> This section describes the notification receptor API that your receptor will need to implement to
24
+ receive and understand notification messages. For code samples that illustrate how to build a
25
+ notification receptor, see <a class="ulink" href="http://developer.amazonwebservices.com/connect/kbcategory.jspa?categoryID=24" target="_blank">the Amazon Web
26
+ Services Resource Center</a>. </p><p> For more information about notifications, see
27
+ <a class="ulink" href="http://docs.amazonwebservices.com/AWSMechanicalTurkRequester/2008-08-02/index.html?Concepts_NotificationsArticle.html" target="_blank">Notifications</a>. For more information about creating, modifying or
28
+ disabling notification specifications on HIT types, see the
29
+ <code class="function">SetHITTypeNotification</code> operation. </p><p> See also the <code class="function">SendTestEventNotification</code> operation, and <a class="link" href="ApiReference_NotificationDataStructureArticle.html" title="Notification">Notification</a>. </p><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e20621">What a Notification Receptor Should Expect</h2></div></div></div><p> Your notification receptor will receive a notification message when a HIT event occurs that
30
+ matches an active notification specification for the HIT type of the HIT, and the specification
31
+ includes the receptor as the message destination. </p><p> A notification message may describe one or more events. If multiple events happen in a short
32
+ period of time, they may be batched into a single message. Your receptor should expect messages to
33
+ describe multiple events. </p><p> Your receptor should also expect to receive a "Ping" event at any time. "Ping" events are used
34
+ for diagnostic purposes, and do not correspond to any HIT activity. Amazon Mechanical Turk will send a
35
+ "Ping" notification when you call the <code class="function">SendTestEventNotification</code> operation,
36
+ and may also send "Ping" events to check the availability of your receptor at other times. </p></div></div><div class="navfooter"><table width="100%" summary="Navigation footer" cellspacing="0" cellpadding="2"><tr><td width="30%" align="left"><a accesskey="p" href="ApiReference_NotificationReceptorAPIArticle.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_NotificationAPI_BuildingANotificationReceptor">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_NotificationAPI_ElementsOfANotification.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_NotificationAPI_ElementsOfANotification.html ADDED
@@ -0,0 +1,40 @@
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>Elements of a Notification Message</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_NotificationReceptorAPIArticle.html" title="Chapter&nbsp;8.&nbsp;The Notification Receptor API"><link rel="prev" href="ApiReference_NotificationAPI_BuildingANotificationReceptor.html" title="Building A Notification Receptor"><link rel="next" href="ApiReference_NotificationReceptorAPI_RESTTransportArticle.html" title="The REST Transport"><!--[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_NotificationAPI_BuildingANotificationReceptor.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_NotificationAPI_ElementsOfANotification">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_NotificationReceptorAPI_RESTTransportArticle.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_NotificationReceptorAPIArticle.html">The Notification Receptor API</a> &raquo; <strong>Elements of a
7
+ Notification Message</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">Elements of a
8
+ Notification Message</h1></div></div></div><p> Notification messages sent with either the REST or SOAP transports contain the following elements: </p><div class="itemizedlist"><ul type="disc"><li><p> a <em class="parameter"><code>Signature</code></em> and <em class="parameter"><code>Timestamp</code></em> that verify the
9
+ notification message is coming from Amazon Mechanical Turk </p></li><li><p> the <em class="parameter"><code>Version</code></em> of the notification API used for the message </p></li><li><p> one or more <em class="parameter"><code>Event</code></em> data structures that describe recent activity for
10
+ HITs of a HIT type </p></li></ul></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e20660">How You Know Amazon Mechanical Turk Sent the Message</h2></div></div></div><p> Similar to how you include a <em class="parameter"><code>Signature</code></em> parameter with your requests to
11
+ the Amazon Mechanical Turk Requester service that proves it is you, and not somebody else, sending the
12
+ request, Amazon Mechanical Turk includes a <em class="parameter"><code>Signature</code></em> with each notification
13
+ message. The signature value is calculated in the same way: Amazon Mechanical Turk produces a string by
14
+ concatenating several values from the notification message, then calculates a Keyed-Hashing for
15
+ Message Authentication code (HMAC) with the SHA-1 hashing method using a key known only to your
16
+ application and Amazon Mechanical Turk: your AWS Secret Access Key. </p><p> To verify the signature in a notification message: </p><div class="orderedlist"><ol type="1"><li><p> Produce a string by concatenating the following values: </p><div class="itemizedlist"><ul type="disc"><li><p>the string "AWSMechanicalTurkRequesterNotification" (the "service" name)</p></li><li><p>the string "Notify" (the "operation" name)</p></li><li><p>the value of the <em class="parameter"><code>Timestamp</code></em> parameter included in the
17
+ notification message</p></li></ul></div></li><li><p> Calculate an RFC 2104-compliant HMAC, using your AWS Secret Access Key as the key. This
18
+ is the same method you use to sign your requests to Amazon Mechanical Turk, and could be
19
+ performed using similar code. </p></li><li><p> Base64 encode the HMAC value. (This is also similar to request signing.) </p></li><li><p> Compare the result to the <em class="parameter"><code>Signature</code></em> value included in the
20
+ notification message. A matching value indicates the notification message is genuine.
21
+ </p></li></ol></div><p> For more information about the method used to produce signature values, see MakingRequests_RequestAuthenticationArticle. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e20704">The Notification API Version</h2></div></div></div><p> Similar to how a REST request sent to the Amazon Mechanical Turk Requester service must include a
22
+ <em class="parameter"><code>Version</code></em> parameter to indicate which version of the service API the
23
+ client is expecting to use, a notification message also contains a <em class="parameter"><code>Version</code></em>
24
+ parameter. This version string will be identical to the version included in the notification
25
+ specification for the HIT type. </p><p> For notifications sent over the SOAP transport, the version will be in the message header as
26
+ part of the WSDL URL. See <a class="link" href="ApiReference_NotificationReceptorAPI_SOAPTransportArticle.html" title="The SOAP Transport">The SOAP Transport</a> for more
27
+ information. </p><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="images/tip.png"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p> Your application may need to accommodate receiving notification messages of different
28
+ versions at the same time if you want to upgrade your notification specifications to a new
29
+ version without missing messages. You can avoid having to accommodate multiple API versions by
30
+ first disabling the notification specifications that use the old version, upgrading your
31
+ application to use the new version, then updating the notification specifications to use the
32
+ new version and re-enable notifications. </p></td></tr></table></div><p> When a new version of the notification API is made available, all existing notification
33
+ specifications will continue to use the API versions they were using previously. You must update
34
+ your notification specifications to use a new version of the API. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e20724">Events</h2></div></div></div><a class="indexterm" name="d0e20727"></a><p> A notification message describes one or more events that happened in regards to a HIT type.
35
+ Each event includes: </p><div class="itemizedlist"><ul type="disc"><li><p>the event type (<em class="parameter"><code>EventType</code></em>), a value corresponding to the
36
+ <em class="parameter"><code>EventType</code></em> value in the <a class="link" href="ApiReference_NotificationDataStructureArticle.html" title="Notification">notification specification
37
+ data structure</a></p></li><li><p>the time of the event (<em class="parameter"><code>EventTime</code></em>), as a <a class="ulink" href="http://www.w3.org/TR/xmlschema-2/#dateTime" target="_blank">dateTime</a> in the Coordinated
38
+ Universal Time time zone, such as <strong class="userinput"><code>2005-01-31T23:59:59Z</code></strong></p></li><li><p>the HIT type ID for the event (<em class="parameter"><code>HITTypeId</code></em>)</p></li><li><p>the HIT ID for the event (<em class="parameter"><code>HITId</code></em>)</p></li><li><p>the assignment ID for the event, if applicable
39
+ (<em class="parameter"><code>AssignmentId</code></em>)</p></li></ul></div><p> Multiple events may be batched into a single notification message. </p><p> Amazon Mechanical Turk may send a "Ping" event to your notification receptor at any time. "Ping"
40
+ events are for diagnostic purposes, and do not correspond to HIT activity. </p></div></div><div class="navfooter"><table width="100%" summary="Navigation footer" cellspacing="0" cellpadding="2"><tr><td width="30%" align="left"><a accesskey="p" href="ApiReference_NotificationAPI_BuildingANotificationReceptor.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_NotificationAPI_ElementsOfANotification">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_NotificationReceptorAPI_RESTTransportArticle.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_NotificationDataStructureArticle.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>Notification</title><link rel="stylesheet" href="aws-docs-IE.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><link rel="home" href="#top" title="Amazon Mechanical Turk"><link rel="up" href="ApiReference_DataStructuresArticle.html" title="Chapter&nbsp;6.&nbsp;Data Structures"><link rel="prev" href="ApiReference_QualificationTypeDataStructureArticle.html" title="QualificationType"><link rel="next" href="ApiReference_QuestionAnswerDataArticle.html" title="Chapter&nbsp;7.&nbsp;Question and Answer Data"><!--[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_QualificationTypeDataStructureArticle.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_NotificationDataStructureArticle">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_QuestionAnswerDataArticle.html"><img src="images/next.gif" alt="Next"></a></td></tr></table><div class="breadcrumb"><a href="Welcome.html">Welcome</a><a href=""></a> &raquo; <a href="ApiReference_DataStructuresArticle.html">Data Structures</a> &raquo; <strong>Notification</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">Notification</h1></div></div></div><a class="indexterm" name="d0e16719"></a><a class="indexterm" name="d0e16722"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e16727">Description</h2></div></div></div><p> The Notification data structure describes a HIT event notification for a HIT type. </p><p> The Notification data structure is used as a parameter for the following operations: </p><div class="itemizedlist"><ul type="disc"><li><p>
7
+ <a class="link" href="ApiReference_SetHITTypeNotificationOperation.html" title="SetHITTypeNotification">SetHITTypeNotification</a>
8
+ </p></li><li><p>
9
+ <a class="link" href="ApiReference_SendTestEventNotificationOperation.html" title="SendTestEventNotification">SendTestEventNotification</a>
10
+ </p></li></ul></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e16747">Elements</h2></div></div></div><p> The Notification structure can contain the elements described in the following table. When the
11
+ structure is used in a request, elements described as <span class="guilabel">Required</span> must be
12
+ included for the request to succeed. </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col><col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>
13
+ <p class="simpara">
14
+ <em class="parameter"><code>Destination</code></em>
15
+ </p>
16
+ </td><td>
17
+ <p class="simpara"> The destination for notification messages. </p>
18
+ <p class="simpara"> Type: For e-mail notifications (if <em class="parameter"><code>Transport</code></em> is
19
+ <strong class="userinput"><code>Email</code></strong>), this is an e-mail address. For web service
20
+ notifications (if <em class="parameter"><code>Transport</code></em> is
21
+ <strong class="userinput"><code>SOAP</code></strong> or <strong class="userinput"><code>REST</code></strong>), this is the URL
22
+ end point for your application's notification receptor. </p>
23
+ <p class="simpara">Default: None</p>
24
+ </td><td>
25
+ <p class="simpara">Yes</p>
26
+ </td></tr><tr><td>
27
+ <p class="simpara">
28
+ <em class="parameter"><code>Transport</code></em>
29
+ </p>
30
+ </td><td>
31
+ <p class="simpara">The method Amazon Mechanical Turk uses to send the notification.</p>
32
+ <p class="simpara">Type: String</p>
33
+ <p class="simpara">Valid Values: Email | SOAP | REST</p>
34
+ <p class="simpara">Default: None</p>
35
+ </td><td>
36
+ <p class="simpara">Yes</p>
37
+ </td></tr><tr><td>
38
+ <p class="simpara">
39
+ <em class="parameter"><code>Version</code></em>
40
+ </p>
41
+ </td><td>
42
+ <p class="simpara"> The version of the notification WSDL/schema to use for SOAP or REST
43
+ notifications. </p>
44
+ <p class="simpara">Type: String</p>
45
+ <p class="simpara">Default: None</p>
46
+
47
+ </td><td>
48
+ <p class="simpara">Yes</p>
49
+ </td></tr><tr><td>
50
+ <p class="simpara">
51
+ <em class="parameter"><code>EventType</code></em>
52
+ </p>
53
+ </td><td>
54
+ <p class="simpara"> The events that should cause notifications to be sent. You can specify
55
+ multiple events by repeating this parameter </p>
56
+ <p class="simpara">Type: String</p>
57
+ <p class="simpara"> Valid Values: AssignmentAccepted | AssignmentAbandoned |
58
+ AssignmentReturned | AssignmentSubmitted | HITReviewable | HITExpired </p>
59
+ <p class="simpara">Default: None</p>
60
+ </td><td>
61
+ <p class="simpara">Yes</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="d0e16890">Example</h2></div></div></div><p> In the following example the notification specification says that when Worker returns or
63
+ abandons a HIT of the HIT type whose notifications specification this is), the web service
64
+ application at the given URL should be notified with a REST-style web service call, using the
65
+ <strong class="userinput"><code>2006-05-05</code></strong> version of the notification message schema. </p><pre class="programlisting">
66
+ &lt;Notification&gt;
67
+ &lt;Destination&gt;http://example.com:80/mt/notifications.cgi&lt;/Destination&gt;
68
+ &lt;Transport&gt;REST&lt;/Transport&gt;
69
+ &lt;Version&gt;2006-05-05&lt;/Version&gt;
70
+ &lt;EventType&gt;AssignmentAbandoned&lt;/EventType&gt;
71
+ &lt;EventType&gt;AssignmentReturned&lt;/EventType&gt;
72
+ &lt;/Notification&gt;
73
+ </pre></div></div><div class="navfooter"><table width="100%" summary="Navigation footer" cellspacing="0" cellpadding="2"><tr><td width="30%" align="left"><a accesskey="p" href="ApiReference_QualificationTypeDataStructureArticle.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_NotificationDataStructureArticle">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_QuestionAnswerDataArticle.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_NotificationReceptorAPIArticle.html ADDED
@@ -0,0 +1,9 @@
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;8.&nbsp;The Notification Receptor API</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_ExternalQuestionArticle.html" title="ExternalQuestion"><link rel="next" href="ApiReference_NotificationAPI_BuildingANotificationReceptor.html" title="Building A Notification Receptor"><!--[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_ExternalQuestionArticle.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_NotificationReceptorAPIArticle">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_NotificationAPI_BuildingANotificationReceptor.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>The Notification Receptor API</strong></div></div><div class="chapter" lang="en" id="ApiReference_NotificationReceptorAPIArticle"><div class="titlepage"><div><div><h1 class="topictitle">The Notification Receptor API</h1></div></div></div><a class="indexterm" name="d0e20557"></a><a class="indexterm" name="d0e20562"></a><a class="indexterm" name="d0e20565"></a><a class="indexterm" name="d0e20570"></a><div class="highlights"><p><strong>Topics</strong></p><ul><li><a href="ApiReference_NotificationAPI_BuildingANotificationReceptor.html">Building A
7
+ Notification Receptor</a></li><li><a href="ApiReference_NotificationAPI_ElementsOfANotification.html">Elements of a
8
+ Notification Message</a></li><li><a href="ApiReference_NotificationReceptorAPI_RESTTransportArticle.html">The REST Transport</a></li><li><a href="ApiReference_NotificationReceptorAPI_SOAPTransportArticle.html">The SOAP Transport</a></li></ul></div><p> This section describes the way Amazon Mechanical Turk sends notification messages to your application, if
9
+ you set up notifications for your HIT types using the REST or SOAP transports. </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_ExternalQuestionArticle.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_NotificationReceptorAPIArticle">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_NotificationAPI_BuildingANotificationReceptor.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_NotificationReceptorAPI_RESTTransportArticle.html ADDED
@@ -0,0 +1,39 @@
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>The REST Transport</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_NotificationReceptorAPIArticle.html" title="Chapter&nbsp;8.&nbsp;The Notification Receptor API"><link rel="prev" href="ApiReference_NotificationAPI_ElementsOfANotification.html" title="Elements of a Notification Message"><link rel="next" href="ApiReference_NotificationReceptorAPI_SOAPTransportArticle.html" title="The SOAP Transport"><!--[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_NotificationAPI_ElementsOfANotification.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_NotificationReceptorAPI_RESTTransportArticle">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_NotificationReceptorAPI_SOAPTransportArticle.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_NotificationReceptorAPIArticle.html">The Notification Receptor API</a> &raquo; <strong>The REST Transport</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">The REST Transport</h1></div></div></div><a class="indexterm" name="d0e20780"></a><p> The REST notification transport makes an HTTP connection to your notification receptor, and sends
7
+ the notification message using the HTTP GET method, as a set of key-value pairs. </p><p> The <em class="parameter"><code>Destination</code></em> that you specify in your <a class="link" href="ApiReference_NotificationDataStructureArticle.html" title="Notification">notification specification</a> is the
8
+ URL Amazon Mechanical Turk will use for the HTTP request. </p><p> The HTTP request will include key-value pairs for the values described in <a class="link" href="#">???</a>, such as
9
+ <em class="parameter"><code>Signature</code></em>, <em class="parameter"><code>Timestamp</code></em>, and
10
+ <em class="parameter"><code>Version</code></em>. </p><p> Each event is represented in the REST request by a set of keys for the event properties. Each
11
+ property name is prefixed with <em class="parameter"><code>Event</code></em>, a period, a number, and another period,
12
+ where the number is a counter incremented for each event in the notification message. For example, the
13
+ key <em class="parameter"><code>Event.1.EventTime</code></em> will have the <em class="parameter"><code>EventTime</code></em> value for
14
+ the first event described by the message. </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> Only ports 80 and 443 are supported for receiving REST notification messages. </p></td></tr></table></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e20822">Sample Message</h2></div></div></div><p> The following is an example notification message using the REST transport, as an HTTP GET
15
+ message (including headers). In this example, the destination is
16
+ <code class="code">http://example.com:80/mt/notifications.cgi</code>. The "GET" path containing all of the
17
+ notification parameters (from "GET" to "HTTP/1.1") would normally appear all on one line; the line
18
+ below has been split to make it easy to read. </p><pre class="programlisting">GET /mt/notifications.cgi?method=Notify
19
+ &amp;Signature=vH6ZbE0NhkF/hfNyxz2OgmzXYKs=
20
+ &amp;Timestamp=2006-05-23T23:22:30Z
21
+ &amp;Version=2006-05-05
22
+ &amp;Event.1.EventType=AssignmentAccepted
23
+ &amp;Event.1.EventTime=2006-04-21T18:55:23Z
24
+ &amp;Event.1.HITTypeId=KDSFO4455LKDAF3
25
+ &amp;Event.1.HITId=KDSFO4455LKDAF3
26
+ &amp;Event.1.AssignmentId=KDSFO4455LKDAF3KDSFO4455LKDAF3
27
+ &amp;Event.2.EventType=AssignmentReturned
28
+ &amp;Event.2.EventTime=2006-04-21T18:55:23Z
29
+ &amp;Event.2.HITTypeId=KDSFO4455LKDAF3
30
+ &amp;Event.2.HITId=KDSFO4455LKDAF3KDSFO4455LKDAF3
31
+ &amp;Event.2.AssignmentId=KDSFO4455LKDAF3KDSFO4455LKDAF3 HTTP/1.1
32
+ Content-Type: text/xml
33
+ Accept: application/soap+xml, application/dime, multipart/related, text/*
34
+ SOAPAction: http://soap.amazon.com
35
+ User-Agent: Jakarta Commons-HttpClient/2.0final
36
+ Host: example.com:80
37
+ </pre><p> This is similar to a request that would be caused by putting a URL in a web browser that began
38
+ with <code class="code">http://example.com:80/mt/notifications.cgi?method=Notify&amp;...</code> and
39
+ included all of the notification message parameters above. </p></div></div><div class="navfooter"><table width="100%" summary="Navigation footer" cellspacing="0" cellpadding="2"><tr><td width="30%" align="left"><a accesskey="p" href="ApiReference_NotificationAPI_ElementsOfANotification.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_NotificationReceptorAPI_RESTTransportArticle">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_NotificationReceptorAPI_SOAPTransportArticle.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_NotificationReceptorAPI_SOAPTransportArticle.html ADDED
@@ -0,0 +1,45 @@
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>The SOAP Transport</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_NotificationReceptorAPIArticle.html" title="Chapter&nbsp;8.&nbsp;The Notification Receptor API"><link rel="prev" href="ApiReference_NotificationReceptorAPI_RESTTransportArticle.html" title="The REST Transport"><!--[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_NotificationReceptorAPI_RESTTransportArticle.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_NotificationReceptorAPI_SOAPTransportArticle">Documentation Feedback</a></td><td width="30%" align="right"> </td></tr></table><div class="breadcrumb"><a href="Welcome.html">Welcome</a><a href=""></a> &raquo; <a href="ApiReference_NotificationReceptorAPIArticle.html">The Notification Receptor API</a> &raquo; <strong>The SOAP Transport</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">The SOAP Transport</h1></div></div></div><a class="indexterm" name="d0e20840"></a><p> The SOAP notification transport makes an HTTP connection to your notification receptor, and sends
7
+ the notification message according to the SOAP web services standard. </p><p> The <em class="parameter"><code>Destination</code></em> that you specify in your <a class="link" href="ApiReference_NotificationDataStructureArticle.html" title="Notification">notification specification</a> is the
8
+ "end point" (URL) Amazon Mechanical Turk will use for the SOAP request. In other words, this is the URL of
9
+ your web service. </p><p> The SOAP API Amazon Mechanical Turk expects to use for notification messages is described by the
10
+ notification WSDL, which is located at: </p><p>
11
+ <a class="ulink" href="http://mechanicalturk.amazonaws.com/AWSMechanicalTurk/2006-05-05/AWSMechanicalTurkRequesterNotification.wsdl" target="_blank">http://mechanicalturk.amazonaws.com/AWSMechanicalTurk/2006-05-05/AWSMechanicalTurkRequesterNotification.wsdl</a>
12
+ </p><p> Amazon Mechanical Turk calls the <em class="parameter"><code>Notify</code></em> operation of this WSDL, using the end point
13
+ you specified in the notification specification. </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> Only ports 80 and 443 are supported for receiving SOAP notification messages. </p></td></tr></table></div><p> Parameters to the <em class="parameter"><code>Notify</code></em> operation call correspond to the parameters
14
+ described in <a class="link" href="#">???</a>, such as
15
+ <em class="parameter"><code>Signature</code></em>, <em class="parameter"><code>Timestamp</code></em>, and
16
+ <em class="parameter"><code>Version</code></em>. Each event is represented in the SOAP request by a
17
+ <em class="parameter"><code>Event</code></em> element, with sub-elements for each property of an event (such as
18
+ <em class="parameter"><code>EventTime</code></em>). </p><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e20892">Sample Message</h2></div></div></div><p> The following is an example notification message using the SOAP transport, including the SOAP
19
+ wrapper. </p><pre class="programlisting">&lt;?xml version="1.0" encoding="UTF-8"?&gt;
20
+ &lt;soapenv:Envelope
21
+ xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
22
+ xmlns:xsd="http://www.w3.org/2001/XMLSchema"
23
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"&gt;
24
+ &lt;soapenv:Body&gt;
25
+ &lt;Notify xmlns="http://requester.mturk.amazonaws.com/doc/2006-05-05"&gt;
26
+ &lt;Signature&gt;<em class="replaceable"><code>[signature generated from your secret key]</code></em>&lt;/Signature&gt;
27
+ &lt;Timestamp xsi:type="xsd:dateTime"&gt;2006-05-23T23:22:30Z&lt;/Timestamp&gt;
28
+ &lt;Version&gt;2006-05-05&lt;/Version&gt;
29
+ &lt;Event&gt;
30
+ &lt;EventType&gt;AssignmentAccepted&lt;/EventType&gt;
31
+ &lt;EventTime&gt;2006-04-21T18:55:23Z&lt;/EventTime&gt;
32
+ &lt;HITTypeId&gt;KDSFO4455LKDAF3&lt;/HITTypeId&gt;
33
+ &lt;HITId&gt;KDSFO4455LKDAF3&lt;/HITId&gt;
34
+ &lt;AssignmentId&gt;KDSFO4455LKDAF3KDSFO4455LKDAF3&lt;/AssignmentId&gt;
35
+ &lt;/Event&gt;
36
+ &lt;Event&gt;
37
+ &lt;EventType&gt;AssignmentReturned&lt;/EventType&gt;
38
+ &lt;EventTime&gt;2006-04-21T18:55:23Z&lt;/EventTime&gt;
39
+ &lt;HITTypeId&gt;KDSFO4455LKDAF3&lt;/HITTypeId&gt;
40
+ &lt;HITId&gt;KDSFO4455LKDAF3KDSFO4455LKDAF3&lt;/HITId&gt;
41
+ &lt;AssignmentId&gt;KDSFO4455LKDAF3KDSFO4455LKDAF3&lt;/AssignmentId&gt;
42
+ &lt;/Event&gt;
43
+ &lt;/Notify&gt;
44
+ &lt;/soapenv:Body&gt;
45
+ &lt;/soapenv:Envelope&gt;</pre></div></div><div class="navfooter"><table width="100%" summary="Navigation footer" cellspacing="0" cellpadding="2"><tr><td width="30%" align="left"><a accesskey="p" href="ApiReference_NotificationReceptorAPI_RESTTransportArticle.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_NotificationReceptorAPI_SOAPTransportArticle">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> </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_NotifyWorkersOperation.html ADDED
@@ -0,0 +1,82 @@
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>NotifyWorkers</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_HelpOperation.html" title="Help"><link rel="next" href="ApiReference_RegisterHITTypeOperation.html" title="RegisterHITType"><!--[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_HelpOperation.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_NotifyWorkersOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_RegisterHITTypeOperation.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>NotifyWorkers</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">NotifyWorkers</h1></div></div></div><a class="indexterm" name="d0e9673"></a><a class="indexterm" name="d0e9676"></a><a class="indexterm" name="d0e9681"></a><a class="indexterm" name="d0e9686"></a><a class="indexterm" name="d0e9691"></a><a class="indexterm" name="d0e9694"></a><a class="indexterm" name="d0e9697"></a><a class="indexterm" name="d0e9702"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e9707">Description</h2></div></div></div><p> The <code class="function">NotifyWorkers</code> operation sends an e-mail to one or more
7
+ Workers that you specify with the Worker ID. </p><p> You can specifiy up to 100 Worker IDs to send the same message with a single call to
8
+ the <code class="function">NotifyWorkers</code> operation. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e9720">Request Parameters</h2></div></div></div><p> The <code class="function">NotifyWorkers</code> operation 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">NotifyWorkers</code>
11
+ 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>
12
+ <p class="simpara">
13
+ <em class="parameter"><code>Operation</code></em>
14
+ </p>
15
+ </td><td>
16
+ <p class="simpara">The name of the operation</p>
17
+ <p class="simpara">Type: String</p>
18
+ <p class="simpara">Valid Values: NotifyWorkers</p>
19
+ <p class="simpara">Default: None</p>
20
+ </td><td>
21
+ <p class="simpara">Yes</p>
22
+ </td></tr><tr><td>
23
+ <p class="simpara">
24
+ <em class="parameter"><code>Subject</code></em>
25
+ </p>
26
+ </td><td>
27
+ <p class="simpara">The subject line of the e-mail message to send.</p>
28
+ <p class="simpara">Type: String</p>
29
+ <p class="simpara">Default: None</p>
30
+ <p class="simpara">Constraints: can include upto 200 characters.</p>
31
+ </td><td>
32
+ <p class="simpara">Yes</p>
33
+ </td></tr><tr><td>
34
+ <p class="simpara">
35
+ <em class="parameter"><code>MessageText</code></em>
36
+ </p>
37
+ </td><td>
38
+ <p class="simpara">The text of the e-mail message to send</p>
39
+ <p class="simpara">Type: String</p>
40
+ <p class="simpara">Default: None</p>
41
+ <p class="simpara">Constraints: can include up to 4,096 characters</p>
42
+ </td><td>
43
+ <p class="simpara">Yes</p>
44
+ </td></tr><tr><td>
45
+ <p class="simpara">
46
+ <em class="parameter"><code>WorkerId</code></em>
47
+ </p>
48
+ </td><td>
49
+ <p class="simpara"> The ID of the Worker to notify, as returned by the <a class="link" href="ApiReference_GetAssignmentsForHITOperation.html" title="GetAssignmentsForHIT">
50
+ GetAssignmentsForHIT</a> operation. </p>
51
+ <p class="simpara">Type: String</p>
52
+ <p class="simpara">Default: None</p>
53
+ <p class="simpara">Constraints: You can repeat this parameter up to 100 times to
54
+ notify multiple Workers.</p>
55
+ </td><td>
56
+ <p class="simpara">Yes</p>
57
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e9865">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">NotifyWorkers</code> operation returns
58
+ with no errors. The response includes the elements described in the following table. The
59
+ 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>
60
+ <p class="simpara">
61
+ <em class="parameter"><code>NotifyWorkersResult</code></em>
62
+ </p>
63
+ </td><td>
64
+ <p class="simpara"> Contains a <em class="parameter"><code>Request</code></em> element if the
65
+ <strong class="userinput"><code>Request</code></strong>
66
+ <em class="parameter"><code>ResposeGroup</code></em> is specified. </p>
67
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e9907">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">GetHITsForQualificationType</code> operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e9915">Sample Request</h3></div></div></div><p>The following example sends an e-mail message to three Workers.</p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
68
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
69
+ &amp;Version=2008-08-02
70
+ &amp;Operation=NotifyWorkers
71
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
72
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
73
+ &amp;Subject=Thank%20you
74
+ &amp;MessageText=Hello!%20Just%20wanted%20to%20say%20thank%20you...
75
+ &amp;WorkerId.1=AZ3123EXAMPLE
76
+ &amp;WorkerId.2=AZ3456EXAMPLE
77
+ &amp;WorkerId.3=AZ3789EXAMPLE
78
+ </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e9931">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;NotifyWorkersResult&gt;
79
+ &lt;Request&gt;
80
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
81
+ &lt;/Request&gt;
82
+ &lt;/NotifyWorkersResult&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_HelpOperation.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_NotifyWorkersOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_RegisterHITTypeOperation.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>