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
@@ -0,0 +1,67 @@
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>UnblockWorker</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_SetHITTypeNotificationOperation.html" title="SetHITTypeNotification"><link rel="next" href="ApiReference_UpdateQualificationScoreOperation.html" title="UpdateQualificationScore"><!--[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_SetHITTypeNotificationOperation.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_UnblockWorkerOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_UpdateQualificationScoreOperation.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>UnblockWorker</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">UnblockWorker</h1></div></div></div><a class="indexterm" name="d0e12705"></a><a class="indexterm" name="d0e12708"></a><a class="indexterm" name="d0e12713"></a><a class="indexterm" name="d0e12718"></a><a class="indexterm" name="d0e12721"></a><a class="indexterm" name="d0e12726"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e12731">Description</h2></div></div></div><p> The <code class="function">UnblockWorker</code> operation allows you to reinstate a blocked
7
+ Worker to work on your HITs. This operation reverses the effects of the <a class="link" href="ApiReference_BlockWorkerOperation.html" title="BlockWorker">BlockWorker</a> operation. </p><p> You need the Worker ID to use this operation. If the Worker ID is missing or invalid,
8
+ this operation fails and returns the message &#8220;WorkerId is invalid.&#8221; If the specified
9
+ Worker is not blocked, this operation returns successfully. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e12744">Request Parameters</h2></div></div></div><p> The <code class="function">UnblockWorker</code> operation accepts parameters common to all
10
+ 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
11
+ information. </p><p> The following parameters are specific to the <code class="function">UnblockWorker</code>
12
+ 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: UnblockWorker</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>WorkerId</code></em>
26
+ </p>
27
+ </td><td>
28
+ <p class="simpara">The ID of the Worker to unblock.</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>Reason</code></em>
36
+ </p>
37
+ </td><td>
38
+ <p class="simpara"> A message that explains the reason for unblocking the Worker.
39
+ The Worker does not see this message. </p>
40
+ <p class="simpara">Type: String</p>
41
+ <p class="simpara">Default: None</p>
42
+ </td><td>
43
+ <p class="simpara">No</p>
44
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e12852">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">UnblockWorker</code> operation returns
45
+ with no errors. The response includes the elements described in the following table. The
46
+ operation returns no other data. </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>
47
+ <p class="simpara">
48
+ <em class="parameter"><code>UnblockWorkerResult</code></em>
49
+ </p>
50
+ </td><td>
51
+ <p class="simpara"> Contains a <em class="parameter"><code>Request</code></em> element if the
52
+ <strong class="userinput"><code>Request</code></strong>
53
+ <em class="parameter"><code>ResposeGroup</code></em> is specified. </p>
54
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e12894">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">UnblockWorker</code>
55
+ operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e12902">Sample Request</h3></div></div></div><p>The following example unblocks a Worker and allows that Worker to work on your
56
+ HITs.</p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
57
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
58
+ &amp;Version=2008-08-02
59
+ &amp;Operation=UnblockWorker
60
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
61
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
62
+ &amp;WorkerId=AZ3456EXAMPLE
63
+ </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e12918">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;UnblockWorkerResult&gt;
64
+ &lt;Request&gt;
65
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
66
+ &lt;/Request&gt;
67
+ &lt;/UnblockWorkerResult&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_SetHITTypeNotificationOperation.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_UnblockWorkerOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_UpdateQualificationScoreOperation.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>
@@ -0,0 +1,77 @@
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>UpdateQualificationScore</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_UnblockWorkerOperation.html" title="UnblockWorker"><link rel="next" href="ApiReference_UpdateQualificationTypeOperation.html" title="UpdateQualificationType"><!--[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_UnblockWorkerOperation.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_UpdateQualificationScoreOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_UpdateQualificationTypeOperation.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>UpdateQualificationScore</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">UpdateQualificationScore</h1></div></div></div><a class="indexterm" name="d0e12929"></a><a class="indexterm" name="d0e12932"></a><a class="indexterm" name="d0e12937"></a><a class="indexterm" name="d0e12940"></a><a class="indexterm" name="d0e12945"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e12950">Description</h2></div></div></div><p> The <code class="function">UpdateQualificationScore</code> operation changes the value of a
7
+ Qualification previously granted to a Worker. </p><p> Only the owner of a Qualification type can update the score of a Qualification of
8
+ that type. </p><p> The Worker must have already been granted a Qualification of the given Qualification
9
+ type before the score can be updated. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e12962">Request Parameters</h2></div></div></div><p> The <code class="function">UpdateQualificationScore</code> operation accepts parameters common
10
+ 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
11
+ information. </p><p> The following parameters are specific to the <code class="function">UpdateQualificationScore</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: UpdateQualificationScore</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, as returned by <a class="link" href="ApiReference_CreateQualificationTypeOperation.html" title="CreateQualificationType">CreateQualificationType</a> operation. </p>
28
+ <p class="simpara">Type: String</p>
29
+ <p class="simpara">Default: None</p>
30
+ </td><td>
31
+ <p class="simpara">Yes</p>
32
+ </td></tr><tr><td>
33
+ <p class="simpara">
34
+ <em class="parameter"><code>SubjectId</code></em>
35
+ </p>
36
+ </td><td>
37
+ <p class="simpara"> The ID of the Worker whose Qualification is being updated, as
38
+ returned by the <a class="link" href="ApiReference_GetAssignmentsForHITOperation.html" title="GetAssignmentsForHIT">GetAssignmentsForHIT</a> operation. </p>
39
+ <p class="simpara">Type: String</p>
40
+ <p class="simpara">Default: None</p>
41
+ </td><td>
42
+ <p class="simpara">Yes</p>
43
+ </td></tr><tr><td>
44
+ <p class="simpara">
45
+ <em class="parameter"><code>IntegerValue</code></em>
46
+ </p>
47
+ </td><td>
48
+ <p class="simpara">The new value for the Qualification.</p>
49
+ <p class="simpara">Type: Integer</p>
50
+ <p class="simpara">Default: None</p>
51
+ </td><td>
52
+ <p class="simpara">Yes</p>
53
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e13101">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">UpdateQualificationScore</code> operation
54
+ returns with no errors. The response includes the elements described in the following
55
+ table. The operation returns no other data. </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col></colgroup><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>
56
+ <p class="simpara">
57
+ <em class="parameter"><code>UpdateQualificationScoreResult</code></em>
58
+ </p>
59
+ </td><td>
60
+ <p class="simpara"> Contains a <em class="parameter"><code>Request</code></em> element if the
61
+ <strong class="userinput"><code>Request</code></strong>
62
+ <em class="parameter"><code>ResposeGroup</code></em> is specified. </p>
63
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e13143">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">UpdateQualificationScore</code> operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e13151">Sample Request</h3></div></div></div><p>The following example changes the value of a Qualification of the specified
64
+ type for the specified Worker.</p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
65
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
66
+ &amp;Version=2008-08-02
67
+ &amp;Operation=UpdateQualificationScore
68
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
69
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
70
+ &amp;QualificationTypeId=789RVWYBAZW00EXAMPLE
71
+ &amp;SubjectId=AZ3456EXAMPLE
72
+ &amp;IntegerValue=70
73
+ </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e13167">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;UpdateQualificationScoreResult&gt;
74
+ &lt;Request&gt;
75
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
76
+ &lt;/Request&gt;
77
+ &lt;/UpdateQualificationScoreResult&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_UnblockWorkerOperation.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_UpdateQualificationScoreOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_UpdateQualificationTypeOperation.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>
@@ -0,0 +1,180 @@
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>UpdateQualificationType</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_UpdateQualificationScoreOperation.html" title="UpdateQualificationScore"><link rel="next" href="ApiReference_DataStructuresArticle.html" title="Chapter&nbsp;6.&nbsp;Data Structures"><!--[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_UpdateQualificationScoreOperation.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_UpdateQualificationTypeOperation">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_DataStructuresArticle.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>UpdateQualificationType</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">UpdateQualificationType</h1></div></div></div><a class="indexterm" name="d0e13178"></a><a class="indexterm" name="d0e13181"></a><a class="indexterm" name="d0e13188"></a><a class="indexterm" name="d0e13193"></a><a class="indexterm" name="d0e13198"></a><a class="indexterm" name="d0e13203"></a><a class="indexterm" name="d0e13208"></a><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e13213">Description</h2></div></div></div><p> The <code class="function">UpdateQualificationType</code> operation modifies attributes of an
7
+ existing Qualification type. </p><p> Most attributes of a Qualification type can be changed after the type has been
8
+ created. However, the <em class="parameter"><code>Name</code></em> and <em class="parameter"><code>Keywords</code></em>
9
+ fields cannot be modified. If you create a Qualification type and decide you do want to
10
+ use it with its name or keywords as they were created, update the type with the
11
+ <em class="parameter"><code>QualificationTypeStatus</code></em> parameter set to <strong class="userinput"><code>Inactive</code></strong>. Then create a new type using <a class="link" href="ApiReference_CreateQualificationTypeOperation.html" title="CreateQualificationType">CreateQualificationType</a> operation with the desired values. </p><p> You can use this operation to update a the test of a Qualification type. The test is
12
+ updated based on the values specified for the <em class="parameter"><code>Test</code></em>, <em class="parameter"><code>TestDurationInSeconds</code></em> and <em class="parameter"><code>AnswerKey</code></em> parameters.
13
+ All three parameters specify the updated test. If you are updating the test for a type,
14
+ you must specify the <em class="parameter"><code>Test</code></em> and <em class="parameter"><code>TestDurationInSeconds</code></em> parameters. The <em class="parameter"><code>AnswerKey</code></em>
15
+ parameter is optional; omitting it specifies that the updated test does not have an
16
+ answer key. </p><p> If you omit the <em class="parameter"><code>Test</code></em> parameter, the test for the Qualification
17
+ type is unchanged. There is no way to remove a test from a Qualification type that has
18
+ one. If the type already has a test, you cannot update it to be <em class="parameter"><code>AutoGranted</code></em>. If the Qualification type does not have a test and one is
19
+ provided by an update, the type will henceforth have a test. </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> If you want to update the test duration or answer key for an existing test
20
+ without changing the questions, you must specify a <em class="parameter"><code>Test</code></em>
21
+ parameter with the original questions, along with the updated values. </p></td></tr></table></div><p> If you provide an <em class="parameter"><code>AnswerKey</code></em> paramter, Amazon Mechanical Turk
22
+ processes requests for the Qualification automatically, and assigns the Worker a
23
+ Qualification with a value calculated from the <em class="parameter"><code>AnswerKey</code></em> and the
24
+ answers submitted by the Worker. </p><p> If you provide an updated <em class="parameter"><code>Test</code></em> but no <em class="parameter"><code>AnswerKey</code></em>, the new test will not have an answer key. Requests for such
25
+ Qualifications must be granted manually. </p><p> You can also update the <em class="parameter"><code>AutoGranted</code></em> and <em class="parameter"><code>AutoGrantedValue</code></em> attributes of the Qualification type. </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/note.png"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p> A Qualification type cannot be configured with both the <em class="parameter"><code>Test</code></em> parameter specified and the <em class="parameter"><code>AutoGranted</code></em>
26
+ parameter set to <strong class="userinput"><code>true</code></strong>. Currently, there is no way to remove a
27
+ test from a Qualification type that has one. A Qualification type with a test cannot
28
+ be re-configured to use the auto-granting feature. </p></td></tr></table></div><p> Only the owner of a Qualification type can modify its attributes. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e13310">Request Parameters</h2></div></div></div><p> The <code class="function">UpdateQualificationType</code> operation accepts parameters common
29
+ 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
30
+ information. </p><p> The following parameters are specific to the <code class="function">UpdateQualificationType</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>
31
+ <p class="simpara">
32
+ <em class="parameter"><code>Operation</code></em>
33
+ </p>
34
+ </td><td>
35
+ <p class="simpara">The name of the operation</p>
36
+ <p class="simpara">Type: String</p>
37
+ <p class="simpara">Valid Values: UpdateQualificationType</p>
38
+ <p class="simpara">Default: None</p>
39
+ </td><td>
40
+ <p class="simpara">Yes</p>
41
+ </td></tr><tr><td>
42
+ <p class="simpara">
43
+ <em class="parameter"><code>QualificationTypeId</code></em>
44
+ </p>
45
+ </td><td>
46
+ <p class="simpara">The ID of the Qualification type to update.</p>
47
+ <p class="simpara">Type: String</p>
48
+ <p class="simpara">Default: None</p>
49
+ </td><td>
50
+ <p class="simpara">Yes</p>
51
+ </td></tr><tr><td>
52
+ <p class="simpara">
53
+ <em class="parameter"><code>RetryDelayInSeconds</code></em>
54
+ </p>
55
+ </td><td>
56
+ <p class="simpara"> The amount of time, in seconds, that Workers must wait after
57
+ requesting a Qualification of the specified Qualification type
58
+ before they can request it again. </p>
59
+ <p class="simpara">Type: non-negative integer</p>
60
+ <p class="simpara">Default: None. If not specified, retries are
61
+ disabled.</p>
62
+ </td><td>
63
+ <p class="simpara">No</p>
64
+ </td></tr><tr><td>
65
+ <p class="simpara">
66
+ <em class="parameter"><code>QualificationTypeStatus</code></em>
67
+ </p>
68
+ </td><td>
69
+ <p class="simpara">The new status of the Qualification type.</p>
70
+ <p class="simpara">Type: String</p>
71
+ <p class="simpara">Valid Values: Active | Inactive</p>
72
+ <p class="simpara">Default: None</p>
73
+ </td><td>
74
+ <p class="simpara">No</p>
75
+ </td></tr><tr><td>
76
+ <p class="simpara">
77
+ <em class="parameter"><code>Description</code></em>
78
+ </p>
79
+ </td><td>
80
+ <p class="simpara">The new description of the Qualification type.</p>
81
+ <p class="simpara">Type: String</p>
82
+ <p class="simpara">Default: None</p>
83
+ </td><td>
84
+ <p class="simpara">No</p>
85
+ </td></tr><tr><td>
86
+ <p class="simpara">
87
+ <em class="parameter"><code>Test</code></em>
88
+ </p>
89
+ </td><td>
90
+ <p class="simpara"> The questions for a Qualification test a user must answer
91
+ correctly to obtain a Qualification of this type. </p>
92
+ <p class="simpara"> Type: a <a class="link" href="ApiReference_QuestionFormDataStructureArticle.html" title="QuestionForm">QuestionForm</a> data structure. </p>
93
+ <p class="simpara"> Default: None </p>
94
+ <p class="simpara"> Constraints: Cannot be specified if <em class="parameter"><code>AutoGranted</code></em> is <strong class="userinput"><code>true</code></strong>. If you
95
+ update the <em class="parameter"><code>AnswerKey</code></em>, you must provide the
96
+ <em class="parameter"><code>Test</code></em> parameter, even if the test has not
97
+ changed. If you update the <em class="parameter"><code>TestDurationInSeconds</code></em>, you must provide the
98
+ <em class="parameter"><code>Test</code></em> parameter, even if the test has not
99
+ changed. </p>
100
+ </td><td>
101
+ <p class="simpara">No</p>
102
+ </td></tr><tr><td>
103
+ <p class="simpara">
104
+ <em class="parameter"><code>AnswerKey</code></em>
105
+ </p>
106
+ </td><td>
107
+ <p class="simpara"> The answers to the Qualification test specified in the
108
+ <em class="parameter"><code>Test</code></em> parameter. </p>
109
+ <p class="simpara">Type: an <a class="link" href="ApiReference_AnswerKeyDataStructureArticle.html" title="AnswerKey">AnswerKey</a> data structure.</p>
110
+ <p class="simpara">Default: None</p>
111
+ </td><td>
112
+ <p class="simpara">No</p>
113
+ </td></tr><tr><td>
114
+ <p class="simpara">
115
+ <em class="parameter"><code>TestDurationInSeconds</code></em>
116
+ </p>
117
+ </td><td>
118
+ <p class="simpara"> The amount of time, in seconds, that a Worker has to complete
119
+ the Qualification test, starting from when the Worker requested the
120
+ Qualification. </p>
121
+ <p class="simpara">Type: positive integer</p>
122
+ <p class="simpara">Default: None</p>
123
+ <p class="simpara">Conditions: Required if the <em class="parameter"><code>Test</code></em>
124
+ parameter is specified.</p>
125
+ </td><td>
126
+ <p class="simpara">Conditional</p>
127
+ </td></tr><tr><td>
128
+ <p class="simpara">
129
+ <em class="parameter"><code>AutoGranted</code></em>
130
+ </p>
131
+ </td><td>
132
+ <p class="simpara"> Specifies whether requests for the Qualification type will be
133
+ granted immediately, without prompting the Worker with a
134
+ Qualification test. </p>
135
+ <p class="simpara">Type: Boolean</p>
136
+ <p class="simpara">Valid Values: true | false</p>
137
+ <p class="simpara">Default: None</p>
138
+ <p class="simpara">Conditions: Cannot be <strong class="userinput"><code>true</code></strong> if <em class="parameter"><code>Test</code></em> is specified.</p>
139
+ </td><td>
140
+ <p class="simpara">Conditional</p>
141
+ </td></tr><tr><td><p class="simpara"></p>
142
+ <em class="parameter"><code>AutoGrantedValue</code></em>
143
+ </td><td>
144
+ <p class="simpara"> The Qualification value to use if <em class="parameter"><code>AutoGranted</code></em> is <strong class="userinput"><code>true</code></strong>. </p>
145
+ <p class="simpara">Type: Integer</p>
146
+ <p class="simpara">Default: 1</p>
147
+ </td><td>
148
+ <p class="simpara">No</p>
149
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e13648">Response Elements</h2></div></div></div><p> A successful request for the <code class="function">UpdateQualificationType</code> operation
150
+ has a <em class="parameter"><code>QualificationType</code></em> element in the response, as described in
151
+ 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>
152
+ <p class="simpara">
153
+ <em class="parameter"><code>QualficationType</code></em>
154
+ </p>
155
+ </td><td>
156
+ <p class="simpara"> Contains a <a class="link" href="ApiReference_QualificationTypeDataStructureArticle.html" title="QualificationType">QualificationType</a> data strucure. </p>
157
+ <p class="simpara"> Type: a <a class="link" href="ApiReference_QualificationTypeDataStructureArticle.html" title="QualificationType">QualificationType</a> data structure </p>
158
+ </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e13693">Examples</h2></div></div></div><p>The following example shows how to use the <code class="function">UpdateQualificationType</code> operation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e13701">Sample Request</h3></div></div></div><p> The following example changes the <em class="parameter"><code>QualificationTypeStatus</code></em> of a Qualification type. </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
159
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
160
+ &amp;Version=2008-08-02
161
+ &amp;Operation=UpdateQualificationType
162
+ &amp;Signature=<em class="replaceable"><code>[signature for this request]</code></em>
163
+ &amp;Timestamp=<em class="replaceable"><code>[your system's local time]</code></em>
164
+ &amp;QualificationTypeId=789RVWYBAZW00EXAMPLE
165
+ &amp;QualificationTypeStatus=Inactive
166
+ </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title" id="d0e13720">Sample Response</h3></div></div></div><p>The following is an example response.</p><pre class="programlisting">&lt;UpdateQualificationTypeResult&gt;
167
+ &lt;Request&gt;
168
+ &lt;IsValid&gt;True&lt;/IsValid&gt;
169
+ &lt;/Request&gt;
170
+ &lt;QualificationType&gt;
171
+ &lt;QualificationTypeId&gt;789RVWYBAZW00EXAMPLE&lt;/QualificationTypeId&gt;
172
+ &lt;CreationTime&gt;2009-06-15T12:00:01Z&lt;/CreationTime&gt;
173
+ &lt;Name&gt;EnglishWritingAbility&lt;/Name&gt;
174
+ &lt;Description&gt;The ability to write and edit text...&lt;/Description&gt;
175
+ &lt;Keywords&gt;English, text, write, edit, language&lt;/Keywords&gt;
176
+ &lt;QualificationTypeStatus&gt;Active&lt;/QualificationTypeStatus&gt;
177
+ &lt;RetryDelayInSeconds&gt;86400&lt;/RetryDelayInSeconds&gt;
178
+ &lt;IsRequestable&gt;true&lt;/IsRequestable&gt;
179
+ &lt;/QualificationType&gt;
180
+ &lt;/UpdateQualificationTypeResult&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_UpdateQualificationScoreOperation.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_UpdateQualificationTypeOperation">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_DataStructuresArticle.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>
@@ -0,0 +1,95 @@
1
+ <html xmlns:fo="http://www.w3.org/1999/XSL/Format"><head>
2
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3
+ <title>Chapter&nbsp;3.&nbsp;WSDL and Schema Locations</title><link rel="stylesheet" href="aws-docs-IE.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><link rel="home" href="#top" title="Amazon Mechanical Turk"><link rel="up" href="#top" title="Amazon Mechanical Turk"><link rel="prev" href="WhatsNew.html" title="Chapter&nbsp;2.&nbsp;What's New"><link rel="next" href="ApiReference_CommonParametersArticle.html" title="Chapter&nbsp;4.&nbsp;Common Parameters"><!--[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="WhatsNew.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_WsdlLocationArticle">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_CommonParametersArticle.html"><img src="images/next.gif" alt="Next"></a></td></tr></table><div class="breadcrumb"><a href="Welcome.html">Welcome</a><a href=""></a> &raquo; <strong>WSDL and Schema Locations</strong></div></div><div class="chapter" lang="en" id="ApiReference_WsdlLocationArticle"><div class="titlepage"><div><div><h1 class="topictitle">WSDL and Schema Locations</h1></div></div></div><a class="indexterm" name="d0e384"></a><a class="indexterm" name="d0e387"></a><a class="indexterm" name="d0e390"></a><a class="indexterm" name="d0e395"></a><a class="indexterm" name="d0e400"></a><a class="indexterm" name="d0e403"></a><div class="highlights"><p><strong>Topics</strong></p><ul><li><a href="ApiReference_WsdlLocationArticle.html#d0e460">The WSDL and Message Schema Locations</a></li><li><a href="ApiReference_WsdlLocationArticle.html#d0e483">The Data Structure Schema Locations</a></li><li><a href="ApiReference_WsdlLocationArticle.html#d0e560">The Formatted Content XHTML Subset</a></li><li><a href="ApiReference_WsdlLocationArticle.html#d0e597">The Notifications Receptor WSDL Location</a></li><li><a href="ApiReference_WsdlLocationArticle.html#d0e619">Service API Versions</a></li><li><a href="ApiReference_WsdlLocationArticle.html#d0e647">Accessing a Specific Service Version</a></li><li><a href="ApiReference_WsdlLocationArticle.html#d0e672">The Default Version</a></li></ul></div><p> The Amazon Mechanical Turk Service can be accessed using the SOAP web services messaging protocol, or
7
+ using the REST method of HTTP requests with parameters. The SOAP interface is described by a Web
8
+ Services Description Language (WSDL) document. REST requests return messages that conform to an XML
9
+ Schema document. </p><p> To make it easy to upgrade your application when a new version of schemas are released, all schemas
10
+ have a version number. The version number appears in the URL of a schema file, and in a schema's
11
+ target namespace. The API schemas (the WSDL and request/response messages) and the data structure
12
+ schemas (question and answer values) use separate version numbers. The latest versions are as follows: </p><div class="informaltable"><table cellspacing="0" border="0"><colgroup><col><col></colgroup><thead><tr><th> Type of Schema </th><th> Latest Version </th></tr></thead><tbody><tr><td> The API: WSDL and message schemas </td><td>
13
+ <strong class="userinput"><code>2008-08-02</code></strong>
14
+ </td></tr><tr><td> The QuestionForm, QuestionFormAnswers and AnswerKey schemas </td><td>
15
+ <strong class="userinput"><code>2005-10-01</code></strong>
16
+ </td></tr><tr><td> The ExternalQuestion schema </td><td>
17
+ <strong class="userinput"><code>2006-07-14</code></strong>
18
+ </td></tr><tr><td> The formatted content XHTML subset </td><td>
19
+ <strong class="userinput"><code>2006-07-14</code></strong>
20
+ </td></tr><tr><td> The notifications receptor API </td><td>
21
+ <strong class="userinput"><code>2006-05-05</code></strong>
22
+ </td></tr></tbody></table></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e460">The WSDL and Message Schema Locations</h2></div></div></div><p> The WSDL for a given version of the Amazon Mechanical Turk Service API can be found at a URL that
23
+ corresponds to the API version. For example, the WSDL for the
24
+ <strong class="userinput"><code>2008-08-02</code></strong> version of the API can be found here: </p><p>
25
+ <a class="ulink" href="http://mechanicalturk.amazonaws.com/AWSMechanicalTurk/2008-08-02/AWSMechanicalTurkRequester.wsdl" target="_blank">http://mechanicalturk.amazonaws.com/AWSMechanicalTurk/2008-08-02/AWSMechanicalTurkRequester.wsdl</a>
26
+ </p><p> The XML Schema for the messages of a given version of the Amazon Mechanical Turk Service API can be
27
+ found at a URL that corresponds to the API version. For example, the XML Schema for the
28
+ <strong class="userinput"><code>2008-08-02</code></strong> version of the API can be found here: </p><p>
29
+ <a class="ulink" href="http://mechanicalturk.amazonaws.com/AWSMechanicalTurk/2008-08-02/AWSMechanicalTurkRequester.xsd" target="_blank">http://mechanicalturk.amazonaws.com/AWSMechanicalTurk/2008-08-02/AWSMechanicalTurkRequester.xsd</a>
30
+ </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e483">The Data Structure Schema Locations</h2></div></div></div><a class="indexterm" name="d0e486"></a><p> The Amazon Mechanical Turk Service has several parameters and return values that contain XML data. The
31
+ XML content must validate against the appropriate XML schema. For more information, see <a class="link" href="ApiReference_QuestionFormDataStructureArticle.html" title="QuestionForm">QuestionForm</a>, <a class="link" href="ApiReference_QuestionFormAnswersDataStructureArticle.html" title="QuestionFormAnswers">QuestionFormAnswers</a>, and <a class="link" href="ApiReference_AnswerKeyDataStructureArticle.html" title="AnswerKey">AnswerKey</a>. </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/note.png"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p> The API version number and the data structure version number are not related. The two sets
32
+ of schemas may have new releases at different times, and may have different version numbers.
33
+ For example, an application using the <strong class="userinput"><code>2008-08-02</code></strong> version of the
34
+ API may create HITs using the <strong class="userinput"><code>2005-10-01</code></strong> version of the QuestionForm
35
+ schema. (There may not be a "2008-08-02" version of the QuestionForm
36
+ schema.) </p><p> Your application may use any supported version of the data schemas with any supported
37
+ version of the API. A data structure returned by the service will include a namespace that
38
+ corresponds to the relevant schema. </p></td></tr></table></div><p> The <strong class="userinput"><code>2005-10-01</code></strong> version of the QuestionForm schema can be found here: </p><p>
39
+ <a class="ulink" href="http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2005-10-01/QuestionForm.xsd" target="_blank">http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2005-10-01/QuestionForm.xsd</a>
40
+ </p><p> The <strong class="userinput"><code>2005-10-01</code></strong> version of the QuestionFormAnswers schema can be found
41
+ here: </p><p>
42
+ <a class="ulink" href="http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2005-10-01/QuestionFormAnswers.xsd" target="_blank">http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2005-10-01/QuestionFormAnswers.xsd</a>
43
+ </p><p> The <strong class="userinput"><code>2005-10-01</code></strong> version of the AnswerKey schema can be found here: </p><p>
44
+ <a class="ulink" href="http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2005-10-01/AnswerKey.xsd" target="_blank">http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2005-10-01/AnswerKey.xsd</a>
45
+ </p><p> The <strong class="userinput"><code>2006-07-14</code></strong> version of the ExternalQuestion schema can be found here: </p><p>
46
+ <a class="ulink" href="http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2006-07-14/ExternalQuestion.xsd" target="_blank">http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2006-07-14/ExternalQuestion.xsd</a>
47
+ </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> To conform to a schema, XML content must use namespace declarations that match the target
48
+ namespace for the schema. The target namespace is declared at the top of the schema, as the
49
+ "targetNamespace" attribute of the "xs:schema" element. </p><p> The schemas for QuestionForm, QuestionFormAnswers, and AnswerKey use namespace URIs similar
50
+ to the URL at which the schema file can be found, including the service version. For example: </p><pre class="programlisting">&lt;QuestionForm
51
+ xmlns="http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2005-10-01/QuestionForm.xsd"
52
+ &gt;
53
+ <em class="replaceable"><code>[...]</code></em>
54
+ &lt;/QuestionForm&gt;</pre><p> If the service returns an error message about data not validating against the schema, make
55
+ sure your namespace declaration matches the target namespace specified in the schema. </p></td></tr></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e560">The Formatted Content XHTML Subset</h2></div></div></div><a class="indexterm" name="d0e563"></a><a class="indexterm" name="d0e566"></a><a class="indexterm" name="d0e569"></a><a class="indexterm" name="d0e572"></a><p> HITs and Qualification tests can include blocks of content formatted with XHTML tags in their
56
+ instructions and question data. To include text and markup for formatted content in a web service
57
+ request, you specify it as XML CDATA inside a <em class="parameter"><code>FormattedContent</code></em> element,
58
+ part of <a class="link" href="ApiReference_QuestionFormDataStructureArticle.html" title="QuestionForm">the QuestionForm data
59
+ structure</a>. </p><p> Amazon Mechanical Turk validates formatted content by converting the text and markup in the
60
+ CDATA block into an XML document, then validating it against a schema. For more information about
61
+ how this XML document is produced, see <a class="link" href="ApiReference_FormattedContentXHTMLArticle.html" title="Formatted Content: XHTML">Formatted Content: XHTML</a>, "How XHTML Formatted Content Is
62
+ Validated". </p><p> The <strong class="userinput"><code>2006-07-14</code></strong> version of the schema used to validate formatted content
63
+ can be found here: </p><p>
64
+ <a class="ulink" href="http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2006-07-14/FormattedContentXHTMLSubset.xsd" target="_blank">http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2006-07-14/FormattedContentXHTMLSubset.xsd</a>
65
+ </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e597">The Notifications Receptor WSDL Location</h2></div></div></div><a class="indexterm" name="d0e600"></a><a class="indexterm" name="d0e605"></a><p> The WSDL for the notification receptor API is located here: </p><p>
66
+ <a class="ulink" href="http://mechanicalturk.amazonaws.com/AWSMechanicalTurk/2006-05-05/AWSMechanicalTurkRequesterNotification.wsdl" target="_blank">http://mechanicalturk.amazonaws.com/AWSMechanicalTurk/2006-05-05/AWSMechanicalTurkRequesterNotification.wsdl</a>
67
+ </p><p> For more information about building a notification receptor web service, see <a class="link" href="ApiReference_NotificationReceptorAPIArticle.html" title="Chapter&nbsp;8.&nbsp;The Notification Receptor API">The Notification Receptor API</a>. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e619">Service API Versions</h2></div></div></div><p> When a new version of the service API is released, previous versions are supported for a
68
+ limited time to allow applications to continue to function until they are upgraded. The version of
69
+ a service API is specified as a date, such as <strong class="userinput"><code>2008-08-02</code></strong>. </p><p> The version of the API can be found in the URLs of the WSDL and schema files. It can also be
70
+ found in the <em class="parameter"><code>targetNamespace</code></em> of the WSDL and schema files. </p><p> You can retrieve the WSDL or schema files for previous versions of the API by replacing the
71
+ version date in the URL with the desired version. For example, to retrieve the WSDL for API
72
+ version <strong class="userinput"><code>2008-08-02</code></strong>: </p><p>
73
+ <a class="ulink" href="http://mechanicalturk.amazonaws.com/AWSMechanicalTurk/2008-08-02/AWSMechanicalTurkRequester.wsdl" target="_blank">http://mechanicalturk.amazonaws.com/AWSMechanicalTurk/2008-08-02/AWSMechanicalTurkRequester.wsdl</a>
74
+ </p><p> For information about which versions of the API are supported, visit the Amazon Web Services
75
+ web site at <a class="ulink" href="http://aws.amazon.com/mturk" target="_blank">http://aws.amazon.com/mturk</a>. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e647">Accessing a Specific Service Version</h2></div></div></div><p> For your application to use a specific version of the service API, the service needs to be told
76
+ which version is being used with each request. </p><p> For SOAP requests, the Amazon Mechanical Turk Service determines which API version you are using based
77
+ on the namespace in your request message, which is determined by the WSDL you are using with your
78
+ application. SOAP requests always include this information, and SOAP toolkits determine the
79
+ namespace automatically from the WSDL. </p><p> For REST requests, you must explicitly request the version to use by including the
80
+ <em class="parameter"><code>Version</code></em> parameter in your request. The <em class="parameter"><code>Version</code></em>
81
+ parameter ensures that the service does not return response elements that your application is not
82
+ designed to handle. </p><p> Here is an example REST request that includes the <em class="parameter"><code>Version</code></em> parameter: </p><pre class="programlisting">http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
83
+ &amp;AWSAccessKeyId=<em class="replaceable"><code>[the Requester's Access Key ID]</code></em>
84
+ &amp;Version=2008-08-02
85
+ &amp;Operation=GetHIT
86
+ &amp;HITId=123RVWYBAZW00EXAMPLE</pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e672">The Default Version</h2></div></div></div><p> Older AWS services supported requests that did not specify an API version. This behavior is
87
+ still supported for legacy reasons, but its use is discouraged. </p><p> When the Amazon Mechanical Turk Service receives a REST request without a
88
+ <em class="parameter"><code>Version</code></em> parameter, the service will use the latest version. If your
89
+ application does not specify the <em class="parameter"><code>Version</code></em> in each request, when a new
90
+ version of the API is released, your application will start using the new version automatically.
91
+ Because new versions of the API may be incompatible with applications expecting to use an older
92
+ version, specifying an explicit <em class="parameter"><code>Version</code></em> parameter with each request is
93
+ strongly recommended. </p><p> A similar legacy feature exists for SOAP: A request for the WSDL or a schema file using a URL
94
+ that does not include the version number will return the file for the latest version of the API.
95
+ Using WSDL/schema URLs that include the API version number is strongly recommended. </p></div></div><div class="navfooter"><table width="100%" summary="Navigation footer" cellspacing="0" cellpadding="2"><tr><td width="30%" align="left"><a accesskey="p" href="WhatsNew.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_WsdlLocationArticle">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_CommonParametersArticle.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>
@@ -0,0 +1,37 @@
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>Using XML Parameter Values</title><link rel="stylesheet" href="aws-docs-IE.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><link rel="home" href="#top" title="Amazon Mechanical Turk"><link rel="up" href="ApiReference_QuestionAnswerDataArticle.html" title="Chapter&nbsp;7.&nbsp;Question and Answer Data"><link rel="prev" href="ApiReference_QuestionAnswerDataArticle.html" title="Chapter&nbsp;7.&nbsp;Question and Answer Data"><link rel="next" href="ApiReference_QuestionFormDataStructureArticle.html" title="QuestionForm"><!--[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_QuestionAnswerDataArticle.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_XMLParameterValuesArticle">Documentation Feedback</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_QuestionFormDataStructureArticle.html"><img src="images/next.gif" alt="Next"></a></td></tr></table><div class="breadcrumb"><a href="Welcome.html">Welcome</a><a href=""></a> &raquo; <a href="ApiReference_QuestionAnswerDataArticle.html">Question and Answer Data</a> &raquo; <strong>Using XML Parameter Values</strong></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h1 class="topictitle">Using XML Parameter Values</h1></div></div></div><a class="indexterm" name="d0e16918"></a><a class="indexterm" name="d0e16921"></a><p> The <a class="link" href="ApiReference_QuestionFormDataStructureArticle.html" title="QuestionForm">QuestionForm</a>, <a class="link" href="ApiReference_QuestionFormAnswersDataStructureArticle.html" title="QuestionFormAnswers">QuestionFormAnswers</a>, and
7
+ <a class="link" href="ApiReference_AnswerKeyDataStructureArticle.html" title="AnswerKey">AnswerKey</a> data structures are
8
+ used as parameter values in service requests, and as return values in service responses. Unlike other
9
+ data structures described in this API reference, these XML structures are not part of the service API
10
+ directly, but rather are used as string values going in and out of the service. This article describes
11
+ the encoding methods needed to use XML data as parameter and return values. </p><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e16935">XML Data as a Parameter</h2></div></div></div><p> For SOAP requests, XML data in a parameter value must appear in the request <span class="emphasis"><em>XML
12
+ escaped</em></span>. Characters that are part of XML syntax, such as ampersands
13
+ (<strong class="userinput"><code>&amp;</code></strong>) and angle brackets
14
+ (<strong class="userinput"><code>&lt;&gt;</code></strong>), must be replaced with the corresponding XML character
15
+ entities in the parameter value. Most SOAP toolkits will automatically escape data set as the
16
+ string value of the parameter. </p><p> The following is a fragment of a <em class="parameter"><code>QuestionForm</code></em> data structure, escaped
17
+ with XML character entities: </p><pre class="programlisting">&amp;lt;QuestionForm xmlns="..."&amp;gt;
18
+ &amp;lt;Overview&amp;gt;
19
+ &amp;lt;Text&amp;gt;
20
+ Musicals by Rodgers &amp;amp;amp; Hart...
21
+ &amp;lt;/Text&amp;gt;
22
+ &amp;lt;Overview&amp;gt;
23
+ ...
24
+ &amp;lt;/QuestionForm&amp;gt;</pre><p> For REST requests, the data must be <span class="emphasis"><em>URL encoded</em></span> to appear as a single
25
+ parameter value in the request. (This is true for all REST parameter values.) Characters that are
26
+ part of URL syntax, such as question marks (<strong class="userinput"><code>?</code></strong>) and ampersands
27
+ (<strong class="userinput"><code>&amp;</code></strong>), must be replaced with the corresponding URL character
28
+ codes. </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> XML data in REST requests should only be URL encoded, <span class="emphasis"><em>not</em></span> XML escaped.
29
+ </p></td></tr></table></div><p> In service responses, this data will be XML escaped. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="d0e16975">Namespaces for XML Parameter Values</h2></div></div></div><p> XML data in parameter values must have a namespace specified for all elements. The easiest way
30
+ to do this is to include an <code class="code">xmlns</code> attribute in the root element equal to the
31
+ appropriate namespace. </p><p> The namespace for a <em class="parameter"><code>QuestionForm</code></em>,
32
+ <em class="parameter"><code>QuestionFormAnswers</code></em>, or <em class="parameter"><code>AnswerKey</code></em> element is
33
+ identical to the URL of the corresponding schema document, including the version date. While XML
34
+ namespaces need not be URLs according to the XML specification, this convention ensures that the
35
+ consumer of the value knows which version of the schema is being used for the data. </p><p> For the locations of the schema documents, as well as instructions on how to include the
36
+ version date in the URL, see <a class="link" href="ApiReference_WsdlLocationArticle.html" title="Chapter&nbsp;3.&nbsp;WSDL and Schema Locations">WSDL and Schema
37
+ Locations</a>. </p></div></div><div class="navfooter"><table width="100%" summary="Navigation footer" cellspacing="0" cellpadding="2"><tr><td width="30%" align="left"><a accesskey="p" href="ApiReference_QuestionAnswerDataArticle.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_XMLParameterValuesArticle">Documentation Feedback</a><br><a href="copyrightinfo.html">Copyright Information</a></td><td width="30%" align="right"> <a accesskey="n" href="ApiReference_QuestionFormDataStructureArticle.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>