SearchQualificationTypes

Description

The SearchQualificationTypes operation searches for Qualification types using the specified search query, and returns a list of Qualification types.

The operation sorts the results, divides them into numbered pages, and returns a single page of results. You can control sorting and pagination with parameters to the operation.

Request Parameters

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

The following parameters are specific to the SearchQualificationTypes operation:

Name	Description	Required
Operation	The name of the operation Type: String Valid Values: SearchQualificationTypes Default: None	Yes
Query	A text query against all of the searchable attributes of Qualification types. Type: String Default: None. If not specified, the complete set of all Qualification types is considered for the results.	No
SortProperty	The field on which to sort the results returned by the operation. Type: String Valid Values: Name Default: Name	No
SortDirection	The direction of the sort used with the field specified by SortProperty. Type: String Valid Values: Ascending | Descending Default: Descending	No
PageSize	The number of Qualification types to include in a page of results. The operation divides the complete sorted result set into pages of this many Qualification types. Type: positive integer Valid Values: any integer between 1 and 100. Default: 10	No
PageNumber	The page of results to return. After the operation filters, sorts, and divides the Qualification types into pages of size PageSize, it returns page corresponding to PageNumber as the results of the operation. Type: positive integer Default: 1	No
MustBeRequestable	Specifies that only Qualification types that a user can request through the Amazon Mechanical Turk web site, such as by taking a Qualification test, are returned as results of the search. Some Qualification types, such as those assigned automatically by the system, cannot be requested directly by users. If false, all Qualification types, including those managed by the system, are considered for the search. Type: Boolean Valid Values: true | false Default: None	Yes
MustBeOwnedByCaller	Specifies that only Qualification types that the Requester created are returned. If false, the operation returns all Qualification types.	No

Response Elements

A successful request for the SearchQualificationTypes operation has a SearchQualificationTypesResult element in the response.

The SearchQualificationTypesResult element contains the elements described in the following table:

Name	Description
NumResults	The number of Qualification types on this page in the filtered results list, equivalent to the number of types this operation returns. Type: non-negative integer
PageNumber	The number of this page in the filtered results list. Type: positive integer
TotalNumResults	The total number of Qualification types in the filtered results list based on this call. Type: non-negative integer
QualificationType	The Qualification type. The response includes one QualificationType element for each Qualification type the query returns. Type: a QualificationType data structure.

Examples

The following example shows how to use the SearchQualificationTypes operation.

Sample Request

The following example performs a simple text query for Qualification types.

https://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
&AWSAccessKeyId=[the Requester's Access Key ID]
&Version=2017-01-17
&Operation=SearchQualificationTypes
&Signature=[signature for this request]
&Timestamp=[your system's local time]
&Query=English
          

Sample Response

The following is an example response.

<SearchQualificationTypesResult>
  <Request>
    <IsValid>True</IsValid>
  </Request>
  <NumResults>10</NumResults>
  <TotalNumResults>5813</TotalNumResults>
  <QualificationType>
    <QualificationTypeId>WKAZMYZDCYCZP412TZEZ</QualificationTypeId>
    <CreationTime>2009-05-17T10:05:15Z</CreationTime>
    <Name> WebReviews Qualification Master Test</Name>
    <Description>
    This qualification will allow you to earn more on the WebReviews HITs.
    </Description>
    <Keywords>WebReviews, webreviews, web reviews</Keywords>
    <QualificationTypeStatus>Active</QualificationTypeStatus>
      <Test>
        <QuestionForm xmlns="http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2005-10-01/QuestionForm.xsd">
          <Overview>
          <Title>WebReviews Survey</Title>
          <Text>
          After you have filled out this survey you will be assigned one or more qualifications...
          </Text>
        </Overview>
        <Question>
          <QuestionIdentifier>age</QuestionIdentifier>
          <DisplayName>What is your age?</DisplayName>
          <IsRequired>true</IsRequired>
          <QuestionContent>
            <Text>
            Please choose the age group you belong to.
            </Text>
          </QuestionContent>
          <AnswerSpecification>
    		<SelectionAnswer>
    		  <StyleSuggestion>radiobutton</StyleSuggestion>
    		  <Selections>
    		    <Selection>
    		      <SelectionIdentifier>0018</SelectionIdentifier>
    		      <Text>-18</Text>
    		    </Selection>
  		    <Selection>
  		      <SelectionIdentifier>5160</SelectionIdentifier>
  		      <Text>51-60</Text>
  		    </Selection>
  		    <Selection>
  		      <SelectionIdentifier>6000</SelectionIdentifier>
  		      <Text>60+</Text>
  		    </Selection>
  		  </Selections>  
  	    </SelectionAnswer>
         </AnswerSpecification>
      </Question> 
    </QuestionForm>
    </Test>
    <TestDurationInSeconds>1200</TestDurationInSeconds>
  </QualificationType>
</SearchQualificationTypesResult>