Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Change aws_docs to a tarball so they don't clutter up search results.…

… Unpack them if you want them; the directory is now gitignored so you won't accidentally check them in.
  • Loading branch information...
commit 541759082e4ac21b1848a2b9791eb10c80fd2801 1 parent d3da97a
@alexch authored
Showing with 18 additions and 9,326 deletions.
  1. +1 −0  .gitignore
  2. BIN  aws_docs.tar.gz
  3. +0 −98 aws_docs/ApiReference_AnswerKeyDataStructureArticle.html
  4. +0 −75 aws_docs/ApiReference_ApproveAssignmentOperation.html
  5. +0 −107 aws_docs/ApiReference_AssignQualificationOperation.html
  6. +0 −171 aws_docs/ApiReference_AssignmentDataStructureArticle.html
  7. +0 −70 aws_docs/ApiReference_BlockWorkerOperation.html
  8. +0 −68 aws_docs/ApiReference_ChangeHITTypeOfHITOperation.html
  9. +0 −119 aws_docs/ApiReference_CommonParametersArticle.html
  10. +0 −330 aws_docs/ApiReference_CreateHITOperation.html
  11. +0 −190 aws_docs/ApiReference_CreateQualificationTypeOperation.html
  12. +0 −7 aws_docs/ApiReference_DataStructuresArticle.html
  13. +0 −63 aws_docs/ApiReference_DisableHITOperation.html
  14. +0 −56 aws_docs/ApiReference_DisposeHITOperation.html
  15. +0 −52 aws_docs/ApiReference_DisposeQualificationTypeOperation.html
  16. +0 −86 aws_docs/ApiReference_ExtendHITOperation.html
  17. +0 −125 aws_docs/ApiReference_ExternalQuestionArticle.html
  18. +0 −61 aws_docs/ApiReference_ForceExpireHITOperation.html
  19. +0 −289 aws_docs/ApiReference_FormattedContentXHTMLArticle.html
  20. +0 −51 aws_docs/ApiReference_GetAccountBalanceOperation.html
  21. +0 −166 aws_docs/ApiReference_GetAssignmentsForHITOperation.html
  22. +0 −160 aws_docs/ApiReference_GetBonusPaymentsOperation.html
  23. +0 −75 aws_docs/ApiReference_GetFileUploadURLOperation.html
  24. +0 −89 aws_docs/ApiReference_GetHITOperation.html
  25. +0 −137 aws_docs/ApiReference_GetHITsForQualificationTypeOperation.html
  26. +0 −155 aws_docs/ApiReference_GetQualificationRequestsOperation.html
  27. +0 −68 aws_docs/ApiReference_GetQualificationScoreOperation.html
  28. +0 −57 aws_docs/ApiReference_GetQualificationTypeOperation.html
  29. +0 −134 aws_docs/ApiReference_GetQualificationsForQualificationTypeOperation.html
  30. +0 −315 aws_docs/ApiReference_GetRequesterStatisticOperation.html
  31. +0 −155 aws_docs/ApiReference_GetReviewableHITsOperation.html
  32. +0 −95 aws_docs/ApiReference_GrantBonusOperation.html
  33. +0 −69 aws_docs/ApiReference_GrantQualificationOperation.html
  34. +0 −302 aws_docs/ApiReference_HITDataStructureArticle.html
  35. +0 −125 aws_docs/ApiReference_HelpOperation.html
  36. +0 −29 aws_docs/ApiReference_LocaleDataStructureArticle.html
  37. +0 −36 aws_docs/ApiReference_NotificationAPI_BuildingANotificationReceptor.html
  38. +0 −40 aws_docs/ApiReference_NotificationAPI_ElementsOfANotification.html
  39. +0 −73 aws_docs/ApiReference_NotificationDataStructureArticle.html
  40. +0 −9 aws_docs/ApiReference_NotificationReceptorAPIArticle.html
  41. +0 −39 aws_docs/ApiReference_NotificationReceptorAPI_RESTTransportArticle.html
  42. +0 −45 aws_docs/ApiReference_NotificationReceptorAPI_SOAPTransportArticle.html
  43. +0 −82 aws_docs/ApiReference_NotifyWorkersOperation.html
  44. +0 −8 aws_docs/ApiReference_OperationsArticle.html
  45. +0 −65 aws_docs/ApiReference_PriceDataStructureArticle.html
  46. +0 −89 aws_docs/ApiReference_QualificationDataStructureArticle.html
  47. +0 −102 aws_docs/ApiReference_QualificationRequestDataStructureArticle.html
  48. +0 −176 aws_docs/ApiReference_QualificationRequirementDataStructureArticle.html
  49. +0 −198 aws_docs/ApiReference_QualificationTypeDataStructureArticle.html
  50. +0 −8 aws_docs/ApiReference_QuestionAnswerDataArticle.html
  51. +0 −54 aws_docs/ApiReference_QuestionFormAnswersDataStructureArticle.html
  52. +0 −796 aws_docs/ApiReference_QuestionFormDataStructureArticle.html
  53. +0 −149 aws_docs/ApiReference_RegisterHITTypeOperation.html
  54. +0 −66 aws_docs/ApiReference_RejectAssignmentOperation.html
  55. +0 −61 aws_docs/ApiReference_RejectQualificationRequestOperation.html
  56. +0 −78 aws_docs/ApiReference_RevokeQualificationOperation.html
  57. +0 −164 aws_docs/ApiReference_SearchHITsOperation.html
  58. +0 −211 aws_docs/ApiReference_SearchQualificationTypesOperation.html
  59. +0 −78 aws_docs/ApiReference_SendTestEventNotificationOperation.html
  60. +0 −73 aws_docs/ApiReference_SetHITAsReviewingOperation.html
  61. +0 −99 aws_docs/ApiReference_SetHITTypeNotificationOperation.html
  62. +0 −67 aws_docs/ApiReference_UnblockWorkerOperation.html
  63. +0 −77 aws_docs/ApiReference_UpdateQualificationScoreOperation.html
  64. +0 −180 aws_docs/ApiReference_UpdateQualificationTypeOperation.html
  65. +0 −95 aws_docs/ApiReference_WsdlLocationArticle.html
  66. +0 −37 aws_docs/ApiReference_XMLParameterValuesArticle.html
  67. +0 −125 aws_docs/Welcome.html
  68. +0 −16 aws_docs/WhatsNew.html
  69. +0 −28 aws_docs/_title.html
  70. +0 −749 aws_docs/_toc.html
  71. +0 −419 aws_docs/aws-docs-IE.css
  72. +0 −455 aws_docs/aws-docs.css
  73. +0 −14 aws_docs/copyrightinfo.html
  74. +0 −12 aws_docs/frameset.js
  75. BIN  aws_docs/images/Feedback_link.gif
  76. BIN  aws_docs/images/caution.png
  77. BIN  aws_docs/images/home.gif
  78. BIN  aws_docs/images/important.png
  79. BIN  aws_docs/images/next.gif
  80. BIN  aws_docs/images/note.png
  81. BIN  aws_docs/images/prev.gif
  82. BIN  aws_docs/images/tip.png
  83. BIN  aws_docs/images/title-swoosh-logo.gif
  84. BIN  aws_docs/images/toc_bullet.gif
  85. BIN  aws_docs/images/toc_plus.gif
  86. +0 −18 aws_docs/index.html
  87. +0 −84 aws_docs/toc.js
  88. +2 −2 spec/mturk.sample.yml
  89. +15 −0 spec/operations/create_hit_spec.rb
