Returns the version of the current BestMatchItemDetails Service.
You can also use this call as a ping to ensure you have a connection to the server.
Back to top
|Output Detail Controls Samples Change History User Notes|
getVersion has no input fields.
Back to top
|Input Detail Controls Samples Change History User Notes|
The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).
See also Samples.
<?xml version="1.0" encoding="utf-8"?> <getVersionResponse xmlns="http://www.ebay.com/marketplace/search/v1/services"> <!-- (No call-specific Output fields) --> <!-- Standard Output Fields --> <ack> AckValue </ack> <errorMessage> ErrorMessage <error> ErrorData <category> ErrorCategory </category> <domain> string </domain> <errorId> long </errorId> <exceptionId> token </exceptionId> <message> string </message> <parameter name="string"> ErrorParameter (string) </parameter> <!-- ... more parameter values allowed here ... --> <severity> ErrorSeverity </severity> <subdomain> string </subdomain> </error> <!-- ... more error nodes allowed here ... --> </errorMessage> <timestamp> dateTime </timestamp> <version> string </version> </getVersionResponse>
|(No call-specific fields)|
|Standard Output Fields|
Indicates whether or not the request was successful, or if errors or warnings were generated during the processing of the request.
eBay encountered a fatal error during the processing of the request, causing the request to fail. When a serious application-level error occurs, the error is returned instead of the business data.
eBay successfully processed the request, but one or more non-fatal errors occurred during the processing. For best results, requests should return without warning messages. Inspect the message details and resolve any problems before resubmitting the request.
eBay successfully processed the request and the business data is returned in the response. Note that it is possible for a response to return Success, but still not contain the expected data in the result.
The request was successfully processed, but eBay encountered a non-fatal error during the processing. For best results, requests should return without warnings. Inspect the warning details and resolve the problem before resubmitting the request.
|errorMessage||ErrorMessage||Conditionally||Description of an error or warning that occurred when eBay processed the request. Not returned if the ack value is Success.|
|Details about a single error.|
There are three categories of errors: Request errors, Application errors, and System errors.
An error occurred due to a problem with the request, with the most likely source being the application sending the request. For example, the request is missing a required data element or it contains an invalid field. The problem must be corrected before the request can be resent. Inspect the error message to find the cause of the problem. If the problem is due to an application error, modify the application and resend the request. If the error is due to invalid data, the source of the data must be corrected before you resend the resend request to eBay.
An error occurred due to a problem with the request, with the most likely source being missing or invalid data in the request. The problem must be corrected before the request can be retried. Inspect the error message to find the cause of the problem. If the problem is a result of end-user data, alert the end-user to the problem and provide the means for them to correct the problem. Once the problem is resolved, resend the request to eBay.
Indicates that an error has occurred on the eBay system side. For example, a database or server could be down. Inspect the error message to find the cause of the problem. If the problem is on the eBay side, an application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
Name of the domain in which the error occurred.
|errorMessage.error.errorId||long||Conditionally||A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.|
|errorMessage.error.exceptionId||token||Conditionally||Unique identifier for an exception associated with an error.|
|errorMessage.error.message||string||Conditionally||A detailed description of the condition that caused in the error.|
|Various warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error.|
[ attribute name ]
|string||Conditionally||The name of the input parameter returned with the error. Inspecting the parameter (or its input value) will often aid in understanding the cause of the error. Not all error messages contain this value.|
Indicates whether the reported problem is fatal (an error) or is less severe (a warning). Review the error message details for information on the cause.
If the request fails and the application is the source of the error (for example, a required element is missing), update the application before you retry the request. If the problem is due to incorrect user data, alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, re-send the request to eBay.
If the source of the problem is on eBay's side, you can retry the request a reasonable number of times (eBay recommends you try the request twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, you can resend the request in its original form.
If a warning occurs, warning information is returned in addition to the business data. Normally, you do not need to resend the request (as the original request was successful). However, depending on the cause of the warning, you might need to contact the end user, or eBay, to effect a long term solution to the problem.
eBay encountered a fatal error during the processing of the request, causing the request to fail. When eBay encounters an error, it returns error data instead of the requested business data. Inspect the error details and resolve the problem before resubmitting the request.
The request was successfully processed, but eBay encountered a non-fatal error during the processing that could affect the data returned. For example, eBay might have changed the value of an input field. In this case, eBay returns a successful response, but it also returns a warning. For best results, requests should return without warnings. Inspect the warning details and resolve the problem before resubmitting the request.
Name of the subdomain in which the error occurred.
|timestamp||dateTime||Always||This value represents the date and time when eBay processed the request. This value is returned in GMT, the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the time format, and for details on converting to and from the GMT time zone.|
The release version that eBay used to process the request. Developer Technical Support may ask you for the version value if you work with them to troubleshoot issues.
Note: The version in use is normally the latest release version, as specified in the release notes. Note that eBay releases the API to international sites about a week after the API version is released to the US site.
Back to top
|Input Output Samples Change History User Notes|
This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.
Back to top
|Input Output Detail Controls Change History User Notes|
New to making API calls? Please see Making an API Call.
Note: Some data in these samples might no longer be active. If necessary, you can substitute current data in your requests.
Retrieves the version of the service.
There are no inputs to this call; specify the call name and authentication token in the HTTP headers. You can use this call to test your headers and to ensure the service is up and running.
XML format (HTTP POST). Also available is the .txt version of this XML. <?xml version="1.0" encoding="utf-8"?> <getVersionRequest xmlns="http://www.ebay.com/marketplace/search/v1/services"> </getVersionRequest>
XML format. Also available is the .txt version of this XML. <getVersionResponse xmlns:ms="http://www.ebay.com/marketplace/services" xmlns="http://www.ebay.com/marketplace/search/v1/services"> <ack>Success</ack> <version>1.1.0</version> <timestamp>2009-10-22T21:21:39.632Z</timestamp> </getVersionResponse>
Back to top
|Input Output Detail Controls Samples User Notes|
Back to top
|Input Output Detail Controls Samples Change History User Notes|
Copyright © 2009–2012 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developer Network and API License Agreement.