GetPictureManagerDetails

This call will be deprecated by late 2009.

Requests information about folders or pictures in a Picture Manager account or the account settings.

GetPictureManagerDetails Input

The box below lists all fields that could be included in the call request. 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.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<GetPictureManagerDetailsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
  <!-- Call-specific Input Fields -->
  <FolderID> int </FolderID>
  <PictureManagerDetailLevel> PictureManagerDetailLevelCodeType </PictureManagerDetailLevel>
  <PictureURL> string </PictureURL>
</GetPictureManagerDetailsRequest>

Argument	Type	Occurrence	Meaning

Standard Input Fields [Jump to call-specific fields]

ErrorLanguage	string	Optional	Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong See Tags for the Identification of Languages.
MessageID	string	Optional	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Version	string	Conditional	The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects: - It indicates the version of the code lists and other data that eBay should use to process your request. - It indicates the schema version you are using. You need to use a version that is greater than or equal to the lowest supported version. For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See: HTTP Headers (XML API Only) eBay Schema Versioning Strategy Lowest Supported Version
WarningLevel	WarningLevelCodeType	Optional	Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level.

Call-specific Input Fields
FolderID	int	Optional	The ID of a folder in the user's Picture Manager album for which you want information. If you specify both FolderID and PictureURL, the picture must exist in the folder.
PictureManagerDetailLevel	PictureManagerDetailLevelCodeType	Optional	The type of information you want returned, about pictures and folders, the account subscription, or both. Use this element rather than the generic DetailLevel element defined in AbstractRequestType. You can use the following values: ReturnAll, ReturnSubscription, or ReturnPicture. Applicable values: • CustomCode (in) Reserved for internal or future use • ReturnAll (in) All pictures, folders, and account settings. Default value. • ReturnPicture (in) Return only data about pictures and folders in the authenticated user's account. • ReturnSubscription (in) Only data about the account subscription.
PictureURL	string	Optional	The URL of a picture in the user's Picture Manager album. If you specify both FolderID and PictureURL, the picture must exist in the folder.

GetPictureManagerDetails Output

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.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<GetPictureManagerDetailsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType 
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType 
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
  <!-- Call-specific Output Fields -->
  <PictureManagerDetails> PictureManagerDetailsType 
    <Folder> PictureManagerFolderType 
      <FolderID> int </FolderID>
      <Name> string </Name>
      <Picture> PictureManagerPictureType 
        <Date> dateTime </Date>
        <DisplayFormat> PictureManagerPictureDisplayType 
          <DisplayType> PictureManagerPictureDisplayTypeCodeType </DisplayType>
          <Height> int </Height>
          <Size> int </Size>
          <URL> anyURI </URL>
          <Width> int </Width>
        </DisplayFormat>
        <!-- ... more DisplayFormat nodes here ... -->
        <Name> string </Name>
      </Picture>
      <!-- ... more Picture nodes here ... -->
    </Folder>
    <!-- ... more Folder nodes here ... -->
    <KeepOriginal> boolean </KeepOriginal>
    <StorageUsed> int </StorageUsed>
    <SubscriptionLevel> PictureManagerSubscriptionLevelCodeType </SubscriptionLevel>
    <TotalStorageAvailable> int </TotalStorageAvailable>
    <WatermarkEPS> boolean </WatermarkEPS>
    <WatermarkUserID> boolean </WatermarkUserID>
  </PictureManagerDetails>
</GetPictureManagerDetailsResponse>

Return Value	Type	Occurrence	Meaning

Standard Output Fields [Jump to call-specific fields]

