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_RegisterHITTypeOperation.html ADDED
@@ -0,0 +1,149 @@
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>RegisterHITType</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_NotifyWorkersOperation.html" title="NotifyWorkers"><link rel="next" href="ApiReference_RejectAssignmentOperation.html" title="RejectAssignment"><!--[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_NotifyWorkersOperation.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_RegisterHITTypeOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_RejectAssignmentOperation.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>RegisterHITType</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">RegisterHITType</h1></div></div></div><a class="indexterm" name="d0e9942"></a><a class="indexterm" name="d0e9945"></a><a class="indexterm" name="d0e9952"></a><a class="indexterm" name="d0e9957"></a><a class="indexterm" name="d0e9962"></a><a class="indexterm" name="d0e9967"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e9972">Description</h2></div></div></div><p> The <code class="function">RegisterHITType</code> operation creates a new HIT type. </p><p> The <code class="function">RegisterHITType</code> operation lets you be explicit about which
7
+ HITs ought to be the same type. It also gives you error checking, to ensure that you
8
+ call the <a class="link" href="ApiReference_CreateHITOperation.html" title="CreateHIT">CreateHIT</a> operation with
9
+ a valid HIT type ID. </p><p> If you register a HIT type with values that match an existing HIT type, the HIT type
10
+ ID of the existing type will be returned. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e9990">Request Parameters</h2></div></div></div><p> The <code class="function">RegisterHITType</code> operation accepts parameters common to all
11
+ operations. Some common parameters are required. See <a class="link" href="ApiReference_CommonParametersArticle.html" title="Chapter&nbsp;4.&nbsp;Common Parameters">Common Parameters</a> for more
12
+ information. </p><p> The following parameters are specific to the <code class="function">RegisterHITType</code>
13
+ 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: RegisterHITType</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>Title</code></em>
27
+ </p>
28
+ </td><td>
29
+ <p class="simpara">The title for HITs of this type.</p>
30
+ <p class="simpara"> A <em class="parameter"><code>Title</code></em> parameter should be short and
31
+ descriptive about the kind of task the HIT contains. On the Amazon
32
+ Mechanical Turk web site, the HIT title appears in search results,
33
+ and everywhere the HIT is mentioned. </p>
34
+ <p class="simpara">Type: String</p>
35
+ <p class="simpara">Default: None</p>
36
+ <p class="simpara">Constraints: can be up to 128 characters in length</p>
37
+ </td><td>
38
+ <p class="simpara">Yes</p>
39
+ </td></tr><tr><td>
40
+ <p class="simpara">
41
+ <em class="parameter"><code>Description</code></em>
42
+ </p>
43
+ </td><td>
44
+ <p class="simpara">A general description of HITs of this type</p>
45
+ <p class="simpara"> A <em class="parameter"><code>Description</code></em> includes detailed
46
+ information about the kind of task the HIT contains. On the Amazon
47
+ Mechanical Turk web site, the HIT description appears in the
48
+ expanded view of search results, and in the HIT and assignment
49
+ screens. A good description gives the user enough information to
50
+ evaluate the HIT before accepting it. It should not include
51
+ instructions for completing the HIT. </p>
52
+ <p class="simpara">Type: String</p>
53
+ <p class="simpara">Default: None</p>
54
+ <p class="simpara">Constraints: must be less than 2,000 characters in
55
+ length</p>
56
+ </td><td>
57
+ <p class="simpara">Yes</p>
58
+ </td></tr><tr><td>
59
+ <p class="simpara">
60
+ <em class="parameter"><code>Reward</code></em>
61
+ </p>
62
+ </td><td>
63
+ <p class="simpara"> The amount of money the Requester will pay a user for
64
+ successfully completing a HIT of this type. </p>
65
+ <p class="simpara">Type: a <a class="link" href="ApiReference_PriceDataStructureArticle.html" title="Price">Price</a> data structure</p>
66
+ <p class="simpara">Default: None</p>
67
+ </td><td>
68
+ <p class="simpara">Yes</p>
69
+ </td></tr><tr><td>
70
+ <p class="simpara">
71
+ <em class="parameter"><code>AssignmentDurationInSeconds</code></em>
72
+ </p>
73
+ </td><td>
74
+ <p class="simpara"> The amount of time a Worker has to complete a HIT of this type
75
+ after accepting it. </p>
76
+ <p class="simpara">Type: positive integer</p>
77
+ <p class="simpara">Default: None</p>
78
+ <p class="simpara">Constraints: any integer between 30 (30 seconds) and 3153600
79
+ (365 days)</p>
80
+ </td><td>
81
+ <p class="simpara">Yes</p>
82
+ </td></tr><tr><td>
83
+ <p class="simpara">
84
+ <em class="parameter"><code>Keywords</code></em>
85
+ </p>
86
+ </td><td>
87
+ <p class="simpara"> One or more words or phrases that describe a HIT of this type,
88
+ separated by commas. Searches for words similar to the keywords are
89
+ more likely to return the HIT in the search results. </p>
90
+ <p class="simpara">Type: String</p>
91
+ <p class="simpara">Default: None</p>
92
+ <p class="simpara"> Constraints: The complete string, including commas and spaces,
93
+ must be fewer than 1,000 characters. </p>
94
+ </td><td>
95
+ <p class="simpara">No</p>
96
+ </td></tr><tr><td>
97
+ <p class="simpara">
98
+ <em class="parameter"><code>AutoApprovalDelayInSeconds</code></em>
99
+ </p>
100
+ </td><td>
101
+ <p class="simpara"> An amount of time, in seconds, after an assignment for a HIT
102
+ of this type has been submitted, that the assignment becomes
103
+ <span class="guilabel">Approved</span> automatically, unless the
104
+ Requester explicitly rejects it. </p>
105
+ <p class="simpara">Type: positive integer</p>
106
+ <p class="simpara">Default: 2592000 (30 days)</p>
107
+ <p class="simpara">Constraints: must be between 0 (immediate) and 2592000 (30
108
+ days).</p>
109
+ </td><td>
110
+ <p class="simpara">No</p>
111
+ </td></tr><tr><td>
112
+ <p class="simpara">
113
+ <em class="parameter"><code>QualificationRequirement</code></em>
114
+ </p>
115
+ </td><td>
116
+ <p class="simpara"> A condition that a Worker's Qualifications must meet before
117
+ the Worker is allowed to accept and complete a HIT of this type. </p>
118
+ <p class="simpara"> Type: a <a class="link" href="ApiReference_QualificationRequirementDataStructureArticle.html" title="QualificationRequirement"> QualificationRequirement</a> data structure. </p>
119
+ <p class="simpara">Default: None</p>
120
+ </td><td>
121
+ <p class="simpara">No</p>
122
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e10259">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">RegisterHITType</code> operation has a
123
+ <em class="parameter"><code>RegisterHITTypeResult</code></em> element in the response. </p><p> The <em class="parameter"><code>RegisterHITTypeResult</code></em> element contains the following
124
+ elements: </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>
125
+ <p class="simpara">
126
+ <em class="parameter"><code>HITTypeId</code></em>
127
+ </p>
128
+ </td><td>
129
+ <p class="simpara">The ID of the newly registered HIT type</p>
130
+ <p class="simpara">Type: String</p>
131
+ <p class="simpara">Default: None</p>
132
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e10306">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="d0e10314">Sample Request</h3></div></div></div><p> The following example registers a new HIT type. </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
133
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
134
+ &amp;Version=2008-08-02
135
+ &amp;Operation=RegisterHITType
136
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
137
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
138
+ &amp;Title=Location%20and%20Photograph%20Identification
139
+ &amp;Description=Select%20the%20image%20that%20best%20represents...
140
+ &amp;Reward.1.Amount=5
141
+ &amp;Reward.1.CurrencyCode=USD
142
+ &amp;AssignmentDurationInSeconds=30
143
+ &amp;Keywords=location,%20photograph,%20image,%20identification,%20opinion
144
+ </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e10330">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;RegisterHITTypeResult&gt;
145
+ &lt;Request&gt;
146
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
147
+ &lt;/Request&gt;
148
+ &lt;HITTypeId&gt;KZ3GKTRXBWGYX8WXBW60&lt;/HITTypeId&gt;
149
+ &lt;/RegisterHITTypeResult&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_NotifyWorkersOperation.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_RegisterHITTypeOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_RejectAssignmentOperation.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_RejectAssignmentOperation.html ADDED
@@ -0,0 +1,66 @@
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>RejectAssignment</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_RegisterHITTypeOperation.html" title="RegisterHITType"><link rel="next" href="ApiReference_RejectQualificationRequestOperation.html" title="RejectQualificationRequest"><!--[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_RegisterHITTypeOperation.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_RejectAssignmentOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_RejectQualificationRequestOperation.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>RejectAssignment</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">RejectAssignment</h1></div></div></div><a class="indexterm" name="d0e10341"></a><a class="indexterm" name="d0e10344"></a><a class="indexterm" name="d0e10349"></a><a class="indexterm" name="d0e10354"></a><a class="indexterm" name="d0e10359"></a><a class="indexterm" name="d0e10364"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e10369">Description</h2></div></div></div><p> The <code class="function">RejectAssignment</code> operation rejects the results of a completed
7
+ assignment. </p><p> You can include an optional feedback message with the rejection, which the Worker can see in
8
+ the <span class="guilabel">Status</span> section of the web site. When you include a feedback message with
9
+ the rejection, it helps the Worker understand why the assignment was rejected, and can improve the
10
+ quality of the results the Worker submits in the future. </p><p>Only the Requester who created the HIT can reject an assignment for the HIT. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e10384">Request Parameters</h2></div></div></div><p> The <code class="function">RejectAssignment</code> operation accepts parameters common to all
11
+ operations. Some common parameters are required. See <a class="link" href="ApiReference_CommonParametersArticle.html" title="Chapter&nbsp;4.&nbsp;Common Parameters">Common Parameters</a> for more information. </p><p> The following parameters are specific to the <code class="function">RejectAssignment</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>
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: RejectAssignment</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>AssignmentId</code></em>
25
+ </p>
26
+ </td><td>
27
+ <p class="simpara">The assignment ID</p>
28
+ <p class="simpara">Type: String</p>
29
+ <p class="simpara">Default: None</p>
30
+ </td><td>
31
+ <p class="simpara">Yes</p>
32
+ </td></tr><tr><td>
33
+ <p class="simpara">
34
+ <em class="parameter"><code>RequesterFeedback</code></em>
35
+ </p>
36
+ </td><td>
37
+ <p class="simpara"> A message for the Worker, which the Worker can see in the
38
+ <span class="guilabel">Status</span> section of the web site. </p>
39
+ <p class="simpara">Type: String</p>
40
+ <p class="simpara">Default: None</p>
41
+ <p class="simpara">Constraints: can be up to 1024 characters, including multi-byte
42
+ characters.</p>
43
+ </td><td>
44
+ <p class="simpara">No</p>
45
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e10498">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">RejectAssignment</code> operation returns with no
46
+ errors. The response includes the elements described in the following table. The operation returns
47
+ no other data. </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>
48
+ <p class="simpara">
49
+ <em class="parameter"><code>RejectAssignmentResult</code></em>
50
+ </p>
51
+ </td><td>
52
+ <p class="simpara"> Contains a <em class="parameter"><code>Request</code></em> element if the
53
+ <strong class="userinput"><code>Request</code></strong>
54
+ <em class="parameter"><code>ResposeGroup</code></em> is specified. </p>
55
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e10540">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">RejectAssignment</code> operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e10548">Sample Request</h3></div></div></div><p>The following example rejects an assignment identified by its assignment ID.</p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
56
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
57
+ &amp;Version=2008-08-02
58
+ &amp;Operation=RejectAssignment
59
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
60
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
61
+ &amp;AssignmentId=123RVWYBAZW00EXAMPLE456RVWYBAZW00EXAMPLE
62
+ </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e10564">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;RejectAssignmentResult&gt;
63
+ &lt;Request&gt;
64
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
65
+ &lt;/Request&gt;
66
+ &lt;/RejectAssignmentResult&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_RegisterHITTypeOperation.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_RejectAssignmentOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_RejectQualificationRequestOperation.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_RejectQualificationRequestOperation.html ADDED
@@ -0,0 +1,61 @@
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>RejectQualificationRequest</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_RejectAssignmentOperation.html" title="RejectAssignment"><link rel="next" href="ApiReference_RevokeQualificationOperation.html" title="RevokeQualification"><!--[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_RejectAssignmentOperation.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_RejectQualificationRequestOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_RevokeQualificationOperation.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>RejectQualificationRequest</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">RejectQualificationRequest</h1></div></div></div><a class="indexterm" name="d0e10575"></a><a class="indexterm" name="d0e10578"></a><a class="indexterm" name="d0e10585"></a><a class="indexterm" name="d0e10590"></a><a class="indexterm" name="d0e10595"></a><a class="indexterm" name="d0e10600"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e10605">Description</h2></div></div></div><p> The <code class="function">RejectQualificationRequest</code> operation rejects a user's
7
+ request for a Qualification. </p><p> You can provide a text message explaining why the request was rejected. The Worker
8
+ who made the request can see this message. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e10615">Request Parameters</h2></div></div></div><p> Tje <code class="function">RejectQualificationRequest</code> operation accepts parameters
9
+ 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 information. </p><p> The following parameters are specific to the <code class="function">RejectQualificationRequest</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>
10
+ <p class="simpara">
11
+ <em class="parameter"><code>Operation</code></em>
12
+ </p>
13
+ </td><td>
14
+ <p class="simpara">The name of the operation</p>
15
+ <p class="simpara">Type: String</p>
16
+ <p class="simpara">Valid Values: RejectQualificationRequest</p>
17
+ <p class="simpara">Default: None</p>
18
+ </td><td>
19
+ <p class="simpara">Yes</p>
20
+ </td></tr><tr><td>
21
+ <p class="simpara">
22
+ <em class="parameter"><code>QualificationRequestId</code></em>
23
+ </p>
24
+ </td><td>
25
+ <p class="simpara"> The ID of the Qualification request to reject, as returned
26
+ from a call to the <a class="link" href="ApiReference_GetQualificationRequestsOperation.html" title="GetQualificationRequests">GetQualificationRequest</a> operation. </p>
27
+ <p class="simpara">Type: String</p>
28
+ <p class="simpara">Default: None</p>
29
+ </td><td>
30
+ <p class="simpara">Yes</p>
31
+ </td></tr><tr><td>
32
+ <p class="simpara">
33
+ <em class="parameter"><code>Reason</code></em>
34
+ </p>
35
+ </td><td>
36
+ <p class="simpara"> A text message explaining why the request was rejected, to be
37
+ shown to the Worker who made the request. </p>
38
+ </td><td>
39
+ <p class="simpara">No</p>
40
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e10719">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">RejectQualificationRequest</code>
41
+ operation returns with no errors. The response includes the elements described in the
42
+ following 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>
43
+ <p class="simpara">
44
+ <em class="parameter"><code>RejectQualificationRequestResult</code></em>
45
+ </p>
46
+ </td><td>
47
+ <p class="simpara"> Contains a <em class="parameter"><code>Request</code></em> element if the
48
+ <strong class="userinput"><code>Request</code></strong>
49
+ <em class="parameter"><code>ResposeGroup</code></em> is specified. </p>
50
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e10761">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">RejectQualificationRequestType</code> operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e10769">Sample Request</h3></div></div></div><p> The following example rejects a specified Qualification request. </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
51
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
52
+ &amp;Version=2008-08-02
53
+ &amp;Operation=RejectQualificationRequest
54
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
55
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
56
+ &amp;QualificationRequestId=789RVWYBAZW00EXAMPLE951RVWYBAZW00EXAMPLE
57
+ </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e10785">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;RejectQualificationRequestResult&gt;
58
+ &lt;Request&gt;
59
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
60
+ &lt;/Request&gt;
61
+ &lt;/RejectQualificationRequestResult&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_RejectAssignmentOperation.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_RejectQualificationRequestOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_RevokeQualificationOperation.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_RevokeQualificationOperation.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>RevokeQualification</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_RejectQualificationRequestOperation.html" title="RejectQualificationRequest"><link rel="next" href="ApiReference_SearchHITsOperation.html" title="SearchHITs"><!--[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_RejectQualificationRequestOperation.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_RevokeQualificationOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_SearchHITsOperation.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>RevokeQualification</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">RevokeQualification</h1></div></div></div><a class="indexterm" name="d0e10796"></a><a class="indexterm" name="d0e10799"></a><a class="indexterm" name="d0e10804"></a><a class="indexterm" name="d0e10807"></a><a class="indexterm" name="d0e10812"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e10817">Description</h2></div></div></div><p> The <code class="function">RevokeQualification</code> operation revokes a previously granted
7
+ Qualification from a user. </p><p> You can provide a text message explaining why the Qualification was revoked. The user
8
+ who had the Qualification can see this message. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e10827">Request Parameters</h2></div></div></div><p> The <code class="function">RevokeQualification</code> operation accepts parameters common to
9
+ all operations. Some common parameters are required. See <a class="link" href="ApiReference_CommonParametersArticle.html" title="Chapter&nbsp;4.&nbsp;Common Parameters">Common Parameters</a> for more information. </p><p> The following parameters are specific to the <code class="function">RevokeQualification</code>
10
+ operation: </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col><col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>
11
+ <p class="simpara">
12
+ <em class="parameter"><code>Operation</code></em>
13
+ </p>
14
+ </td><td>
15
+ <p class="simpara">The name of the operation</p>
16
+ <p class="simpara">Type: String</p>
17
+ <p class="simpara">Valid Values: RevokeQualification</p>
18
+ <p class="simpara">Default: None</p>
19
+ </td><td>
20
+ <p class="simpara">Yes</p>
21
+ </td></tr><tr><td>
22
+ <p class="simpara">
23
+ <em class="parameter"><code>SubjectId</code></em>
24
+ </p>
25
+ </td><td>
26
+ <p class="simpara"> The ID of the Worker who possesses the Qualification to be
27
+ revoked. </p>
28
+ <p class="simpara">Type: String</p>
29
+ <p class="simpara">Default: None</p>
30
+ </td><td>
31
+ <p class="simpara">Yes</p>
32
+ </td></tr><tr><td>
33
+ <p class="simpara">
34
+ <em class="parameter"><code>QualificationTypeId</code></em>
35
+ </p>
36
+ </td><td>
37
+ <p class="simpara">The ID of the Qualification type of the Qualification to be
38
+ revoked.</p>
39
+ <p class="simpara">Type: String</p>
40
+ <p class="simpara">Default: None</p>
41
+ </td><td>
42
+ <p class="simpara">Yes</p>
43
+ </td></tr><tr><td>
44
+ <p class="simpara">
45
+ <em class="parameter"><code>Reason</code></em>
46
+ </p>
47
+ </td><td>
48
+ <p class="simpara"> A text message that explains why the Qualification was
49
+ revoked. The user who had the Qualification sees this message. </p>
50
+ <p class="simpara">Type: String</p>
51
+ <p class="simpara">Default: None</p>
52
+ </td><td>
53
+ <p class="simpara">No</p>
54
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e10959">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">RevokeQualification</code> operation
55
+ returns with no errors. The response includes the elements described in the following
56
+ 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>
57
+ <p class="simpara">
58
+ <em class="parameter"><code>RevokeQualificationResult</code></em>
59
+ </p>
60
+ </td><td>
61
+ <p class="simpara"> Contains a <em class="parameter"><code>Request</code></em> element if the
62
+ <strong class="userinput"><code>Request</code></strong>
63
+ <em class="parameter"><code>ResposeGroup</code></em> is specified. </p>
64
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e11001">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">RevokeQualification</code>
65
+ operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e11009">Sample Request</h3></div></div></div><p> The following example revokes Qualification of the specified Qualification
66
+ type for the specified user. </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
67
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
68
+ &amp;Version=2008-08-02
69
+ &amp;Operation=RevokeQualification
70
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
71
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
72
+ &amp;SubjectId=AZ3456EXAMPLE
73
+ &amp;QualificationTypeId=789RVWYBAZW00EXAMPLE
74
+ </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e11025">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;RevokeQualificationResult&gt;
75
+ &lt;Request&gt;
76
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
77
+ &lt;/Request&gt;
78
+ &lt;/RevokeQualificationResult&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_RejectQualificationRequestOperation.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_RevokeQualificationOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_SearchHITsOperation.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_SearchHITsOperation.html ADDED
@@ -0,0 +1,164 @@
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>SearchHITs</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_RevokeQualificationOperation.html" title="RevokeQualification"><link rel="next" href="ApiReference_SearchQualificationTypesOperation.html" title="SearchQualificationTypes"><!--[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_RevokeQualificationOperation.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_SearchHITsOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_SearchQualificationTypesOperation.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>SearchHITs</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">SearchHITs</h1></div></div></div><a class="indexterm" name="d0e11036"></a><a class="indexterm" name="d0e11039"></a><a class="indexterm" name="d0e11044"></a><a class="indexterm" name="d0e11049"></a><a class="indexterm" name="d0e11054"></a><a class="indexterm" name="d0e11059"></a><a class="indexterm" name="d0e11064"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e11069">Description</h2></div></div></div><p> The <code class="function">SearchHITs</code> operation returns all of a Requester's HITs, on
7
+ behalf of the Requester. </p><p> The operation returns HITs of any status, except for HITs that have been disposed
8
+ with the <a class="link" href="ApiReference_DisposeHITOperation.html" title="DisposeHIT">DisposeHIT</a> operation. </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">SearchHITs</code> operation does not accept any search
9
+ parameters that filter the results. </p></td></tr></table></div><p> The operation sorts the results and divides them into numbered pages. The operation
10
+ returns a single page of results. You can control sorting and pagination with parameters
11
+ to the operation. </p><p> When (<em class="parameter"><code>PageNumber</code></em> x <em class="parameter"><code>PageSize</code></em>) is less
12
+ than 100, you can get reliable results when you use any of the sort properties. If this
13
+ number is greater than 100, use the <strong class="userinput"><code>Enumeration</code></strong> sort property for
14
+ best results. The <strong class="userinput"><code>Enumeration</code></strong> sort property guarantees that all
15
+ HITs are returned with no duplicates, but not in any specific order. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e11104">Request Parameters</h2></div></div></div><p> The <code class="function">SearchHITs</code> operation accepts parameters common to all
16
+ operations. Some common parameters are required. See <a class="link" href="ApiReference_CommonParametersArticle.html" title="Chapter&nbsp;4.&nbsp;Common Parameters">Common Parameters</a> for more
17
+ information. </p><p> The following parameters are specific to the <code class="function">SearchHITs</code>
18
+ operation: </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col><col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>
19
+ <p class="simpara">
20
+ <em class="parameter"><code>Operation</code></em>
21
+ </p>
22
+ </td><td>
23
+ <p class="simpara">The name of the operation</p>
24
+ <p class="simpara">Type: String</p>
25
+ <p class="simpara">Valid Values: SearchHITs</p>
26
+ <p class="simpara">Default: None</p>
27
+ </td><td>
28
+ <p class="simpara">Yes</p>
29
+ </td></tr><tr><td>
30
+ <p class="simpara">
31
+ <em class="parameter"><code>SortProperty</code></em>
32
+ </p>
33
+ </td><td>
34
+ <p class="simpara">The field on which to sort the returned results</p>
35
+ <p class="simpara">Type: String</p>
36
+ <p class="simpara">Valid Values: Title | Reward | Expiration | CreationTime |
37
+ Enumeration</p>
38
+ <p class="simpara">Default: CreationTime</p>
39
+ </td><td>
40
+ <p class="simpara">No</p>
41
+ </td></tr><tr><td>
42
+ <p class="simpara">
43
+ <em class="parameter"><code>SortDirection</code></em>
44
+ </p>
45
+ </td><td>
46
+ <p class="simpara"> The direction of the sort, used with the field specified by
47
+ the <em class="parameter"><code>SortProperty</code></em> parameter. </p>
48
+ <p class="simpara">Type: String</p>
49
+ <p class="simpara">Valid Values: Ascending | Descending</p>
50
+ <p class="simpara">Default: Ascending</p>
51
+ </td><td>
52
+ <p class="simpara">No</p>
53
+ </td></tr><tr><td>
54
+ <p class="simpara">
55
+ <em class="parameter"><code>PageSize</code></em>
56
+ </p>
57
+ </td><td>
58
+ <p class="simpara"> The number of HITs to include in a page of results. The
59
+ complete sorted result set is divided into pages of this many HITs. </p>
60
+ <p class="simpara">Type: positive integer</p>
61
+ <p class="simpara">Valid Values: any integer between 1 and 100</p>
62
+ <p class="simpara">Default: 10</p>
63
+ </td><td>
64
+ <p class="simpara">No</p>
65
+ </td></tr><tr><td>
66
+ <p class="simpara">
67
+ <em class="parameter"><code>PageNumber</code></em>
68
+ </p>
69
+ </td><td>
70
+ <p class="simpara"> The page of results to return. After the operation sorts the
71
+ HITs and divides them into pages of size <em class="parameter"><code>PageSize</code></em>, the operation returns the page
72
+ corresponding to <em class="parameter"><code>PageNumber</code></em>. </p>
73
+ <p class="simpara">Type: positive integer</p>
74
+ <p class="simpara">Default: 1</p>
75
+ </td><td>
76
+ <p class="simpara">No</p>
77
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e11280">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">SearchHITs</code> operation will have a
78
+ <em class="parameter"><code>SearchHITsResult</code></em> element in the response. </p><p> The <em class="parameter"><code>SearchHITsResult</code></em> element contains the following elements: </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>
79
+ <p class="simpara">
80
+ <em class="parameter"><code>NumResults</code></em>
81
+ </p>
82
+ </td><td>
83
+ <p class="simpara"> The number of HITs on this page in the filtered results list,
84
+ equivalent to the number of HITs being returned by this call. </p>
85
+ <p class="simpara">Type: non-negative integer</p>
86
+ </td></tr><tr><td>
87
+ <p class="simpara">
88
+ <em class="parameter"><code>PageNumber</code></em>
89
+ </p>
90
+ </td><td>
91
+ <p class="simpara">The number of this page in the filtered results list.</p>
92
+ <p class="simpara">Type: positive integer</p>
93
+ </td></tr><tr><td>
94
+ <p class="simpara">
95
+ <em class="parameter"><code>TotalNumResults</code></em>
96
+ </p>
97
+ </td><td>
98
+ <p class="simpara">The total number of HITs in the filtered results list based on
99
+ this call.</p>
100
+ <p class="simpara">Type: non-negative integer</p>
101
+ </td></tr><tr><td>
102
+ <p class="simpara">
103
+ <em class="parameter"><code>HIT</code></em>
104
+ </p>
105
+ </td><td>
106
+ <p class="simpara"> The HIT. The response includes one <em class="parameter"><code>HIT</code></em>
107
+ element for each HIT the query returns. </p>
108
+ <p class="simpara">Type: a <a class="link" href="ApiReference_HITDataStructureArticle.html" title="HIT">HIT</a> data structure.</p>
109
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e11381">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="d0e11389">Sample Request</h3></div></div></div><p> The following example queries all of the HITs for a Requester. The example
110
+ uses default values for sorting and pagination. </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
111
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
112
+ &amp;Operation=SearchHITs
113
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
114
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
115
+ </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e11405">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;SearchHITsResult&gt;
116
+ &lt;Request&gt;
117
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
118
+ &lt;/Request&gt;
119
+ &lt;NumResults&gt;2&lt;/NumResults&gt;
120
+ &lt;TotalNumResults&gt;2&lt;/TotalNumResults&gt;
121
+ &lt;PageNumber&gt;1&lt;/PageNumber&gt;
122
+
123
+ &lt;HIT&gt;
124
+ &lt;HITId&gt;GBHZVQX3EHXZ2AYDY2T0&lt;/HITId&gt;
125
+ &lt;HITTypeId&gt;NYVZTQ1QVKJZXCYZCZVZ&lt;/HITTypeId&gt;
126
+ &lt;CreationTime&gt;2009-04-22T00:17:32Z&lt;/CreationTime&gt;
127
+ &lt;Title&gt;Location&lt;/Title&gt;
128
+ &lt;Description&gt;Select the image that best represents&lt;/Description&gt;
129
+ &lt;HITStatus&gt;Reviewable&lt;/HITStatus&gt;
130
+ &lt;MaxAssignments&gt;1&lt;/MaxAssignments&gt;
131
+ &lt;Reward&gt;
132
+ &lt;Amount&gt;5.00&lt;/Amount&gt;
133
+ &lt;CurrencyCode&gt;USD&lt;/CurrencyCode&gt;
134
+ &lt;FormattedPrice&gt;$5.00&lt;/FormattedPrice&gt;
135
+ &lt;/Reward&gt;
136
+ &lt;AutoApprovalDelayInSeconds&gt;2592000&lt;/AutoApprovalDelayInSeconds&gt;
137
+ &lt;Expiration&gt;2009-04-29T00:17:32Z&lt;/Expiration&gt;
138
+ &lt;AssignmentDurationInSeconds&gt;30&lt;/AssignmentDurationInSeconds&gt;
139
+ &lt;NumberOfAssignmentsPending&gt;0&lt;/NumberOfAssignmentsPending&gt;
140
+ &lt;NumberOfAssignmentsAvailable&gt;0&lt;/NumberOfAssignmentsAvailable&gt;
141
+ &lt;NumberOfAssignmentsCompleted&gt;1&lt;/NumberOfAssignmentsCompleted&gt;
142
+ &lt;/HIT&gt;
143
+
144
+ &lt;HIT&gt;
145
+ &lt;HITId&gt;ZZRZPTY4ERDZWJ868JCZ&lt;/HITId&gt;
146
+ &lt;HITTypeId&gt;NYVZTQ1QVKJZXCYZCZVZ&lt;/HITTypeId&gt;
147
+ &lt;CreationTime&gt;2009-07-07T00:56:40Z&lt;/CreationTime&gt;
148
+ &lt;Title&gt;Location&lt;/Title&gt;
149
+ &lt;Description&gt;Select the image that best represents&lt;/Description&gt;
150
+ &lt;HITStatus&gt;Assignable&lt;/HITStatus&gt;
151
+ &lt;MaxAssignments&gt;1&lt;/MaxAssignments&gt;
152
+ &lt;Reward&gt;
153
+ &lt;Amount&gt;5.00&lt;/Amount&gt;
154
+ &lt;CurrencyCode&gt;USD&lt;/CurrencyCode&gt;
155
+ &lt;FormattedPrice&gt;$5.00&lt;/FormattedPrice&gt;
156
+ &lt;/Reward&gt;
157
+ &lt;AutoApprovalDelayInSeconds&gt;2592000&lt;/AutoApprovalDelayInSeconds&gt;
158
+ &lt;Expiration&gt;2009-07-14T00:56:40Z&lt;/Expiration&gt;
159
+ &lt;AssignmentDurationInSeconds&gt;30&lt;/AssignmentDurationInSeconds&gt;
160
+ &lt;NumberOfAssignmentsPending&gt;0&lt;/NumberOfAssignmentsPending&gt;
161
+ &lt;NumberOfAssignmentsAvailable&gt;1&lt;/NumberOfAssignmentsAvailable&gt;
162
+ &lt;NumberOfAssignmentsCompleted&gt;0&lt;/NumberOfAssignmentsCompleted&gt;
163
+ &lt;/HIT&gt;
164
+ &lt;/SearchHITsResult&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_RevokeQualificationOperation.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_SearchHITsOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_SearchQualificationTypesOperation.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>