View
1  .gitignore
@@ -6,3 +6,4 @@ pkg
*.sw?
.rvmrc
tags
+aws_docs
View
BIN  aws_docs.tar.gz
Binary file not shown
View
98 aws_docs/ApiReference_AnswerKeyDataStructureArticle.html
@@ -1,98 +0,0 @@
-<html xmlns:fo="http://www.w3.org/1999/XSL/Format"><head>
- <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
- <title>AnswerKey</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_QuestionAnswerDataArticle.html" title="Chapter&nbsp;7.&nbsp;Question and Answer Data"><link rel="prev" href="ApiReference_QuestionFormAnswersDataStructureArticle.html" title="QuestionFormAnswers"><link rel="next" href="ApiReference_ExternalQuestionArticle.html" title="ExternalQuestion"><!--[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">
- urchinTracker();
- </script><script xmlns="http://www.w3.org/1999/xhtml" type="text/javascript" src="frameset.js"> //
- </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_QuestionFormAnswersDataStructureArticle.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_AnswerKeyDataStructureArticle">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_ExternalQuestionArticle.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_QuestionAnswerDataArticle.html">Question and Answer Data</a> &raquo; <strong>AnswerKey</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">AnswerKey</h1></div></div></div><a class="indexterm" name="d0e19956"></a><a class="indexterm" name="d0e19959"></a><a class="indexterm" name="d0e19964"></a><a class="indexterm" name="d0e19969"></a><div class="highlights"><p><strong>Topics</strong></p><ul><li><a href="ApiReference_AnswerKeyDataStructureArticle.html#d0e19975">Description</a></li><li><a href="ApiReference_AnswerKeyDataStructureArticle.html#d0e20019">The Structure of an Answer Key</a></li><li><a href="ApiReference_AnswerKeyDataStructureArticle.html#d0e20166">Example</a></li></ul></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e19975">Description</h2></div></div></div><p> The AnswerKey data structure specifies answers for a Qualification test, and a mechanism to use
- to calculate a score from the key and a Worker's answers. </p><p> An AnswerKey data structure is a string value that consists of XML data. The XML data must
- conform to the AnswerKey schema. See <a class="link" href="ApiReference_WsdlLocationArticle.html" title="Chapter&nbsp;3.&nbsp;WSDL and Schema Locations">WSDL and
- Schema Locations</a> for the location of this schema. For more information about using XML
- data as parameter or return value, see <a class="link" href="ApiReference_XMLParameterValuesArticle.html" title="Using XML Parameter Values">Using XML Parameter Values</a>. </p><p> The AnswerKey data structure is used as a parameter for the following operations: </p><div class="itemizedlist"><ul type="disc"><li><p>
- <code class="function">CreateQualificationType</code>
- </p></li></ul></div><p> The AnswerKey data structure is used as a return value for the following operations: </p><div class="itemizedlist"><ul type="disc"><li><p>
- <code class="function">GetQualificationType</code>
- </p></li></ul></div><p> The AnswerKey data structure is a value in a <a class="link" href="ApiReference_QualificationTypeDataStructureArticle.html" title="QualificationType">Qualification type data
- structure</a>. </p><p> All elements in a <em class="parameter"><code>AnswerKey</code></em> belong to a namespace whose name is
- identical to the URL of the <em class="parameter"><code>AnswerKey</code></em> schema document for the version of
- the API you are using. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e20019">The Structure of an Answer Key</h2></div></div></div><p> An answer key is contained in a <em class="parameter"><code>AnswerKey</code></em> element. This element contains
- a <em class="parameter"><code>Question</code></em> element for each question in the Qualification test, and an
- optional <em class="parameter"><code>QualificationValueMapping</code></em> element that describes how to calculate
- the Qualification value from the answer key and the Worker's answers. </p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e20033">Question</h3></div></div></div><p> A <em class="parameter"><code>Question</code></em> element contains a
- <em class="parameter"><code>QuestionIdentifier</code></em> element, which identifies the question for this
- answer. This value corresponds to a <em class="parameter"><code>QuestionIdentifier</code></em> in the
- QuestionForm. </p><p> A <em class="parameter"><code>Question</code></em> element has one or more
- <em class="parameter"><code>AnswerOption</code></em> elements, one for each combination of selections in the
- multiple-choice question that affects the Worker's test score. </p><p> Each <em class="parameter"><code>AnswerOption</code></em> contains one or more
- <em class="parameter"><code>SelectionIdentifier</code></em> elements that correspond to identifiers for the
- selections in the QuestionForm. It also contains an <em class="parameter"><code>AnswerScore</code></em>
- element, a number that is added to the Worker's test score if the Worker's answer matches this
- option. The Worker must select all of the selections specified by the
- <em class="parameter"><code>SelectionIdentifier</code></em> elements, and no others, to earn the score. </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> An <em class="parameter"><code>AnswerScore</code></em> for an <em class="parameter"><code>AnswerOption</code></em> may be
- negative. </p></td></tr></table></div><p> The <em class="parameter"><code>Question</code></em> may have an optional
- <em class="parameter"><code>DefaultScore</code></em>, a number that is added to the Worker's test score if none
- of the answer options exactly match the Worker's answer for the question.
- <em class="parameter"><code>DefaultScore</code></em> is optional, and defaults to 0. </p><pre class="programlisting">&lt;AnswerOption&gt;
- &lt;SelectionIdentifier&gt;apples&lt;/SelectionIdentifier&gt;
- &lt;AnswerScore&gt;10&lt;/AnswerScore&gt;
-&lt;/AnswerOption&gt;</pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e20091">QualificationValueMapping</h3></div></div></div><p> The <em class="parameter"><code>Question</code></em> may have an optional
- <em class="parameter"><code>QualificationValueMapping</code></em> element that describes how to calculate
- the Worker's overall score from the scores of the Worker's answers. It contains either a
- <em class="parameter"><code>PercentageMapping</code></em> element, a <em class="parameter"><code>ScaleMapping</code></em>
- element, or a <em class="parameter"><code>RangeMapping</code></em> element. </p><p> If no <em class="parameter"><code>QualificationValueMapping</code></em> is specified, the sum of the scores
- of the answers is used as the Qualification value. </p><pre class="programlisting">&lt;QualificationValueMapping&gt;
- ...
-&lt;/QualificationValueMapping&gt;</pre><p> A <em class="parameter"><code>PercentageMapping</code></em> specifies a maximum score for the test, as a
- <em class="parameter"><code>MaximumSummedScore</code></em> element. The Qualification value is calculated
- as the sum of the scores of the selected answers, divided by the maximum, multiplied by 100
- and rounded to the nearest integer to produce a percentage. </p><pre class="programlisting"> ...
- &lt;PercentageMapping&gt;
- &lt;MaximumSummedScore&gt;15&lt;/MaximumSummedScore&gt;
- &lt;/PercentageMapping&gt;</pre><p> A <em class="parameter"><code>ScaleMapping</code></em> specifies a multiplier, as a decimal value in a
- <em class="parameter"><code>SummedScoreMultiplier</code></em> element. The Qualification value is
- calculated as the sum of the scores of the selected answers, multiplied by the multiplier. </p><pre class="programlisting"> ...
- &lt;ScaleMapping&gt;
- &lt;SummedScoreMultiplier&gt;3&lt;/SummedScoreMultiplier&gt;
- &lt;/ScaleMapping&gt;</pre><p> A <em class="parameter"><code>RangeMapping</code></em> assigns specific Qualification values to ranges of
- total test scores. It contains one or more <em class="parameter"><code>SummedScoreRange</code></em> elements,
- each of which specify an <em class="parameter"><code>InclusiveLowerBound</code></em> element, an
- <em class="parameter"><code>InclusiveUpperBound</code></em> element, and a
- <em class="parameter"><code>QualificationValue</code></em> that becomes the Qualification value if the sum of
- the scores of the selected answers falls within the specified range. Finally, the
- <em class="parameter"><code>RangeMapping</code></em> includes a single
- <em class="parameter"><code>OutOfRangeQualificationValue</code></em>, which specifies the Qualification
- value if the sum of the scores of the selected answers do not fall within a specified range. </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> Ranges cannot overlap. If ranges overlap, the behavior is undefined. </p></td></tr></table></div><pre class="programlisting"> ...
- &lt;RangeMapping&gt;
- &lt;SummedScoreRange&gt;
- &lt;InclusiveLowerBound&gt;5&lt;/InclusiveLowerBound&gt;
- &lt;InclusiveUpperBound&gt;7&lt;/InclusiveUpperBound&gt;
- &lt;QualificationValue&gt;5&lt;/QualificationValue&gt;
- &lt;/SummedScoreRange&gt;
- &lt;SummedScoreRange&gt;
- &lt;InclusiveLowerBound&gt;8&lt;/InclusiveLowerBound&gt;
- &lt;InclusiveUpperBound&gt;10&lt;/InclusiveUpperBound&gt;
- &lt;QualificationValue&gt;10&lt;/QualificationValue&gt;
- &lt;/SummedScoreRange&gt;
- &lt;OutOfRangeQualificationValue&gt;0&lt;/OutOfRangeQualificationValue&gt;
- &lt;/RangeMapping&gt;</pre></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e20166">Example</h2></div></div></div><p> The following is an example of a complete <em class="parameter"><code>QuestionForm</code></em> data structure.
- Remember that to pass this structure in as a parameter to an operation, XML characters must be
- escaped as character entities. </p><pre class="programlisting">&lt;AnswerKey xmlns="<em class="replaceable"><code>[the AnswerKey schema URL]</code></em>"&gt;
- &lt;Question&gt;
- &lt;QuestionIdentifier&gt;nextmove&lt;/QuestionIdentifier&gt;
- &lt;AnswerOption&gt;
- &lt;SelectionIdentifier&gt;D&lt;/SelectionIdentifier&gt;
- &lt;AnswerScore&gt;5&lt;/AnswerScore&gt;
- &lt;/AnswerOption&gt;
- &lt;/Question&gt;
- &lt;Question&gt;
- &lt;QuestionIdentifier&gt;favoritefruit&lt;/QuestionIdentifier&gt;
- &lt;AnswerOption&gt;
- &lt;SelectionIdentifier&gt;apples&lt;/SelectionIdentifier&gt;
- &lt;AnswerScore&gt;10&lt;/AnswerScore&gt;
- &lt;/AnswerOption&gt;
- &lt;/Question&gt;
- &lt;QualificationValueMapping&gt;
- &lt;PercentageMapping&gt;
- &lt;MaximumSummedScore&gt;15&lt;/MaximumSummedScore&gt;
- &lt;/PercentageMapping&gt;
- &lt;/QualificationValueMapping&gt;
-&lt;/AnswerKey&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_QuestionFormAnswersDataStructureArticle.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_AnswerKeyDataStructureArticle">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_ExternalQuestionArticle.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>
View
75 aws_docs/ApiReference_ApproveAssignmentOperation.html
@@ -1,75 +0,0 @@
-<html xmlns:fo="http://www.w3.org/1999/XSL/Format"><head>
- <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
- <title>ApproveAssignment</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_OperationsArticle.html" title="Chapter&nbsp;5.&nbsp;Operations"><link rel="next" href="ApiReference_AssignQualificationOperation.html" title="AssignQualification"><!--[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">
- urchinTracker();
- </script><script xmlns="http://www.w3.org/1999/xhtml" type="text/javascript" src="frameset.js"> //
- </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_OperationsArticle.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_ApproveAssignmentOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_AssignQualificationOperation.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>ApproveAssignment</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">ApproveAssignment</h1></div></div></div><a class="indexterm" name="d0e1122"></a><a class="indexterm" name="d0e1125"></a><a class="indexterm" name="d0e1130"></a><a class="indexterm" name="d0e1135"></a><a class="indexterm" name="d0e1140"></a><a class="indexterm" name="d0e1145"></a><a class="indexterm" name="d0e1148"></a><a class="indexterm" name="d0e1153"></a><a class="indexterm" name="d0e1158"></a><a class="indexterm" name="d0e1163"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e1168">Description</h2></div></div></div><p> The <code class="function">ApproveAssignment</code> operation approves the results of a
- completed assignment. </p><p> Approving an assignment initiates two payments from the Requester's Amazon.com
- account: the Worker who submitted the results is paid the reward specified in the HIT,
- and Amazon Mechanical Turk fees are debited. If the Requester's account does not have
- adequate funds for these payments, the call to <code class="function">ApproveAssignment</code>
- returns an exception, and the approval is not processed. </p><p> You can include an optional feedback message with the approval, which the Worker can
- see in the <span class="guilabel">Status</span> section of the web site. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e1186">Request Parameters</h2></div></div></div><p> The <code class="function">ApproveAssignment</code> operation accepts parameters 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">ApproveAssignment</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>
- <p class="simpara">
- <em class="parameter"><code>Operation</code></em>
- </p>
- </td><td>
- <p class="simpara">The name of the operation</p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Valid Values: ApproveAssignment</p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>AssignmentId</code></em>
- </p>
- </td><td>
- <p class="simpara"> The ID of the assignment. This parameter must correspond to a
- HIT created by the Requester. </p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>RequesterFeedback</code></em>
- </p>
- </td><td>
- <p class="simpara"> A message for the Worker, which the Worker can see in the
- <span class="guilabel">Status</span> section of the web site. </p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Default: None</p>
- <p class="simpara"> Constraints: Can be up to 1024 characters (including
- multi-byte characters). </p>
- <p class="simpara"> The <em class="parameter"><code>RequesterFeedback</code></em> parameter cannot
- contain ASCII characters 0-8, 11,12, or 14-31. If these characters
- are present, the operation throws an InvalidParameterValue error.
- </p>
- </td><td>
- <p class="simpara">No</p>
- </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e1305">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">ApproveAssignment</code> operation returns
- with no errors. The response includes the elements described in the 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>
- <p class="simpara">
- <em class="parameter"><code>ApproveAssignmentResult</code></em>
- </p>
- </td><td>
- <p class="simpara">Contains a <em class="parameter"><code>Request</code></em> element if the
- <strong class="userinput"><code>Request</code></strong>
- <em class="parameter"><code>ResposeGroup</code></em> is specified. </p>
- </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e1347">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">ApproveAssignment</code>
- operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e1355">Sample Request</h3></div></div></div><p> The following example approves an assignment identified by its assignment ID. </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
-&amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
-&amp;Version=2008-08-02
-&amp;Operation=ApproveAssignment
-&amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
-&amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
-&amp;AssignmentId=123RVWYBAZW00EXAMPLE456RVWYBAZW00EXAMPLE
- </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e1371">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;ApproveAssignmentResult&gt;
- &lt;Request&gt;
- &lt;IsValid&gt;True&lt;/IsValid&gt;
- &lt;/Request&gt;
-&lt;/ApproveAssignmentResult&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_OperationsArticle.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_ApproveAssignmentOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_AssignQualificationOperation.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>
View
107 aws_docs/ApiReference_AssignQualificationOperation.html
@@ -1,107 +0,0 @@
-<html xmlns:fo="http://www.w3.org/1999/XSL/Format"><head>
- <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
- <title>AssignQualification</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_ApproveAssignmentOperation.html" title="ApproveAssignment"><link rel="next" href="ApiReference_BlockWorkerOperation.html" title="BlockWorker"><!--[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">
- urchinTracker();
- </script><script xmlns="http://www.w3.org/1999/xhtml" type="text/javascript" src="frameset.js"> //
- </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_ApproveAssignmentOperation.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_AssignQualificationOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_BlockWorkerOperation.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>AssignQualification</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">AssignQualification</h1></div></div></div><a class="indexterm" name="d0e1381"></a><a class="indexterm" name="d0e1384"></a><a class="indexterm" name="d0e1389"></a><a class="indexterm" name="d0e1392"></a><a class="indexterm" name="d0e1397"></a><a class="indexterm" name="d0e1402"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e1407">Description</h2></div></div></div><p> The <code class="function">AssignQualification</code> operation gives a Worker a
- Qualification. <code class="function">AssignQualification</code> does not require that the Worker
- submit a Qualification request. It gives the Qualification directly to the Worker. </p><p> You can assign a Qualification to any Worker who has submitted one of your HITs in
- the past. </p><p> You can only assign a Qualification of a Qualification type that you created (using
- the <a class="link" href="ApiReference_CreateQualificationTypeOperation.html" title="CreateQualificationType">
- CreateQualificationType</a> operation). </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>
- <code class="function">AssignQualification</code> does not affect any pending Qualification
- requests for the Qualification by the Worker. If you assign a Qualification to a
- Worker, then later grant a Qualification request made by the Worker, the granting of
- the request may modify the Qualification score. To resolve a pending Qualification
- request without affecting the Qualification the Worker already has, reject the
- request with the <a class="link" href="ApiReference_RejectQualificationRequestOperation.html" title="RejectQualificationRequest">
- RejectQualificationRequest</a> operation. </p></td></tr></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e1434">Request Parameters</h2></div></div></div><p> The <code class="function">AssignQualification</code> operation accepts parameters common to
- all operations. Some common parameters are required. See <a class="link" href="ApiReference_CommonParametersArticle.html" title="Chapter&nbsp;4.&nbsp;Common Parameters">CommonParameters</a> for more
- information. </p><p> The following parameters are specific to the <code class="function">AssignQualification</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>
- <p class="simpara">
- <em class="parameter"><code>Operation</code></em>
- </p>
- </td><td>
- <p class="simpara">The name of the operation</p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Valid Values: AssignQualifcation</p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>QualificationTypeId</code></em>
- </p>
- </td><td>
- <p class="simpara">The ID of the Qualification type to use for the assigned
- Qualification.</p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Default: None</p>
- <p class="simpara"> Constraints: must be a valid Qualification type ID, as
- returned by the <a class="link" href="ApiReference_CreateQualificationTypeOperation.html" title="CreateQualificationType">
- CreateQualificationType</a> operation. </p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>WorkerId</code></em>
- </p>
- </td><td>
- <p class="simpara"> The ID of the Worker to whom the Qualification is being
- assigned. Worker IDs are included with submitted HIT assignments and
- Qualification requests. </p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>IntegerValue</code></em>
- </p>
- </td><td>
- <p class="simpara">The value of the Qualification to assign.</p>
- <p class="simpara">Type: Integer</p>
- <p class="simpara">Default: 1</p>
- </td><td>
- <p class="simpara">No</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>SendNotification</code></em>
- </p>
- </td><td>
- <p class="simpara"> Specifies whether to send a notification email message to the
- Worker saying that the qualification was assigned to the Worker. </p>
- <p class="simpara">Type: Boolean</p>
- <p class="simpara"> Valid Values: <code class="code">true</code> | <code class="code">false</code>. </p>
- <p class="simpara">Default: <code class="code">true</code></p>
- </td><td>
- <p class="simpara">No</p>
- </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e1609">Response Elements</h2></div></div></div><p> A successful request for the AssignQualification operation returns with no errors.
- The response includes the elements described in the 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>
- <p class="simpara">
- <em class="parameter"><code>AssignQualificationResult</code></em>
- </p>
- </td><td>
- <p class="simpara"> Contains a <em class="parameter"><code>Request</code></em> element if the
- <strong class="userinput"><code>Request</code></strong>
- <em class="parameter"><code>ResposeGroup</code></em> is specified. </p>
- </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e1648">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">AssignQualification</code>
- operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e1656">Sample Request</h3></div></div></div><p> The following example assigns a Qualification of a specified type to a Worker
- with the specified ID, using the specified Qualification value. By default,
- Amazon Mechanical Turk sends the Worker an e-mail message saying that the Worker
- has received the Qualification. </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
-&amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
-&amp;Version=2008-08-02
-&amp;Operation=AssignQualification
-&amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
-&amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
-&amp;QualificationTypeId=789RVWYBAZW00EXAMPLE
-&amp;WorkerId=AZ3456EXAMPLE
-&amp;IntegerValue=800
- </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e1672">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;AssignQualificationResult&gt;
- &lt;Request&gt;
- &lt;IsValid&gt;True&lt;/IsValid&gt;
- &lt;/Request&gt;
-&lt;/AssignQualificationResult&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_ApproveAssignmentOperation.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_AssignQualificationOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_BlockWorkerOperation.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>
View
171 aws_docs/ApiReference_AssignmentDataStructureArticle.html
@@ -1,171 +0,0 @@
-<html xmlns:fo="http://www.w3.org/1999/XSL/Format"><head>
- <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
- <title>Assignment</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_DataStructuresArticle.html" title="Chapter&nbsp;6.&nbsp;Data Structures"><link rel="next" href="ApiReference_HITDataStructureArticle.html" title="HIT"><!--[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">
- urchinTracker();
- </script><script xmlns="http://www.w3.org/1999/xhtml" type="text/javascript" src="frameset.js"> //
- </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_DataStructuresArticle.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_AssignmentDataStructureArticle">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_HITDataStructureArticle.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>Assignment</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">Assignment</h1></div></div></div><a class="indexterm" name="d0e13741"></a><a class="indexterm" name="d0e13744"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e13749">Description</h2></div></div></div><p> The Assignment data structure represents a single assignment of a HIT to a Worker. The
- assignment tracks the Worker's efforts to complete the HIT, and contains the results for later
- retrieval. </p><p> The Assignment data structure is used as a response element for the following operation: </p><div class="itemizedlist"><ul type="disc"><li><p>
- <a class="link" href="ApiReference_GetAssignmentsForHITOperation.html" title="GetAssignmentsForHIT">GetAssignmentsForHIT</a>
- </p></li></ul></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e13763">Elements</h2></div></div></div><p> The Assignment structure can contain the following elements. </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>
- <p class="simpara">
- <em class="parameter"><code>AssignmentId</code></em>
- </p>
- </td><td>
- <p class="simpara">A unique identifier for the assignment</p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">No</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>WorkerId</code></em>
- </p>
- </td><td>
- <p class="simpara"> The ID of the Worker who accepted the HIT. </p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">No</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>HITId</code></em>
- </p>
- </td><td>
- <p class="simpara">The ID of the HIT</p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">No</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>AssignmentStatus</code></em>
- </p>
- </td><td>
- <p class="simpara">The status of the assignment</p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Valid Values: Submitted | Approved | Rejected</p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">No</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>AutoApprovalTime</code></em>
- </p>
- </td><td>
- <p class="simpara"> If results have been submitted, <em class="parameter"><code>AutoApprovalTime</code></em>
- is the date and time the results of the assignment results are considered
- <span class="guilabel">Approved</span> automatically if they have not already been
- explicitly approved or rejected by the Requester. This value is derived from
- the auto-approval delay specified by the Requester in the HIT. This value is
- omitted from the assignment if the Worker has not yet submitted results. </p>
- <p class="simpara"> Type: a <a class="ulink" href="http://www.w3.org/TR/xmlschema-2/#dateTime" target="_blank">dateTime</a> structure in the Coordinated Universal Time (Greenwich Mean
- Time) time zone, such as <strong class="userinput"><code>2005-01-31T23:59:59Z</code></strong>. </p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">No</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>AcceptTime</code></em>
- </p>
- </td><td>
- <p class="simpara">The date and time the Worker accepted the assignment.</p>
- <p class="simpara"> Type: a <a class="ulink" href="http://www.w3.org/TR/xmlschema-2/#dateTime" target="_blank">dateTime</a> structure in the Coordinated Universal Time (Greenwich Mean
- Time) time zone, such as <strong class="userinput"><code>2005-01-31T23:59:59Z</code></strong>. </p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">No</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>SubmitTime</code></em>
- </p>
- </td><td>
- <p class="simpara"> If the Worker has submitted results, <em class="parameter"><code>SubmitTime</code></em>
- is the date and time the assignment was submitted. This value is omitted from
- the assignment if the Worker has not yet submitted results. </p>
- <p class="simpara"> Type: a <a class="ulink" href="http://www.w3.org/TR/xmlschema-2/#dateTime" target="_blank">dateTime</a> structure in the Coordinated Universal Time (Greenwich Mean
- Time) time zone, such as <strong class="userinput"><code>2005-01-31T23:59:59Z</code></strong>. </p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">No</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>ApprovalTime</code></em>
- </p>
- </td><td>
- <p class="simpara"> If the Worker has submitted results and the Requester has approved the
- results, <em class="parameter"><code>ApprovalTime</code></em> is the date and time the
- Requester approved the results. This value is omitted from the assignment if
- the Requester has not yet approved the results. </p>
- <p class="simpara"> Type: a <a class="ulink" href="http://www.w3.org/TR/xmlschema-2/#dateTime" target="_blank">dateTime</a> structure in the Coordinated Universal Time (Greenwich Mean
- Time) time zone, such as <strong class="userinput"><code>2005-01-31T23:59:59Z</code></strong>. </p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">No</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>RejectionTime</code></em>
- </p>
- </td><td>
- <p class="simpara"> If the Worker has submitted results and the Requester has rejected the
- results, <em class="parameter"><code>RejectionTime</code></em> is the date and time the
- Requester rejected the results. </p>
- <p class="simpara"> Type: a <a class="ulink" href="http://www.w3.org/TR/xmlschema-2/#dateTime" target="_blank">dateTime</a> structure in the Coordinated Universal Time (Greenwich Mean
- Time) time zone, such as <strong class="userinput"><code>2005-01-31T23:59:59Z</code></strong>. </p>
- <p class="simpara"> Default: None. This value is omitted from the assignment if the
- Requester has not yet rejected the results. </p>
- </td><td>
- <p class="simpara">No</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>Deadline</code></em>
- </p>
- </td><td>
- <p class="simpara"> The date and time of the deadline for the assignment. This value is
- derived from the deadline specification for the HIT and the date and time the
- Worker accepted the HIT. </p>
- <p class="simpara"> Type: a <a class="ulink" href="http://www.w3.org/TR/xmlschema-2/#dateTime" target="_blank">dateTime</a> structure in the Coordinated Universal Time (Greenwich Mean
- Time) time zone, such as <strong class="userinput"><code>2005-01-31T23:59:59Z</code></strong>. </p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">No</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>Answer</code></em>
- </p>
- </td><td>
- <p class="simpara">No</p>
- </td><td class="auto-generated">&nbsp;</td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>RequesterFeedback</code></em>
- </p>
- </td><td>
- <p class="simpara"> The feedback string included with the call to the <a class="link" href="ApiReference_ApproveAssignmentOperation.html" title="ApproveAssignment">
- ApproveAssignment</a> operation or the<a class="link" href="ApiReference_RejectAssignmentOperation.html" title="RejectAssignment"> RejectAssignment</a>
- operation, if the Requester approved or rejected the assignment and specified
- feedback. </p>
- <p class="simpara">Type: String</p>
- <p class="simpara"> Default: None. This field is not returned with assignment data by
- default. To request this field, specify a response group of
- <strong class="userinput"><code>AssignmentFeedback</code></strong>. </p>
- </td><td>
- <p class="simpara">No</p>
- </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e14134">Example</h2></div></div></div><p> The following example shows an Assignment data structure returned by the <a class="link" href="ApiReference_GetAssignmentsForHITOperation.html" title="GetAssignmentsForHIT">GetAssignmentsForHIT</a> operation.
- The <a class="link" href="ApiReference_GetAssignmentsForHITOperation.html" title="GetAssignmentsForHIT">GetAssignmentsForHIT</a>
- operaton returns zero or more <em class="parameter"><code>Assignment</code></em> elements for a
- <span class="guilabel">Reviewable</span> HIT. </p><pre class="programlisting">
-&lt;Assignment&gt;
- &lt;AssignmentId&gt;123RVWYBAZW00EXAMPLE456RVWYBAZW00EXAMPLE&lt;/AssignmentId&gt;
- &lt;WorkerId&gt;AZ3456EXAMPLE&lt;/WorkerId&gt;
- &lt;HITId&gt;123RVWYBAZW00EXAMPLE&lt;/HITId&gt;
- &lt;AssignmentStatus&gt;Submitted&lt;/AssignmentStatus&gt;
- &lt;Deadline&gt;2005-12-01T23:59:59Z&lt;/Deadline&gt;
- &lt;AcceptTime&gt;2005-12-01T12:00:00Z&lt;/AcceptTime&gt;
- &lt;SubmitTime&gt;2005-12-07T23:59:59Z&lt;/SubmitTime&gt;
- &lt;Answer&gt;
- &amp;lt;QuestionFormAnswers&amp;gt;
- <em class="replaceable"><code>[XML-encoded Answer data]</code></em>
- &amp;lt;/QuestionFormAnswers&amp;gt;
- &lt;/Answer&gt;
-&lt;/Assignment&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_DataStructuresArticle.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_AssignmentDataStructureArticle">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_HITDataStructureArticle.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>
View
70 aws_docs/ApiReference_BlockWorkerOperation.html
@@ -1,70 +0,0 @@
-<html xmlns:fo="http://www.w3.org/1999/XSL/Format"><head>
- <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
- <title>BlockWorker</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_AssignQualificationOperation.html" title="AssignQualification"><link rel="next" href="ApiReference_ChangeHITTypeOfHITOperation.html" title="ChangeHITTypeOfHIT"><!--[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">
- urchinTracker();
- </script><script xmlns="http://www.w3.org/1999/xhtml" type="text/javascript" src="frameset.js"> //
- </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_AssignQualificationOperation.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_BlockWorkerOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_ChangeHITTypeOfHITOperation.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>BlockWorker</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">BlockWorker</h1></div></div></div><a class="indexterm" name="d0e1682"></a><a class="indexterm" name="d0e1685"></a><a class="indexterm" name="d0e1690"></a><a class="indexterm" name="d0e1693"></a><a class="indexterm" name="d0e1696"></a><a class="indexterm" name="d0e1701"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e1706">Description</h2></div></div></div><p> The <code class="function">BlockWorker</code> operation allows you to prevent a Worker from
- working on your HITs. For example, you can block a Worker who is producing poor quality
- work. You can block up to 100,000 Workers. </p><p> You need the Worker ID to use this operation. You can get the Worker ID in the
- assignment data returned by a call to the <a class="link" href="ApiReference_GetAssignmentsForHITOperation.html" title="GetAssignmentsForHIT">GetAssignmentsForHIT</a>
- operation. If the Worker ID is missing or invalid, this operation returns with the
- failure message "WorkerId is invalid." If the Worker is already blocked, this operation
- returns successfully. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e1719">Request Parameters</h2></div></div></div><p> The <code class="function">BlockWorker</code> operation accepts parameters 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">BlockWorker</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>
- <p class="simpara">
- <em class="parameter"><code>Operation</code></em>
- </p>
- </td><td>
- <p class="simpara">The name of the operation</p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Valid Values: BlockWorker</p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>WorkerId</code></em>
- </p>
- </td><td>
- <p class="simpara"> The ID of the Worker to block. </p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>Reason</code></em>
- </p>
- </td><td>
- <p class="simpara"> A message explaining the reason for blocking the Worker. This
- parameter enables you to keep track of your Workers. The Worker does
- not see this message. </p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e1826">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">BlockWorker</code> operation returns with
- no errors. The response includes the elements described in the 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>
- <p class="simpara">
- <em class="parameter"><code>BlockWorkerResult</code></em>
- </p>
- </td><td>
- <p class="simpara"> Contains a <em class="parameter"><code>Request</code></em> element if the
- <strong class="userinput"><code>Request</code></strong>
- <em class="parameter"><code>ResposeGroup</code></em> is specified. </p>
- </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e1868">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">BlockWorker</code>
- operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e1876">Sample Request </h3></div></div></div><p>The following example blocks a Worker from working on your HITs.</p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
-&amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
-&amp;Version=2008-08-02
-&amp;Operation=BlockWorker
-&amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
-&amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
-&amp;WorkerId=AZ3456EXAMPLE
-&amp;Reason=After%20several%20warnings,%20he%20continued%20to%20submit%20answers%20without%20reading%20the%20instructions%20carefully.
- </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e1892">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;BlockWorkerResult&gt;
- &lt;Request&gt;
- &lt;IsValid&gt;True&lt;/IsValid&gt;
- &lt;/Request&gt;
-&lt;/BlockWorkerResult&gt;</pre></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e1899">Related Operations </h2></div></div></div><p> To unblock a Worker use the <a class="link" href="ApiReference_UnblockWorkerOperation.html" title="UnblockWorker">UnblockWorker</a> operation. </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_AssignQualificationOperation.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_BlockWorkerOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_ChangeHITTypeOfHITOperation.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>
View
68 aws_docs/ApiReference_ChangeHITTypeOfHITOperation.html
@@ -1,68 +0,0 @@
-<html xmlns:fo="http://www.w3.org/1999/XSL/Format"><head>
- <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
- <title>ChangeHITTypeOfHIT</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_BlockWorkerOperation.html" title="BlockWorker"><link rel="next" href="ApiReference_CreateHITOperation.html" title="CreateHIT"><!--[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">
- urchinTracker();
- </script><script xmlns="http://www.w3.org/1999/xhtml" type="text/javascript" src="frameset.js"> //
- </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_BlockWorkerOperation.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_ChangeHITTypeOfHITOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_CreateHITOperation.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>ChangeHITTypeOfHIT</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">ChangeHITTypeOfHIT</h1></div></div></div><a class="indexterm" name="d0e1911"></a><a class="indexterm" name="d0e1914"></a><a class="indexterm" name="d0e1919"></a><a class="indexterm" name="d0e1924"></a><a class="indexterm" name="d0e1929"></a><a class="indexterm" name="d0e1934"></a><a class="indexterm" name="d0e1941"></a><a class="indexterm" name="d0e1944"></a><a class="indexterm" name="d0e1949"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e1954">Description</h2></div></div></div><p> The <code class="function">ChangeHITTypeOfHIT</code> operation allows you to change the
- <em class="parameter"><code>HITType</code></em> properties of a HIT. This operation disassociates the
- HIT from its old <em class="parameter"><code>HITType</code></em> properties and associates it with the
- new <em class="parameter"><code>HITType</code></em> properties. The HIT takes on the properties of the
- new <em class="parameter"><code>HITType</code></em> in place of the old ones. For more information about
- HIT types, see
-<a class="ulink" href="http://docs.amazonwebservices.com/AWSMechTurk/2008-08-02/DG/index.html?Concepts_HITTypesArticle.html" target="_blank">HIT Types</a>. </p><p> You can use <code class="function">ChangeHITTypeOfHIT</code> to update any of the <em class="parameter"><code>HITType</code></em> properties of a HIT. All properties except for <em class="parameter"><code>Reward</code></em> can be updated at any time. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e1988">Request Parameters</h2></div></div></div><p> The <code class="function">ChangeHITTypeOfHIT</code> operation accepts parameters 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">ChangeHITTypeOfHIT</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>
- <p class="simpara">
- <em class="parameter"><code>Operation</code></em>
- </p>
- </td><td>
- <p class="simpara">The name of the operation</p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Valid Values: ChangeHITTypeOfHIT</p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>HITId</code></em>
- </p>
- </td><td>
- <p class="simpara">The ID of the HIT to change</p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>HITTypeId</code></em>
- </p>
- </td><td>
- <p class="simpara">The ID of the new HIT type</p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e2095">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">ChangeHITTypeOfHIT</code> operation
- returns with no errors. The response includes the elements described in the 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>
- <p class="simpara">
- <em class="parameter"><code>ChangeHITTypeOfHITResult</code></em>
- </p>
- </td><td>
- <p class="simpara"> Contains a <em class="parameter"><code>Request</code></em> element if the
- <strong class="userinput"><code>Request</code></strong>
- <em class="parameter"><code>ResposeGroup</code></em> is specified. </p>
- </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e2137">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">ChangeHITTypeOfHIT</code>
- operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e2145">Sample Request</h3></div></div></div><p>The following example changes the HIT type.</p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
-&amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
-&amp;Version=2008-08-02
-&amp;Operation=ChangeHITTypeOfHIT
-&amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
-&amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
-&amp;HITId=123RVWYBAZW00EXAMPLE
-&amp;HITTypeId=T100CN9P324W00EXAMPLE
- </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e2161">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;ChangeHITTypeOfHITResult&gt;
- &lt;Request&gt;
- &lt;IsValid&gt;True&lt;/IsValid&gt;
- &lt;/Request&gt;
-&lt;/ChangeHITTypeOfHITResult&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_BlockWorkerOperation.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_ChangeHITTypeOfHITOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_CreateHITOperation.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>
View
119 aws_docs/ApiReference_CommonParametersArticle.html
@@ -1,119 +0,0 @@
-<html xmlns:fo="http://www.w3.org/1999/XSL/Format"><head>
- <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
- <title>Chapter&nbsp;4.&nbsp;Common Parameters</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_WsdlLocationArticle.html" title="Chapter&nbsp;3.&nbsp;WSDL and Schema Locations"><link rel="next" href="ApiReference_OperationsArticle.html" title="Chapter&nbsp;5.&nbsp;Operations"><!--[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">
- urchinTracker();
- </script><script xmlns="http://www.w3.org/1999/xhtml" type="text/javascript" src="frameset.js"> //
- </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_WsdlLocationArticle.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_CommonParametersArticle">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_OperationsArticle.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>Common Parameters</strong></div></div><div class="chapter" lang="en" id="ApiReference_CommonParametersArticle"><div class="titlepage"><div><div><h1 class="topictitle">Common Parameters</h1></div></div></div><a class="indexterm" name="d0e693"></a><a class="indexterm" name="d0e698"></a><a class="indexterm" name="d0e701"></a><a class="indexterm" name="d0e704"></a><a class="indexterm" name="d0e707"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e710">Introduction</h2></div></div></div><p> The Amazon Mechanical Turk Service accepts a set of parameters in the request common to every
- operation. Each required parameter must be included in a request for the request to be successful. </p><p> Parameters common to all operations are explained here. For more information about the
- parameters for a specific operation, see the description of the operation in the <a class="link" href="ApiReference_OperationsArticle.html" title="Chapter&nbsp;5.&nbsp;Operations">Operations</a>
- section of this reference. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e719">Common Request Parameters</h2></div></div></div><p> Requests to the Amazon Mechanical Turk service can include the parameters described in the
- following table. Required parameters must be included with each request 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>
- <p class="simpara">
- <em class="parameter"><code>AWSAccessKeyId</code></em>
- </p>
- </td><td>
- <p class="simpara"> The Requester's Access Key ID, a unique identifier that corresponds to a
- Secret Access Key and an Amazon.com account. </p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>Service</code></em>
- </p>
- </td><td>
- <p class="simpara">The name of the Amazon Web Services service.</p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Valid Values: AWSMechanicalTurkRequester</p>
- <p class="simpara">Default: None</p>
- <p class="simpara">Constraints: For REST requests only.</p>
- <p class="simpara"> For SOAP requests the name of the service is part of the SOAP entry
- point, and does not need to bespecified in the request. </p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>Operation</code></em>
- </p>
- </td><td>
- <p class="simpara">The name of the operation</p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Default: None</p>
- <p class="simpara">Contraints: For REST requests only</p>
- <p class="simpara"> For SOAP requests, the operation name is part of the SOAP message
- structure provided by your SOAP toolkit, and is not part of the request.
- </p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>Signature</code></em>
- </p>
- </td><td>
- <p class="simpara"> The signature for this request, an encrypted string calculated from
- elements of the request and the AWS access key that corresponds to your AWS
- Access Key ID. For information about how to calculate a
- <em class="parameter"><code>Signature</code></em>, see MakingRequests_RequestAuthenticationArticle. </p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>Timestamp</code></em>
- </p>
- </td><td>
- <p class="simpara"> The current time on your system. This value is included to validate
- against the <em class="parameter"><code>Signature</code></em> parameter. </p>
- <p class="simpara"> Type: a <a class="ulink" href="http://www.w3.org/TR/xmlschema-2/#dateTime" target="_blank">dateTime</a> in the Coordinated Universal Time (Greenwich Mean Time) time
- zone, such as <strong class="userinput"><code>2005-01-31T23:59:59Z</code></strong>. </p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>ResponseGroup</code></em>
- </p>
- </td><td>
- <p class="simpara">A list of response groups</p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>Version</code></em>
- </p>
- </td><td>
- <p class="simpara">Specifies what version of the API to use.</p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Default: None. If not specified, the latest version of the API is used.</p>
- <p class="simpara">Constraints: Used only for REST requests</p>
- </td><td>
- <p class="simpara">No</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>Validate</code></em>
- </p>
- </td><td>
- <p class="simpara"> If specified, instructs the service to <span class="emphasis"><em>not</em></span> perform
- the operation, and only return information about whether or not the request is
- valid. </p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Default: None. If not specified, the service executes the requested
- operation.</p>
- </td><td>
- <p class="simpara">No</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>Credential</code></em>
- </p>
- </td><td>
- <p class="simpara">This parameter is reserved for future use.</p>
- <p class="simpara">Type: None</p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">Not used</p>
- </td></tr></tbody></table></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_WsdlLocationArticle.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_CommonParametersArticle">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_OperationsArticle.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>
View
330 aws_docs/ApiReference_CreateHITOperation.html
@@ -1,330 +0,0 @@
-<html xmlns:fo="http://www.w3.org/1999/XSL/Format"><head>
- <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
- <title>CreateHIT</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_ChangeHITTypeOfHITOperation.html" title="ChangeHITTypeOfHIT"><link rel="next" href="ApiReference_CreateQualificationTypeOperation.html" title="CreateQualificationType"><!--[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">
- urchinTracker();
- </script><script xmlns="http://www.w3.org/1999/xhtml" type="text/javascript" src="frameset.js"> //
- </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_ChangeHITTypeOfHITOperation.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_CreateHITOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_CreateQualificationTypeOperation.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>CreateHIT</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">CreateHIT</h1></div></div></div><a class="indexterm" name="d0e2172"></a><a class="indexterm" name="d0e2175"></a><a class="indexterm" name="d0e2180"></a><a class="indexterm" name="d0e2185"></a><a class="indexterm" name="d0e2190"></a><a class="indexterm" name="d0e2193"></a><a class="indexterm" name="d0e2198"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e2203">Description</h2></div></div></div><p> The <code class="function">CreateHIT</code> operation creates a new HIT. The new HIT is made
- available for Workers to find and accept on the Amazon Mechanical Turk web site. </p><p> There are two ways to call the <code class="function">CreateHIT</code> operation: with the HIT
- type ID, or with the common property values. If the <em class="parameter"><code>HITTypeId</code></em>
- parameter is specified, the <code class="function">CreateHIT</code> operation assumes the syntax
- with a HIT type ID is what you intended. If you accidentally provide both a HIT type ID
- and values for the common properties, the common property values will be ignored.
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e2222">Request Parameters</h2></div></div></div><p> The <code class="function">CreateHIT</code> operation accepts parameters 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 tables describe the additonal parameters required to call the <code class="function">CreateHIT</code> operation with an explicit HIT type ID and without a HIT type
- ID. </p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e2238">Calling <code class="function">CreateHIT</code> with a HIT Type ID</h3></div></div></div><p> The following parameters are specific to calling the <code class="function">CreateHIT</code> operation with an explicit HIT type ID: </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>
- <p class="simpara">
- <em class="parameter"><code>Operation</code></em>
- </p>
- </td><td>
- <p class="simpara">The name of the operation</p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Valid Values: CreateHIT</p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>HITTypeId</code></em>
- </p>
- </td><td>
- <p class="simpara">The HIT type ID</p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>Question</code></em>
- </p>
- </td><td>
- <p class="simpara"> The data the person completing the HIT uses to produce the
- results. </p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Default: None</p>
- <p class="simpara"> Constraints: must be a <a class="link" href="ApiReference_QuestionFormDataStructureArticle.html" title="QuestionForm">
- QuestionForm</a> data structure or an <a class="link" href="ApiReference_ExternalQuestionArticle.html" title="ExternalQuestion">
- ExternalQuestion</a> data structure. The XML Question
- data must not be larger than 64 kilobytes (65,535 bytes) in
- size, including whitespace. </p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>LifetimeInSeconds</code></em>
- </p>
- </td><td>
- <p class="simpara"> The number of seconds after which the HIT is no longer
- available for users to accept. After the lifetime of the HIT has
- elapsed, the HIT no longer appears in HIT searches, even if not
- all of the HIT's assignments have been accepted. </p>
- <p class="simpara">Type: positive integer</p>
- <p class="simpara"> Valid Values: any integer between 30 (30 seconds) and
- 31536000 (365 days). </p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>MaxAssignments</code></em>
- </p>
- </td><td>
- <p class="simpara"> The number of times the HIT can be accepted and completed
- before the HIT becomes unavailable. </p>
- <p class="simpara">Type: positive integer</p>
- <p class="simpara"> Valid Values: any integer between 1 and 1000000000 (1
- billion). </p>
- <p class="simpara">Default: 1</p>
- </td><td>
- <p class="simpara">No</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>RequesterAnnotation</code></em>
- </p>
- </td><td>
- <p class="simpara"> An arbitrary data field. The <em class="parameter"><code>RequesterAnnotation</code></em> parameter lets your
- application attach arbitrary data to the HIT for tracking
- purposes. For example, this parameter could be an identifier
- internal to the Requester's application that corresponds with
- the HIT. </p>
- <p class="simpara"> The <em class="parameter"><code>RequesterAnnotation</code></em> parameter
- for a HIT is only visible to the Requester who created the HIT.
- It is not shown to the Worker, or any other Requester. </p>
- <p class="simpara"> The <em class="parameter"><code>RequesterAnnotation</code></em> paramter
- may be different for each HIT you submit. It does not affect how
- your HITs are grouped. </p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Default: None</p>
- <p class="simpara">Constraints: must not be longer than 255
- characters</p>
- </td><td>
- <p class="simpara">No</p>
- </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e2449">Calling <code class="function">CreateHIT</code> Without a HIT Type ID</h3></div></div></div><p> The following parameters are specific to calling the <code class="function">CreateHIT</code> operation without a HIT type ID, letting Amazon Mechanical
- Turk determine the HIT type from the property values: </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>
- <p class="simpara">
- <em class="parameter"><code>Operation</code></em>
- </p>
- </td><td>
- <p class="simpara">The name of the operation</p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Valid Values: CreateHIT</p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>Title</code></em>
- </p>
- </td><td>
- <p class="simpara"> The title of the HIT. A title should be short and
- descriptive about the kind of task the HIT contains. On the
- Amazon Mechanical Turk web site, the HIT title appears in search
- results, and everywhere the HIT is mentioned. </p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Default: None</p>
- <p class="simpara">Constraints: must not be more than 128 characters</p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>Description</code></em>
- </p>
- </td><td>
- <p class="simpara"> A general description of the HIT. A description includes
- detailed information about the kind of task the HIT contains. On
- the Amazon Mechanical Turk web site, the HIT description appears
- in the expanded view of search results, and in the HIT and
- assignment screens. A good description gives the user enough
- information to evaluate the HIT before accepting it. </p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Default: None</p>
- <p class="simpara">Constraints: cannot be more than 2,000 characters in
- length</p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>Question</code></em>
- </p>
- </td><td>
- <p class="simpara"> The data the person completing the HIT uses to produce the
- results. </p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Default: None</p>
- <p class="simpara"> Constraints: Must be a <a class="link" href="ApiReference_QuestionFormDataStructureArticle.html" title="QuestionForm">
- QuestionForm</a> data structure or an <a class="link" href="ApiReference_ExternalQuestionArticle.html" title="ExternalQuestion">
- ExternalQuestion</a> data structure. The XML Question
- data must not be larger than 64 kilobytes (65,535 bytes) in
- size, including whitespace. </p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>Reward</code></em>
- </p>
- </td><td>
- <p class="simpara"> The amount of money the Requester will pay a Worker for
- successfully completing the HIT. </p>
- <p class="simpara"> Type: <a class="link" href="ApiReference_PriceDataStructureArticle.html" title="Price">Price</a> data structure. </p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>AssignmentDurationInSeconds</code></em>
- </p>
- </td><td>
- <p class="simpara"> The amount of time, in seconds, that a Worker has to
- complete the HIT after accepting it. If a Worker does not
- complete the assignment within the specified duration, the
- assignment is considered abandoned. If the HIT is still active
- (that is, its lifetime has not elapsed), the assignment becomes
- available for other users to find and accept. </p>
- <p class="simpara">Type: positive integer</p>
- <p class="simpara"> Valid Values: any integer between 30 (30 seconds) and
- 31536000 (365 days). </p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>LifetimeInSeconds</code></em>
- </p>
- </td><td>
- <p class="simpara"> An amount of time, in seconds, after which the HIT is no
- longer available for users to accept. After the lifetime of the
- HIT elapses, the HIT no longer appears in HIT searches, even if
- not all of the assignments for the HIT have been accepted. </p>
- <p class="simpara">Type: positive integer</p>
- <p class="simpara"> Valid Values: any integer between 30 (30 seconds) and
- 31536000 (365 days). </p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>Keywords</code></em>
- </p>
- </td><td>
- <p class="simpara"> One or more words or phrases that describe the HIT,
- separated by commas. These words are used in searches to find
- HITs. </p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Default: None</p>
- <p class="simpara"> Constraints: The complete string of keywords, including
- commas and spaces, canot be more than 1,000 characters.
- </p>
- </td><td>
- <p class="simpara">No</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>MaxAssignments</code></em>
- </p>
- </td><td>
- <p class="simpara"> The number of times the HIT can be accepted and completed
- before the HIT becomes unavailable. </p>
- <p class="simpara">Type: positive integer</p>
- <p class="simpara">Valid Values: any integer between 1 and 1000000000 (1
- billion).</p>
- <p class="simpara">Default: 1</p>
- </td><td>
- <p class="simpara">No</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>AutoApprovalDelayInSeconds</code></em>
- </p>
- </td><td>
- <p class="simpara"> The number of seconds after an assignment for the HIT has
- been submitted, after which the assignment is considered
- <span class="guilabel">Approved</span> automatically unless the
- Requester explicitly rejects it. </p>
- <p class="simpara">Type: non-negative integer</p>
- <p class="simpara"> Valid Values: any integer between 0 (auto-approve results
- as soon as they are submitted) and 2592000 (30 days). </p>
- <p class="simpara">Default: 2592000 (30 days)</p>
- </td><td>
- <p class="simpara">No</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>QualificationRequirement</code></em>
- </p>
- </td><td>
- <p class="simpara"> A condition that a Worker's Qualifications must meet
- before the Worker is allowed to accept and complete the HIT. </p>
- <p class="simpara"> Type: a <a class="link" href="ApiReference_QualificationRequirementDataStructureArticle.html" title="QualificationRequirement">QualificationRequirement</a> data structure. </p>
- <p class="simpara">Default: None</p>
- <p class="simpara"> Constraints: there can be no more than 10 <em class="parameter"><code>QualificationRequirement</code></em> data structures for
- each HIT. </p>
- </td><td>
- <p class="simpara">No</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>RequesterAnnotation</code></em>
- </p>
- </td><td>
- <p class="simpara"> An arbitrary data field. The <em class="parameter"><code>RequesterAnnotation</code></em> parameter lets your
- application attach arbitrary data to the HIT for tracking
- purposes. For example, the <em class="parameter"><code>RequesterAnnotation</code></em> parameter could be an
- identifier internal to the Requester's application that
- corresponds with the HIT. </p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Default: None</p>
- <p class="simpara">Constraints: must not be longer than 255
- characters</p>
- </td><td>
- <p class="simpara">No</p>
- </td></tr></tbody></table></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e2831">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">CreateHIT</code> operation includes the
- elements described in the following table. </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>
- <p class="simpara">
- <em class="parameter"><code>HIT</code></em>
- </p>
- </td><td>
- <p class="simpara"> Contains the newly created HIT data. For a description of the
- HIT data structure as it appears in responses, see the <a class="link" href="ApiReference_HITDataStructureArticle.html" title="HIT"> HIT Data
- Structure</a>. </p>
- </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e2867">Examples</h2></div></div></div><p>The following examples show how to use the <code class="function">CreateHIT</code>
- operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e2875">Sample Request</h3></div></div></div><p>The following are examples of REST requests. </p><div class="example"><a name="d0e2880"></a><p class="title"><b>Example Request (Query) Using CreateHIT with a HIT Type ID</b></p><div class="example-contents"><p> The following example creates a simple HIT, using an explicit HIT type ID.
- The <em class="parameter"><code>Question</code></em> parameter takes a block of XML data as its
- value. See the <a class="link" href="ApiReference_QuestionFormDataStructureArticle.html" title="QuestionForm">
- QuestionForm</a> data structure and the<a class="link" href="ApiReference_ExternalQuestionArticle.html" title="ExternalQuestion"> ExternalQuestion</a> data
- structure for more information. </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
-&amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
-&amp;Version=2008-08-02
-&amp;Operation=CreateHIT
-&amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
-&amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
-&amp;HITTypeId=T100CN9P324W00EXAMPLE
-&amp;Question=<em class="replaceable"><code>[URL-encoded question data]</code></em>
-&amp;LifetimeInSeconds=604800
- </pre></div></div><br class="example-break"><div class="example"><a name="d0e2908"></a><p class="title"><b>Example Request (Query) Using CreateHIT Without a HIT Type ID</b></p><div class="example-contents"><p> The following example creates a simple HIT with some properties, letting
- Amazon Mechanical Turk determine the HIT type ID from the property values. The
- <em class="parameter"><code>Question</code></em> parameter takes a block of XML data as its
- value. See the <a class="link" href="ApiReference_QuestionFormDataStructureArticle.html" title="QuestionForm">
- QuestionForm</a> data structure and the<a class="link" href="ApiReference_ExternalQuestionArticle.html" title="ExternalQuestion"> ExternalQuestion</a> data
- structure for more information. </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
-&amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
-&amp;Version=2008-08-02
-&amp;Operation=CreateHIT
-&amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
-&amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
-&amp;Title=Location%20and%20Photograph%20Identification
-&amp;Description=Select%20the%20image%20that%20best%20represents...
-&amp;Reward.1.Amount=5
-&amp;Reward.1.CurrencyCode=USD
-&amp;Question=<em class="replaceable"><code>[URL-encoded question data]</code></em>
-&amp;AssignmentDurationInSeconds=30
-&amp;LifetimeInSeconds=604800
-&amp;Keywords=location,%20photograph,%20image,%20identification,%20opinion
- </pre></div></div><br class="example-break"></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e2936">Sample Response</h3></div></div></div><p>Amazon Mechanical Turk might return the following response for either of the preceeding requests.</p><pre class="programlisting">&lt;CreateHITResponse&gt;
- &lt;OperationRequest&gt;
- &lt;RequestId&gt;ece2785b-6292-4b12-a60e-4c34847a7916&lt;/RequestId&gt;
- &lt;/OperationRequest&gt;
- &lt;HIT&gt;
- &lt;Request&gt;
- &lt;IsValid&gt;True&lt;/IsValid&gt;
- &lt;/Request&gt;
- &lt;HITId&gt;GBHZVQX3EHXZ2AYDY2T0&lt;/HITId&gt;
- &lt;HITTypeId&gt;NYVZTQ1QVKJZXCYZCZVZ&lt;/HITTypeId&gt;
- &lt;/HIT&gt;
-&lt;/CreateHITResponse&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_ChangeHITTypeOfHITOperation.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_CreateHITOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_CreateQualificationTypeOperation.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>
View
190 aws_docs/ApiReference_CreateQualificationTypeOperation.html
@@ -1,190 +0,0 @@
-<html xmlns:fo="http://www.w3.org/1999/XSL/Format"><head>
- <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
- <title>CreateQualificationType</title><link rel="stylesheet" href="aws-docs-IE.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><link rel="home" href="#top" title="Amazon Mechanical Turk"><link rel="up" href="ApiReference_OperationsArticle.html" title="Chapter&nbsp;5.&nbsp;Operations"><link rel="prev" href="ApiReference_CreateHITOperation.html" title="CreateHIT"><link rel="next" href="ApiReference_DisableHITOperation.html" title="DisableHIT"><!--[if !IE]>--><link rel="stylesheet" href="aws-docs.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><!--<![endif]--><meta xmlns="http://www.w3.org/1999/xhtml" http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><script src="/urchin.js" type="text/javascript"></script><script type="text/javascript">
- urchinTracker();
- </script><script xmlns="http://www.w3.org/1999/xhtml" type="text/javascript" src="frameset.js"> //
- </script></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header" cellspacing="0" cellpadding="2"><tr><td width="30%" align="left"><a accesskey="p" href="ApiReference_CreateHITOperation.html"><img src="images/prev.gif" alt="Prev"></a> </td><td width="40%" align="center"><a href="http://survey.amazonwebservices.com/survey/s?s=559&amp;opdata_page=Mturk_API_2008-08-02_ApiReference_CreateQualificationTypeOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_DisableHITOperation.html"><img src="images/next.gif" alt="Next"></a></td></tr></table><div class="breadcrumb"><a href="Welcome.html">Welcome</a><a href=""></a> &raquo; <a href="ApiReference_OperationsArticle.html">Operations</a> &raquo; <strong>CreateQualificationType</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">CreateQualificationType</h1></div></div></div><a class="indexterm" name="d0e2947"></a><a class="indexterm" name="d0e2950"></a><a class="indexterm" name="d0e2955"></a><a class="indexterm" name="d0e2962"></a><a class="indexterm" name="d0e2967"></a><a class="indexterm" name="d0e2972"></a><a class="indexterm" name="d0e2977"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e2982">Description</h2></div></div></div><p> The <code class="function">CreateQualificationType</code> operation creates a new
- Qualification type. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e2990">Request Parameters</h2></div></div></div><p>
- <code class="function">CreateQualificationType</code> accepts parameters 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">CreateQualificationType</code> operation: </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col><col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>
- <p class="simpara">
- <em class="parameter"><code>Operation</code></em>
- </p>
- </td><td>
- <p class="simpara">The name of the operation</p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Valid Values: CreateQualificationType</p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p>Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>Name</code></em>
- </p>
- </td><td>
- <p class="simpara"> The name you give to the Qualification type. The type name is
- used to represent the Qualification to Workers, and to find the type
- using a Qualification type search. </p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Default: None</p>
- <p class="simpara">Constraints: must be unique across all of your Qualification
- types.</p>
- </td><td>
- <p>Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>Description</code></em>
- </p>
- </td><td>
- <p class="simpara"> A long description for the Qualification type. On the Amazon
- Mechanical Turk web site, the long description is displayed when a
- user examines a Qualification type. </p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Default: None</p>
- <p class="simpara">Constraints: Must be less than or equal to 2000
- characters.</p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>Keywords</code></em>
- </p>
- </td><td>
- <p class="simpara"> One or more words or phrases that describe the Qualification
- type, separated by commas. The Keywords of a type make the type
- easier to find during a search. </p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Default: None</p>
- <p class="simpara">Constraints: Must be less than or equal to 1000 characters,
- including commas and spaces.</p>
- </td><td>
- <p class="simpara">No</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>RetryDelayInSeconds</code></em>
- </p>
- </td><td>
- <p class="simpara"> The number of seconds after requesting a Qualification of the
- Qualification type that a user must wait before that user can
- request it again. </p>
- <p class="simpara">Type: non-negative integer</p>
- <p class="simpara"> Default: None. If not specified, retrys are disabled and users
- can request a Qualficiation of this type only once, even if the user
- has not been granted the Qualification. </p>
- </td><td>
- <p class="simpara">No</p>
- </td></tr><tr><td>
- <p>
- <em class="parameter"><code>QualificationTypeStatus</code></em>
- </p>
- </td><td>
- <p class="simpara"> The initial status of the Qualification type. </p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Valid Values: Active | Inactive</p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>Test</code></em>
- </p>
- </td><td>
- <p class="simpara"> The questions for the Qualification test a user must answer
- correctly to obtain a Qualification of this type. </p>
- <p class="simpara"> If this parameter is specified, <em class="parameter"><code>TestDurationInSeconds</code></em> must also be specified. </p>
- <p class="simpara"> Type: String. </p>
- <p class="simpara"> Default: None. If not specified, the user may request the
- Qualification without answering any questions. </p>
- <p class="simpara"> Constraints: must be a <a class="link" href="ApiReference_QuestionFormDataStructureArticle.html" title="QuestionForm">QuestionForm</a> data structure. This parameter cannot be
- specified if <em class="parameter"><code>AutoGranted</code></em> is
- <code class="code">true</code>. </p>
- </td><td>
- <p class="simpara">No</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>AnswerKey</code></em>
- </p>
- </td><td>
- <p class="simpara"> The answers to the Qualification test specified in the
- <em class="parameter"><code>Test</code></em> parameter, in the form of an <a class="link" href="ApiReference_AnswerKeyDataStructureArticle.html" title="AnswerKey">AnswerKey</a> data structure. </p>
- <p class="simpara"> Type: String </p>
- <p class="simpara">Default: None. If not specified, you must process Qualification
- requests manually.</p>
- </td><td>
- <p class="simpara">No</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>TestDurationInSeconds</code></em>
- </p>
- </td><td>
- <p class="simpara"> The number of seconds the user has to complete the
- Qualification test, starting at the time the user requests the
- Qualification. </p>
- <p class="simpara">Type: Integer</p>
- <p class="simpara">Valid Values: Positive integer</p>
- <p class="simpara">Default: None</p>
- <p class="simpara"> Conditions: Required if the <em class="parameter"><code>Test</code></em>
- parameter is specified. </p>
- </td><td>
- <p class="simpara">Conditional</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>AutoGranted</code></em>
- </p>
- </td><td>
- <p class="simpara"> Specifies whether requests for the Qualification type are
- granted immediately, without prompting the Worker with a
- Qualification test.</p>
- <p class="simpara">Type: Boolean</p>
- <p class="simpara">Valid Values: <code class="code">true</code> | <code class="code">false</code></p>
- <p class="simpara">Default: None</p>
- <p class="simpara"> Constraints: If the <em class="parameter"><code>Test</code></em> parameter is
- specified, this parameter cannot be <code class="code">true</code>. </p>
- </td><td>
- <p class="simpara">No</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>AutoGrantedValue</code></em>
- </p>
- </td><td>
- <p class="simpara"> The Qualification value to use for automatically granted
- Qualifications. This parameter is used only if the <em class="parameter"><code>AutoGranted</code></em> parameter is <code class="code">true</code>. </p>
- <p class="simpara">Type: Integer</p>
- <p class="simpara">Default: 1</p>
- </td><td>
- <p class="simpara">No</p>
- </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e3366">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">CreateQualificaionType</code> operation
- includes the elements found in the following table: </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>
- <p class="simpara">
- <em class="parameter"><code>QualificationType</code></em>
- </p>
- </td><td>
- <p class="simpara"> The created Qualification type. </p>
- <p class="simpara"> Type: a <a class="link" href="ApiReference_QualificationTypeDataStructureArticle.html" title="QualificationType">QualificationType</a> data structure. </p>
- </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e3405">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">CreateQualificaionType</code>
- operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e3413">Sample Request</h3></div></div></div><p>The following example creates a Qualification type.</p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
-&amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
-&amp;Version=2008-08-02
-&amp;Operation=CreateQualificationType
-&amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
-&amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
-&amp;Name=EnglishWritingAbility
-&amp;Description=The%20ability%20to%20write%20and%20edit%20text...
-&amp;QualificationTypeStatus=Active
- </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e3429">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;CreateQualificationTypeResponse&gt;
- &lt;OperationRequest&gt;
- &lt;RequestId&gt;5218189c-1d7e-49a3-abbf-672fb5e77c66&lt;/RequestId&gt;
- &lt;/OperationRequest&gt;
- &lt;QualificationType&gt;
- &lt;Request&gt;
- &lt;IsValid&gt;True&lt;/IsValid&gt;
- &lt;/Request&gt;
- &lt;QualificationTypeId&gt;ZSPJXD4F1SFZP7YNJWR0&lt;/QualificationTypeId&gt;
- &lt;CreationTime&gt;2009-07-13T17:26:33Z&lt;/CreationTime&gt;
- &lt;Name&gt;SampleQualificationTest&lt;/Name&gt;
- &lt;Description&gt;Description of my qualification test.&lt;/Description&gt;
- &lt;QualificationTypeStatus&gt;Active&lt;/QualificationTypeStatus&gt;
- &lt;AutoGranted&gt;0&lt;/AutoGranted&gt;
- &lt;/QualificationType&gt;
-&lt;/CreateQualificationTypeResponse&gt;</pre></div></div></div><div class="navfooter"><table width="100%" summary="Navigation footer" cellspacing="0" cellpadding="2"><tr><td width="30%" align="left"><a accesskey="p" href="ApiReference_CreateHITOperation.html"><img src="images/prev.gif" alt="Prev"></a> </td><td width="40%" align="center"><a href="http://survey.amazonwebservices.com/survey/s?s=559&amp;opdata_page=Mturk_API_2008-08-02_ApiReference_CreateQualificationTypeOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_DisableHITOperation.html"><img src="images/next.gif" alt="Next"></a></td></tr><tr><td width="30%" align="left" valign="top">&nbsp;</td><td width="40%" align="center"><a accesskey="h" href="#top"><img src="images/home.gif" alt="Home"></a></td><td width="30%" align="right" valign="top">&nbsp;</td></tr></table></div></body></html>
View
7 aws_docs/ApiReference_DataStructuresArticle.html
@@ -1,7 +0,0 @@
-<html xmlns:fo="http://www.w3.org/1999/XSL/Format"><head>
- <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
- <title>Chapter&nbsp;6.&nbsp;Data Structures</title><link rel="stylesheet" href="aws-docs-IE.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><link rel="home" href="#top" title="Amazon Mechanical Turk"><link rel="up" href="#top" title="Amazon Mechanical Turk"><link rel="prev" href="ApiReference_UpdateQualificationTypeOperation.html" title="UpdateQualificationType"><link rel="next" href="ApiReference_AssignmentDataStructureArticle.html" title="Assignment"><!--[if !IE]>--><link rel="stylesheet" href="aws-docs.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><!--<![endif]--><meta xmlns="http://www.w3.org/1999/xhtml" http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><script src="/urchin.js" type="text/javascript"></script><script type="text/javascript">
- urchinTracker();
- </script><script xmlns="http://www.w3.org/1999/xhtml" type="text/javascript" src="frameset.js"> //
- </script></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header" cellspacing="0" cellpadding="2"><tr><td width="30%" align="left"><a accesskey="p" href="ApiReference_UpdateQualificationTypeOperation.html"><img src="images/prev.gif" alt="Prev"></a> </td><td width="40%" align="center"><a href="http://survey.amazonwebservices.com/survey/s?s=559&amp;opdata_page=Mturk_API_2008-08-02_ApiReference_DataStructuresArticle">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_AssignmentDataStructureArticle.html"><img src="images/next.gif" alt="Next"></a></td></tr></table><div class="breadcrumb"><a href="Welcome.html">Welcome</a><a href=""></a> &raquo; <strong>Data Structures</strong></div></div><div class="chapter" lang="en" id="ApiReference_DataStructuresArticle"><div class="titlepage"><div><div><h1 class="topictitle">Data Structures</h1></div></div></div><a class="indexterm" name="d0e13730"></a><div class="highlights"><p><strong>Topics</strong></p><ul><li><a href="ApiReference_AssignmentDataStructureArticle.html">Assignment</a></li><li><a href="ApiReference_HITDataStructureArticle.html">HIT</a></li><li><a href="ApiReference_LocaleDataStructureArticle.html">Locale</a></li><li><a href="ApiReference_PriceDataStructureArticle.html">Price</a></li><li><a href="ApiReference_QualificationDataStructureArticle.html">Qualification</a></li><li><a href="ApiReference_QualificationRequestDataStructureArticle.html">QualificationRequest</a></li><li><a href="ApiReference_QualificationRequirementDataStructureArticle.html">QualificationRequirement</a></li><li><a href="ApiReference_QualificationTypeDataStructureArticle.html">QualificationType</a></li><li><a href="ApiReference_NotificationDataStructureArticle.html">Notification</a></li></ul></div><p> The Amazon Mechanical Turk Service API uses several common data structures in its operation request and
- response structures. For easy reference, these structures are documented in separate articles. For more information, refer to their corresponding operations.</p></div><div class="navfooter"><table width="100%" summary="Navigation footer" cellspacing="0" cellpadding="2"><tr><td width="30%" align="left"><a accesskey="p" href="ApiReference_UpdateQualificationTypeOperation.html"><img src="images/prev.gif" alt="Prev"></a> </td><td width="40%" align="center"><a href="http://survey.amazonwebservices.com/survey/s?s=559&amp;opdata_page=Mturk_API_2008-08-02_ApiReference_DataStructuresArticle">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_AssignmentDataStructureArticle.html"><img src="images/next.gif" alt="Next"></a></td></tr><tr><td width="30%" align="left" valign="top">&nbsp;</td><td width="40%" align="center"><a accesskey="h" href="#top"><img src="images/home.gif" alt="Home"></a></td><td width="30%" align="right" valign="top">&nbsp;</td></tr></table></div></body></html>
View
63 aws_docs/ApiReference_DisableHITOperation.html
@@ -1,63 +0,0 @@
-<html xmlns:fo="http://www.w3.org/1999/XSL/Format"><head>
- <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
- <title>DisableHIT</title><link rel="stylesheet" href="aws-docs-IE.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><link rel="home" href="#top" title="Amazon Mechanical Turk"><link rel="up" href="ApiReference_OperationsArticle.html" title="Chapter&nbsp;5.&nbsp;Operations"><link rel="prev" href="ApiReference_CreateQualificationTypeOperation.html" title="CreateQualificationType"><link rel="next" href="ApiReference_DisposeHITOperation.html" title="DisposeHIT"><!--[if !IE]>--><link rel="stylesheet" href="aws-docs.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><!--<![endif]--><meta xmlns="http://www.w3.org/1999/xhtml" http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><script src="/urchin.js" type="text/javascript"></script><script type="text/javascript">
- urchinTracker();
- </script><script xmlns="http://www.w3.org/1999/xhtml" type="text/javascript" src="frameset.js"> //
- </script></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header" cellspacing="0" cellpadding="2"><tr><td width="30%" align="left"><a accesskey="p" href="ApiReference_CreateQualificationTypeOperation.html"><img src="images/prev.gif" alt="Prev"></a> </td><td width="40%" align="center"><a href="http://survey.amazonwebservices.com/survey/s?s=559&amp;opdata_page=Mturk_API_2008-08-02_ApiReference_DisableHITOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_DisposeHITOperation.html"><img src="images/next.gif" alt="Next"></a></td></tr></table><div class="breadcrumb"><a href="Welcome.html">Welcome</a><a href=""></a> &raquo; <a href="ApiReference_OperationsArticle.html">Operations</a> &raquo; <strong>DisableHIT</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">DisableHIT</h1></div></div></div><a class="indexterm" name="d0e3440"></a><a class="indexterm" name="d0e3443"></a><a class="indexterm" name="d0e3448"></a><a class="indexterm" name="d0e3453"></a><a class="indexterm" name="d0e3458"></a><a class="indexterm" name="d0e3461"></a><a class="indexterm" name="d0e3464"></a><a class="indexterm" name="d0e3467"></a><a class="indexterm" name="d0e3472"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e3477">Description</h2></div></div></div><p> The <code class="function">DisableHIT</code> operation removes a HIT from the Amazon
- Mechanical Turk marketplace, approves all submitted assignments that have not already
- been approved or rejected, and disposes of the HIT and all assignment data. </p><p> Assignments for the HIT that have already been submitted, but not yet approved or
- rejected, are automatically approved. Assignments in progress at the time of the call to
- the <code class="function">DisableHIT</code> operation are approved once the assignments are
- submitted. You will be charged for approval of these assignments. </p><div class="caution" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Caution"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="images/caution.png"></td><th align="left">Caution</th></tr><tr><td align="left" valign="top"><p> The <code class="function">DisableHIT</code> operation does not work on HITs in the
- <span class="guilabel">Reviewable</span> state. For reviewable HITs, call the <a class="link" href="ApiReference_ApproveAssignmentOperation.html" title="ApproveAssignment">ApproveAssignment</a>
- operation or the <a class="link" href="ApiReference_RejectAssignmentOperation.html" title="RejectAssignment">RejectAssignment</a> operation for each submitted assignment, if any. Then
- call the <a class="link" href="ApiReference_DisposeHITOperation.html" title="DisposeHIT">DisposeHIT</a>
- operation to dispose of the HIT. </p></td></tr></table></div><p> The <code class="function">DisableHIT</code> operation completely disposes of the HIT and all
- submitted assignment data. Assignment results data cannot be retrieved for a HIT that
- has been disposed. </p><p> Only the Requester who created a HIT can disable it. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e3515">Request Parameters</h2></div></div></div><p> The <code class="function">DisableHIT</code> operation accepts parameters common to all
- operations. Some common parameters are required. See <a class="link" href="ApiReference_CommonParametersArticle.html" title="Chapter&nbsp;4.&nbsp;Common Parameters">Common Parameters</a> for more information. </p><p> The following parameters are specific to the <code class="function">DisableHIT</code>
- 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>
- <p class="simpara">
- <em class="parameter"><code>Operation</code></em>
- </p>
- </td><td>
- <p class="simpara">The name of the operation</p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Valid Values: DisableHIT</p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr><tr><td>
- <p class="simpara">
- <em class="parameter"><code>HITId</code></em>
- </p>
- </td><td>
- <p class="simpara"> The ID of the HIT, as returned by the <a class="link" href="ApiReference_CreateHITOperation.html" title="CreateHIT">CreateHIT</a>
- operation. </p>
- <p class="simpara">Type: String</p>
- <p class="simpara">Default: None</p>
- </td><td>
- <p class="simpara">Yes</p>
- </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e3600">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">DisableHIT</code> operation returns with
- no errors. The response includes the elements in the 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>
- <p class="simpara">
- <em class="parameter"><code>DisableHITResult</code></em>
- </p>
- </td><td>
- <p class="simpara"> Contains a <em class="parameter"><code>Request</code></em> element if the
- <strong class="userinput"><code>Request</code></strong>
- <em class="parameter"><code>ResposeGroup</code></em> is specified. </p>
- </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e3642">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">DisableHIT</code>
- operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e3650">Sample Request</h3></div></div></div><p> The following example disables a HIT with a specified HIT ID. </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
-&amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
-&amp;Version=2008-08-02
-&amp;Operation=DisableHIT
-&amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
-&amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em></