GetCustomerNotes

With the GetCustomerNotes call, you can retrieve the notes from a customer's data record.

This call is available since SOAP version 100.
All of the notes for a customer can be retrieved. In doing so, a maximum of 5 notes will always be returned at once. You can receive additional notes by using the page parameter.

GetCustomerNotes Input

Field Type Occurrence Meaning Available since
CallItemsLimit Integer Optional Call items limit for own server 112
CustomerID Integer Required Customer ID 105
Page Integer Optional Page 105

GetCustomerNotes 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_GetCustomerNotes>
<Page>Integer</Page>
</PlentySoapRequest_GetCustomerNotes>

GetCustomerNotes Output

Field Type Occurrence Meaning Available since
Notes ObjectOptional Returns the individual notes for the respective customer 105
Notes.
PlentySoapObject_CustomerNote.
CustomerID
Integer Required Customer ID 105
Notes.
PlentySoapObject_CustomerNote.
Inserted
Integer Optional The time when it was created 105
Notes.
PlentySoapObject_CustomerNote.
Note
String Required Note 105
Notes.
PlentySoapObject_CustomerNote.
UserID
Integer Required User ID 105
Pages Integer Optional Pages 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

GetCustomerNotes 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
CustomerID 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 - - - The note was successfully retrieved. The customer ID is returned.

Success Messages Output schema

For this call no success messages output schema exists.

Error messages

Code Key Value Message Explanation
800 Unable to save data record The data record could not be saved.
800 CustomerID 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>CustomerID</Key>
</item>
</ErrorMessages>

Warnings

Code Key Value Message Explanation
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>
<Value>Unused parameter</Value>
</item>
</Warnings>
Nach oben