QualificationType

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-mechanical-turk/refs/heads/main/json-schema/amazon-mechanical-turk-qualification-type-schema.json",
  "title": "QualificationType",
  "description": " The QualificationType data structure represents a Qualification type, a description of a property of a Worker that must match the requirements of a HIT for the Worker to be able to accept the HIT. The type also describes how a Worker can obtain a Qualification of that type, such as through a Qualification test. ",
  "type": "object",
  "properties": {
    "QualificationTypeId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EntityId"
        },
        {
          "description": " A unique identifier for the Qualification type. A Qualification type is given a Qualification type ID when you call the CreateQualificationType operation. "
        }
      ]
    },
    "CreationTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": " The date and time the Qualification type was created. "
        }
      ]
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": " The name of the Qualification type. The type name is used to identify the type, and to find the type using a Qualification type search. "
        }
      ]
    },
    "Description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": " A long description for the Qualification type. "
        }
      ]
    },
    "Keywords": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": " One or more words or phrases that describe theQualification type, separated by commas. The Keywords make the type easier to find using a search. "
        }
      ]
    },
    "QualificationTypeStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/QualificationTypeStatus"
        },
        {
          "description": " The status of the Qualification type. A Qualification type's status determines if users can apply to receive a Qualification of this type, and if HITs can be created with requirements based on this type. Valid values are Active | Inactive. "
        }
      ]
    },
    "Test": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": " The questions for a Qualification test associated with this Qualification type that a user can take to obtain a Qualification of this type. This parameter must be specified if AnswerKey is present. A Qualification type cannot have both a specified Test parameter and an AutoGranted value of true. "
        }
      ]
    },
    "TestDurationInSeconds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Long"
        },
        {
          "description": " The amount of time, in seconds, given to a Worker to complete the Qualification test, beginning from the time the Worker requests the Qualification. "
        }
      ]
    },
    "AnswerKey": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The answers to the Qualification test specified in the Test parameter."
        }
      ]
    },
    "RetryDelayInSeconds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Long"
        },
        {
          "description": " The amount of time, in seconds, Workers must wait after taking the Qualification test before they can take it again. Workers can take a Qualification test multiple times if they were not granted the Qualification from a previous attempt, or if the test offers a gradient score and they want a better score. If not specified, retries are disabled and Workers can request a Qualification only once. "
        }
      ]
    },
    "IsRequestable": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": " Specifies whether the Qualification type is one that a user can request through the Amazon Mechanical Turk web site, such as by taking a Qualification test. This value is False for Qualifications assigned automatically by the system. Valid values are True | False. "
        }
      ]
    },
    "AutoGranted": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "Specifies that requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test. Valid values are True | False."
        }
      ]
    },
    "AutoGrantedValue": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Integer"
        },
        {
          "description": " The Qualification integer value to use for automatically granted Qualifications, if AutoGranted is true. This is 1 by default. "
        }
      ]
    }
  }
}