Skip to content
pCon.configurator onlineDocumentation
Esc
↑↓navigate↵open⌘Jpreview
On this page

getPackageInfo

Synopsis

PackageInfo[] getPackageInfo(
    SessionId sessionId,
    string[] manuIds,
    PackageId[] packageIds,
    GetPackageInfoOptions? options
)
throws CatalogServiceFault;

See also: PackageInfo, SessionId, PackageId (unresolved source reference), GetPackageInfoOptions, CatalogServiceFault

Arguments manuIds and packageIds must be possibly empty sequences of valid OFML manufacturer IDs and package IDs. Invalid IDs cause the operation to terminated with a CatalogServiceFault.

If both sets of IDs are empty the operation returns information about all registered packages. Otherwise it returns information about all packages whose OFML manufacturer ID matches one of the given OFML manufacturer IDs or whose package ID partially matches one of the given package IDs. Two package IDs match partially if the fields present in both package IDs are equal.

The options argument controls what data is returned for selected packages. All fields of GetPackageInfoOptions are optional. If no instance of GetPackageInfoOptions is passed to getPackageInfo the operation behaves as if an empty instance has been passed, i.e. an instance with all fields unspecified.

The following options are supported by operation getPackageInfo:

allData - Controls the default value of all other options except useManufacturerConfig. The default value of allData itself is false.

allLanguages - If true, all available translations are returned. If false, only one translation is returned. The returned translation depends on the current list of effective project languages. The lang field of returned instances of DisplayText is not present, i.e. there is no information which translation has been selected.

useManufacturerConfig - Controls whether or returned manufacturer name, distributor name and copyright may originate from the manufacturer configuration file for the package’s manufacturer. The default value of this option is false.

If useManufacturerConfig is true and allLanguages is false, the operation tries to fetch the name/text from the manufacturer configuration if no non-empty text is found for the package.

If both useManufacturerConfig and allLanguages are true, the language-to-text mapping of the package is augmented with entries from the manufacturer configuration’s language-to-text mapping (package entries take precedence).

All other options control whether corresponding fields (i.e. fields with the same name) are present in returned instances of PackageInfo.

With a few exceptions field names of PackageInfo are based on the names of DSR keys, with underline followed by a lower case letter replaced by the corresponding upper case letter. Exceptions are:

packageId - There is no DSR key package_id. Instead, the package ID is composed of the values of DSR keys manufacturer, program, version, and distribution_region. Consequently, there are no fields in PackageInfo that correspond to these DSR keys.

seriesIds - The corresponding DSR key is program_id.

dependencies - The corresponding DSR key is depend.

priceProfileRegionId - The corresponding DSR key is ppr_region_id.

globalTradeItemNumber - The corresponding DSR key is gtin_id.

Sequence fields are encoded as a single element whose name is equal to the field’s name. The element contains one XML element for each sequence element. The nested XML element’s name is the singular form of the field name, except for sequences of type DisplayText[], which use text.