GetArticleDataOptions
Synopsis
struct GetArticleDataOptions (
boolean? noProperties,
boolean? fetchCatalogImage,
boolean? fetchCatalogIcon,
string? viewId,
boolean? separateCurrencies,
boolean? highResPropValueIcons,
boolean? fetchPropValueImages,
boolean? enableBooleanPropType
)
All options are optional. If an option is omitted, its default behavior applies.
noProperties
The noProperties option, if set to true, tells the operation not to fetch the articles properties. This may be useful as fetching the properties may be slow, and they should not be necessary to display the list of articles contained in the basket. Furthermore, if an article has been loaded from a project file (loadSession), the operation may not be able to fetch the properties if the correct version of the article’s product data is not available and will fail if the noProperties option is not set to true.
fetchCatalogImage
With the option fetchCatalogImage set to true, the operation getArticleData returns an URL for the article’s catalog image, or an empty string if no catalog image has been found. The default value of this options is true.
viewId
If this field is present its value must be empty, be the NIL UUID, or the ID of a current basket view.
If the field contains the ID of a current basket view then itemId parameter must contain the ID of an item of that basket view and this item must reference a basket item. The operation will then behave as if invoked for that basket item.
If the field is missing or contains an empty string or the NIL UUID then the operation will behave as before.
highResPropValueIcons
Controls whether fields smallIcon and largeIcon of type PropertyValue return URLs for the traditional low resolution material icons (if false) or may return URLs for high resolution material icons (if true).
If set to false (the default value), the behavior of EAIWS with regards do fields smallIcon and largeIcon does not change.
If set to true, and directories …/mat/ and …/mat/m exist, smallIcon, if non-empty, references a file in …/mat/s, and largeIcon, if non-empty, references a file in …/mat/m.
If set to true and at least one of …/mat/s and …/mat/m does not exist, both smallIcon and largeIcon, if non-empty, reference a file in …/mat.
fetchPropValueImages
Controls whether the new field image of type PropertyValue is absent (if false, the default value) or may reference a material image in directory …/mat/l (if true).
Field image is absent if option fetchPropValueImages is set to true but no corresponding image file is found. This differs from fields smallIcon and largeIcon, which are always present, but contain an empty string if the corresponding icon is not found.
enableBooleanPropType
The optional boolean field enableBooleanPropType enables boolean properties. Its default value is false, resulting in no change of behavior. Previously, boolean properties have been treated as properties of type Numeric with values one and zero for true and false when returned by operations getArticleData, getChoiceList and getAllChoiceLists, or zero and non-zero for false and true when set with operation setPropertyValue.
If enableBooleanPropType is set to true, the behavior for boolean properties changes as follows:
-
Operation
getArticleDatareturnsBooleaninstead ofNumberin fieldtypeof typeProperty. -
Operation
getArticleDatareturnstrueandfalseinstead of 1. and 0. in fieldvalueof typePropertyValue.
If option enableBooleanPropType is effectively false, operation getArticleData returns the value of boolean properties as 1 and 0 instead of 1. and 0. in field value of type PropertyValue.