Tradera.com API Documentation - [WebService] RestrictedService

GetRequestResults |WebMethod|

Retrieves final request results for asynchronous requests like: AddShopItem and SetPriceOnShopItems .

Parameters

requestIds, Request ids that are returned from asynchronous requests.

Returns

Array of found RequestResult for every request id that was provided. No request result will be returned for request ids that at the time have no result.

Code Example

This PHP example shows how the this method can be used to check the result of a method (SetPriceOnShopItems in this case).
Too keep it general no tools have been used for class generation.

  1:
  2:
  3:
  4:
  5:
  6:
  7:
  8:
  9:
 10:
 11:
 12:
 13:
 14:
 15:
 16:
 17:
 18:
 19:
 20:
 21:
 22:
 23:
 24:
 25:
 26:
 27:
 28:
 29:
 30:
 31:
 32:
 33:
 34:
 35:
 36:
 37:
 38:
 39:
 40:
 41:
 42:
 43:
 44:
 45:
 46:
 47:
 48:
 49:
 50:
 51:
 52:
 53:
 54:
 55:
 56:
 57:
 58:
 59:
 60:
 61:
 62:
 63:
 64:
 65:
 66:
 67:
 68:
 69:
 70:
 71:
 72:
 73:
 74:
 75:
 76:
 77:
 78:
 79:
 80:
 81:
 82:
 83:
 84:
 85:
 86:
 87:
 88:
 89:
 90:
 91:
 92:
 93:

 // Replace the following variables with your own key management
 // $APPLICATION_KEY
 // $TOKEN
 // $USER_ID
 // $APPLICATION_ID
 try {

 	$appId = $APPLICATION_ID;
 	$userId = $USER_ID;
 	$token = $TOKEN;
 	$appKey = $APPLICATION_KEY;
 	$restrictedServiceUrl = 'https://api.tradera.com/v3/RestrictedService.asmx';

 	$restrictedServiceUrlWithAuth = $restrictedServiceUrl
 					. '?appId=' . $appId
 					. '&appKey=' . $appKey
 					. '&userId=' . $userId
 					. '&token=' . $token;

 	$restrictedClient = new SoapClient(
 		$restrictedServiceUrl . '?WSDL',
 		array('location' => $restrictedServiceUrlWithAuth)
 	);
 	// Manufacture data (itemId => new price)
 	$itemsToUpdate = array(260143133 => 7890, 259588151 => 7890);

 	// Create shop item data

 	$setPriceRequest = new StdClass();
 	$setPriceRequest -> ShopItems = new StdClass();
 	$setPriceRequest -> ShopItems = array();

 	foreach ($itemsToUpdate as $itemId => $price) {
 		$setPriceItem = new StdClass();
 		$setPriceItem -> Id = $itemId;
 		$setPriceItem -> Price = $price;

 		array_push($setPriceRequest -> ShopItems, $setPriceItem);
 	}

 	$setPriceOnShopItemsParams = new StdClass();
 	$setPriceOnShopItemsParams -> request = $setPriceRequest;

 	// Make Soap call
 	$setPriceResult = $restrictedClient->SetPriceOnShopItems($setPriceOnShopItemsParams);

 	// Handle result
 	$queuedRequestResponses = $setPriceResult -> SetPriceOnShopItemsResult -> QueuedRequestResponses -> QueuedRequestResponse;
 	$validationErrors = $setPriceResult -> SetPriceOnShopItemsResult -> ValidationErrors;

 	// Print Errors
 	foreach ($validationErrors as $validationError) {
 		echo 'ERROR:' . PHP_EOL;
 		echo print_r($validationError);
 	}

 ///////////////////////////////////////////////
 	// Verify results
 	// This is where we use GetRequestResults to verify our changes
 	sleep(5);

 	$getReqResultsParams = new StdClass();
 	$getReqResultsParams -> requestIds -> int = array();
 	foreach ($queuedRequestResponses as $queuedRequestResponse) {
 		array_push($getReqResultsParams -> requestIds -> int, $queuedRequestResponse -> RequestId);
 	}

 	$requestResult = $restrictedClient -> GetRequestResults($getReqResultsParams);

 	echo 'FINISHED REQUEST RESULTS:' . PHP_EOL;
 	$unfinishedRequests = array();
 	foreach ($requestResult -> GetRequestResultsResult -> RequestResult as $result) {
 		if($result -> ResultCode == 'Ok'){
 			echo $result -> Message . PHP_EOL;
 		}
 		else {
 			echo 'ResultCode: ';
 			echo print_r($result -> ResultCode);
 			array_push($unfinishedRequests, $result);
 		}
 	}

 	echo PHP_EOL . 'UNFINISHED REQUESTS/ERRORS:' .PHP_EOL;
 	foreach ($unfinishedRequests as $request) {
 		// Do something with the request
 		print_r($request);
 	}

 }
 catch(SoapFault $soapFault) {
 	echo 'Error: ' . $soapFault->faultstring;
 }

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /v3/RestrictedService.asmx HTTP/1.1
Host: api.tradera.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.tradera.com/GetRequestResults"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="http://api.tradera.com">
      <AppId>int</AppId>
      <AppKey>string</AppKey>
    </AuthenticationHeader>
    <AuthorizationHeader xmlns="http://api.tradera.com">
      <UserId>int</UserId>
      <Token>string</Token>
    </AuthorizationHeader>
    <ConfigurationHeader xmlns="http://api.tradera.com">
      <Sandbox>int</Sandbox>
      <MaxResultAge>int</MaxResultAge>
    </ConfigurationHeader>
  </soap:Header>
  <soap:Body>
    <GetRequestResults xmlns="http://api.tradera.com">
      <requestIds>
        <int>int</int>
        <int>int</int>
      </requestIds>
    </GetRequestResults>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetRequestResultsResponse xmlns="http://api.tradera.com">
      <GetRequestResultsResult>
        <RequestResult>
          <RequestId>int</RequestId>
          <ResultCode>Ok or ImageProcessingError or Error or Timeout or TryAgain or UpdateNotAllowed or ReachedMaximumActiveItemsThreshold or WaitingToBeProcessed or Uncommited</ResultCode>
          <Message>string</Message>
        </RequestResult>
        <RequestResult>
          <RequestId>int</RequestId>
          <ResultCode>Ok or ImageProcessingError or Error or Timeout or TryAgain or UpdateNotAllowed or ReachedMaximumActiveItemsThreshold or WaitingToBeProcessed or Uncommited</ResultCode>
          <Message>string</Message>
        </RequestResult>
      </GetRequestResultsResult>
    </GetRequestResultsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /v3/RestrictedService.asmx HTTP/1.1
