updateQualificationType method

Future<UpdateQualificationTypeResponse> updateQualificationType({ required String qualificationTypeId, String? answerKey, bool? autoGranted, int? autoGrantedValue, String? description, QualificationTypeStatus? qualificationTypeStatus, int? retryDelayInSeconds, String? test, int? testDurationInSeconds, })

The UpdateQualificationType operation modifies the attributes of an existing Qualification type, which is represented by a QualificationType data structure. Only the owner of a Qualification type can modify its attributes.

Most attributes of a Qualification type can be changed after the type has been created. However, the Name and Keywords fields cannot be modified. The RetryDelayInSeconds parameter can be modified or added to change the delay or to enable retries, but RetryDelayInSeconds cannot be used to disable retries.

You can use this operation to update the test for a Qualification type. The test is updated based on the values specified for the Test, TestDurationInSeconds and AnswerKey parameters. All three parameters specify the updated test. If you are updating the test for a type, you must specify the Test and TestDurationInSeconds parameters. The AnswerKey parameter is optional; omitting it specifies that the updated test does not have an answer key.

If you omit the Test parameter, the test for the Qualification type is unchanged. There is no way to remove a test from a Qualification type that has one. If the type already has a test, you cannot update it to be AutoGranted. If the Qualification type does not have a test and one is provided by an update, the type will henceforth have a test.

If you want to update the test duration or answer key for an existing test without changing the questions, you must specify a Test parameter with the original questions, along with the updated values.

If you provide an updated Test but no AnswerKey, the new test will not have an answer key. Requests for such Qualifications must be granted manually.

You can also update the AutoGranted and AutoGrantedValue attributes of the Qualification type.

May throw ServiceFault. May throw RequestError.

Parameter qualificationTypeId : The ID of the Qualification type to update.

Parameter answerKey : The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure.

Parameter autoGranted : Specifies whether requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test.

Constraints: If the Test parameter is specified, this parameter cannot be true.

Parameter autoGrantedValue : The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true.

Parameter description : The new description of the Qualification type.

Parameter qualificationTypeStatus : The new status of the Qualification type - Active | Inactive

Parameter retryDelayInSeconds : The amount of time, in seconds, that Workers must wait after requesting a Qualification of the specified Qualification type before they can retry the Qualification request. It is not possible to disable retries for a Qualification type after it has been created with retries enabled. If you want to disable retries, you must dispose of the existing retry-enabled Qualification type using DisposeQualificationType and then create a new Qualification type with retries disabled using CreateQualificationType.

Parameter test : The questions for the Qualification test a Worker must answer correctly to obtain a Qualification of this type. If this parameter is specified, TestDurationInSeconds must also be specified.

Constraints: Must not be longer than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot be specified if AutoGranted is true.

Constraints: None. If not specified, the Worker may request the Qualification without answering any questions.

Parameter testDurationInSeconds : The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification.

Implementation

Future<UpdateQualificationTypeResponse> updateQualificationType({
  required String qualificationTypeId,
  String? answerKey,
  bool? autoGranted,
  int? autoGrantedValue,
  String? description,
  QualificationTypeStatus? qualificationTypeStatus,
  int? retryDelayInSeconds,
  String? test,
  int? testDurationInSeconds,
}) async {
  ArgumentError.checkNotNull(qualificationTypeId, 'qualificationTypeId');
  _s.validateStringLength(
    'qualificationTypeId',
    qualificationTypeId,
    1,
    64,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'MTurkRequesterServiceV20170117.UpdateQualificationType'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'QualificationTypeId': qualificationTypeId,
      if (answerKey != null) 'AnswerKey': answerKey,
      if (autoGranted != null) 'AutoGranted': autoGranted,
      if (autoGrantedValue != null) 'AutoGrantedValue': autoGrantedValue,
      if (description != null) 'Description': description,
      if (qualificationTypeStatus != null)
        'QualificationTypeStatus': qualificationTypeStatus.toValue(),
      if (retryDelayInSeconds != null)
        'RetryDelayInSeconds': retryDelayInSeconds,
      if (test != null) 'Test': test,
      if (testDurationInSeconds != null)
        'TestDurationInSeconds': testDurationInSeconds,
    },
  );

  return UpdateQualificationTypeResponse.fromJson(jsonResponse.body);
}