GetPropertyGroups

The GetPropertiesGroups call returns the property groups that are saved in the system.

This call is available since SOAP version 104.
A maximum of 250 property groups can be returned.
If you use the Lang parameter, only property groups for the specified language will be returned.
You can use the parameter Page to specify which page you want to retrieve. In the response object, the value Pages indicates how many pages can be retrieved in total. If you want to retrieve the first page, then you have to use the value 0 as the Page parameter (this is the default numbering scheme for retrieving pages). The last page has the value Pages minus 1.

GetPropertyGroups Input

Field Type Occurrence Meaning Available since
CallItemsLimit Integer Optional Call items limit for own server 112
Lang String Optional Language 105
LastUpdateFrom Integer Optional Last update timestamp. Last edit from… 110
LastUpdateTill Integer Optional Last update timestamp. Last edit until… 110
Page Integer Optional Page 105

GetPropertyGroups 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_GetPropertyGroups>
<Lang>String</Lang>
<Page>Integer</Page>
</PlentySoapRequest_GetPropertyGroups>

GetPropertyGroups Output

Field Type Occurrence Meaning Available since
Pages Integer Optional Pages 105
PropertyGroups ObjectOptional List of property groups 105
PropertyGroups.
PlentySoapObject_PropertyGroup.
BackendName
String Optional The name used in the system 105
PropertyGroups.
PlentySoapObject_PropertyGroup.
Description
String Optional Description 105
PropertyGroups.
PlentySoapObject_PropertyGroup.
FrontendName
String Optional The name used in the webshop 105
PropertyGroups.
PlentySoapObject_PropertyGroup.
IsMarkupPercental
Integer Optional Attribute surcharge 105
PropertyGroups.
PlentySoapObject_PropertyGroup.
Lang
String Optional Language 105
PropertyGroups.
PlentySoapObject_PropertyGroup.
PropertyGroupID
Integer Optional Property group ID 105
PropertyGroups.
PlentySoapObject_PropertyGroup.
PropertyGroupTyp
String Optional Property group type 105
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
Success Boolean Optional Has the value true or false, depending on whether a request worked. 112

GetPropertyGroups 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

For this call no identification keys and values exist.

Identification Output schema

For this call no identification output schema exists.

Success messages

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

Code Key Value Message Explanation
100 - - - -

Success Messages Output schema

For this call no success messages output schema exists.

Error messages

For this call no error messages exist

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.

Warnings

Code Key Value Message Explanation
110 No data No result matching the given search parameters No search result is available for the parameters that were entered
110 Page Unused parameter Parameter was not entered. A default value was used for the call.

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.

<Warnings>
<item> </item>
<item>
<Value>Unused parameter</Value>
</item>
</Warnings>
Nach oben