Host: api.tradera.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <AuthenticationHeader xmlns="http://api.tradera.com">
      <AppId>int</AppId>
      <AppKey>string</AppKey>
    </AuthenticationHeader>
    <AuthorizationHeader xmlns="http://api.tradera.com">
      <UserId>int</UserId>
      <Token>string</Token>
    </AuthorizationHeader>
    <ConfigurationHeader xmlns="http://api.tradera.com">
      <Sandbox>int</Sandbox>
      <MaxResultAge>int</MaxResultAge>
    </ConfigurationHeader>
  </soap12:Header>
  <soap12:Body>
    <GetRequestResults xmlns="http://api.tradera.com">
      <requestIds>
        <int>int</int>
        <int>int</int>
      </requestIds>
    </GetRequestResults>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetRequestResultsResponse xmlns="http://api.tradera.com">
      <GetRequestResultsResult>
        <RequestResult>
          <RequestId>int</RequestId>
          <ResultCode>Ok or ImageProcessingError or Error or Timeout or TryAgain or UpdateNotAllowed or ReachedMaximumActiveItemsThreshold or WaitingToBeProcessed or Uncommited</ResultCode>
          <Message>string</Message>
        </RequestResult>
        <RequestResult>
          <RequestId>int</RequestId>
          <ResultCode>Ok or ImageProcessingError or Error or Timeout or TryAgain or UpdateNotAllowed or ReachedMaximumActiveItemsThreshold or WaitingToBeProcessed or Uncommited</ResultCode>
          <Message>string</Message>
        </RequestResult>
      </GetRequestResultsResult>
    </GetRequestResultsResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /v3/RestrictedService.asmx/GetRequestResults?requestIds=string&requestIds=string HTTP/1.1
Host: api.tradera.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfRequestResult xmlns="http://api.tradera.com">
  <RequestResult>
    <RequestId>int</RequestId>
    <ResultCode>Ok or ImageProcessingError or Error or Timeout or TryAgain or UpdateNotAllowed or ReachedMaximumActiveItemsThreshold or WaitingToBeProcessed or Uncommited</ResultCode>
    <Message>string</Message>
  </RequestResult>
  <RequestResult>
    <RequestId>int</RequestId>
    <ResultCode>Ok or ImageProcessingError or Error or Timeout or TryAgain or UpdateNotAllowed or ReachedMaximumActiveItemsThreshold or WaitingToBeProcessed or Uncommited</ResultCode>
    <Message>string</Message>
  </RequestResult>
</ArrayOfRequestResult>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /v3/RestrictedService.asmx/GetRequestResults HTTP/1.1
Host: api.tradera.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

requestIds=string&requestIds=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfRequestResult xmlns="http://api.tradera.com">
  <RequestResult>
    <RequestId>int</RequestId>
    <ResultCode>Ok or ImageProcessingError or Error or Timeout or TryAgain or UpdateNotAllowed or ReachedMaximumActiveItemsThreshold or WaitingToBeProcessed or Uncommited</ResultCode>
    <Message>string</Message>
  </RequestResult>
  <RequestResult>
    <RequestId>int</RequestId>
    <ResultCode>Ok or ImageProcessingError or Error or Timeout or TryAgain or UpdateNotAllowed or ReachedMaximumActiveItemsThreshold or WaitingToBeProcessed or Uncommited</ResultCode>
    <Message>string</Message>
  </RequestResult>
</ArrayOfRequestResult>