rturk 2.0.2 → 2.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (122) hide show
  1. data/README.markdown +3 -2
  2. data/Rakefile +10 -4
  3. data/VERSION +1 -1
  4. data/aws_docs/ApiReference_AnswerKeyDataStructureArticle.html +98 -0
  5. data/aws_docs/ApiReference_ApproveAssignmentOperation.html +75 -0
  6. data/aws_docs/ApiReference_AssignQualificationOperation.html +107 -0
  7. data/aws_docs/ApiReference_AssignmentDataStructureArticle.html +171 -0
  8. data/aws_docs/ApiReference_BlockWorkerOperation.html +70 -0
  9. data/aws_docs/ApiReference_ChangeHITTypeOfHITOperation.html +68 -0
  10. data/aws_docs/ApiReference_CommonParametersArticle.html +119 -0
  11. data/aws_docs/ApiReference_CreateHITOperation.html +330 -0
  12. data/aws_docs/ApiReference_CreateQualificationTypeOperation.html +190 -0
  13. data/aws_docs/ApiReference_DataStructuresArticle.html +7 -0
  14. data/aws_docs/ApiReference_DisableHITOperation.html +63 -0
  15. data/aws_docs/ApiReference_DisposeHITOperation.html +56 -0
  16. data/aws_docs/ApiReference_DisposeQualificationTypeOperation.html +52 -0
  17. data/aws_docs/ApiReference_ExtendHITOperation.html +86 -0
  18. data/aws_docs/ApiReference_ExternalQuestionArticle.html +125 -0
  19. data/aws_docs/ApiReference_ForceExpireHITOperation.html +61 -0
  20. data/aws_docs/ApiReference_FormattedContentXHTMLArticle.html +289 -0
  21. data/aws_docs/ApiReference_GetAccountBalanceOperation.html +51 -0
  22. data/aws_docs/ApiReference_GetAssignmentsForHITOperation.html +166 -0
  23. data/aws_docs/ApiReference_GetBonusPaymentsOperation.html +160 -0
  24. data/aws_docs/ApiReference_GetFileUploadURLOperation.html +75 -0
  25. data/aws_docs/ApiReference_GetHITOperation.html +89 -0
  26. data/aws_docs/ApiReference_GetHITsForQualificationTypeOperation.html +137 -0
  27. data/aws_docs/ApiReference_GetQualificationRequestsOperation.html +155 -0
  28. data/aws_docs/ApiReference_GetQualificationScoreOperation.html +68 -0
  29. data/aws_docs/ApiReference_GetQualificationTypeOperation.html +57 -0
  30. data/aws_docs/ApiReference_GetQualificationsForQualificationTypeOperation.html +134 -0
  31. data/aws_docs/ApiReference_GetRequesterStatisticOperation.html +315 -0
  32. data/aws_docs/ApiReference_GetReviewableHITsOperation.html +155 -0
  33. data/aws_docs/ApiReference_GrantBonusOperation.html +95 -0
  34. data/aws_docs/ApiReference_GrantQualificationOperation.html +69 -0
  35. data/aws_docs/ApiReference_HITDataStructureArticle.html +302 -0
  36. data/aws_docs/ApiReference_HelpOperation.html +125 -0
  37. data/aws_docs/ApiReference_LocaleDataStructureArticle.html +29 -0
  38. data/aws_docs/ApiReference_NotificationAPI_BuildingANotificationReceptor.html +36 -0
  39. data/aws_docs/ApiReference_NotificationAPI_ElementsOfANotification.html +40 -0
  40. data/aws_docs/ApiReference_NotificationDataStructureArticle.html +73 -0
  41. data/aws_docs/ApiReference_NotificationReceptorAPIArticle.html +9 -0
  42. data/aws_docs/ApiReference_NotificationReceptorAPI_RESTTransportArticle.html +39 -0
  43. data/aws_docs/ApiReference_NotificationReceptorAPI_SOAPTransportArticle.html +45 -0
  44. data/aws_docs/ApiReference_NotifyWorkersOperation.html +82 -0
  45. data/aws_docs/ApiReference_OperationsArticle.html +8 -0
  46. data/aws_docs/ApiReference_PriceDataStructureArticle.html +65 -0
  47. data/aws_docs/ApiReference_QualificationDataStructureArticle.html +89 -0
  48. data/aws_docs/ApiReference_QualificationRequestDataStructureArticle.html +102 -0
  49. data/aws_docs/ApiReference_QualificationRequirementDataStructureArticle.html +176 -0
  50. data/aws_docs/ApiReference_QualificationTypeDataStructureArticle.html +198 -0
  51. data/aws_docs/ApiReference_QuestionAnswerDataArticle.html +8 -0
  52. data/aws_docs/ApiReference_QuestionFormAnswersDataStructureArticle.html +54 -0
  53. data/aws_docs/ApiReference_QuestionFormDataStructureArticle.html +796 -0
  54. data/aws_docs/ApiReference_RegisterHITTypeOperation.html +149 -0
  55. data/aws_docs/ApiReference_RejectAssignmentOperation.html +66 -0
  56. data/aws_docs/ApiReference_RejectQualificationRequestOperation.html +61 -0
  57. data/aws_docs/ApiReference_RevokeQualificationOperation.html +78 -0
  58. data/aws_docs/ApiReference_SearchHITsOperation.html +164 -0
  59. data/aws_docs/ApiReference_SearchQualificationTypesOperation.html +211 -0
  60. data/aws_docs/ApiReference_SendTestEventNotificationOperation.html +78 -0
  61. data/aws_docs/ApiReference_SetHITAsReviewingOperation.html +73 -0
  62. data/aws_docs/ApiReference_SetHITTypeNotificationOperation.html +99 -0
  63. data/aws_docs/ApiReference_UnblockWorkerOperation.html +67 -0
  64. data/aws_docs/ApiReference_UpdateQualificationScoreOperation.html +77 -0
  65. data/aws_docs/ApiReference_UpdateQualificationTypeOperation.html +180 -0
  66. data/aws_docs/ApiReference_WsdlLocationArticle.html +95 -0
  67. data/aws_docs/ApiReference_XMLParameterValuesArticle.html +37 -0
  68. data/aws_docs/Welcome.html +125 -0
  69. data/aws_docs/WhatsNew.html +16 -0
  70. data/aws_docs/_title.html +28 -0
  71. data/aws_docs/_toc.html +749 -0
  72. data/aws_docs/aws-docs-IE.css +419 -0
  73. data/aws_docs/aws-docs.css +455 -0
  74. data/aws_docs/copyrightinfo.html +14 -0
  75. data/aws_docs/frameset.js +12 -0
  76. data/aws_docs/images/Feedback_link.gif +0 -0
  77. data/aws_docs/images/caution.png +0 -0
  78. data/aws_docs/images/home.gif +0 -0
  79. data/aws_docs/images/important.png +0 -0
  80. data/aws_docs/images/next.gif +0 -0
  81. data/aws_docs/images/note.png +0 -0
  82. data/aws_docs/images/prev.gif +0 -0
  83. data/aws_docs/images/tip.png +0 -0
  84. data/aws_docs/images/title-swoosh-logo.gif +0 -0
  85. data/aws_docs/images/toc_bullet.gif +0 -0
  86. data/aws_docs/images/toc_plus.gif +0 -0
  87. data/aws_docs/index.html +18 -0
  88. data/aws_docs/toc.js +84 -0
  89. data/lib/rturk.rb +2 -2
  90. data/lib/rturk/adapter.rb +11 -0
  91. data/lib/rturk/adapters/assignment.rb +13 -50
  92. data/lib/rturk/adapters/hit.rb +21 -9
  93. data/lib/rturk/adapters/worker.rb +23 -0
  94. data/lib/rturk/operation.rb +1 -1
  95. data/lib/rturk/operations/create_hit.rb +10 -54
  96. data/lib/rturk/operations/register_hit_type.rb +68 -0
  97. data/lib/rturk/operations/search_hits.rb +44 -0
  98. data/lib/rturk/parser.rb +8 -0
  99. data/lib/rturk/parsers/answer_parser.rb +29 -0
  100. data/lib/rturk/parsers/assignment_parser.rb +49 -0
  101. data/lib/rturk/parsers/hit_parser.rb +50 -0
  102. data/lib/rturk/{response.rb → parsers/response.rb} +7 -2
  103. data/lib/rturk/{responses → parsers/responses}/create_hit_response.rb +2 -2
  104. data/lib/rturk/{responses → parsers/responses}/get_account_balance_response.rb +0 -0
  105. data/lib/rturk/{responses → parsers/responses}/get_assignments_for_hit_response.rb +3 -3
  106. data/lib/rturk/{responses → parsers/responses}/get_hit_response.rb +9 -16
  107. data/lib/rturk/{responses → parsers/responses}/get_reviewable_hits_response.rb +3 -5
  108. data/lib/rturk/parsers/responses/register_hit_type_response.rb +17 -0
  109. data/lib/rturk/parsers/responses/search_hits_response.rb +65 -0
  110. data/lib/rturk/xml_utilities.rb +14 -3
  111. data/rturk.gemspec +112 -12
  112. data/spec/adapters/hit_spec.rb +10 -0
  113. data/spec/fake_responses/register_hit_type.xml +6 -0
  114. data/spec/fake_responses/search_hits.xml +50 -0
  115. data/spec/operations/create_hit_spec.rb +2 -2
  116. data/spec/operations/get_hit_spec.rb +1 -1
  117. data/spec/operations/register_hit_type_spec.rb +24 -0
  118. data/spec/{adapters/answers_spec.rb → parsers/answer_parser_spec.rb} +2 -2
  119. data/spec/parsers/hit_parser_spec.rb +41 -0
  120. data/spec/xml_parse_spec.rb +2 -2
  121. metadata +111 -11
  122. data/lib/rturk/adapters/answers.rb +0 -38
