Help

Prev		Next

Description

The Help operation returns information about the Mechanical Turk Service operations and response groups. You can use it to facilitate development and documentation of your web site and tools. It is similar to the Help operation found in other AWS web services.

Sample Request: Using Help (REST)

The following example of a Help operation returns information about the GetReviewableHITs operation.

http://mechanicalturk.amazonaws.com/onca/xml?Service=AWSMechanicalTurkRequester
&AWSAccessKeyId=[the Requester's Access Key ID]
&Version=2006-10-31
&Operation=Help
&HelpType=Operation
&About=GetReviewableHITs

Request Parameters

A request to the Mechanical Turk Service includes parameters that control its behavior and the data it returns. Required parameters must be included for the request to succeed.

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

The following parameters are specific to the Help operation:

Name	Description	Type	Value
`Operation`	Use the `Operation` parameter to specify the name of the operation you would like to call. To access the `Help` operation, set the `Operation` parameter to `Help`.	Required	`Help`
`HelpType`	The kind of help, either `Operation` for help with an operation, or `ResponseGroup` for help with a response group.	Required	`Operation` \| `ResponseGroup`
`About`	The name of the operation or response group for which to return help. See Common Parameters for more information about response groups.	Required	A valid Mechanical Turk Service operation name or response group name

Responses

A successful request for the Help operation will have an Information element in the response. Information will contain either an OperationInformation element or a ResponseGroupInformation element, depending on the HelpType requested.

An OperationInformation element contains a Name element with the name of the operation, a Description element with a description of the operation, RequiredParameters and AvailableParameters elements with Parameter elements that list the required and optional parameters to the operation, and DefaultResponseGroups and AvailableResponseGroups elements with ResponseGroup elements that list the default and available response groups for the operation.

A ResponseGroupInformation element contains a Name element with the name of the response group, a ValidOperations element with Operation elements that list the operations that return data for the group, and an Elements element with Element elements that list the elements provided by the group. An element is specified as a slash-delimited element path to the element in a response.