GetPropertiesList

The GetPropertiesList call returns a list of property groups along with the properties belonging to each group.

This call is available since SOAP version 104.
With the help of this call, properties that are not assigned to any group will be listed in the property group:
ID = -1 / Name = Properties without Group.
This call is only available for version 102 and then again for version 104 and higher.

GetPropertiesList Input

Field Type Occurrence Meaning Available since
Lang String Optional Language 105

GetPropertiesList 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_GetPropertiesList>
<Lang>String</Lang>
</PlentySoapRequest_GetPropertiesList>

GetPropertiesList Output

Field Type Occurrence Meaning Available since
PropertyGroups ObjectOptional List of property groups 105
PropertyGroups.
PlentySoapObject_GetPropertiesListGroup.
Properties
ObjectOptional List of properties 105
PropertyGroups.
PlentySoapObject_GetPropertiesListGroup.
Properties.
PlentySoapObject_GetPropertiesListPropertie.
IsSalesOrderParam
Boolean Optional 110
PropertyGroups.
PlentySoapObject_GetPropertiesListGroup.
Properties.
PlentySoapObject_GetPropertiesListPropertie.
PropertyID
Integer Optional Property ID 105
PropertyGroups.
PlentySoapObject_GetPropertiesListGroup.
Properties.
PlentySoapObject_GetPropertiesListPropertie.
PropertyName
String Optional Property name 105
PropertyGroups.
PlentySoapObject_GetPropertiesListGroup.
Properties.
PlentySoapObject_GetPropertiesListPropertie.
PropertyValueType
String Optional 110
PropertyGroups.
PlentySoapObject_GetPropertiesListGroup.
PropertyGroupID
Integer Optional Property group ID 105
PropertyGroups.
PlentySoapObject_GetPropertiesListGroup.
PropertyGroupName
String Optional Property group name 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

GetPropertiesList 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

For this call no warnings exist.

Warnings Output schema

For this call no warnings output schema exists.

Nach oben