Soap Request Format

Your soap toolkit is responsible for formatting and sending requests based on the provided WSDL. This section shows what SOAP requests look like "on the wire".

Sample Non-batch Request

This is a sample non-batch SOAP request. Notice that the parameters Signature, Timestamp, and AWSAccessKeyId are identical to those in Query requests. The Action parameter however is specified in the element name in the form of <[Action]>.

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<SOAP-ENV:Body>
		<m:TopSites xmlns:m="http://webservices.amazon.com/AlexaTopSites/2005-11-21">
			<m:Request>
				<m:Security>
					<m:AWSAccessKeyId>1234567890ABCDEFGHIJ</m:AWSAccessKeyId>
					<m:Signature>aGxMveHcJuDF3WoJaM5NGJydtiU=</m:Signature>
					<m:Timestamp>2006-09-07T23:43:31.000Z</m:Timestamp>
				</m:Security>
				<m:CountryCode>CN</m:CountryCode>
				<m:Count>2</m:Count>
				<m:ResponseGroup>Country</m:ResponseGroup>
			</m:Request>
		</m:TopSites>
	</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
           

Sample Batch Request

This is a sample batch SOAP request with three service calls. Also, note that the Signature, Timestamp, and AWSAccessKeyId parameters need only be in the first <Request element.

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<SOAP-ENV:Body>
		<m:TopSites xmlns:m="http://webservices.amazon.com/AlexaTopSites/2005-11-21">
			<m:Request>
				<m:Security>
					<m:AWSAccessKeyId>1234567890ABCDEFGHIJ</m:AWSAccessKeyId>
					<m:Signature>aGxMveHcJuDF3WoJaM5NGJydtiU=</m:Signature>
					<m:Timestamp>2006-09-07T23:43:31.000Z</m:Timestamp>
				</m:Security>
				<m:CountryCode>CN</m:CountryCode>
				<m:Count>1</m:Count>
				<m:ResponseGroup>Country</m:ResponseGroup>
			</m:Request>
			<m:Request>
				<m:CityCode>500</m:CityCode>
				<m:Count>1</m:Count>
				<m:ResponseGroup>City</m:ResponseGroup>
			</m:Request>
		</m:TopSites>
	</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
            

Parameter Details

The parameters in the example are described in the following table:

Parameter	Required	Description
AWSAccessKeyId	yes	This is your Amazon Web Services Access Key ID. This parameter is used to identify the sender of the request. Note: To obtain an AWS Access Key ID, you must sign up for an Amazon Web Services Account. To sign up, please use the sign in page.
Signature	yes	This parameter holds the computed signature for this request. Request signatures are used to authenticate requests, and assure that the request contents were not altered between the sender and AWS. For more information about request signatures, please see the Request Authentication section.
ResponseGroup	yes	This parameter specifies the response group to allow the user more control over what data is returned. By specifying one or more response groups when making the request, users can retrieve only the information they are interested in.