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_GetHITOperation.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>GetHIT</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_GetFileUploadURLOperation.html" title="GetFileUploadURL"><link rel="next" href="ApiReference_GetHITsForQualificationTypeOperation.html" title="GetHITsForQualificationType"><!--[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_GetFileUploadURLOperation.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_GetHITOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_GetHITsForQualificationTypeOperation.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>GetHIT</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">GetHIT</h1></div></div></div><a class="indexterm" name="d0e5920"></a><a class="indexterm" name="d0e5923"></a><a class="indexterm" name="d0e5928"></a><a class="indexterm" name="d0e5933"></a><a class="indexterm" name="d0e5938"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e5943">Description</h2></div></div></div><p> The <code class="function">GetHIT</code> operation retrieves the details of the specified HIT.
7
+ </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e5951">Request Parameters</h2></div></div></div><p> The <code class="function">GetHIT</code> accepts parameters common to all operations. Some
8
+ 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">GetHIT</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>
9
+ <p class="simpara">
10
+ <em class="parameter"><code>Operation</code></em>
11
+ </p>
12
+ </td><td>
13
+ <p class="simpara">The name of the operation.</p>
14
+ <p class="simpara">Type: String</p>
15
+ <p class="simpara">Valid Values: GetHIT</p>
16
+ <p class="simpara">Default: None</p>
17
+ </td><td>
18
+ <p class="simpara">Yes</p>
19
+ </td></tr><tr><td>
20
+ <p class="simpara">
21
+ <em class="parameter"><code>HITId</code></em>
22
+ </p>
23
+ </td><td>
24
+ <p class="simpara">The ID of the HIT to retrieve.</p>
25
+ <p class="simpara">Type: String</p>
26
+ <p class="simpara">Default: None</p>
27
+ </td><td>
28
+ <p class="simpara">Yes</p>
29
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e6034">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">GetHIT</code> operation returns the
30
+ elements described in the following table in the response. </p><p> The <em class="parameter"><code>HIT</code></em> element contains the requested HIT data. For a
31
+ description of the HIT data structure as it appears in responses, see the <a class="link" href="ApiReference_HITDataStructureArticle.html" title="HIT"> HIT</a> data structure. </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>
32
+ <p class="simpara">
33
+ <em class="parameter"><code>HIT</code></em>
34
+ </p>
35
+ </td><td>
36
+ <p class="simpara"> Contains the requested HIT data. </p>
37
+ <p class="simpara"> Type: <a class="link" href="ApiReference_HITDataStructureArticle.html" title="HIT">
38
+ HIT Data Structure</a>
39
+ </p>
40
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e6081">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">GetHIT</code>
41
+ operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e6089">Sample Request</h3></div></div></div><p> The following example gets a HIT specified by a HIT ID. </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
42
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
43
+ &amp;Version=2008-08-02
44
+ &amp;Operation=GetHIT
45
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
46
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
47
+ &amp;HITId=123RVWYBAZW00EXAMPLE
48
+ </pre></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e6105">Sample Response</h2></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;HIT&gt;
49
+ &lt;Request&gt;
50
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
51
+ &lt;/Request&gt;
52
+ &lt;HITId&gt;ZZRZPTY4ERDZWJ868JCZ&lt;/HITId&gt;
53
+ &lt;HITTypeId&gt;NYVZTQ1QVKJZXCYZCZVZ&lt;/HITTypeId&gt;
54
+ &lt;CreationTime&gt;2009-07-07T00:56:40Z&lt;/CreationTime&gt;
55
+ &lt;Title&gt;Location&lt;/Title&gt;
56
+ &lt;Description&gt;Select the image that best represents&lt;/Description&gt;
57
+ &lt;Question&gt;
58
+ &lt;QuestionForm xmlns="http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2005-10-01/QuestionForm.xsd"&gt;
59
+ &lt;Question&gt;
60
+ &lt;QuestionIdentifier&gt;Question100&lt;/QuestionIdentifier&gt;
61
+ &lt;DisplayName&gt;My Question&lt;/DisplayName&gt;
62
+ &lt;IsRequired&gt;true&lt;/IsRequired&gt;
63
+ &lt;QuestionContent&gt;
64
+ &lt;Binary&gt;
65
+ &lt;MimeType&gt;
66
+ &lt;Type&gt;image&lt;/Type&gt;
67
+ &lt;SubType&gt;gif&lt;/SubType&gt;
68
+ &lt;/MimeType&gt;
69
+ &lt;DataURL&gt;http://tictactoe.amazon.com/game/01523/board.gif&lt;/DataURL&gt;
70
+ &lt;AltText&gt;The game board, with "X" to move.&lt;/AltText&gt;
71
+ &lt;/Binary&gt;
72
+ &lt;/QuestionContent&gt;
73
+ &lt;AnswerSpecification&gt;&lt;FreeTextAnswer/&gt;&lt;/AnswerSpecification&gt;
74
+ &lt;/Question&gt;
75
+ &lt;/QuestionForm&gt;
76
+ &lt;/Question&gt;
77
+ &lt;HITStatus&gt;Assignable&lt;/HITStatus&gt;
78
+ &lt;MaxAssignments&gt;1&lt;/MaxAssignments&gt;
79
+ &lt;Reward&gt;
80
+ &lt;Amount&gt;5.00&lt;/Amount&gt;
81
+ &lt;CurrencyCode&gt;USD&lt;/CurrencyCode&gt;
82
+ &lt;FormattedPrice&gt;$5.00&lt;/FormattedPrice&gt;
83
+ &lt;/Reward&gt;
84
+ &lt;AutoApprovalDelayInSeconds&gt;2592000&lt;/AutoApprovalDelayInSeconds&gt;
85
+ &lt;Expiration&gt;2009-07-14T00:56:40Z&lt;/Expiration&gt;
86
+ &lt;AssignmentDurationInSeconds&gt;30&lt;/AssignmentDurationInSeconds&gt;
87
+ &lt;NumberOfSimilarHITs&gt;1&lt;/NumberOfSimilarHITs&gt;
88
+ &lt;HITReviewStatus&gt;NotReviewed&lt;/HITReviewStatus&gt;
89
+ &lt;/HIT&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_GetFileUploadURLOperation.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_GetHITOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_GetHITsForQualificationTypeOperation.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_GetHITsForQualificationTypeOperation.html ADDED
@@ -0,0 +1,137 @@
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>GetHITsForQualificationType</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_GetHITOperation.html" title="GetHIT"><link rel="next" href="ApiReference_GetQualificationsForQualificationTypeOperation.html" title="GetQualificationsForQualificationType"><!--[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_GetHITOperation.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_GetHITsForQualificationTypeOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_GetQualificationsForQualificationTypeOperation.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>GetHITsForQualificationType</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">GetHITsForQualificationType</h1></div></div></div><a class="indexterm" name="d0e6116"></a><a class="indexterm" name="d0e6119"></a><a class="indexterm" name="d0e6124"></a><a class="indexterm" name="d0e6129"></a><a class="indexterm" name="d0e6134"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e6139">Description</h2></div></div></div><p> The <code class="function">GetHITsForQualificationType</code> operation returns the HITs that
7
+ use the given Qualification type for a Qualification requirement. </p><p> The operation returns HITs of any status, except for HITs that have been disposed
8
+ with the <a class="link" href="ApiReference_DisposeHITOperation.html" title="DisposeHIT">DisposeHIT</a> operation. </p><p> This operation returns only HITs that you created. </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> For reasons internal to the service, there may be a delay between when a HIT is
9
+ created and when the HIT will be returned from a call to <code class="function">GetHITsForQualificationType</code>. </p></td></tr></table></div><p> The operation divides the results into numbered pages and returns a single page of
10
+ results. You can control pagination with parameters to the operation. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e6162">Request Parameters</h2></div></div></div><p> The <code class="function">GetHITsForQualificationType</code> operation accepts parameters
11
+ 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">GetHITsForQualificationType</code> operation: </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col><col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>
12
+ <p class="simpara">
13
+ <em class="parameter"><code>Operation</code></em>
14
+ </p>
15
+ </td><td>
16
+ <p class="simpara">The name of the operation.</p>
17
+ <p class="simpara">Type: String</p>
18
+ <p class="simpara">Valid Values: GetHITsForQualificationType</p>
19
+ <p class="simpara">Default: None</p>
20
+ </td><td>
21
+ <p class="simpara">Yes</p>
22
+ </td></tr><tr><td>
23
+ <p class="simpara">
24
+ <em class="parameter"><code>QualificationTypeId</code></em>
25
+ </p>
26
+ </td><td>
27
+ <p class="simpara"> The ID of the Qualification type to use when querying HITs, as
28
+ returned by the <a class="link" href="ApiReference_CreateQualificationTypeOperation.html" title="CreateQualificationType">CreateQualificationType</a> operation. The operation returns
29
+ HITs that require that a Worker have a Qualification of this type. </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>PageSize</code></em>
37
+ </p>
38
+ </td><td>
39
+ <p class="simpara"> The number of HITs to include in a page of results. The
40
+ complete results set is divided into pages of this many HITs. </p>
41
+ <p class="simpara">Type: positive integer</p>
42
+ <p class="simpara">Valid Values: any integer between 1 and 100</p>
43
+ <p class="simpara">Default: 10</p>
44
+ </td><td>
45
+ <p class="simpara">No</p>
46
+ </td></tr><tr><td>
47
+ <p class="simpara">
48
+ <em class="parameter"><code>PageNumber</code></em>
49
+ </p>
50
+ </td><td>
51
+ <p class="simpara"> The page of results to return. After the HITs are divided into
52
+ pages of size <em class="parameter"><code>PageSize</code></em>, the operation returns
53
+ the page corresponding to the <em class="parameter"><code>PageNumber</code></em>. </p>
54
+ <p class="simpara">Type: positive integer</p>
55
+ <p class="simpara">Default: 1</p>
56
+ </td><td>
57
+ <p>No</p>
58
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e6306">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">GetHITsForQualificationType</code>
59
+ operation returns a <em class="parameter"><code>GetHITsForQualificationTypeResult</code></em> element in
60
+ the response. </p><p> The <em class="parameter"><code>GetHITsForQualificationTypeResult</code></em> element contains the
61
+ following elements: </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>
62
+ <p class="simpara">
63
+ <em class="parameter"><code>NumResults</code></em>
64
+ </p>
65
+ </td><td>
66
+ <p class="simpara"> The number of HITs on this page in the filtered results list,
67
+ equivalent to the number of HITs being returned by this call. </p>
68
+ <p class="simpara">Type: non-negative integer</p>
69
+ </td></tr><tr><td>
70
+ <p class="simpara">
71
+ <em class="parameter"><code>PageNumber</code></em>
72
+ </p>
73
+ </td><td>
74
+ <p class="simpara"> The number of this page in the filtered results list. </p>
75
+ <p class="simpara">Type: positive integer</p>
76
+ </td></tr><tr><td>
77
+ <p class="simpara">
78
+ <em class="parameter"><code>TotalNumResults</code></em>
79
+ </p>
80
+ </td><td>
81
+ <p class="simpara"> The total number of HITs in the filtered results list based on
82
+ this call. </p>
83
+ <p class="simpara">Type: non-negative integer</p>
84
+ </td></tr><tr><td>
85
+ <p class="simpara">
86
+ <em class="parameter"><code>HIT</code></em>
87
+ </p>
88
+ </td><td>
89
+ <p class="simpara"> The HIT. The response includes one <em class="parameter"><code>HIT</code></em>
90
+ element for each HIT returned by the query. </p>
91
+ <p class="simpara"> Type: <a class="link" href="ApiReference_HITDataStructureArticle.html" title="HIT">
92
+ HIT</a> data structure. </p>
93
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e6407">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">GetHITsForQualificationType</code> operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e6415">Sample Request</h3></div></div></div><p> The following example returns HITs that use the specified Qualification type for
94
+ a Qualification requirement. </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
95
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
96
+ &amp;Version=2008-08-02
97
+ &amp;Operation=GetHITsForQualificationType
98
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
99
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
100
+ &amp;QualificationTypeId=789RVWYBAZW00EXAMPLE
101
+ </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e6431">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;GetHITsForQualificationTypeResult&gt;
102
+ &lt;Request&gt;
103
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
104
+ &lt;/Request&gt;
105
+ &lt;NumResults&gt;1&lt;/NumResults&gt;
106
+ &lt;TotalNumResults&gt;1&lt;/TotalNumResults&gt;
107
+ &lt;PageNumber&gt;1&lt;/PageNumber&gt;
108
+ &lt;HIT&gt;
109
+ &lt;HITId&gt;123RVWYBAZW00EXAMPLE&lt;/HITId&gt;
110
+ &lt;HITTypeId&gt;T100CN9P324W00EXAMPLE&lt;/HITTypeId&gt;
111
+ &lt;CreationTime&gt;2009-06-15T12:00:01&lt;/CreationTime&gt;
112
+ &lt;HITStatus&gt;Assignable&lt;/HITStatus&gt;
113
+ &lt;MaxAssignments&gt;5&lt;/MaxAssignments&gt;
114
+ &lt;AutoApprovalDelayInSeconds&gt;86400&lt;/AutoApprovalDelayInSeconds&gt;
115
+ &lt;LifetimeInSeconds&gt;86400&lt;/LifetimeInSeconds&gt;
116
+ &lt;AssignmentDurationInSeconds&gt;300&lt;/AssignmentDurationInSeconds&gt;
117
+ &lt;Reward&gt;
118
+ &lt;Amount&gt;25&lt;/Amount&gt;
119
+ &lt;CurrencyCode&gt;USD&lt;/CurrencyCode&gt;
120
+ &lt;FormattedPrice&gt;$0.25&lt;/FormattedPrice&gt;
121
+ &lt;/Reward&gt;
122
+ &lt;Title&gt;Location and Photograph Identification&lt;/Title&gt;
123
+ &lt;Description&gt;Select the image that best represents...&lt;/Description&gt;
124
+ &lt;Keywords&gt;location, photograph, image, identification, opinion&lt;/Keywords&gt;
125
+ &lt;Question&gt;
126
+ &amp;lt;QuestionForm&amp;gt;
127
+ [XML-encoded Question data]
128
+ &amp;lt;/QuestionForm&amp;gt;
129
+ &lt;/Question&gt;
130
+ &lt;QualificationRequirement&gt;
131
+ &lt;QualificationTypeId&gt;789RVWYBAZW00EXAMPLE&lt;/QualificationTypeId&gt;
132
+ &lt;Comparator&gt;GreaterThan&lt;/Comparator&gt;
133
+ &lt;Value&gt;18&lt;/Value&gt;
134
+ &lt;/QualificationRequirement&gt;
135
+ &lt;HITReviewStatus&gt;NotReviewed&lt;/HITReviewStatus&gt;
136
+ &lt;/HIT&gt;
137
+ &lt;/GetHITsForQualificationTypeResult&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_GetHITOperation.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_GetHITsForQualificationTypeOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_GetQualificationsForQualificationTypeOperation.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_GetQualificationRequestsOperation.html ADDED
@@ -0,0 +1,155 @@
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>GetQualificationRequests</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_GetQualificationsForQualificationTypeOperation.html" title="GetQualificationsForQualificationType"><link rel="next" href="ApiReference_GetQualificationScoreOperation.html" title="GetQualificationScore"><!--[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_GetQualificationsForQualificationTypeOperation.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_GetQualificationRequestsOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_GetQualificationScoreOperation.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>GetQualificationRequests</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">GetQualificationRequests</h1></div></div></div><a class="indexterm" name="d0e6783"></a><a class="indexterm" name="d0e6786"></a><a class="indexterm" name="d0e6791"></a><a class="indexterm" name="d0e6796"></a><a class="indexterm" name="d0e6801"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e6806">Description</h2></div></div></div><p> The <code class="function">GetQualificationRequests</code> operation retrieves requests for
7
+ Qualifications of a particular Qualification type. The owner of the Qualification type
8
+ calls this operation to poll for pending requests, and grants Qualifications based on
9
+ the requests using the <a class="link" href="ApiReference_GrantQualificationOperation.html" title="GrantQualification">GrantQualification</a> operation. </p><p> The <code class="function">GetQualificationRequests</code> operation returns only those
10
+ Qualifications that require the type owner's attention. The operation does not return
11
+ requests awaiting Qualification test answers and requests that have already been
12
+ granted. </p><p> Only the owner of the Qualification type can retrieve its requests. </p><p> The operation sorts the results, divides them into numbered pages, and returns a
13
+ single page of results. You can control sorting and pagination with parameters to the
14
+ operation. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e6826">Request Parameters</h2></div></div></div><p> The <code class="function">GetQualificationRequests</code> operation accepts parameters common
15
+ 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
16
+ information. </p><p> The following parameters are specific to the <code class="function">GetQualificationRequests</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>
17
+ <p class="simpara">
18
+ <em class="parameter"><code>Operation</code></em>
19
+ </p>
20
+ </td><td>
21
+ <p class="simpara">The name of the operation.</p>
22
+ <p class="simpara">Type: String</p>
23
+ <p class="simpara">Valid Values: GetQualificationRequests</p>
24
+ <p class="simpara">Default: None</p>
25
+ </td><td>
26
+ <p class="simpara">Yes</p>
27
+ </td></tr><tr><td>
28
+ <p class="simpara">
29
+ <em class="parameter"><code>QualificationTypeId</code></em>
30
+ </p>
31
+ </td><td>
32
+ <p class="simpara"> The ID of the Qualification type, as returned by the <a class="link" href="ApiReference_CreateQualificationTypeOperation.html" title="CreateQualificationType">CreateQualificationType</a> operation. </p>
33
+ <p class="simpara">Type: String</p>
34
+ <p class="simpara"> Default: None. If not specified, all requests for all of your
35
+ Qualification types are considered for the results. </p>
36
+ </td><td>
37
+ <p class="simpara">No</p>
38
+ </td></tr><tr><td>
39
+ <p class="simpara">
40
+ <em class="parameter"><code>SortProperty</code></em>
41
+ </p>
42
+ </td><td>
43
+ <p class="simpara"> The field on which to sort the returned results. </p>
44
+ <p class="simpara">Type: String</p>
45
+ <p class="simpara">Valid Values: QualificationTypeId | SubmitTime</p>
46
+ <p class="simpara">Default: SubmitTime</p>
47
+ </td><td>
48
+ <p class="simpara">No</p>
49
+ </td></tr><tr><td>
50
+ <p class="simpara">
51
+ <em class="parameter"><code>SortDirection</code></em>
52
+ </p>
53
+ </td><td>
54
+ <p class="simpara"> The direction of the sort. </p>
55
+ <p class="simpara">Type: String</p>
56
+ <p class="simpara">Valid Values: Ascending | Descending</p>
57
+ <p class="simpara">Default: Ascending</p>
58
+ </td><td>
59
+ <p class="simpara">No</p>
60
+ </td></tr><tr><td>
61
+ <p class="simpara">
62
+ <em class="parameter"><code>PageSize</code></em>
63
+ </p>
64
+ </td><td>
65
+ <p class="simpara"> The number of Qualification requests to include in a page of
66
+ results. The operation divides the complete sorted result set into
67
+ pages of this many Qualification requests. </p>
68
+ <p class="simpara">Type: positive integer</p>
69
+ <p class="simpara">Valid Values: any number between 1 and 100</p>
70
+ <p class="simpara">Default: 10</p>
71
+ </td><td>
72
+ <p class="simpara">No</p>
73
+ </td></tr><tr><td>
74
+ <p class="simpara">
75
+ <em class="parameter"><code>PageNumber</code></em>
76
+ </p>
77
+ </td><td>
78
+ <p class="simpara"> The page of results to return. When the operation has filtered
79
+ the Qualification requests, sorted them, and divided them into pages
80
+ of size <em class="parameter"><code>PageSize</code></em>, the operation returns the
81
+ page corresponding to the <em class="parameter"><code>PageNumber</code></em>
82
+ parameter. </p>
83
+ <p class="simpara">Type: positive integer</p>
84
+ <p class="simpara">Default: 1</p>
85
+ </td><td>
86
+ <p class="simpara">No</p>
87
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e7027">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">GetQualificationRequests</code> operation
88
+ returns a <em class="parameter"><code>GetQualificationRequestsResult</code></em> element in the response. </p><p> The <em class="parameter"><code>GetQualificationRequestsResult</code></em> element contains the
89
+ following elements: </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>
90
+ <p class="simpara">
91
+ <em class="parameter"><code>NumResults</code></em>
92
+ </p>
93
+ </td><td>
94
+ <p class="simpara"> The number of Qualification requests on this page in the
95
+ filtered results list, equivalent to the number of Qualification
96
+ requests being returned by this call. </p>
97
+ <p class="simpara">Type: non-negative integer</p>
98
+ </td></tr><tr><td>
99
+ <p class="simpara">
100
+ <em class="parameter"><code>PageNumber</code></em>
101
+ </p>
102
+ </td><td>
103
+ <p class="simpara">The number of this page in the filtered results list.</p>
104
+ <p class="simpara">Type: positive integer</p>
105
+ </td></tr><tr><td>
106
+ <p class="simpara">
107
+ <em class="parameter"><code>TotalNumResults</code></em>
108
+ </p>
109
+ </td><td>
110
+ <p class="simpara">The total number of Qualification requests in the filtered
111
+ results list based on this call.</p>
112
+ <p class="simpara">Type: non-negative integer</p>
113
+ </td></tr><tr><td>
114
+ <p class="simpara">
115
+ <em class="parameter"><code>QualificationRequest</code></em>
116
+ </p>
117
+ </td><td>
118
+ <p class="simpara"> The Qualification request. The response includes one
119
+ <em class="parameter"><code>QualificationRequest</code></em> element for each
120
+ Qualification request returned by the query. </p>
121
+ <p class="simpara"> Type: a <a class="link" href="ApiReference_QualificationRequestDataStructureArticle.html" title="QualificationRequest">
122
+ QualificationRequest</a> data structure. </p>
123
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e7128">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">GetQualificationRequests</code> operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e7136">Sample Request</h3></div></div></div><p> The following example retrieves Qualification requests for a specified
124
+ Qualification type. </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
125
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
126
+ &amp;Version=2008-08-02
127
+ &amp;Operation=GetQualificationRequests
128
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
129
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
130
+ &amp;QualificationTypeId=789RVWYBAZW00EXAMPLE
131
+ </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e7152">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;GetQualificationRequestsResult&gt;
132
+ &lt;Request&gt;
133
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
134
+ &lt;/Request&gt;
135
+ &lt;NumResults&gt;1&lt;/NumResults&gt;
136
+ &lt;TotalNumResults&gt;1&lt;/TotalNumResults&gt;
137
+ &lt;PageNumber&gt;1&lt;/PageNumber&gt;
138
+ &lt;QualificationRequest&gt;
139
+ &lt;QualificationRequestId&gt;789RVWYBAZW00EXAMPLE951RVWYBAZW00EXAMPLE
140
+ &lt;/QualificationRequestId&gt;
141
+ &lt;QualificationTypeId&gt;789RVWYBAZW00EXAMPLE&lt;/QualificationTypeId&gt;
142
+ &lt;SubjectId&gt;AZ3456EXAMPLE&lt;/SubjectId&gt;
143
+ &lt;Test&gt;
144
+ &amp;lt;QuestionForm&amp;gt;
145
+ [XML-encoded question data]
146
+ &amp;lt;/QuestionForm&amp;gt;
147
+ &lt;/Test&gt;
148
+ &lt;Answer&gt;
149
+ &amp;lt;QuestionFormAnswers&amp;gt;
150
+ [XML-encoded answer data]
151
+ &amp;lt;/QuestionFormAnswers&amp;gt;
152
+ &lt;/Answer&gt;
153
+ &lt;SubmitTime&gt;2005-12-01T23:59:59Z&lt;/SubmitTime&gt;
154
+ &lt;/QualificationRequest&gt;
155
+ &lt;/GetQualificationRequestsResult&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_GetQualificationsForQualificationTypeOperation.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_GetQualificationRequestsOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_GetQualificationScoreOperation.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_GetQualificationScoreOperation.html ADDED
@@ -0,0 +1,68 @@
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>GetQualificationScore</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_GetQualificationRequestsOperation.html" title="GetQualificationRequests"><link rel="next" href="ApiReference_GetQualificationTypeOperation.html" title="GetQualificationType"><!--[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_GetQualificationRequestsOperation.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_GetQualificationScoreOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_GetQualificationTypeOperation.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>GetQualificationScore</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">GetQualificationScore</h1></div></div></div><a class="indexterm" name="d0e7163"></a><a class="indexterm" name="d0e7166"></a><a class="indexterm" name="d0e7171"></a><a class="indexterm" name="d0e7176"></a><a class="indexterm" name="d0e7181"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e7186">Description</h2></div></div></div><p> The <code class="function">GetQualificationScore</code> operation returns the value of a
7
+ Worker's Qualification for a given Qualification type. </p><p> To get a Worker's Qualification, you must know the Worker's ID. The Worker's ID is
8
+ included in the assignment data returned by the <a class="link" href="ApiReference_GetAssignmentsForHITOperation.html" title="GetAssignmentsForHIT">GetAssignmentsForHIT</a>
9
+ operation. </p><p> Only the owner of a Qualification type can query the value of a Worker's
10
+ Qualification of that type. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e7201">Request Parameters</h2></div></div></div><p> The <code class="function">GetQualificationScore</code> operation accepts parameters common to
11
+ 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
12
+ information. </p><p> The following parameters are specific to the <code class="function">GetQualificationScore</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>
13
+ <p class="simpara">
14
+ <em class="parameter"><code>Operation</code></em>
15
+ </p>
16
+ </td><td>
17
+ <p class="simpara">The name of the operation.</p>
18
+ <p class="simpara">Type: String</p>
19
+ <p class="simpara">Valid Values: GetQualificationScore</p>
20
+ <p class="simpara">Default: None</p>
21
+ </td><td>
22
+ <p class="simpara">Yes</p>
23
+ </td></tr><tr><td>
24
+ <p class="simpara">
25
+ <em class="parameter"><code>QualificationTypeId</code></em>
26
+ </p>
27
+ </td><td>
28
+ <p class="simpara"> The ID of the Qualification type, as returned by the <a class="link" href="ApiReference_CreateQualificationTypeOperation.html" title="CreateQualificationType">CreateQualificationType</a> operation. </p>
29
+ <p class="simpara">Type: String</p>
30
+ <p class="simpara">Default: None</p>
31
+ </td><td>
32
+ <p class="simpara">Yes</p>
33
+ </td></tr><tr><td>
34
+ <p class="simpara">
35
+ <em class="parameter"><code>SubjectId</code></em>
36
+ </p>
37
+ </td><td>
38
+ <p class="simpara">The ID of the Worker whose Qualification is being
39
+ updated.</p>
40
+ <p class="simpara">Type: String</p>
41
+ <p class="simpara">Default: None</p>
42
+ </td><td>
43
+ <p class="simpara">Yes</p>
44
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e7312">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">GetQualificationScore</code> operation
45
+ 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>
46
+ <p class="simpara">
47
+ <em class="parameter"><code>Qualification</code></em>
48
+ </p>
49
+ </td><td>
50
+ <p class="simpara"> For information about the contents of the <em class="parameter"><code>Qualification</code></em> element, see the <a class="link" href="ApiReference_QualificationDataStructureArticle.html" title="Qualification">Qualification</a> data structure. </p>
51
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e7351">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">GetQualificationScore</code>
52
+ operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e7359">Sample Request</h3></div></div></div><p> The following example gets the value of a Qualification for a given user and
53
+ Qualification type. </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
54
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
55
+ &amp;Version=2008-08-02
56
+ &amp;Operation=GetQualificationScore
57
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
58
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
59
+ &amp;QualificationTypeId=789RVWYBAZW00EXAMPLE
60
+ &amp;SubjectId=AZ3456EXAMPLE
61
+ </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e7375">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;GetQualificationScoreResult&gt;
62
+ &lt;Qualification&gt;
63
+ &lt;QualificationTypeId&gt;789RVWYBAZW00EXAMPLE&lt;/QualificationTypeId&gt;
64
+ &lt;SubjectId&gt;AZ3456EXAMPLE&lt;/SubjectId&gt;
65
+ &lt;GrantTime&gt;2005-01-31T23:59:59Z&lt;/GrantTime&gt;
66
+ &lt;IntegerValue&gt;95&lt;/IntegerValue&gt;
67
+ &lt;/Qualification&gt;
68
+ &lt;/GetQualificationScoreResult&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_GetQualificationRequestsOperation.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_GetQualificationScoreOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_GetQualificationTypeOperation.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>