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

getAllItems

Synopsis

BasketItem[] getAllItems(SessionId sessionId,
    BItemId itemIds,
    GetAllItemsOptions options)
throws BasketServiceFault;

See also: BasketItem, SessionId, BItemId, ItemSelectionOptions, GetAllItemsOptions, BasketServiceFault

The getAllItems operation returns basic information about all items of the basket item tree maintained by the basket service for the session identified by the sessionId parameter and the items specified in the itemIds parameter. Return value is a list of BasketItem structures in the same order as produced by a pre-order traversal of the basket item hierarchy, starting with the (invisible) top folder. See section BasketItem for more information.

The final order of selected items is determined by a pre-order traversal of the basket item hierarchy.

The option viewId of ItemSelectionOptions is supported by this operation. If it contains the ID of a view then the behavior of the operation is changed as follows:

  • Item IDs passed with parameter itemIds are interpreted as IDs of items within this view.

  • The options parentItems and subItems, if set, affect the selection of additional view items.

Instances of BasketItem returned for view items do not contain fields mainArticleId, subArticleIds, setArticleId, setArticlePartIds and geometryId. Instances of BasketItem returned for referenced basket items (field basketItems) contain or may contain (depending on options setArticleIds and geometryIds) these fields.

A BasketServiceFault is returned if any of the following conditions occurs:

  • The sessionId parameter is not a valid string representation of an UUID or does not represent an open session.

  • If the options parameter is present and duplicate item Ids occur.