rturk 2.0.2 → 2.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (122) hide show
  1. data/README.markdown +3 -2
  2. data/Rakefile +10 -4
  3. data/VERSION +1 -1
  4. data/aws_docs/ApiReference_AnswerKeyDataStructureArticle.html +98 -0
  5. data/aws_docs/ApiReference_ApproveAssignmentOperation.html +75 -0
  6. data/aws_docs/ApiReference_AssignQualificationOperation.html +107 -0
  7. data/aws_docs/ApiReference_AssignmentDataStructureArticle.html +171 -0
  8. data/aws_docs/ApiReference_BlockWorkerOperation.html +70 -0
  9. data/aws_docs/ApiReference_ChangeHITTypeOfHITOperation.html +68 -0
  10. data/aws_docs/ApiReference_CommonParametersArticle.html +119 -0
  11. data/aws_docs/ApiReference_CreateHITOperation.html +330 -0
  12. data/aws_docs/ApiReference_CreateQualificationTypeOperation.html +190 -0
  13. data/aws_docs/ApiReference_DataStructuresArticle.html +7 -0
  14. data/aws_docs/ApiReference_DisableHITOperation.html +63 -0
  15. data/aws_docs/ApiReference_DisposeHITOperation.html +56 -0
  16. data/aws_docs/ApiReference_DisposeQualificationTypeOperation.html +52 -0
  17. data/aws_docs/ApiReference_ExtendHITOperation.html +86 -0
  18. data/aws_docs/ApiReference_ExternalQuestionArticle.html +125 -0
  19. data/aws_docs/ApiReference_ForceExpireHITOperation.html +61 -0
  20. data/aws_docs/ApiReference_FormattedContentXHTMLArticle.html +289 -0
  21. data/aws_docs/ApiReference_GetAccountBalanceOperation.html +51 -0
  22. data/aws_docs/ApiReference_GetAssignmentsForHITOperation.html +166 -0
  23. data/aws_docs/ApiReference_GetBonusPaymentsOperation.html +160 -0
  24. data/aws_docs/ApiReference_GetFileUploadURLOperation.html +75 -0
  25. data/aws_docs/ApiReference_GetHITOperation.html +89 -0
  26. data/aws_docs/ApiReference_GetHITsForQualificationTypeOperation.html +137 -0
  27. data/aws_docs/ApiReference_GetQualificationRequestsOperation.html +155 -0
  28. data/aws_docs/ApiReference_GetQualificationScoreOperation.html +68 -0
  29. data/aws_docs/ApiReference_GetQualificationTypeOperation.html +57 -0
  30. data/aws_docs/ApiReference_GetQualificationsForQualificationTypeOperation.html +134 -0
  31. data/aws_docs/ApiReference_GetRequesterStatisticOperation.html +315 -0
  32. data/aws_docs/ApiReference_GetReviewableHITsOperation.html +155 -0
  33. data/aws_docs/ApiReference_GrantBonusOperation.html +95 -0
  34. data/aws_docs/ApiReference_GrantQualificationOperation.html +69 -0
  35. data/aws_docs/ApiReference_HITDataStructureArticle.html +302 -0
  36. data/aws_docs/ApiReference_HelpOperation.html +125 -0
  37. data/aws_docs/ApiReference_LocaleDataStructureArticle.html +29 -0
  38. data/aws_docs/ApiReference_NotificationAPI_BuildingANotificationReceptor.html +36 -0
  39. data/aws_docs/ApiReference_NotificationAPI_ElementsOfANotification.html +40 -0
  40. data/aws_docs/ApiReference_NotificationDataStructureArticle.html +73 -0
  41. data/aws_docs/ApiReference_NotificationReceptorAPIArticle.html +9 -0
  42. data/aws_docs/ApiReference_NotificationReceptorAPI_RESTTransportArticle.html +39 -0
  43. data/aws_docs/ApiReference_NotificationReceptorAPI_SOAPTransportArticle.html +45 -0
  44. data/aws_docs/ApiReference_NotifyWorkersOperation.html +82 -0
  45. data/aws_docs/ApiReference_OperationsArticle.html +8 -0
  46. data/aws_docs/ApiReference_PriceDataStructureArticle.html +65 -0
  47. data/aws_docs/ApiReference_QualificationDataStructureArticle.html +89 -0
  48. data/aws_docs/ApiReference_QualificationRequestDataStructureArticle.html +102 -0
  49. data/aws_docs/ApiReference_QualificationRequirementDataStructureArticle.html +176 -0
  50. data/aws_docs/ApiReference_QualificationTypeDataStructureArticle.html +198 -0
  51. data/aws_docs/ApiReference_QuestionAnswerDataArticle.html +8 -0
  52. data/aws_docs/ApiReference_QuestionFormAnswersDataStructureArticle.html +54 -0
  53. data/aws_docs/ApiReference_QuestionFormDataStructureArticle.html +796 -0
  54. data/aws_docs/ApiReference_RegisterHITTypeOperation.html +149 -0
  55. data/aws_docs/ApiReference_RejectAssignmentOperation.html +66 -0
  56. data/aws_docs/ApiReference_RejectQualificationRequestOperation.html +61 -0
  57. data/aws_docs/ApiReference_RevokeQualificationOperation.html +78 -0
  58. data/aws_docs/ApiReference_SearchHITsOperation.html +164 -0
  59. data/aws_docs/ApiReference_SearchQualificationTypesOperation.html +211 -0
  60. data/aws_docs/ApiReference_SendTestEventNotificationOperation.html +78 -0
  61. data/aws_docs/ApiReference_SetHITAsReviewingOperation.html +73 -0
  62. data/aws_docs/ApiReference_SetHITTypeNotificationOperation.html +99 -0
  63. data/aws_docs/ApiReference_UnblockWorkerOperation.html +67 -0
  64. data/aws_docs/ApiReference_UpdateQualificationScoreOperation.html +77 -0
  65. data/aws_docs/ApiReference_UpdateQualificationTypeOperation.html +180 -0
  66. data/aws_docs/ApiReference_WsdlLocationArticle.html +95 -0
  67. data/aws_docs/ApiReference_XMLParameterValuesArticle.html +37 -0
  68. data/aws_docs/Welcome.html +125 -0
  69. data/aws_docs/WhatsNew.html +16 -0
  70. data/aws_docs/_title.html +28 -0
  71. data/aws_docs/_toc.html +749 -0
  72. data/aws_docs/aws-docs-IE.css +419 -0
  73. data/aws_docs/aws-docs.css +455 -0
  74. data/aws_docs/copyrightinfo.html +14 -0
  75. data/aws_docs/frameset.js +12 -0
  76. data/aws_docs/images/Feedback_link.gif +0 -0
  77. data/aws_docs/images/caution.png +0 -0
  78. data/aws_docs/images/home.gif +0 -0
  79. data/aws_docs/images/important.png +0 -0
  80. data/aws_docs/images/next.gif +0 -0
  81. data/aws_docs/images/note.png +0 -0
  82. data/aws_docs/images/prev.gif +0 -0
  83. data/aws_docs/images/tip.png +0 -0
  84. data/aws_docs/images/title-swoosh-logo.gif +0 -0
  85. data/aws_docs/images/toc_bullet.gif +0 -0
  86. data/aws_docs/images/toc_plus.gif +0 -0
  87. data/aws_docs/index.html +18 -0
  88. data/aws_docs/toc.js +84 -0
  89. data/lib/rturk.rb +2 -2
  90. data/lib/rturk/adapter.rb +11 -0
  91. data/lib/rturk/adapters/assignment.rb +13 -50
  92. data/lib/rturk/adapters/hit.rb +21 -9
  93. data/lib/rturk/adapters/worker.rb +23 -0
  94. data/lib/rturk/operation.rb +1 -1
  95. data/lib/rturk/operations/create_hit.rb +10 -54
  96. data/lib/rturk/operations/register_hit_type.rb +68 -0
  97. data/lib/rturk/operations/search_hits.rb +44 -0
  98. data/lib/rturk/parser.rb +8 -0
  99. data/lib/rturk/parsers/answer_parser.rb +29 -0
  100. data/lib/rturk/parsers/assignment_parser.rb +49 -0
  101. data/lib/rturk/parsers/hit_parser.rb +50 -0
  102. data/lib/rturk/{response.rb → parsers/response.rb} +7 -2
  103. data/lib/rturk/{responses → parsers/responses}/create_hit_response.rb +2 -2
  104. data/lib/rturk/{responses → parsers/responses}/get_account_balance_response.rb +0 -0
  105. data/lib/rturk/{responses → parsers/responses}/get_assignments_for_hit_response.rb +3 -3
  106. data/lib/rturk/{responses → parsers/responses}/get_hit_response.rb +9 -16
  107. data/lib/rturk/{responses → parsers/responses}/get_reviewable_hits_response.rb +3 -5
  108. data/lib/rturk/parsers/responses/register_hit_type_response.rb +17 -0
  109. data/lib/rturk/parsers/responses/search_hits_response.rb +65 -0
  110. data/lib/rturk/xml_utilities.rb +14 -3
  111. data/rturk.gemspec +112 -12
  112. data/spec/adapters/hit_spec.rb +10 -0
  113. data/spec/fake_responses/register_hit_type.xml +6 -0
  114. data/spec/fake_responses/search_hits.xml +50 -0
  115. data/spec/operations/create_hit_spec.rb +2 -2
  116. data/spec/operations/get_hit_spec.rb +1 -1
  117. data/spec/operations/register_hit_type_spec.rb +24 -0
  118. data/spec/{adapters/answers_spec.rb → parsers/answer_parser_spec.rb} +2 -2
  119. data/spec/parsers/hit_parser_spec.rb +41 -0
  120. data/spec/xml_parse_spec.rb +2 -2
  121. metadata +111 -11
  122. data/lib/rturk/adapters/answers.rb +0 -38
