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

getChoiceList

Synopsis

PropertyValue[] getChoiceList(SessionId sessionId,
    BItemId itemId,
    string propClass,
    string propName,
    GetChoiceListOptions options
)
throws BasketServiceFault;

See also: PropertyValue, SessionId, BItemId, GetChoiceListOptions, BasketServiceFault

The getChoiceList operation returns the list of allowed property values1 for a single property.

The itemId parameter must identify an article item that is part of the basket item tree maintained by the basket service for the session identified by the sessionId parameter.

The propClass and propName parameters must identify a property of the article. The returned choice list is empty if the property happens to be an internal property2 or a property explicitly hidden by relation knowledge, or if the choiceList field of the Property structure is false. Otherwise, the choice list is not empty and contains at least the current property value.

See PropertyValue for a description of the PropertyValue structure which is used as the element type of the returned sequence.

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.

  • The itemId parameter does not represent an UUID.

  • The itemId parameter does not identify an article item.

  • The propClass and propName parameters do not identify a property of the article.

Footnotes

  1. If the addValues field of the Property structure is true, then the choice list contains only proposed values. ↩

  2. This is condition is quite unlikely as the current version of the basket service does not expose internal properties. ↩