data/aws_docs/ApiReference_GetQualificationTypeOperation.html ADDED
@@ -0,0 +1,57 @@
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>GetQualificationType</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_GetQualificationScoreOperation.html" title="GetQualificationScore"><link rel="next" href="ApiReference_GetRequesterStatisticOperation.html" title="GetRequesterStatistic"><!--[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_GetQualificationScoreOperation.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_GetQualificationTypeOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_GetRequesterStatisticOperation.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>GetQualificationType</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">GetQualificationType</h1></div></div></div><a class="indexterm" name="d0e7386"></a><a class="indexterm" name="d0e7389"></a><a class="indexterm" name="d0e7396"></a><a class="indexterm" name="d0e7401"></a><a class="indexterm" name="d0e7406"></a><a class="indexterm" name="d0e7411"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e7416">Description</h2></div></div></div><p> The <code class="function">GetQualificationType</code> operation retrieves information about a
7
+ Qualification type using its ID. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e7424">Request Parameters</h2></div></div></div><p> The <code class="function">GetQualificationType</code> operation accepts parameters common to
8
+ 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">GetQualificationType</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: GetQualificationType</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>QualificationTypeId</code></em>
22
+ </p>
23
+ </td><td>
24
+ <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>
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="d0e7509">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">GetQualificationType</code> operation
30
+ returns 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>
31
+ <p class="simpara">
32
+ <em class="parameter"><code>QualificationType</code></em>
33
+ </p>
34
+ </td><td>
35
+ <p class="simpara"> For information about the data structure of a Qualification
36
+ type, see <a class="link" href="ApiReference_QualificationTypeDataStructureArticle.html" title="QualificationType">
37
+ QualificationType</a> data structure. </p>
38
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e7545">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">GetQualificationType</code>
39
+ operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e7553">Sample Request</h3></div></div></div><p> The following example gets a Qualification type by its ID. </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
40
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
41
+ &amp;Version=2008-08-02
42
+ &amp;Operation=GetQualificationType
43
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
44
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
45
+ &amp;QualificationTypeId=789RVWYBAZW00EXAMPLE
46
+ </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e7569">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;GetQualificationTypeResult&gt;
47
+ &lt;QualificationType&gt;
48
+ &lt;QualificationTypeId&gt;789RVWYBAZW00EXAMPLE&lt;/QualificationTypeId&gt;
49
+ &lt;CreationTime&gt;2005-01-31T23:59:59Z&lt;/CreationTime&gt;
50
+ &lt;Name&gt;EnglishWritingAbility&lt;/Name&gt;
51
+ &lt;Description&gt;The ability to write and edit text...&lt;/Description&gt;
52
+ &lt;Keywords&gt;English, text, write, edit, language&lt;/Keywords&gt;
53
+ &lt;QualificationTypeStatus&gt;Active&lt;/QualificationTypeStatus&gt;
54
+ &lt;RetryDelayInSeconds&gt;86400&lt;/RetryDelayInSeconds&gt;
55
+ &lt;IsRequestable&gt;true&lt;/IsRequestable&gt;
56
+ &lt;/QualificationType&gt;
57
+ &lt;/GetQualificationTypeResult&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_GetQualificationScoreOperation.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_GetQualificationTypeOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_GetRequesterStatisticOperation.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_GetQualificationsForQualificationTypeOperation.html ADDED
@@ -0,0 +1,134 @@
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>GetQualificationsForQualificationType</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_GetHITsForQualificationTypeOperation.html" title="GetHITsForQualificationType"><link rel="next" href="ApiReference_GetQualificationRequestsOperation.html" title="GetQualificationRequests"><!--[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_GetHITsForQualificationTypeOperation.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_GetQualificationsForQualificationTypeOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_GetQualificationRequestsOperation.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>GetQualificationsForQualificationType</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">GetQualificationsForQualificationType</h1></div></div></div><a class="indexterm" name="d0e6442"></a><a class="indexterm" name="d0e6445"></a><a class="indexterm" name="d0e6450"></a><a class="indexterm" name="d0e6455"></a><a class="indexterm" name="d0e6460"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e6465">Description</h2></div></div></div><p> The <code class="function">GetQualificationsForQualificationType</code> operation returns all
7
+ of the Qualifications granted to Workers for a given Qualification type. </p><p> This operations divides the results into numbered pages and returns a single page of
8
+ 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="d0e6475">Request Parameters</h2></div></div></div><p> The <code class="function">GetQualificationsForQualificationType</code> operation accepts
9
+ parameters common to all operations. Some common parameters are required. See <a class="link" href="ApiReference_CommonParametersArticle.html" title="Chapter&nbsp;4.&nbsp;Common Parameters">Common Parameters</a> for more information. </p><p> The following parameters are specific to the <code class="function">GetQualificationsForQualificationType</code> operation: </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col><col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>
10
+ <p class="simpara">
11
+ <em class="parameter"><code>Operation</code></em>
12
+ </p>
13
+ </td><td>
14
+ <p class="simpara">The name of the operation.</p>
15
+ <p class="simpara">Type: String</p>
16
+ <p class="simpara">Valid Values: GetQualificationForQualificationType</p>
17
+ <p class="simpara">Default: None</p>
18
+ </td><td>
19
+ <p class="simpara">Yes</p>
20
+ </td></tr><tr><td>
21
+ <p class="simpara">
22
+ <em class="parameter"><code>QualificationTypeId</code></em>
23
+ </p>
24
+ </td><td>
25
+ <p class="simpara">The ID of the Qualification type of the Qualifications to
26
+ return.</p>
27
+ <p class="simpara">Type: String</p>
28
+ <p class="simpara">Default: None</p>
29
+ </td><td>
30
+ <p class="simpara">Yes</p>
31
+ </td></tr><tr><td>
32
+ <p class="simpara">
33
+ <em class="parameter"><code>Status</code></em>
34
+ </p>
35
+ </td><td>
36
+ <p class="simpara">The status of the Qualifications to return.</p>
37
+ <p class="simpara">Type: String</p>
38
+ <p class="simpara">Valid Values: Granted | Revoked</p>
39
+ <p class="simpara">Default: Granted</p>
40
+ </td><td>
41
+ <p class="simpara">No</p>
42
+ </td></tr><tr><td>
43
+ <p class="simpara">
44
+ <em class="parameter"><code>PageSize</code></em>
45
+ </p>
46
+ </td><td>
47
+ <p class="simpara"> The number of Qualifications to include in a page of results.
48
+ The operation divides the complete result set into pages of this
49
+ many Qualifications. </p>
50
+ <p class="simpara">Type: positive integer</p>
51
+ <p class="simpara"> Valid Values: any number between 1 and 100 </p>
52
+ <p class="simpara">Default: 10</p>
53
+ </td><td>
54
+ <p class="simpara">No</p>
55
+ </td></tr><tr><td>
56
+ <p class="simpara">
57
+ <em class="parameter"><code>PageNumber</code></em>
58
+ </p>
59
+ </td><td>
60
+ <p class="simpara"> The page of results to return. Once the operation divides the
61
+ Qualifications into pages of size <em class="parameter"><code>PageSize</code></em>,
62
+ it returns the page corresponding to <em class="parameter"><code>PageNumber</code></em>. </p>
63
+ <p class="simpara">Type: positive integer</p>
64
+ <p class="simpara">Default: 1</p>
65
+ </td><td>
66
+ <p class="simpara">No</p>
67
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e6644">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">GetQualificationsForQualificationType</code> operation returns a <em class="parameter"><code>GetQualificationsForQualificationTypeResult</code></em> element in the response. </p><p> The <em class="parameter"><code>GetQualificationsForQualificationTypeResult</code></em> element
68
+ contains the following elements: </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>
69
+ <p class="simpara">
70
+ <em class="parameter"><code>PageNumber</code></em>
71
+ </p>
72
+ </td><td>
73
+ <p class="simpara"> The page of results to return. Once the operation divides the
74
+ Qualifications into pages of size <em class="parameter"><code>PageSize</code></em>,
75
+ the operation returns the page corresponding to <em class="parameter"><code>PageNumber</code></em>. </p>
76
+ <p class="simpara">Type: positive integer</p>
77
+ </td></tr><tr><td>
78
+ <p class="simpara">
79
+ <em class="parameter"><code>NumResults</code></em>
80
+ </p>
81
+ </td><td>
82
+ <p class="simpara"> The number of Qualifications on this page in the filtered
83
+ results list, equivalent to the number of Qualifications being
84
+ returned by this call. </p>
85
+ <p class="simpara">Type: non-negative integer</p>
86
+ </td></tr><tr><td>
87
+ <p class="simpara">
88
+ <em class="parameter"><code>TotalNumResults</code></em>
89
+ </p>
90
+ </td><td>
91
+ <p class="simpara"> The total number of Qualifications in the filtered results
92
+ list based on this call. </p>
93
+ <p class="simpara">Type: non-negative integer</p>
94
+ </td></tr><tr><td>
95
+ <p class="simpara">
96
+ <em class="parameter"><code>Qualification</code></em>
97
+ </p>
98
+ </td><td>
99
+ <p class="simpara"> The Qualification. The response includes one <em class="parameter"><code>Qualification</code></em> element for each Qualification
100
+ returned by the query. </p>
101
+ <p class="simpara"> Type: a <a class="link" href="ApiReference_QualificationDataStructureArticle.html" title="Qualification">Qualification</a> data structure. </p>
102
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e6751">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">GetQualificationsForQualificationType</code> operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e6759">Sample Request</h3></div></div></div><p> The following example returns the Qualifications assigned to Workers for the
103
+ given Qualification type. </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/onca/xml?
104
+ Service=AWSMechanicalTurkRequester
105
+ &amp;Operation=GetQualificationsForQualificationType
106
+ &amp;Version=2008-08-02
107
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
108
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
109
+ &amp;Timestamp=2009-07-15T01:21:28.186Z
110
+ &amp;QualificationTypeId=ZSPJXD4F1SFZP7YNJWR0</pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e6772">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;GetQualificationsForQualificationTypeResult&gt;
111
+ &lt;Request&gt;
112
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
113
+ &lt;/Request&gt;
114
+ &lt;NumResults&gt;1&lt;/NumResults&gt;
115
+ &lt;TotalNumResults&gt;1&lt;/TotalNumResults&gt;
116
+ &lt;PageNumber&gt;1&lt;/PageNumber&gt;
117
+ &lt;QualificationRequest&gt;
118
+ &lt;QualificationRequestId&gt;789RVWYBAZW00EXAMPLE951RVWYBAZW00EXAMPLE
119
+ &lt;/QualificationRequestId&gt;
120
+ &lt;QualificationTypeId&gt;ZSPJXD4F1SFZP7YNJWR0&lt;/QualificationTypeId&gt;
121
+ &lt;SubjectId&gt;AZ3456EXAMPLE&lt;/SubjectId&gt;
122
+ &lt;Test&gt;
123
+ &amp;lt;QuestionForm&amp;gt;
124
+ [XML-encoded question data]
125
+ &amp;lt;/QuestionForm&amp;gt;
126
+ &lt;/Test&gt;
127
+ &lt;Answer&gt;
128
+ &amp;lt;QuestionFormAnswers&amp;gt;
129
+ [XML-encoded answer data]
130
+ &amp;lt;/QuestionFormAnswers&amp;gt;
131
+ &lt;/Answer&gt;
132
+ &lt;SubmitTime&gt;2009-07-15T01:21:28.296Z&lt;/SubmitTime&gt;
133
+ &lt;/QualificationRequest&gt;
134
+ &lt;/GetQualificationsForQualificationTypeResult&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_GetHITsForQualificationTypeOperation.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_GetQualificationsForQualificationTypeOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_GetQualificationRequestsOperation.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_GetRequesterStatisticOperation.html ADDED
@@ -0,0 +1,315 @@
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>GetRequesterStatistic</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_GetQualificationTypeOperation.html" title="GetQualificationType"><link rel="next" href="ApiReference_GetReviewableHITsOperation.html" title="GetReviewableHITs"><!--[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_GetQualificationTypeOperation.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_GetRequesterStatisticOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_GetReviewableHITsOperation.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>GetRequesterStatistic</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">GetRequesterStatistic</h1></div></div></div><a class="indexterm" name="d0e7580"></a><a class="indexterm" name="d0e7583"></a><a class="indexterm" name="d0e7588"></a><a class="indexterm" name="d0e7593"></a><a class="indexterm" name="d0e7598"></a><a class="indexterm" name="d0e7603"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e7608">Description</h2></div></div></div><p> The <code class="function">GetRequesterStatistic</code> operation retrieves statistics about
7
+ you (the Requester calling the operation). The following table describes the available
8
+ statistics: </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>
9
+ <p class="simpara">
10
+ NumberAssignmentsAvailable
11
+ </p>
12
+ </td><td>
13
+ <p class="simpara">The number of times Workers can accept an available HIT,
14
+ totalled over all available HITs. In other words, a HIT with 3
15
+ <em class="parameter"><code>MaxAssignments</code></em> can be described as having
16
+ 3 available assignments, each of become <span class="guilabel">Accepted</span> when a Worker accepts the HIT.
17
+ (Technically, Amazon Mechanical Turk does not create an assignment
18
+ with an assignment ID until a Worker accepts a HIT.) </p>
19
+ <p class="simpara">Type: Long</p>
20
+ </td></tr><tr><td>
21
+ <p class="simpara">
22
+ NumberAssignmentsAccepted
23
+ </p>
24
+ </td><td>
25
+ <p class="simpara">The number of times Workers have accepted your HITs. </p>
26
+ <p class="simpara">Type: Long</p>
27
+ </td></tr><tr><td>
28
+ <p class="simpara">
29
+ NumberAssignmentsPending
30
+ </p>
31
+ </td><td>
32
+ <p class="simpara">The total number of assignments for your HITs that have been
33
+ submitted by Workers and are awaiting approval. The total increases
34
+ and decreases as assignments are submitted by Workers and approved
35
+ or rejected by you. </p>
36
+ <p class="simpara">Type: Long</p>
37
+ </td></tr><tr><td>
38
+ <p class="simpara">
39
+ NumberAssignmentsApproved
40
+ </p>
41
+ </td><td>
42
+ <p class="simpara">The number of assignments you have approved.</p>
43
+ <p class="simpara">Type: Long</p>
44
+ </td></tr><tr><td>
45
+ <p class="simpara">
46
+ NumberAssignmentsRejected
47
+ </p>
48
+ </td><td>
49
+ <p class="simpara">The number of assignments you have rejected.</p>
50
+ <p class="simpara">Type: Long</p>
51
+ </td></tr><tr><td>
52
+ <p class="simpara">
53
+ NumberAssignmentsReturned
54
+ </p>
55
+ </td><td>
56
+ <p class="simpara">The number of times Workers have returned assignments for your
57
+ HITs.</p>
58
+ <p class="simpara">Type: Long</p>
59
+ </td></tr><tr><td>
60
+ NumberAssignmentsAbandoned
61
+ </td><td>
62
+ <p class="simpara">The number of times Workers have abandoned assignments (allowed
63
+ the deadline to elapse without submitting results) for your HITs. </p>
64
+ <p class="simpara">Type: Long</p>
65
+ </td></tr><tr><td>
66
+ <p class="simpara">
67
+ PercentAssignmentsApproved
68
+ </p>
69
+ </td><td>
70
+ <p class="simpara">The percentage of assignments that you have approved, computed
71
+ over all assignments that you have approved or rejected. The
72
+ percentage is represented as a decimal fraction between 0 and 1. The
73
+ statistic value for a given day represents a change in the overall
74
+ percentage due to activity for that day. </p>
75
+ <p class="simpara">Type: Double</p>
76
+ </td></tr><tr><td>
77
+ <p class="simpara">
78
+ PercentAssignmentsRejected
79
+ </p>
80
+ </td><td>
81
+ <p class="simpara">The percentage of assignments that you have rejected, computed
82
+ over all assignments that you have approved or rejected. The
83
+ percentage is represented as a decimal fraction between 0 and 1. The
84
+ statistic value for a given day represents a change in the overall
85
+ percentage due to activity for that day. </p>
86
+ <p class="simpara">Type: Double</p>
87
+ </td></tr><tr><td>
88
+ <p class="simpara">
89
+ TotalRewardPayout
90
+ </p>
91
+ </td><td>
92
+ <p class="simpara">The total amount of the rewards paid for approved assignments.
93
+ The amount is given in U.S. dollars. </p>
94
+ <p class="simpara">Type: Double</p>
95
+ </td></tr><tr><td>
96
+ <p class="simpara">
97
+ AverageRewardAmount
98
+ </p>
99
+ </td><td>
100
+ <p class="simpara">The change in the average amount of the rewards paid for
101
+ approved assignments. The amount is given in U.S. dollars. </p>
102
+ <p class="simpara">Type: Double</p>
103
+ </td></tr><tr><td>
104
+ <p class="simpara">
105
+ TotalRewardFeePayout
106
+ </p>
107
+ </td><td>
108
+ <p class="simpara">The total amount of the HIT listing fees paid for approved
109
+ assignments. The amount is given in U.S. dollars. </p>
110
+ <p class="simpara">Type: Double</p>
111
+ </td></tr><tr><td>
112
+ <p class="simpara">
113
+ TotalFeePayout
114
+ </p>
115
+ </td><td>
116
+ <p class="simpara">The total amount of the HIT listing fees paid for approved
117
+ assignments and bonus payments. The amount is given in U.S. dollars. </p>
118
+ <p class="simpara">
119
+ <span class="emphasis"><em>This statistic is deprecated. </em></span> To get the total
120
+ amount of fees paid for rewards and bonuses, get the <em class="parameter"><code>TotalRewardFeePayout</code></em> statistic and the <em class="parameter"><code>TotalBonusFeePayout</code></em> statistic and add them
121
+ together. </p>
122
+ <p class="simpara">Type: Double</p>
123
+ </td></tr><tr><td>
124
+ <p class="simpara">
125
+ TotalRewardAndFeePayout
126
+ </p>
127
+ </td><td>
128
+ <p class="simpara">The total amount of money paid for approved assignments,
129
+ including rewards and fees. The amount is given in U.S. dollars. </p>
130
+ <p class="simpara"> This total does <span class="emphasis"><em>not</em></span> include fees for
131
+ bonus payments made with the <a class="link" href="ApiReference_GrantBonusOperation.html" title="GrantBonus">GrantBonus</a>
132
+ operation. </p>
133
+ <p class="simpara">
134
+ <span class="emphasis"><em>This statistic is deprecated.</em></span> To get the total
135
+ amount of money paid for rewards and reward fees, get the <em class="parameter"><code>TotalRewardPayout</code></em> and <em class="parameter"><code>TotalRewardFeePayout</code></em> statistics and add them
136
+ together. </p>
137
+ <p class="simpara">Type: Double</p>
138
+ </td></tr><tr><td>
139
+ <p class="simpara">
140
+ TotalBonusPayout
141
+ </p>
142
+ </td><td>
143
+ <p class="simpara">The total amount of the bonuses paid to Workers. The amount is
144
+ given in U.S. dollars. </p>
145
+ <p class="simpara">Type: Double</p>
146
+ </td></tr><tr><td>
147
+ <p class="simpara">
148
+ TotalBonusFeePayout
149
+ </p>
150
+ </td><td>
151
+ <p class="simpara">The total amount of the fees paid for bonus payments. The
152
+ amount is given in U.S. dollars. </p>
153
+ <p class="simpara">Type: Double</p>
154
+ </td></tr><tr><td>
155
+ <p class="simpara">
156
+ NumberHITsCreated
157
+ </p>
158
+ </td><td>
159
+ <p class="simpara">The number of HITs you created. </p>
160
+ <p class="simpara">Type: Long</p>
161
+ </td></tr><tr><td>
162
+ <p class="simpara">
163
+ NumberHITsCompleted
164
+ </p>
165
+ </td><td>
166
+ <p class="simpara">The total number of your HITs that have been completed to their
167
+ final state of either <span class="guilabel">Disposed</span> or <span class="guilabel">Disabled</span>. </p>
168
+ <p class="simpara">Type: Long</p>
169
+ </td></tr><tr><td>
170
+ <p class="simpara">
171
+ NumberHITsAssignable
172
+ </p>
173
+ </td><td>
174
+ <p class="simpara">The number of your HITs with status <span class="guilabel">Assignable</span>. </p>
175
+ <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 class="simpara">
176
+ <em class="parameter"><code>NumberHITsAssignable</code></em> can only be queried
177
+ as a <span class="guilabel">LifeToDate</span> value. While most
178
+ statistics change in real time, a day's value for this statistic
179
+ is added to the <em class="parameter"><code>LifeToDate</code></em> total at the
180
+ end of the day. </p></td></tr></table></div>
181
+ <p class="simpara">Type: Long</p>
182
+ </td></tr><tr><td>
183
+ <p class="simpara">
184
+ NumberHITsReviewable
185
+ </p>
186
+ </td><td>
187
+ <p class="simpara">The number of your HITs with status <span class="guilabel">Reviewable</span>. </p>
188
+ <p class="simpara">Type: Long</p>
189
+ </td></tr><tr><td>
190
+ <p class="simpara">
191
+ EstimatedRewardLiability
192
+ </p>
193
+ </td><td>
194
+ <p class="simpara">The total amount of all of the rewards for HITs and assignments
195
+ that have not yet been completed. This includes the reward for each
196
+ unclaimed assignment for HITs that have not yet expired, each
197
+ assignment in progress, and each submitted assignment that has not
198
+ yet been approved or rejected. This is an estimate, because it is
199
+ possible that not all of a HIT's assignments will be completed
200
+ before the HIT expires. The amount is given in U.S. dollars. </p>
201
+ <p class="simpara">Type: Double</p>
202
+ </td></tr><tr><td>
203
+ <p class="simpara">
204
+ EstimatedFeeLiability
205
+ </p>
206
+ </td><td>
207
+ <p class="simpara">The total amount of all of the HIT listing fees for HITs and
208
+ assignments that have not yet been completed at a given point in
209
+ time. The amount is given in U.S. dollars. </p>
210
+ <p class="simpara">Type: Double</p>
211
+ </td></tr><tr><td>
212
+ <p class="simpara">
213
+ EstimatedTotalLiability
214
+ </p>
215
+ </td><td>
216
+ <p class="simpara">The total amount of all of the rewards and fees for HITs and
217
+ assignments that have not yet been completed at a given point in
218
+ time. The amount is given in U.S. dollars. </p>
219
+ <p class="simpara">Type: Double</p>
220
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e8010">Request Parameters</h2></div></div></div><p> The <code class="function">GetRequesterStatistic</code> operation accepts parameters common to
221
+ 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
222
+ information. </p><p> The following parameters are specific to the <code class="function">GetRequesterStatistic</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>
223
+ <p class="simpara">
224
+ <em class="parameter"><code>Operation</code></em>
225
+ </p>
226
+ </td><td>
227
+ <p class="simpara">The name of the operation</p>
228
+ <p class="simpara">Type: String</p>
229
+ <p class="simpara">Valid Values: GetRequesterStatistic</p>
230
+ <p class="simpara">Default: None</p>
231
+ </td><td>
232
+ <p class="simpara">Yes</p>
233
+ </td></tr><tr><td>
234
+ <p class="simpara">
235
+ <em class="parameter"><code>Statistic</code></em>
236
+ </p>
237
+ </td><td>
238
+ <p class="simpara">The statistic to return</p>
239
+ <p class="simpara">Type: String</p>
240
+ <p class="simpara">Valid Values: See the preceding table.</p>
241
+ <p class="simpara">Default: None</p>
242
+ </td><td>
243
+ <p class="simpara">Yes</p>
244
+ </td></tr><tr><td>
245
+ <p class="simpara">
246
+ <em class="parameter"><code>TimePeriod</code></em>
247
+ </p>
248
+ </td><td>
249
+ <p class="simpara">The time period of the statistic to return.</p>
250
+ <p class="simpara">Type: String</p>
251
+ <p class="simpara">Valid Values: OneDay | SevenDays | ThirtyDays |
252
+ LifeToDate</p>
253
+ <p class="simpara">Default: None</p>
254
+ </td><td>
255
+ <p class="simpara">Yes</p>
256
+ </td></tr><tr><td>
257
+ <p class="simpara">
258
+ <em class="parameter"><code>Count</code></em>
259
+ </p>
260
+ </td><td>
261
+ <p class="simpara">The number of data points to return</p>
262
+ <p class="simpara">Type: positive integer</p>
263
+ <p class="simpara">Default: 1</p>
264
+ <p class="simpara"> Conditions: only used if <em class="parameter"><code>TimePeriod</code></em> is
265
+ <code class="code">OneDay</code>
266
+ </p>
267
+ <p class="simpara"> For example, if <em class="parameter"><code>TimePeriod</code></em> is
268
+ <code class="code">OneDay</code> and <em class="parameter"><code>Count</code></em> is
269
+ <code class="code">12</code>, the operation returns 12 data points for the
270
+ statistic, one for each of 12 calendar days leading up to the
271
+ current date, including the current day. </p>
272
+ </td><td>
273
+ <p class="simpara">Conditional</p>
274
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e8173">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">GetRequesterStatistic</code> operation has
275
+ a <em class="parameter"><code>GetStatisticResult</code></em> element in the response. </p><p> The <em class="parameter"><code>GetStatisticResult</code></em> element contains a <em class="parameter"><code>DataPoint</code></em> element for each value requested. </p><p> Each <em class="parameter"><code>DataPoint</code></em> element contains the following elements: </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>
276
+ <p class="simpara">
277
+ <em class="parameter"><code>Date</code></em>
278
+ </p>
279
+ </td><td>
280
+ <p class="simpara">The date represented by the data point. For aggregate values,
281
+ this is the current date. </p>
282
+ <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
283
+ (Greenwich Mean Time) time zone, such as
284
+ <code class="code">2005-01-31T23:59:59Z</code>
285
+ </p>
286
+ </td></tr><tr><td>
287
+ <p class="simpara">
288
+ <em class="parameter"><code>LongValue</code></em> | <em class="parameter"><code>DoubleValue</code></em>
289
+ </p>
290
+ </td><td>
291
+ <p class="simpara">The value of the statistic over the specified time period. The
292
+ element name and data type depend on which statistic was requested. </p>
293
+ <p class="simpara">Type: a long or a double, depending on the requested
294
+ statistic.</p>
295
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e8251">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">GetRequesterStatistic</code>
296
+ operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e8259">Sample Request</h3></div></div></div><p> The following example of a call to the <code class="function">GetRequesterStatistic</code>
297
+ operation retrieves the total reward payout for the thirty days leading up to the
298
+ current date. </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
299
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
300
+ &amp;Version=2008-08-02
301
+ &amp;Operation=GetRequesterStatistic
302
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
303
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
304
+ &amp;Statistic=TotalRewardPayout
305
+ &amp;TimePeriod=ThirtyDays
306
+ &amp;Count=1
307
+ </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e8278">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;GetStatisticResult&gt;
308
+ &lt;Request&gt;
309
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
310
+ &lt;/Request&gt;
311
+ &lt;DataPoint&gt;
312
+ &lt;Date&gt;2009-07-13T07:00:00Z&lt;/Date&gt;
313
+ &lt;DoubleValue&gt;20&lt;/DoubleValue&gt;
314
+ &lt;/DataPoint&gt;
315
+ &lt;/GetStatisticResult&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_GetQualificationTypeOperation.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_GetRequesterStatisticOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_GetReviewableHITsOperation.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>