insertUserArticle
Synopsis
void insertUserArticle(SessionId sessionId,
BItemId fatherId,
BItemId beforeId,
DisplayText shortText)
throws BasketServiceFault;
See also: SessionId, BItemId, DisplayText, BasketServiceFault
The insertUserArticle operation inserts a new user article item (also known as manual article) into the basket item tree maintained by the basket service for the session identified by the sessionId parameter.
The fatherId parameter, if not the null-UUID, must identify the basket item that will become the parent of the new OFML article item. If fatherId is the null-UUID (§UUID), the root item of the basket item tree will be used as the parent item.
The beforeId parameter, if not the null-UUID, must identify an existing basket item. If this item is a descendant of the basket item that has been selected as the parent of the newly inserted item, then the new item will be inserted in front of the parent’s child which is either equal to the item identified by beforeId, or an ancestor of this item. Otherwise (if beforeId is a null-UUID, or if the basket item identified by beforeId is not a descendant of the parent item) the new item will be inserted as the last child of the parent item.
The parameter shortText should contain the short description of the article.
The inserted basket item is of type UserArticle (§BasketItemType). Additional properties of the newly inserted user article item may be set using the setItemProperties operation (§setItemProperties).
A BasketServiceFault is returned if any of the following conditions occurs:
-
The
sessionIdparameter is not a valid string representation of an UUID or does not represent an open session. -
Either the
fatherIdorbeforeIdparameter does not represent an UUID. -
Either the
fatherIdorbeforeIdparameter does not identify a basket item and is not the null-UUID. -
The basket item identified by the
fatherIdparameter does not permit child items. -
There was some error during the actual process of inserting the user article item.