GetQualificationsForQualificationType

Description

The GetQualificationsForQualificationType operation returns all of the Qualifications granted to Workers for a given Qualification type.

This operations divides the results into numbered pages and returns a single page of results. You can control pagination with parameters to the operation.

Request Parameters

The GetQualificationsForQualificationType operation accepts parameters common to all operations. Some common parameters are required. See Common Parameters for more information.

The following parameters are specific to the GetQualificationsForQualificationType operation:

Name	Description	Required
`Operation`	The name of the operation. Type: String Valid Values: GetQualificationForQualificationType Default: None	Yes
`QualificationTypeId`	The ID of the Qualification type of the Qualifications to return. Type: String Default: None	Yes
`Status`	The status of the Qualifications to return. Type: String Valid Values: Granted \| Revoked Default: Granted	No
`PageSize`	The number of Qualifications to include in a page of results. The operation divides the complete result set into pages of this many Qualifications. Type: positive integer Valid Values: any number between 1 and 100 Default: 10	No
`PageNumber`	The page of results to return. Once the operation divides the Qualifications into pages of size `PageSize`, it returns the page corresponding to `PageNumber`. Type: positive integer Default: 1	No

Response Elements

A successful request for the GetQualificationsForQualificationType operation returns a GetQualificationsForQualificationTypeResult element in the response.

The GetQualificationsForQualificationTypeResult element contains the following elements:

Name	Description
`PageNumber`	The page of results to return. Once the operation divides the Qualifications into pages of size `PageSize`, the operation returns the page corresponding to `PageNumber`. Type: positive integer
`NumResults`	The number of Qualifications on this page in the filtered results list, equivalent to the number of Qualifications being returned by this call. Type: non-negative integer
`TotalNumResults`	The total number of Qualifications in the filtered results list based on this call. Type: non-negative integer
`Qualification`	The Qualification. The response includes one `Qualification` element for each Qualification returned by the query. Type: a Qualification data structure.

Examples

The following example shows how to use the GetQualificationsForQualificationType operation.

Sample Request

The following example returns the Qualifications assigned to Workers for the given Qualification type.

http://mechanicalturk.amazonaws.com/onca/xml?
Service=AWSMechanicalTurkRequester
&Operation=GetQualificationsForQualificationType
&Version=2008-08-02
&AWSAccessKeyId=[the Requester's Access Key ID]
&Signature=[signature for this request]
&Timestamp=2009-07-15T01:21:28.186Z
&QualificationTypeId=ZSPJXD4F1SFZP7YNJWR0

Sample Response

The following is an example response.

<GetQualificationsForQualificationTypeResult>
  <Request>
    <IsValid>True</IsValid>
  </Request>
  <NumResults>1</NumResults>
  <TotalNumResults>1</TotalNumResults>
  <PageNumber>1</PageNumber>
    <QualificationRequest>
    <QualificationRequestId>789RVWYBAZW00EXAMPLE951RVWYBAZW00EXAMPLE
    </QualificationRequestId>
    <QualificationTypeId>ZSPJXD4F1SFZP7YNJWR0</QualificationTypeId>
      <SubjectId>AZ3456EXAMPLE</SubjectId>
      <Test>
        &lt;QuestionForm&gt;
        [XML-encoded question data]
        &lt;/QuestionForm&gt;
      </Test>
      <Answer>
        &lt;QuestionFormAnswers&gt;
        [XML-encoded answer data]
        &lt;/QuestionFormAnswers&gt;
      </Answer>
      <SubmitTime>2009-07-15T01:21:28.296Z</SubmitTime>
    </QualificationRequest>
</GetQualificationsForQualificationTypeResult>