GetContentPage

The GetContentPage call allows you to retrieve a content page in a language of your choice. To do this, the Content page ID and the language need to be entered (see also request parameter).

This call is available since SOAP version 100.

GetContentPage Input

Field Type Occurrence Meaning Available since
ContentPageID Integer Required Content page ID 105
Lang String Required Language 105
StoreID Integer Required Store ID 112

GetContentPage Input schema

The box below lists all fields that could be included in the call request (version 112). To learn more about an individual field or its type, click its name in the box.

<PlentySoapRequest_GetContentPage>
<Lang>String</Lang>
<StoreID>Integer</StoreID>
</PlentySoapRequest_GetContentPage>

GetContentPage Output

Field Type Occurrence Meaning Available since
CategoryID Integer Optional Category ID 112
Description String Optional Description 112
Description2 String Optional Description 2 112
FullTextActive Integer Optional Full text view: 1= "Y", 0 = "N" 112
Image Integer Optional Image 112
Image2 Integer Optional Image 2 112
ItemListView String Optional Item list view: 'ItemViewCategoriesList','ItemViewCategoriesList2','ItemViewCategoriesList3','ItemViewCategoriesList4','ItemViewCategoriesList5' 112
Lang String Optional Lang 112
LastUpdateTimestamp Integer Optional Last update timestamp 112
LastUpdateUser String Optional Last update user 112
MetaDescription String Optional Meta description 112
MetaKeywords String Optional Meta keywords 112
MetaTitle String Optional Meta title 112
Name String Optional Name 112
NameURL String Optional Name URL 112
PageView String Optional Page view: 'PageDesignContent','PageDesignCheckout','PageDesignCustom','PageDesignCustom2','PageDesignCustom3' 112
PlaceholderTranslation Integer Optional Placeholder translation: 1 = "Y", 0 = "N", -1 = "L" 112
Position Integer Optional Position 112
ResponseMessages ObjectOptional Returns a list of error messages for the current call. 112
ResponseMessages.
PlentySoapResponseMessage.
Code
Integer Optional Code 105
ResponseMessages.
PlentySoapResponseMessage.
ErrorMessages
ObjectOptional Sub Messages 110
ResponseMessages.
PlentySoapResponseMessage.
ErrorMessages.
PlentySoapResponseSubMessage.
Key
String Optional Key 109
ResponseMessages.
PlentySoapResponseMessage.
ErrorMessages.
PlentySoapResponseSubMessage.
Value
String Optional Value 109
ResponseMessages.
PlentySoapResponseMessage.
IdentificationKey
String Optional Message 110
ResponseMessages.
PlentySoapResponseMessage.
IdentificationValue
String Optional Message 110
ResponseMessages.
PlentySoapResponseMessage.
SuccessMessages
ObjectOptional Sub Messages 110
ResponseMessages.
PlentySoapResponseMessage.
SuccessMessages.
PlentySoapResponseSubMessage.
Key
String Optional Key 109
ResponseMessages.
PlentySoapResponseMessage.
SuccessMessages.
PlentySoapResponseSubMessage.
Value
String Optional Value 109
ResponseMessages.
PlentySoapResponseMessage.
Warnings
ObjectOptional Sub Messages 110
ResponseMessages.
PlentySoapResponseMessage.
Warnings.
PlentySoapResponseSubMessage.
Key
String Optional Key 109
ResponseMessages.
PlentySoapResponseMessage.
Warnings.
PlentySoapResponseSubMessage.
Value
String Optional Value 109
ShortDescription String Optional Short description 112
SingleItemView Integer Optional Single item view: 'ItemViewSingleItem','ItemViewSingleItem2','ItemViewSingleItem3','ItemViewSingleItem4','ItemViewSingleItem5' 112
Success Boolean Optional Has the value true or false, depending on whether a request worked. 112
WebTemplateExist Integer Optional Web template exist: 1 = "Y", 0 = "N" 112
WebstoreID Integer Optional Webstore ID 112

GetContentPage Output schema

The box below lists all fields that could be included in the response call (version 112). To learn more about an individual field or its type, click its name in the box.

Identification Keys

(The dynamicValue stands for any parameter values that could be outputted.)

Key Value
ContentPageID dynamicValue

Identification Output schema

The box below lists all identification fields that could be outputted in the call response (version 112). The dynamicValue stands for any parameter values that could be outputted. To learn more about an individual field or its type, click its name in the box.

Success messages

(The dynamicValue stands for any parameter values that could be outputted.)

Code Key Value Message Explanation
100 - - - Content page was successfully loaded. The content page ID is returned.

Success Messages Output schema

For this call no success messages output schema exists.

Error messages

Code Key Value Message Explanation
800 ContentPageID Missing parameter Required parameter was not entered
800 Lang Missing parameter Required parameter was not entered

Error messages Output schema

The box below lists all error message fields that could be outputted in the call response (version 112). To learn more about an individual field or its type, click its name in the box.

<ErrorMessages>
<item>
<Value>Missing parameter</Value>
<Key>ContentPageID</Key>
</item>
<item>
<Value>Missing parameter</Value>
</item>
</ErrorMessages>

Warnings

Code Key Value Message Explanation
110 No data No data found

Warnings Output schema

The box below lists all warning fields that could be outputted in the call response (version 112). To learn more about an individual field or its type, click its name in the box.

Nach oben