Ack	AckCodeType	Always	A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack. Applicable values: • CustomCode (out) Reserved for internal or future use. • Failure (out) Request processing failed • Success (out) Request processing succeeded • Warning (out) Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.)
Build	string	Always	This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID	string	Conditionally	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors	ErrorType	Conditionally, repeatable: [0..*]	A list of application-level errors (if any) that occurred when eBay processed the request. See Error Handling.
Errors.ErrorClassification	ErrorClassificationCodeType	Conditionally	API errors are divided between two classes: system errors and request errors. Applicable values: • CustomCode (out) Reserved for internal or future use. • RequestError (out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data. • SystemError (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. 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.
Errors.ErrorCode	token	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. See the "Errors by Number" document.
Errors.ErrorParameters	ErrorParameterType	Conditionally, repeatable: [0..*]	This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters [ attribute ParamID ]	string	Conditionally	The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value	string	Conditionally	The value of the variable (e.g., the attribute set ID)
Errors.LongMessage	string	Conditionally	A more detailed description of the condition that raised the error.
Errors.SeverityCode	SeverityCodeType	Conditionally	Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user. Applicable values: • CustomCode (out) Reserved for internal or future use • Error (out) Application-level error • Warning (out) Warning or informational error
Errors.ShortMessage	string	Conditionally	A brief description of the condition that raised the error.
HardExpirationWarning	string	Conditionally	Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp	dateTime	Always	This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version	string	Always	The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.

Call-specific Output Fields
PictureManagerDetails	PictureManagerDetailsType	Always	Contains details of the account settings, folders or pictures in the user's album, or both. PictureManagerDetailLevel: ReturnAll, ReturnPicture, ReturnSubscription. Also returned if PictureManagerDetailLevel is not provided on input.
PictureManagerDetails.Folder	PictureManagerFolderType	Always, repeatable: [1..*]	The folder requested in the album. PictureManagerDetailLevel: ReturnAll, ReturnPicture. Also returned if PictureManagerDetailLevel is not provided on input.
PictureManagerDetails.Folder .FolderID	int	Always	The ID of the folder. PictureManagerDetailLevel: ReturnAll, ReturnPicture. Also returned if PictureManagerDetailLevel is not provided on input.
PictureManagerDetails.Folder .Name	string	Always	The name of the folder. Max length: 55. PictureManagerDetailLevel: ReturnAll, ReturnPicture. Also returned if PictureManagerDetailLevel is not provided on input.
PictureManagerDetails.Folder .Picture	PictureManagerPictureType	Conditionally, repeatable: [0..*]	A picture within the folder, identified by a name, date, URL, and other metadata. PictureManagerDetailLevel: ReturnAll, ReturnPicture. Also returned if PictureManagerDetailLevel is not provided on input.
PictureManagerDetails.Folder .Picture.Date	dateTime	Conditionally	The date the picture was uploaded to the Picture Manager account. PictureManagerDetailLevel: ReturnAll, ReturnPicture. Also returned if PictureManagerDetailLevel is not provided on input.
PictureManagerDetails.Folder .Picture.DisplayFormat	PictureManagerPictureDisplayType	Conditionally, repeatable: [0..*]	The type of picture display in Picture Manager. PictureManagerDetailLevel: ReturnAll, ReturnPicture. Also returned if PictureManagerDetailLevel is not provided on input.
PictureManagerDetails.Folder .Picture.DisplayFormat .DisplayType	PictureManagerPictureDisplayTypeCodeType	Conditionally	The style of picture display, with a maximum size. Applicable values: • BIBO (in/out) A BIBO image. Maximum size 200 pixels. • CustomCode (in/out) Reserved for internal or future use • Large (in/out) A large image. Maximum size 500 pixels. • Original (in/out) The original uploaded image. • Standard (in/out) A standard size image. Maximum size 400 pixels. • Supersize (in/out) A very large image. Maximum size 800 pixels. • Thumbnail (in/out) A small image, thumbnail size. Maximum size 96 pixels. PictureManagerDetailLevel: ReturnAll, ReturnPicture. Also returned if PictureManagerDetailLevel is not provided on input.
PictureManagerDetails.Folder .Picture.DisplayFormat.Height	int	Conditionally	The height of a specific image, or the maximum allowed height, in pixels. Varies for different calls. PictureManagerDetailLevel: ReturnAll, ReturnPicture. Also returned if PictureManagerDetailLevel is not provided on input.
PictureManagerDetails.Folder .Picture.DisplayFormat.Size	int	Conditionally	The total file size of the picture, in bytes. PictureManagerDetailLevel: ReturnAll, ReturnPicture. Also returned if PictureManagerDetailLevel is not provided on input.
PictureManagerDetails.Folder .Picture.DisplayFormat.URL	anyURI	Conditionally	The URL to the image in the Picture Manager album. PictureManagerDetailLevel: ReturnAll, ReturnPicture. Also returned if PictureManagerDetailLevel is not provided on input.
PictureManagerDetails.Folder .Picture.DisplayFormat.Width	int	Conditionally	The width of a specific image, or the maximum allowed width, in pixels. Varies for different calls. PictureManagerDetailLevel: ReturnAll, ReturnPicture. Also returned if PictureManagerDetailLevel is not provided on input.
PictureManagerDetails.Folder .Picture.Name	string	Conditionally	The name of the picture, specified by the user. PictureManagerDetailLevel: ReturnAll, ReturnPicture. Also returned if PictureManagerDetailLevel is not provided on input.
PictureManagerDetails .KeepOriginal	boolean	Always	Whether to keep a copy of the original picture without resizing. Default is false. true = keep originals. PictureManagerDetailLevel: ReturnAll, ReturnPicture. Also returned if PictureManagerDetailLevel is not provided on input.
PictureManagerDetails .StorageUsed	int	Always	The amount of storage already in use. Measured in bytes. Read-only value. PictureManagerDetailLevel: ReturnAll, ReturnSubscription. Also returned if PictureManagerDetailLevel is not provided on input.
PictureManagerDetails .SubscriptionLevel	PictureManagerSubscriptionLevelCodeType	Always	The level of Picture Manager subscription. Each level has a monthly fee and provides a certain amount of storage space. Applicable values: • CustomCode (out) Reserved for internal or future use • Free (out) Free to Stores users. • Level1 (out) 10 MB of storage. • Level2 (out) 50 MB of storage. • Level3 (out) 125 MB of storage. • Level4 (out) 300 MB of storage. PictureManagerDetailLevel: ReturnAll, ReturnSubscription. Also returned if PictureManagerDetailLevel is not provided on input.
PictureManagerDetails .TotalStorageAvailable	int	Always	The amount of storage space remaining in the authenticated user's album. Measured in bytes. Read-only value. PictureManagerDetailLevel: ReturnAll, ReturnSubscription. Also returned if PictureManagerDetailLevel is not provided on input.
PictureManagerDetails .WatermarkEPS	boolean	Always	Whether to show the EPS watermark when photos are displayed. Default is false. true = show. PictureManagerDetailLevel: ReturnAll, ReturnPicture. Also returned if PictureManagerDetailLevel is not provided on input.
PictureManagerDetails .WatermarkUserID	boolean	Always	Whether to show the user ID watermark when photos are displayed. Default is false. true = show. PictureManagerDetailLevel: ReturnAll, ReturnPicture. Also returned if PictureManagerDetailLevel is not provided on input.

GetPictureManagerDetails Detail Controls

Detail Control: DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.

Detail Control: PictureManagerDetailLevel

The PictureManagerDetailLevel input field influences which call-specific fields may be returned. (All standard output fields are returned regardless of PictureManagerDetailLevel.)

The none column indicates the fields that are returned when you do not specify a PictureManagerDetailLevel.

Y	The field is always returned.
(Y)	The field is conditionally returned. See the field description for clarification of conditions.
-	The field is not returned.

Output Field	none	ReturnAll	ReturnPicture	ReturnSubscription
PictureManagerDetails	Y	Y	Y	Y
PictureManagerDetails.Folder	Y	Y	Y	-
PictureManagerDetails.Folder.FolderID	Y	Y	Y	-
PictureManagerDetails.Folder.Name	Y	Y	Y	-
PictureManagerDetails.Folder.Picture	(Y)	(Y)	(Y)	-
PictureManagerDetails.Folder.Picture.Date	(Y)	(Y)	(Y)	-
PictureManagerDetails.Folder.Picture.DisplayFormat	(Y)	(Y)	(Y)	-
PictureManagerDetails.Folder.Picture.DisplayFormat.DisplayType	(Y)	(Y)	(Y)	-
PictureManagerDetails.Folder.Picture.DisplayFormat.Height	(Y)	(Y)	(Y)	-
PictureManagerDetails.Folder.Picture.DisplayFormat.Size	(Y)	(Y)	(Y)	-
PictureManagerDetails.Folder.Picture.DisplayFormat.URL	(Y)	(Y)	(Y)	-
PictureManagerDetails.Folder.Picture.DisplayFormat.Width	(Y)	(Y)	(Y)	-
PictureManagerDetails.Folder.Picture.Name	(Y)	(Y)	(Y)	-
PictureManagerDetails.KeepOriginal	Y	Y	Y	-
PictureManagerDetails.StorageUsed	Y	Y	-	Y
PictureManagerDetails.SubscriptionLevel	Y	Y	-	Y
PictureManagerDetails.TotalStorageAvailable	Y	Y	-	Y
PictureManagerDetails.WatermarkEPS	Y	Y	Y	-
PictureManagerDetails.WatermarkUserID	Y	Y	Y	-

GetPictureManagerDetails Samples

An inline sample will be added in a future release. Please refer to the Samples section of the eBay Web Services Guide chapter for GetPictureManagerDetails.

GetPictureManagerDetails Change History

Version	Description
599 2009-1-07	(doc change) This call will be deprecated by late 2009.
471 2006-7-26	DetailLevel (doc change): The I/O Doc has been updated to remove DetailLevel is an applicable input. Detail levels in GetPictureManagerDetails are controlled with PictureManagerDetailLevel.

This document was generated with a customized version of the apireferencedocs tool.

eBay Trading API Call Reference Version 643

eBay Trading API
Call Reference Version 643