data/aws_docs/ApiReference_OperationsArticle.html ADDED
@@ -0,0 +1,8 @@
1
+ <html xmlns:fo="http://www.w3.org/1999/XSL/Format"><head>
2
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3
+ <title>Chapter&nbsp;5.&nbsp;Operations</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_CommonParametersArticle.html" title="Chapter&nbsp;4.&nbsp;Common Parameters"><link rel="next" href="ApiReference_ApproveAssignmentOperation.html" title="ApproveAssignment"><!--[if !IE]>--><link rel="stylesheet" href="aws-docs.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><!--<![endif]--><meta xmlns="http://www.w3.org/1999/xhtml" http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><script src="/urchin.js" type="text/javascript"></script><script type="text/javascript">
4
+ urchinTracker();
5
+ </script><script xmlns="http://www.w3.org/1999/xhtml" type="text/javascript" src="frameset.js"> //
6
+ </script></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header" cellspacing="0" cellpadding="2"><tr><td width="30%" align="left"><a accesskey="p" href="ApiReference_CommonParametersArticle.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_OperationsArticle">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_ApproveAssignmentOperation.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>Operations</strong></div></div><div class="chapter" lang="en" id="ApiReference_OperationsArticle"><div class="titlepage"><div><div><h1 class="topictitle">Operations</h1></div></div></div><p>
7
+ The Amazon Mechanical Turk Service API consists of web service operations for every task the service can perform. This section describes each operation in detail.
8
+ </p><div class="itemizedlist"><ul type="disc"><li><p><a class="link" href="ApiReference_ApproveAssignmentOperation.html" title="ApproveAssignment">ApproveAssignment</a></p></li><li><p><a class="link" href="ApiReference_AssignQualificationOperation.html" title="AssignQualification">AssignQualification</a></p></li><li><p><a class="link" href="ApiReference_BlockWorkerOperation.html" title="BlockWorker">BlockWorker</a></p></li><li><p><a class="link" href="ApiReference_ChangeHITTypeOfHITOperation.html" title="ChangeHITTypeOfHIT">ChangeHITTypeOfHIT</a></p></li><li><p><a class="link" href="ApiReference_CreateHITOperation.html" title="CreateHIT">CreateHIT</a></p></li><li><p><a class="link" href="ApiReference_CreateQualificationTypeOperation.html" title="CreateQualificationType">CreateQualificationType</a></p></li><li><p><a class="link" href="ApiReference_DisableHITOperation.html" title="DisableHIT">DisableHIT</a></p></li><li><p><a class="link" href="ApiReference_DisposeHITOperation.html" title="DisposeHIT">DisposeHIT</a></p></li><li><p><a class="link" href="ApiReference_DisposeHITOperation.html" title="DisposeHIT">DisposeQualificationType</a></p></li><li><p><a class="link" href="ApiReference_ExtendHITOperation.html" title="ExtendHIT">ExtendHIT</a></p></li><li><p><a class="link" href="ApiReference_ForceExpireHITOperation.html" title="ForceExpireHIT">ForceExpireHIT</a></p></li><li><p><a class="link" href="ApiReference_GetAccountBalanceOperation.html" title="GetAccountBalance">GetAccountBalance</a></p></li><li><p><a class="link" href="ApiReference_GetAssignmentsForHITOperation.html" title="GetAssignmentsForHIT">GetAssignmentsForHIT</a></p></li><li><p><a class="link" href="ApiReference_GetBonusPaymentsOperation.html" title="GetBonusPayments">GetBonusPayments</a></p></li><li><p><a class="link" href="ApiReference_GetFileUploadURLOperation.html" title="GetFileUploadURL">GetFileUploadURL</a></p></li><li><p><a class="link" href="ApiReference_GetHITOperation.html" title="GetHIT">GetHIT</a></p></li><li><p><a class="link" href="ApiReference_GetHITsForQualificationTypeOperation.html" title="GetHITsForQualificationType">GetHITsForQualificationType</a></p></li><li><p><a class="link" href="ApiReference_GetQualificationRequestsOperation.html" title="GetQualificationRequests">GetQualificationsForQualificationType</a></p></li><li><p><a class="link" href="ApiReference_GetQualificationRequestsOperation.html" title="GetQualificationRequests">GetQualificationRequests</a></p></li><li><p><a class="link" href="ApiReference_GetQualificationScoreOperation.html" title="GetQualificationScore">GetQualificationScore</a></p></li><li><p><a class="link" href="ApiReference_GetQualificationTypeOperation.html" title="GetQualificationType">GetQualificationType</a></p></li><li><p><a class="link" href="ApiReference_GetReviewableHITsOperation.html" title="GetReviewableHITs">GetReviewableHITs</a></p></li><li><p><a class="link" href="ApiReference_GetRequesterStatisticOperation.html" title="GetRequesterStatistic">GetRequesterStatistic</a></p></li><li><p><a class="link" href="ApiReference_GrantBonusOperation.html" title="GrantBonus">GrantBonus</a></p></li><li><p><a class="link" href="ApiReference_GrantQualificationOperation.html" title="GrantQualification">GrantQualification</a></p></li><li><p><a class="link" href="ApiReference_HelpOperation.html" title="Help">Help</a></p></li><li><p><a class="link" href="ApiReference_NotifyWorkersOperation.html" title="NotifyWorkers">NotifyWorkers</a></p></li><li><p><a class="link" href="ApiReference_RegisterHITTypeOperation.html" title="RegisterHITType">RegisterHITType</a></p></li><li><p><a class="link" href="ApiReference_RejectAssignmentOperation.html" title="RejectAssignment">RejectAssignment</a></p></li><li><p><a class="link" href="ApiReference_RejectQualificationRequestOperation.html" title="RejectQualificationRequest">RejectQualificationRequest</a></p></li><li><p><a class="link" href="ApiReference_RevokeQualificationOperation.html" title="RevokeQualification">RevokeQualification</a></p></li><li><p><a class="link" href="ApiReference_SearchHITsOperation.html" title="SearchHITs">SearchHITs</a></p></li><li><p><a class="link" href="ApiReference_SearchQualificationTypesOperation.html" title="SearchQualificationTypes">SearchQualificationTypes</a></p></li><li><p><a class="link" href="ApiReference_SendTestEventNotificationOperation.html" title="SendTestEventNotification">SendTestEventNotification</a></p></li><li><p><a class="link" href="ApiReference_SetHITAsReviewingOperation.html" title="SetHITAsReviewing">SetHITAsReviewing</a></p></li><li><p><a class="link" href="ApiReference_SetHITTypeNotificationOperation.html" title="SetHITTypeNotification">SetHITTypeNotification</a></p></li><li><p><a class="link" href="ApiReference_UnblockWorkerOperation.html" title="UnblockWorker">UnblockWorker</a></p></li><li><p><a class="link" href="ApiReference_UpdateQualificationScoreOperation.html" title="UpdateQualificationScore">UpdateQualificationScore</a></p></li><li><p><a class="link" href="ApiReference_UpdateQualificationTypeOperation.html" title="UpdateQualificationType">UpdateQualificationType</a></p></li></ul></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_CommonParametersArticle.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_OperationsArticle">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_ApproveAssignmentOperation.html"><img src="images/next.gif" alt="Next"></a></td></tr><tr><td width="30%" align="left" valign="top">&nbsp;</td><td width="40%" align="center"><a accesskey="h" href="#top"><img src="images/home.gif" alt="Home"></a></td><td width="30%" align="right" valign="top">&nbsp;</td></tr></table></div></body></html>
data/aws_docs/ApiReference_PriceDataStructureArticle.html ADDED
@@ -0,0 +1,65 @@
1
+ <html xmlns:fo="http://www.w3.org/1999/XSL/Format"><head>
2
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3
+ <title>Price</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_LocaleDataStructureArticle.html" title="Locale"><link rel="next" href="ApiReference_QualificationDataStructureArticle.html" title="Qualification"><!--[if !IE]>--><link rel="stylesheet" href="aws-docs.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><!--<![endif]--><meta xmlns="http://www.w3.org/1999/xhtml" http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><script src="/urchin.js" type="text/javascript"></script><script type="text/javascript">
4
+ urchinTracker();
5
+ </script><script xmlns="http://www.w3.org/1999/xhtml" type="text/javascript" src="frameset.js"> //
6
+ </script></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header" cellspacing="0" cellpadding="2"><tr><td width="30%" align="left"><a accesskey="p" href="ApiReference_LocaleDataStructureArticle.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_PriceDataStructureArticle">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_QualificationDataStructureArticle.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>Price</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">Price</h1></div></div></div><a class="indexterm" name="d0e14991"></a><a class="indexterm" name="d0e14994"></a><a class="indexterm" name="d0e14999"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e15004">Description</h2></div></div></div><p> The Price data structure represents an amount of money in a given currency. </p><p> The Price data structure is used in the <a class="link" href="ApiReference_HITDataStructureArticle.html" title="HIT">HIT data structure</a>. </p><p> The Price data structure is used as a parameter for the following operations: </p><div class="itemizedlist"><ul type="disc"><li><p>
7
+ <code class="function">CreateHIT</code>
8
+ </p></li></ul></div><p> When you call the <a class="link" href="ApiReference_CreateHITOperation.html" title="CreateHIT">CreateHIT</a> operation,
9
+ you must specify the <em class="parameter"><code>Amount</code></em> and <em class="parameter"><code>CurrencyCode</code></em>
10
+ elements. The <em class="parameter"><code>FormattedPrice</code></em> element is only used in responses sent by the
11
+ service. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e15037">Elements</h2></div></div></div><p> The Price structure can contain the elements described in the following table: </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col><col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>
12
+ <p class="simpara">
13
+ <em class="parameter"><code>Amount</code></em>
14
+ </p>
15
+ </td><td>
16
+ <p class="simpara"> The amount of money, as a number. The amount is in the currency
17
+ specified by the <em class="parameter"><code>CurrencyCode</code></em>. For example, if
18
+ <em class="parameter"><code>CurrencyCode</code></em> is <strong class="userinput"><code>USD</code></strong>, the
19
+ amount will be in United States dollars (e.g. <strong class="userinput"><code>12.75</code></strong> is
20
+ $12.75 US). </p>
21
+ <p class="simpara">Type: Number</p>
22
+ <p class="simpara">Default: None</p>
23
+ </td><td>
24
+ <p class="simpara">No</p>
25
+ </td></tr><tr><td>
26
+ <p class="simpara">
27
+ <em class="parameter"><code>CurrencyCode</code></em>
28
+ </p>
29
+ </td><td>
30
+ <p class="simpara"> A code that represents the country and units of the currency. Its value
31
+ is </p>
32
+ <p class="simpara"> Type an <a class="ulink" href="http://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO
33
+ 4217</a> currency code, such as <strong class="userinput"><code>USD</code></strong> for United
34
+ States dollars. </p>
35
+ <p class="simpara">Default: None</p>
36
+ <p class="simpara">Constraints: Currently, only <strong class="userinput"><code>USD</code></strong> is
37
+ supported.</p>
38
+ </td><td>
39
+ <p class="simpara">No</p>
40
+ </td></tr><tr><td>
41
+ <p class="simpara">
42
+ <em class="parameter"><code>FormattedPrice</code></em>
43
+ </p>
44
+ </td><td>
45
+ <p class="simpara"> A textual representation of the price, using symbols and formatting
46
+ appropriate for the currency. Symbols are represented using the Unicode
47
+ character set. You do not need to specify
48
+ <em class="parameter"><code>FormattedPrice</code></em> in a request. It is only provided by the
49
+ service in responses, as a convenience to your application. </p>
50
+ <p class="simpara">Type: String</p>
51
+ <p class="simpara">Default: None</p>
52
+ </td><td>
53
+ <p class="simpara">No</p>
54
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e15158">Example</h2></div></div></div><p> The following example shows how you can pass a Price data structure in a call to the <a class="link" href="ApiReference_CreateHITOperation.html" title="CreateHIT">CreateHIT</a> operation. The <a class="link" href="ApiReference_CreateHITOperation.html" title="CreateHIT">CreateHIT</a> operation accepts parameters that
55
+ describe the HIT being created, including the reward the Worker will be paid for completing the
56
+ HIT successfully. For <a class="link" href="ApiReference_CreateHITOperation.html" title="CreateHIT">CreateHIT</a>, the
57
+ parameter name is <strong class="userinput"><code>Reward</code></strong>, and the value is a Price data structure. </p><p> In a SOAP request, the Price data structure is specified as the <em class="parameter"><code>Reward</code></em>
58
+ parameter in XML: </p><pre class="programlisting">&lt;Reward&gt;
59
+ &lt;Amount&gt;0.32&lt;/Amount&gt;
60
+ &lt;CurrencyCode&gt;USD&lt;/CurrencyCode&gt;
61
+ &lt;/Reward&gt;</pre><p> In a REST request, the components of the Price data structure are specified as separate
62
+ parameters: </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
63
+ <em class="replaceable"><code>[...]</code></em>
64
+ &amp;Reward.1.Amount=0.32
65
+ &amp;Reward.1.CurrencyCode=USD</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_LocaleDataStructureArticle.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_PriceDataStructureArticle">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_QualificationDataStructureArticle.html"><img src="images/next.gif" alt="Next"></a></td></tr><tr><td width="30%" align="left" valign="top">&nbsp;</td><td width="40%" align="center"><a accesskey="h" href="#top"><img src="images/home.gif" alt="Home"></a></td><td width="30%" align="right" valign="top">&nbsp;</td></tr></table></div></body></html>
data/aws_docs/ApiReference_QualificationDataStructureArticle.html ADDED
@@ -0,0 +1,89 @@
1
+ <html xmlns:fo="http://www.w3.org/1999/XSL/Format"><head>
2
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3
+ <title>Qualification</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_PriceDataStructureArticle.html" title="Price"><link rel="next" href="ApiReference_QualificationRequestDataStructureArticle.html" title="QualificationRequest"><!--[if !IE]>--><link rel="stylesheet" href="aws-docs.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><!--<![endif]--><meta xmlns="http://www.w3.org/1999/xhtml" http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><script src="/urchin.js" type="text/javascript"></script><script type="text/javascript">
4
+ urchinTracker();
5
+ </script><script xmlns="http://www.w3.org/1999/xhtml" type="text/javascript" src="frameset.js"> //
6
+ </script></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header" cellspacing="0" cellpadding="2"><tr><td width="30%" align="left"><a accesskey="p" href="ApiReference_PriceDataStructureArticle.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_QualificationDataStructureArticle">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_QualificationRequestDataStructureArticle.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>Qualification</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">Qualification</h1></div></div></div><a class="indexterm" name="d0e15193"></a><a class="indexterm" name="d0e15196"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e15201">Description</h2></div></div></div><p> The Qualification data structure represents a Qualification assigned to a user, including the
7
+ Qualification type and the value (score). </p><p> The Qualification data structure is used as a response element for the following operations: </p><div class="itemizedlist"><ul type="disc"><li><p>
8
+ <a class="link" href="ApiReference_GetQualificationScoreOperation.html" title="GetQualificationScore">GetQualificationScore</a>
9
+ </p></li><li><p>
10
+ <a class="link" href="ApiReference_GetQualificationsForQualificationTypeOperation.html" title="GetQualificationsForQualificationType">
11
+ GetQualificationsForQualificationType</a>
12
+ </p></li></ul></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e15221">Elements</h2></div></div></div><p> The Qualification structure can contain the elements described in the following table. When the
13
+ structure is used in a request, elements described as <span class="guilabel">Required</span> must be
14
+ included for the request to succeed. </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col><col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>
15
+ <p class="simpara">
16
+ <em class="parameter"><code>QualificationTypeId</code></em>
17
+ </p>
18
+ </td><td>
19
+ <p class="simpara">The ID of the Qualification type for the Qualification</p>
20
+ <p class="simpara">Type: String</p>
21
+ <p class="simpara">Default: None</p>
22
+ </td><td>
23
+ <p class="simpara">Yes</p>
24
+ </td></tr><tr><td>
25
+ <p class="simpara">
26
+ <em class="parameter"><code>SubjectId</code></em>
27
+ </p>
28
+ </td><td>
29
+ <p class="simpara">The ID of the Worker who possesses the Qualification.</p>
30
+ <p class="simpara">Type: String</p>
31
+ <p class="simpara">Default: None</p>
32
+ </td><td>
33
+ <p class="simpara">Yes</p>
34
+ </td></tr><tr><td>
35
+ <p class="simpara">
36
+ <em class="parameter"><code>GrantTime</code></em>
37
+ </p>
38
+ </td><td>
39
+ <p class="simpara"> The date and time the Qualification was granted to the Worker. If the
40
+ Worker's Qualification was revoked, and then re-granted based on a new
41
+ Qualification request, <em class="parameter"><code>GrantTime</code></em> is the date and time
42
+ of the last call to the <a class="link" href="ApiReference_GrantQualificationOperation.html" title="GrantQualification">GrantQualification</a> operation. </p>
43
+ <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
44
+ Time) time zone, such as <strong class="userinput"><code>2005-01-31T23:59:59Z</code></strong>
45
+ </p>
46
+ <p class="simpara">Default: None</p>
47
+ </td><td>
48
+ <p class="simpara">Yes</p>
49
+ </td></tr><tr><td>
50
+ <p class="simpara">
51
+ <em class="parameter"><code>IntegerValue</code></em>
52
+ </p>
53
+ </td><td>
54
+ <p class="simpara">The value (score) of the Qualification, if the Qualification has an
55
+ integer value.</p>
56
+ <p class="simpara">Type: Integer</p>
57
+ <p class="simpara">Default: None</p>
58
+ </td><td>
59
+ <p class="simpara">No</p>
60
+ </td></tr><tr><td>
61
+ <p class="simpara">
62
+ <em class="parameter"><code>LocaleValue</code></em>
63
+ </p>
64
+ </td><td>
65
+ <p class="simpara"> The value of the Qualification if the Qualification describes a
66
+ geographical region or location. </p>
67
+ <p class="simpara"> Type: a <a class="link" href="ApiReference_LocaleDataStructureArticle.html" title="Locale">Locale</a> data structure. </p>
68
+ <p class="simpara">Default: None</p>
69
+ </td><td>
70
+ <p class="simpara">No</p>
71
+ </td></tr><tr><td>
72
+ <p class="simpara">
73
+ <em class="parameter"><code>Status</code></em>
74
+ </p>
75
+ </td><td>
76
+ <p class="simpara">The status of the Qualification</p>
77
+ <p class="simpara">Type: String</p>
78
+ <p class="simpara">Valid Values: Granted | Revoked</p>
79
+ <p class="simpara">Default: None</p>
80
+ </td><td>
81
+ <p class="simpara">Yes</p>
82
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e15411">Example</h2></div></div></div><p> The following example illustrates a Qualification with an integer value. </p><pre class="programlisting">
83
+ &lt;Qualification&gt;
84
+ &lt;QualificationTypeId&gt;789RVWYBAZW00EXAMPLE&lt;/QualificationTypeId&gt;
85
+ &lt;SubjectId&gt;AZ3456EXAMPLE&lt;/SubjectId&gt;
86
+ &lt;GrantTime&gt;2005-01-31T23:59:59Z&lt;/GrantTime&gt;
87
+ &lt;IntegerValue&gt;95&lt;/IntegerValue&gt;
88
+ &lt;/Qualification&gt;
89
+ </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_PriceDataStructureArticle.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_QualificationDataStructureArticle">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_QualificationRequestDataStructureArticle.html"><img src="images/next.gif" alt="Next"></a></td></tr><tr><td width="30%" align="left" valign="top">&nbsp;</td><td width="40%" align="center"><a accesskey="h" href="#top"><img src="images/home.gif" alt="Home"></a></td><td width="30%" align="right" valign="top">&nbsp;</td></tr></table></div></body></html>
data/aws_docs/ApiReference_QualificationRequestDataStructureArticle.html ADDED
@@ -0,0 +1,102 @@
1
+ <html xmlns:fo="http://www.w3.org/1999/XSL/Format"><head>
2
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3
+ <title>QualificationRequest</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_QualificationDataStructureArticle.html" title="Qualification"><link rel="next" href="ApiReference_QualificationRequirementDataStructureArticle.html" title="QualificationRequirement"><!--[if !IE]>--><link rel="stylesheet" href="aws-docs.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><!--<![endif]--><meta xmlns="http://www.w3.org/1999/xhtml" http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><script src="/urchin.js" type="text/javascript"></script><script type="text/javascript">
4
+ urchinTracker();
5
+ </script><script xmlns="http://www.w3.org/1999/xhtml" type="text/javascript" src="frameset.js"> //
6
+ </script></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header" cellspacing="0" cellpadding="2"><tr><td width="30%" align="left"><a accesskey="p" href="ApiReference_QualificationDataStructureArticle.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_QualificationRequestDataStructureArticle">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_QualificationRequirementDataStructureArticle.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>QualificationRequest</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">QualificationRequest</h1></div></div></div><a class="indexterm" name="d0e15422"></a><a class="indexterm" name="d0e15425"></a><a class="indexterm" name="d0e15432"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e15437">Description</h2></div></div></div><p> The QualificationRequest data structure represents a request a Worker has made for a
7
+ Qualification. </p><p> The QualificationRequest data structure is used as a response element for the following
8
+ operations: </p><div class="itemizedlist"><ul type="disc"><li><p>
9
+ <a class="link" href="ApiReference_GetQualificationRequestsOperation.html" title="GetQualificationRequests">GetQualificationRequests</a>
10
+ </p></li></ul></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e15451">Elements</h2></div></div></div><p> The QualificationRequest structure can contain the elements described in the following table: </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col><col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>
11
+ <p class="simpara">
12
+ <em class="parameter"><code>QualificationRequestId</code></em>
13
+ </p>
14
+ </td><td>
15
+ <p class="simpara"> The ID of the Qualification request, a unique identifier generated when
16
+ the request was submitted. </p>
17
+ <p class="simpara">Type: String</p>
18
+ <p class="simpara">Default: None</p>
19
+ </td><td>
20
+ <p class="simpara">No</p>
21
+ </td></tr><tr><td>
22
+ <p class="simpara">
23
+ <em class="parameter"><code>QualificationTypeId</code></em>
24
+ </p>
25
+ </td><td>
26
+ <p class="simpara"> The ID of the Qualification type the Worker is requesting, as returned
27
+ by the <a class="link" href="ApiReference_CreateQualificationTypeOperation.html" title="CreateQualificationType">CreateQualificationType</a> operation. </p>
28
+ <p class="simpara">Type: String</p>
29
+ <p class="simpara">Default: None</p>
30
+ </td><td>
31
+ <p class="simpara">No</p>
32
+ </td></tr><tr><td>
33
+ <p class="simpara">
34
+ <em class="parameter"><code>SubjectId</code></em>
35
+ </p>
36
+ </td><td>
37
+ <p class="simpara"> The ID of the Worker requesting the Qualification. This ID corresponds
38
+ to the <em class="parameter"><code>WorkerId</code></em> returned with assignment results when
39
+ the user performs a HIT. </p>
40
+ <p class="simpara">Type: String</p>
41
+ <p class="simpara">Default: None</p>
42
+ </td><td>
43
+ <p class="simpara">No</p>
44
+ </td></tr><tr><td>
45
+ <p class="simpara">
46
+ <em class="parameter"><code>Test</code></em>
47
+ </p>
48
+ </td><td>
49
+ <p class="simpara"> The contents of the Qualification test that was presented to the user,
50
+ if the type has a test and the user has submitted answers. This value is
51
+ identical to the QuestionForm associated with the Qualification type at the
52
+ time the user requests the Qualification. </p>
53
+ <p class="simpara"> Type: a <a class="link" href="ApiReference_QuestionFormDataStructureArticle.html" title="QuestionForm">QuestionForm</a> data structure </p>
54
+ <p class="simpara">Default: None</p>
55
+ </td><td>
56
+ <p class="simpara">No</p>
57
+ </td></tr><tr><td>
58
+ <p class="simpara">
59
+ <em class="parameter"><code>Answer</code></em>
60
+ </p>
61
+ </td><td>
62
+ <p class="simpara"> The user's answers for the Qualification type's test, if the type has a
63
+ test and the user has submitted answers. </p>
64
+ <p class="simpara"> Type: a <a class="link" href="ApiReference_QuestionFormAnswersDataStructureArticle.html" title="QuestionFormAnswers">QuestionFormAnswers</a> data structure/ </p>
65
+ <p class="simpara">Default: None</p>
66
+ </td><td>
67
+ <p class="simpara">No</p>
68
+ </td></tr><tr><td>
69
+ <p class="simpara">
70
+ <em class="parameter"><code>SubmitTime</code></em>
71
+ </p>
72
+ </td><td>
73
+ <p class="simpara"> The date and time the Qualification request had a status of
74
+ <span class="guilabel">Submitted</span>. This is either the time the user submitted
75
+ answers forba Qualification test, or the time the user requestedbthe
76
+ Qualification if the Qualification type does not have a test. </p>
77
+ <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
78
+ Time) time zone, such as <strong class="userinput"><code>2005-01-31T23:59:59Z</code></strong>
79
+ </p>
80
+ <p class="simpara">Default: None</p>
81
+ </td><td>
82
+ <p class="simpara">No</p>
83
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e15641">Example</h2></div></div></div><p> The following example shows a QualificationRequest data structure returned by the <a class="link" href="ApiReference_GetQualificationRequestsOperation.html" title="GetQualificationRequests">GetQualificationRequests</a>
84
+ operation. This operation returns the requests for Qualifications of a Qualification type to the
85
+ owner of the type. </p><pre class="programlisting">
86
+ &lt;QualificationRequest&gt;
87
+ &lt;QualificationRequestId&gt;789RVWYBAZW00EXAMPLE951RVWYBAZW00EXAMPLE&lt;/QualificationRequestId&gt;
88
+ &lt;QualificationTypeId&gt;789RVWYBAZW00EXAMPLE&lt;/QualificationTypeId&gt;
89
+ &lt;SubjectId&gt;AZ3456EXAMPLE&lt;/SubjectId&gt;
90
+ &lt;Test&gt;
91
+ &amp;lt;QuestionForm&amp;gt;
92
+ <em class="replaceable"><code>[XML-encoded question data]</code></em>
93
+ &amp;lt;/QuestionForm&amp;gt;
94
+ &lt;/Test&gt;
95
+ &lt;Answer&gt;
96
+ &amp;lt;QuestionFormAnswers&amp;gt;
97
+ <em class="replaceable"><code>[XML-encoded answer data]</code></em>
98
+ &amp;lt;/QuestionFormAnswers&amp;gt;
99
+ &lt;/Answer&gt;
100
+ &lt;SubmitTime&gt;2005-12-01T23:59:59Z&lt;/SubmitTime&gt;
101
+ &lt;/QualificationRequest&gt;
102
+ </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_QualificationDataStructureArticle.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_QualificationRequestDataStructureArticle">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_QualificationRequirementDataStructureArticle.html"><img src="images/next.gif" alt="Next"></a></td></tr><tr><td width="30%" align="left" valign="top">&nbsp;</td><td width="40%" align="center"><a accesskey="h" href="#top"><img src="images/home.gif" alt="Home"></a></td><td width="30%" align="right" valign="top">&nbsp;</td></tr></table></div></body></html>
data/aws_docs/ApiReference_QualificationRequirementDataStructureArticle.html ADDED
@@ -0,0 +1,176 @@
1
+ <html xmlns:fo="http://www.w3.org/1999/XSL/Format"><head>
2
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3
+ <title>QualificationRequirement</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_QualificationRequestDataStructureArticle.html" title="QualificationRequest"><link rel="next" href="ApiReference_QualificationTypeDataStructureArticle.html" title="QualificationType"><!--[if !IE]>--><link rel="stylesheet" href="aws-docs.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><!--<![endif]--><meta xmlns="http://www.w3.org/1999/xhtml" http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><script src="/urchin.js" type="text/javascript"></script><script type="text/javascript">
4
+ urchinTracker();
5
+ </script><script xmlns="http://www.w3.org/1999/xhtml" type="text/javascript" src="frameset.js"> //
6
+ </script></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header" cellspacing="0" cellpadding="2"><tr><td width="30%" align="left"><a accesskey="p" href="ApiReference_QualificationRequestDataStructureArticle.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_QualificationRequirementDataStructureArticle">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_QualificationTypeDataStructureArticle.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>QualificationRequirement</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">QualificationRequirement</h1></div></div></div><a class="indexterm" name="d0e15661"></a><a class="indexterm" name="d0e15664"></a><a class="indexterm" name="d0e15669"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e15672">Description</h2></div></div></div><p> The QualificationRequirement data structure describes a Qualification a Worker must
7
+ have before the Worker is allowed to accept a HIT. A requirement may optionally state
8
+ that a Worker must have the Qualification to preview the HIT's question data. </p><p> The QualificationRequirement data structure is used as a parameter for the following
9
+ operations: </p><div class="itemizedlist"><ul type="disc"><li><p>
10
+ <code class="function">CreateHIT</code>
11
+ </p></li><li><p>
12
+ <code class="function">RegisterHITType</code>
13
+ </p></li></ul></div><p> The QualificationRequirement data structure is used in the <a class="link" href="ApiReference_HITDataStructureArticle.html" title="HIT">HIT data structure</a>. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="CustomQualificationsandSystemQualifications">Custom Qualifications and System Qualifications</h2></div></div></div><a class="indexterm" name="d0e15700"></a><a class="indexterm" name="d0e15707"></a><a class="indexterm" name="d0e15712"></a><p>A Qualfication requirement can be based on a Qualification you assign to Workers. You
14
+ create the type using the <code class="function">CreateQualificationType</code> operation, then
15
+ grant requests for the Qualification automatically using a Qualification test and answer
16
+ key submitted with the Qualification type, or manually with the <code class="function">GrantQualification</code> operation. <code class="function">CreateQualificationType</code> returns a <em class="parameter"><code>QualificationTypeId</code></em>, which you can use with the
17
+ QualificationRequirement data structure to identify the type of Qualification the Worker
18
+ is required to have to accept a HIT. Either the Qualification test or your call to
19
+ <code class="function">GrantQualification</code> determines a Qualification value, which is
20
+ compared to the requirement in the HIT to determine the Worker's eligibility. </p><p>Amazon Mechanical Turk supplies several values of its own that describe a Worker's
21
+ account activity. These values can also be used as Qualification requirements for your
22
+ HITs. Every Worker has a value for each system Qualification, and these values are
23
+ updated continuously as the Worker uses the system. </p><p> To include a requirement for a system-assigned Qualification, use the Qualification
24
+ type ID that corresponds to the value you wish to use. The following system
25
+ Qualification types are available: </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col><col></colgroup><thead><tr><th> Name </th><th> QualificationTypeId </th><th> Description </th></tr></thead><tbody><tr><td> Worker_&#8203;PercentAssignmentsSubmitted </td><td> 00000000000000000000 </td><td>
26
+ <p> The percentage of assignments the Worker has submitted, over all
27
+ assignments the Worker has accepted. The value is an integer between
28
+ 0 and 100. </p>
29
+ </td></tr><tr><td> Worker_&#8203;PercentAssignmentsAbandoned </td><td> 00000000000000000070 </td><td>
30
+ <p>The percentage of assignments the Worker has abandoned (allowed
31
+ the deadline to elapse), over all assignments the Worker has
32
+ accepted. The value is an integer between 0 and 100. </p>
33
+ </td></tr><tr><td> Worker_&#8203;PercentAssignmentsReturned </td><td> 000000000000000000E0 </td><td>
34
+ <p>The percentage of assignments the Worker has returned, over all
35
+ assignments the Worker has accepted. The value is an integer between
36
+ 0 and 100. </p>
37
+ </td></tr><tr><td> Worker_&#8203;PercentAssignmentsApproved </td><td> 000000000000000000L0 </td><td>
38
+ <p>The percentage of assignments the Worker has submitted that were
39
+ subsequently approved by the Requester, over all assignments the
40
+ Worker has submitted. The value is an integer between 0 and 100.
41
+ </p>
42
+ </td></tr><tr><td> Worker_&#8203;PercentAssignmentsRejected </td><td> 000000000000000000S0 </td><td>
43
+ <p>The percentage of assignments the Worker has submitted that were
44
+ subsequently rejected by the Requester, over all assignments the
45
+ Worker has submitted. The value is an integer between 0 and 100.
46
+ </p>
47
+ </td></tr><tr><td>Worker_&#8203;NumberHITsApproved</td><td> 00000000000000000040 </td><td>Specifies the total number of HITs submitted by a Worker that have
48
+ been approved. The value is an integer greater than or equal to
49
+ 0.</td></tr><tr><td>Worker_Locale </td><td> 00000000000000000071 </td><td>
50
+ <p>The location of the Worker, as specified in the Worker's mailing
51
+ address. For more information about the locale Qualification, see
52
+ the following section. </p>
53
+ </td></tr><tr><td>Worker_Adult</td><td> 00000000000000000060 </td><td>Requires workers to acknowledge that they are over 18 and that they
54
+ agree to work on potentially offensive content. The value type is
55
+ boolean, 1 (required), 0 (not required, the default)</td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="AdultContent">Adding Adult Content</h2></div></div></div><a class="indexterm" name="d0e15829"></a><p>Adult content can be offensive to some people. For that reason, if your HIT is
56
+ adult-oriented, we ask you to use the following procedure.</p><div class="orderedlist"><p class="title"><b>Adding Adult HITs</b></p><ol type="1"><li><p class="simpara">In the HIT title, include the words "adult content."</p></li><li><p class="simpara">Specify the worker's qualifications in one of the following ways: </p><div class="informaltable"><table cellspacing="0" border="1"><colgroup><col></colgroup><tbody><tr><td>
57
+ <p class="simpara">Using the API:</p>
58
+ <div class="itemizedlist"><ul type="disc"><li><p class="simpara">Set the <code class="function">CreateHit</code>
59
+ parameter, <em class="parameter"><code>QualificationRequirement</code></em>, to the
60
+ qualification type, 00000000000000000060.</p></li><li><p class="simpara">Set <em class="parameter"><code>comparator</code></em> parameter
61
+ to "EqualTo." </p></li><li><p class="simpara"> Set the <em class="parameter"><code>IntegerValue</code></em>
62
+ parameter to 1 (required).</p></li></ul></div>
63
+ </td></tr><tr><td>
64
+ <p class="simpara">Using the command line tools, in the HIT properties
65
+ file:</p>
66
+ <div class="itemizedlist"><ul type="disc"><li><p class="simpara">Set <em class="parameter"><code>qualificationTypeId</code></em>
67
+ to 00000000000000000060.</p></li><li><p class="simpara">Set <em class="parameter"><code>comparator</code></em>, to
68
+ "EqualTo." </p></li><li><p class="simpara"> Set the <em class="parameter"><code>IntegerValue</code></em> to
69
+ 1 (required). For example,</p><pre class="programlisting">&lt;QualificationRequirement&gt;
70
+ &lt;QualificationTypeId&gt;00000000000000000060&lt;/QualificationTypeId&gt;
71
+ &lt;Comparator&gt;EqualTo&lt;/Comparator&gt;
72
+ &lt;IntegerValue&gt;1&lt;/IntegerValue&gt;
73
+ &lt;/QualificationRequirement&gt;</pre></li></ul></div>
74
+ </td></tr></tbody></table></div></li><li><p class="simpara">Define the HIT to be private or previewed.</p><p class="simpara">This setting prevents anyone who does not qualify from seeing the HIT. To
75
+ make the HIT private, use one of the following methods:</p><div class="informaltable"><table cellspacing="0" border="1"><colgroup><col></colgroup><tbody><tr><td>Using the API, set the <em class="parameter"><code>RequiredToPreview</code></em> parameter to true.</td></tr><tr><td>
76
+ <p class="simpara">Using the command line tools, in the HIT properties
77
+ file, set the private parameter, <em class="parameter"><code>qualification.private</code></em>, to TRUE. </p>
78
+ </td></tr></tbody></table></div></li></ol></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e15928">The Locale Qualification</h2></div></div></div><a class="indexterm" name="d0e15931"></a><a class="indexterm" name="d0e15934"></a><p> You can create a Qualification requirement based on the Worker's location. The
79
+ Worker's location is specified by the Worker to Amazon Mechanical Turk when the Worker
80
+ creates his account. </p><p> To create a Qualification requirement based on the Worker's location, specify: </p><div class="itemizedlist"><ul type="disc"><li><p>
81
+ <span>a <em class="parameter"><code>QualificationTypeId</code></em> of
82
+ 00000000000000000071</span>
83
+ </p></li><li><p>
84
+ <span>a <em class="parameter"><code>Comparator</code></em> of <em class="parameter"><code>EqualTo</code></em> or
85
+ <em class="parameter"><code>NotEqualTo</code></em></span>
86
+ </p></li><li><p>
87
+ <span>a <em class="parameter"><code>LocaleValue</code></em> data structure that corresponds to
88
+ the desired locale</span>
89
+ </p></li></ul></div><p> For more information on the format of a <em class="parameter"><code>LocaleValue</code></em>, see <a class="link" href="ApiReference_LocaleDataStructureArticle.html" title="Locale">Locale data structure</a>. </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> A Worker must meet <span class="emphasis"><em>all</em></span> of a HIT's Qualification requirements
90
+ to qualify for the HIT. This means you cannot specify more than one locale
91
+ Qualification requirement, because a given Worker will only be able to match one of
92
+ the requirements. There is no way to allow Workers of varying locales to qualify for
93
+ a single HIT. </p></td></tr></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e15990">Sample: CreateHIT</h2></div></div></div><p> The following example of a QualificationRequirement data structure could be passed in
94
+ to a call to <code class="function">CreateHIT</code>. <code class="function">CreateHIT</code> accepts
95
+ parameters that describe the HIT being created, including one or more Qualification
96
+ requirements. </p><p> In a SOAP request, the QualificationRequirement data structure is specified as the
97
+ <em class="parameter"><code>QualificationRequirement</code></em> parameter in XML: </p><pre class="programlisting">&lt;QualificationRequirement&gt;
98
+ &lt;QualificationTypeId&gt;789RVWYBAZW00EXAMPLE&lt;/QualificationTypeId&gt;
99
+ &lt;Comparator&gt;GreaterThan&lt;/Comparator&gt;
100
+ &lt;IntegerValue&gt;18&lt;/IntegerValue&gt;
101
+ &lt;/QualificationRequirement&gt;</pre><p> In a REST request, the components of the QualificationRequirement data structure are
102
+ specified as separate parameters. To specify more than one <em class="parameter"><code>QualificationRequirement</code></em> in a REST request, increment the sequence
103
+ number in the parameter name for each value: </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
104
+ <em class="replaceable"><code>[...]</code></em>
105
+ &amp;QualificationRequirement.1.QualificationTypeId=789RVWYBAZW00EXAMPLE
106
+ &amp;QualificationRequirement.1.Comparator=GreaterThan
107
+ &amp;QualificationRequirement.1.IntegerValue=18
108
+ &amp;QualificationRequirement.2.QualificationTypeId=237HSIANVCI00EXAMPLE
109
+ &amp;QualificationRequirement.2.Comparator=EqualTo
110
+ &amp;QualificationRequirement.2.IntegerValue=1
111
+ </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e16018">Elements</h2></div></div></div><p> The QualificationRequirement structure may 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>Value</th></tr></thead><tbody><tr><td>
112
+ <em class="parameter"><code>QualificationTypeId</code></em>
113
+ </td><td>
114
+ <p> The ID of the Qualification type for the requirement. </p>
115
+ </td><td>
116
+ <p> A valid QualificationType ID </p>
117
+ </td></tr><tr><td>
118
+ <em class="parameter"><code>Comparator</code></em>
119
+ </td><td>
120
+ <p> The kind of comparison to make against a Qualification's value. </p>
121
+ <p> Two values can be compared to see if one value is <em class="parameter"><code>LessThan</code></em>, <em class="parameter"><code>LessThanOrEqualTo</code></em>,
122
+ <em class="parameter"><code>GreaterThan</code></em>, <em class="parameter"><code>GreaterThanOrEqualTo</code></em>, <em class="parameter"><code>EqualTo</code></em>, or <em class="parameter"><code>NotEqualTo</code></em> the
123
+ other. </p>
124
+ <p> A Qualification requirement can also test if a Qualification
125
+ <em class="parameter"><code>Exists</code></em> in the user's profile, regardless
126
+ of its value. </p>
127
+ </td><td>
128
+ <p>
129
+ <em class="parameter"><code>LessThan</code></em> | <em class="parameter"><code>LessThanOrEqualTo</code></em> | <em class="parameter"><code>GreaterThan</code></em> | <em class="parameter"><code>GreaterThanOrEqualTo</code></em> | <em class="parameter"><code>EqualTo</code></em> | <em class="parameter"><code>NotEqualTo</code></em> |
130
+ <em class="parameter"><code>Exists</code></em>
131
+ </p>
132
+ </td></tr><tr><td>
133
+ <em class="parameter"><code>IntegerValue</code></em>
134
+ </td><td>
135
+ <p> The integer value to compare against the Qualification's value. </p>
136
+ <p>
137
+ <em class="parameter"><code>IntegerValue</code></em> must not be present if
138
+ <em class="parameter"><code>Comparator</code></em> is <em class="parameter"><code>Exists</code></em>. </p>
139
+ <p>
140
+ <em class="parameter"><code>IntegerValue</code></em> can only be used if the
141
+ Qualification type has an integer value (i.e. not with the locale
142
+ Qualification). </p>
143
+ </td><td>
144
+ <p> An integer </p>
145
+ </td></tr><tr><td>
146
+ <em class="parameter"><code>LocaleValue</code></em>
147
+ </td><td>
148
+ <p> The locale value to compare against the Qualification's value, if
149
+ the Qualification being compared is the locale Qualification. </p>
150
+ <p>
151
+ <em class="parameter"><code>LocaleValue</code></em> can only be used with the
152
+ <em class="parameter"><code>EqualTo</code></em> and <em class="parameter"><code>NotEqualTo</code></em> comparators. </p>
153
+ <p>
154
+ <em class="parameter"><code>LocaleValue</code></em> can only be used if the
155
+ Qualification type has a locale value (i.e. the locale
156
+ Qualification). </p>
157
+ </td><td>
158
+ <p> A locale data structure. (See previous.) </p>
159
+ </td></tr><tr><td>
160
+ <em class="parameter"><code>RequiredToPreview</code></em>
161
+ </td><td>
162
+ <p> If <strong class="userinput"><code>true</code></strong>, the question data for the HIT
163
+ will not be shown when a Worker whose Qualifications do not meet
164
+ this requirement tries to preview the HIT. That is, a Worker's
165
+ Qualifications must meet all of the requirements for which
166
+ <em class="parameter"><code>RequiredToPreview</code></em> is <strong class="userinput"><code>true</code></strong> in order to preview the HIT. </p>
167
+ <p> If a Worker meets all of the requirements where <em class="parameter"><code>RequiredToPreview</code></em> is <strong class="userinput"><code>true</code></strong>
168
+ (or if there are no such requirements), but does not meet all of the
169
+ requirements for the HIT, the Worker will be allowed to preview the
170
+ HIT's question data, but will not be allowed to accept and complete
171
+ the HIT. </p>
172
+ <p> The default is <strong class="userinput"><code>false</code></strong>. </p>
173
+ </td><td>
174
+ <p> A Boolean value, <strong class="userinput"><code>true</code></strong> or <strong class="userinput"><code>false</code></strong>
175
+ </p>
176
+ </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_QualificationRequestDataStructureArticle.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_QualificationRequirementDataStructureArticle">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_QualificationTypeDataStructureArticle.html"><img src="images/next.gif" alt="Next"></a></td></tr><tr><td width="30%" align="left" valign="top">&nbsp;</td><td width="40%" align="center"><a accesskey="h" href="#top"><img src="images/home.gif" alt="Home"></a></td><td width="30%" align="right" valign="top">&nbsp;</td></tr></table></div></body></html>
data/aws_docs/ApiReference_QualificationTypeDataStructureArticle.html ADDED
@@ -0,0 +1,198 @@
1
+ <html xmlns:fo="http://www.w3.org/1999/XSL/Format"><head>
2
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3
+ <title>QualificationType</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_QualificationRequirementDataStructureArticle.html" title="QualificationRequirement"><link rel="next" href="ApiReference_NotificationDataStructureArticle.html" title="Notification"><!--[if !IE]>--><link rel="stylesheet" href="aws-docs.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><!--<![endif]--><meta xmlns="http://www.w3.org/1999/xhtml" http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><script src="/urchin.js" type="text/javascript"></script><script type="text/javascript">
4
+ urchinTracker();
5
+ </script><script xmlns="http://www.w3.org/1999/xhtml" type="text/javascript" src="frameset.js"> //
6
+ </script></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header" cellspacing="0" cellpadding="2"><tr><td width="30%" align="left"><a accesskey="p" href="ApiReference_QualificationRequirementDataStructureArticle.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_QualificationTypeDataStructureArticle">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_NotificationDataStructureArticle.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>QualificationType</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">QualificationType</h1></div></div></div><a class="indexterm" name="d0e16235"></a><a class="indexterm" name="d0e16238"></a><a class="indexterm" name="d0e16245"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e16250">Description</h2></div></div></div><p> The QualificationType data structure represents a Qualification type, a description of a
7
+ property of a Worker that must match the requirements of a HIT for the Worker to be able to accept
8
+ the HIT. The type also describes how a Worker can obtain a Qualification of that type, such as
9
+ through a Qualification test. </p><p> The QualificationType data structure is used as a response element for the following
10
+ operations: </p><div class="itemizedlist"><ul type="disc"><li><p>
11
+ <a class="link" href="ApiReference_CreateQualificationTypeOperation.html" title="CreateQualificationType">CreateQualificationType</a>
12
+ </p></li><li><p>
13
+ <a class="link" href="ApiReference_GetQualificationTypeOperation.html" title="GetQualificationType">GetQualificationType</a>
14
+ </p></li><li><p>
15
+ <a class="link" href="ApiReference_SearchQualificationTypesOperation.html" title="SearchQualificationTypes">SearchQualificationTypes</a>
16
+ </p></li><li><p>
17
+ <a class="link" href="ApiReference_UpdateQualificationTypeOperation.html" title="UpdateQualificationType">UpdateQualificationType</a>
18
+ </p></li></ul></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e16282">Elements</h2></div></div></div><p> The QualificationType structure can contain the elements described in the following table: </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col><col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>
19
+ <p class="simpara">
20
+ <em class="parameter"><code>QualificationTypeId</code></em>
21
+ </p>
22
+ </td><td>
23
+ <p class="simpara">A unique identifier for the Qualification type. A Qualification type is
24
+ given a Qualification type ID when you call the <a class="link" href="ApiReference_CreateQualificationTypeOperation.html" title="CreateQualificationType">CreateQualificationType</a> operation operation, and it retains that
25
+ ID forever. </p>
26
+ <p class="simpara">Type: String</p>
27
+ <p class="simpara">Default: None</p>
28
+ </td><td>
29
+ <p class="simpara">No</p>
30
+ </td></tr><tr><td>
31
+ <p class="simpara">
32
+ <em class="parameter"><code>CreationTime</code></em>
33
+ </p>
34
+ </td><td>
35
+ <p class="simpara">The date and time the Qualification type was created</p>
36
+ <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
37
+ Time) time zone, such as <strong class="userinput"><code>2005-01-31T23:59:59Z</code></strong>. </p>
38
+ <p class="simpara">Default: None</p>
39
+ </td><td>
40
+ <p class="simpara">No</p>
41
+ </td></tr><tr><td>
42
+ <p class="simpara">
43
+ <em class="parameter"><code>Name</code></em>
44
+ </p>
45
+ </td><td>
46
+ <p class="simpara"> The name of the Qualification type. The type name is used to identify
47
+ the type, and to find the type using a Qualification type search. </p>
48
+ <p class="simpara">Type: String</p>
49
+ <p class="simpara">Default: None</p>
50
+ </td><td>
51
+ <p class="simpara">No</p>
52
+ </td></tr><tr><td>
53
+ <p class="simpara">
54
+ <em class="parameter"><code>Description</code></em>
55
+ </p>
56
+ </td><td>
57
+ <p class="simpara">A long description for the Qualification type.</p>
58
+ <p class="simpara">Type: String</p>
59
+ <p class="simpara">Default: None</p>
60
+ </td><td>
61
+ <p class="simpara">No</p>
62
+ </td></tr><tr><td>
63
+ <p class="simpara">
64
+ <em class="parameter"><code>Keywords</code></em>
65
+ </p>
66
+ </td><td>
67
+ <p class="simpara"> One or more words or phrases that describe theQualification type,
68
+ separated by commas. The Keywords make the type easier to find using a search. </p>
69
+ <p class="simpara">Type: String</p>
70
+ <p class="simpara">Default: None</p>
71
+ </td><td>
72
+ <p class="simpara">No</p>
73
+ </td></tr><tr><td>
74
+ <p class="simpara">
75
+ <em class="parameter"><code>QualificationTypeStatus</code></em>
76
+ </p>
77
+ </td><td>
78
+ <p class="simpara"> The status of the Qualification type. A Qualification type's status
79
+ determines if users can apply to receive a Qualification of this type, and if
80
+ HITs can be created with requirements based on this type. </p>
81
+ <p class="simpara">Type: String</p>
82
+ <p class="simpara">Valid Values: Active | Inactive</p>
83
+ <p class="simpara">Default: None</p>
84
+ </td><td>
85
+ <p class="simpara">No</p>
86
+ </td></tr><tr><td>
87
+ <p class="simpara">
88
+ <em class="parameter"><code>RetryDelayInSeconds</code></em>
89
+ </p>
90
+ </td><td>
91
+ <p class="simpara"> The amount of time, in seconds, Workers must wait after taking the
92
+ Qualification test before they can take it again. Workers can take a
93
+ Qualification test multiple times if they were not granted the Qualification
94
+ from a previous attempt, or if the test offers a gradient score and they want
95
+ a better score. </p>
96
+ <p class="simpara">Type: positive integer</p>
97
+ <p class="simpara"> Default: None. If not specified, retries are disabled and Workers can
98
+ request a Qualification only once. </p>
99
+ </td><td>
100
+ <p class="simpara">No</p>
101
+ </td></tr><tr><td>
102
+ <p class="simpara">
103
+ <em class="parameter"><code>Test</code></em>
104
+ </p>
105
+ </td><td>
106
+ <p class="simpara"> The questions for a Qualification test associated with this
107
+ Qualification type that a user can take to obtain a Qualification of this
108
+ type. </p>
109
+ <p class="simpara"> Type: a <a class="link" href="ApiReference_QuestionFormDataStructureArticle.html" title="QuestionForm">QuestionForm</a> data structure. </p>
110
+ <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> A Qualification test cannot use an <a class="link" href="ApiReference_ExternalQuestionArticle.html" title="ExternalQuestion">ExternalQuestionQuestionForm</a> like a HIT can. </p></td></tr></table></div>
111
+ <p class="simpara">Default: None</p>
112
+ <p class="simpara"> Constraints: must be specified if <em class="parameter"><code>AnswerKey</code></em> is
113
+ present. A Qualification type cannot have both a specified
114
+ <em class="parameter"><code>Test</code></em> parameter and an
115
+ <em class="parameter"><code>AutoGranted</code></em> value of <strong class="userinput"><code>true</code></strong>.
116
+ </p>
117
+ </td><td>
118
+ <p class="simpara">No</p>
119
+ </td></tr><tr><td>
120
+ <p class="simpara">
121
+ <em class="parameter"><code>TestDurationInSeconds</code></em>
122
+ </p>
123
+ </td><td>
124
+ <p class="simpara"> The amount of time, in seconds, given to a Worker to complete the
125
+ Qualification test, beginning from the time the Worker requests the
126
+ Qualification. </p>
127
+ <p class="simpara">Type: positive integer</p>
128
+ <p class="simpara">Default: None</p>
129
+ </td><td>
130
+ <p class="simpara">No</p>
131
+ </td></tr><tr><td>
132
+ <p class="simpara">
133
+ <em class="parameter"><code>AnswerKey</code></em>
134
+ </p>
135
+ </td><td>
136
+ <p class="simpara"> The answers to the Qualification test specified in the
137
+ <em class="parameter"><code>Test</code></em> parameter. </p>
138
+ <p class="simpara"> Type: an <a class="link" href="ApiReference_AnswerKeyDataStructureArticle.html" title="AnswerKey">AnswerKey</a> data structure. </p>
139
+ <p class="simpara"> Default: None. If not provided with a test, the Qualification author
140
+ must process the Qualification request manually. </p>
141
+ </td><td>
142
+ <p class="simpara">No</p>
143
+ </td></tr><tr><td>
144
+ <p class="simpara">
145
+ <em class="parameter"><code>AutoGranted</code></em>
146
+ </p>
147
+ </td><td>
148
+ <p class="simpara"> Specifies that requests for the Qualification type are granted
149
+ immediately, without prompting the Worker with a Qualification test. </p>
150
+ <p class="simpara">Type: Boolean</p>
151
+ <p class="simpara">Valid Values: true | false</p>
152
+ <p class="simpara">Default: None</p>
153
+ <p class="simpara"> Constraints: A Qualification type cannot have both a specified
154
+ <em class="parameter"><code>Test</code></em> parameter and an
155
+ <em class="parameter"><code>AutoGranted</code></em> value of <strong class="userinput"><code>true</code></strong>.
156
+ </p>
157
+ </td><td>
158
+ <p class="simpara">No </p>
159
+ </td></tr><tr><td>
160
+ <p class="simpara">
161
+ <em class="parameter"><code>AutoGrantedValue</code></em>
162
+ </p>
163
+ </td><td>
164
+ <p class="simpara"> The Qualification value to use for automatically granted Qualifications,
165
+ if <em class="parameter"><code>AutoGranted</code></em> is <code class="code">true</code>. </p>
166
+ <p class="simpara">Type: Integer</p>
167
+ <p class="simpara">Default: 1</p>
168
+ </td><td>
169
+ <p class="simpara">No </p>
170
+ </td></tr><tr><td>
171
+ <p class="simpara">
172
+ <em class="parameter"><code>IsRequestable</code></em>
173
+ </p>
174
+ </td><td>
175
+ <p class="simpara"> Specifies whether the Qualification type is one that a user can request
176
+ through the Amazon Mechanical Turk web site, such as by taking a Qualification
177
+ test. This value is <strong class="userinput"><code>false</code></strong> for Qualifications assigned
178
+ automatically by the system. </p>
179
+ <p class="simpara">Type: Boolean</p>
180
+ <p class="simpara">Valid Values: true | false</p>
181
+ <p class="simpara">Default: None</p>
182
+ </td><td>
183
+ <p class="simpara">No </p>
184
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e16696">Example </h2></div></div></div><p> The following example shows a QualificationType data structure returned by a call to the <a class="link" href="ApiReference_GetQualificationTypeOperation.html" title="GetQualificationType">GetQualificationType</a> operation.
185
+ The <a class="link" href="ApiReference_GetQualificationTypeOperation.html" title="GetQualificationType">GetQualificationType</a>
186
+ operation returns a <code class="code">GetQualificationTypeResult</code> element, which contains a
187
+ <code class="code">QualificationType</code> element. </p><pre class="programlisting">
188
+ &lt;QualificationType&gt;
189
+ &lt;QualificationTypeId&gt;789RVWYBAZW00EXAMPLE&lt;/QualificationTypeId&gt;
190
+ &lt;CreationTime&gt;2005-01-31T23:59:59Z&lt;/CreationTime&gt;
191
+ &lt;Name&gt;EnglishWritingAbility&lt;/Name&gt;
192
+ &lt;Description&gt;The ability to write and edit text...&lt;/Description&gt;
193
+ &lt;Keywords&gt;English, text, write, edit, language&lt;/Keywords&gt;
194
+ &lt;QualificationTypeStatus&gt;Active&lt;/QualificationTypeStatus&gt;
195
+ &lt;RetryDelayInSeconds&gt;86400&lt;/RetryDelayInSeconds&gt;
196
+ &lt;IsRequestable&gt;true&lt;/IsRequestable&gt;
197
+ &lt;/QualificationType&gt;
198
+ </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_QualificationRequirementDataStructureArticle.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_QualificationTypeDataStructureArticle">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_NotificationDataStructureArticle.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>