GetMarketDirectories

Loads a list of market directories.

This call is available since SOAP version 112.

GetMarketDirectories Input

Field Type Occurrence Meaning Available since
CallItemsLimit Integer Optional Call items limit for own server 112
GetMarketDirectories ObjectOptional Get market directories 112
GetMarketDirectories.
PlentySoapRequestObject_GetMarketDirectories.
IdentificationValue
String Optional IdentificationValue 112
GetMarketDirectories.
PlentySoapRequestObject_GetMarketDirectories.
MarketDirectoryID
Integer Optional Market directory ID 112

GetMarketDirectories 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.

GetMarketDirectories Output

Field Type Occurrence Meaning Available since
MarketDirectories ObjectOptional Market Directories 112
MarketDirectories.
PlentySoapResponseObject_GetMarketDirectories.
DirectoryId
Integer Optional Directory ID 112
MarketDirectories.
PlentySoapResponseObject_GetMarketDirectories.
DirectoryLevel
Integer Optional Directory Level 112
MarketDirectories.
PlentySoapResponseObject_GetMarketDirectories.
DirectoryName
String Optional Directory Name 112
MarketDirectories.
PlentySoapResponseObject_GetMarketDirectories.
IdentificationValue
String Optional IdentificationValue 112
MarketDirectories.
PlentySoapResponseObject_GetMarketDirectories.
ParentDirectoryId
Integer Optional Parent Directory ID 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
Success Boolean Optional Has the value true or false, depending on whether a request worked. 112

GetMarketDirectories 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

Code Key Value Message Explanation
800 Error loading market directory An error occurred while loading market directory.
800 MarketDirectoryID 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>MarketDirectoryID</Key>
</item>
</ErrorMessages>

Warnings

Code Key Value Message Explanation
110 No data No data was found for the given market directory ID No data was found for the given market directory ID.

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