PageLayout: PageDesign Noun

The Page Design noun represents the layout of a page in a storefront. This noun is used in the store and contains only information that is needed by the store to draw the page layout.

BOD Summary

Access Profile and Expression Builder columns are for Get BOD only.
BOD Action Code / Access Profile Action Expression Service Provided Sample XML Message Client Library / Expression Builder
GetPageDesign IBM_Store_Details /PageDesign[(ObjectIdentifier='$ObjectIdentifier$') and @deviceClass='$deviceClass$' and @pageGroup='$pageGroup$'] Gets a page design for a page group, device class and the object identifier of the object that is being rendered on the store page.
@pageGroup is the page group of the current page, for example Category or Product.
@objectIdentifier is the unique identifier of the primary object on the page. For example if the current page is a product, the object identifier is the unique ID of the product which could look like: 10008.
@deviceClass is the device classes the is making the request, for example Mobile. 		Request
Response

fetchPageDesign
IBM_Store_Summary /PageDesign[@layoutId='$layoutId$'] Gets a page design by unique ID. Request
Response

getPageDesign
IBM_Store_Summary /PageDesign[@layoutActivityId='$layoutActivityId$'] Gets the page design by a layout activity ID. Request
Response

getPageDesign

Access Profile

Some sample XML request and response web service messages are provided for each noun. These sample messages might not include all properties or attributes. To view a sample message that includes other properties or attributes, enable logging and tracing for the appropriate component and then call the web service to set or change the properties or attributes. Review the corresponding log file to see the request or response information.

Access Profile Data Returned
IBM_Store_Summary
  • /PageDesign/LayoutID
  • /PageDesign/LayoutName
 This access profile is used to get basic information for a page layout.
IBM_Store_Details IBM_Store_Summary
+
  • /PageDesign/ObjectIdentifier
  • /PageDesign/PreviewReport
  • /PageDesign/Widget/WidgetIdentifier/UniqueID
  • /PageDesign/Widget/WidgetIdentifier/Name
  • /PageDesign/Widget/WidgetDefinitionIdentifier/UniqueID
  • /PageDesign/Widget/WidgetDefinitionIdentifier/ExternalIdentifier/Identifier
  • /PageDesign/Widget/WidgetDefinitionIdentifier/ExternalIdentifier/StoreIdentifier/UniqueID
  • /PageDesign/Widget/Slot/InternalSlotId
  • /PageDesign/Widget/Slot/PositionProperty(@name)
  • /PageDesign/Widget/Slot/SlotType
  • /PageDesign/Widget/Slot/SlotIdentifier/UniqueID
  • /PageDesign/Widget/Slot/SlotIdentifier/Name
  • /PageDesign/Widget/WidgetProperty(@sequenceOrder)
  • /PageDesign/Widget/WidgetProperty(@sequenceOrder)/Name
  • /PageDesign/Widget/WidgetProperty(@sequenceOrder)/Value
  • /PageDesign/Widget/WidgetProperty(@sequenceOrder)/StoreIdentifier/UniqueID
  • /PageDesign/Widget/ExtendedData(@sequenceOrder)
  • /PageDesign/Widget/ExtendedData(@sequenceOrder)/UniqueID
  • /PageDesign/Widget/ExtendedData(@sequenceOrder)/Identifier
  • /PageDesign/Widget/ExtendedData(@sequenceOrder)/StoreIdentifier/UniqueID
  • /PageDesign/Widget/ExtendedData(@sequenceOrder)/DataType
  • /PageDesign/Widget/ExtendedData(@sequenceOrder)/Attributes(@language)
  • /PageDesign/Widget/ExtendedData(@sequenceOrder)/Attributes(@language)/Attribute(@name)
  • /PageDesign/Widget/ChildWidget(@widgetSequence)
 This access profile is designed for the Store to return the details of a page design so the page can be rendered and displayed to a shopper.

XSD files