Purpose
Adds text note to a Key.
Signature
Method name: partner10.addNoteToKey
Parameters
# |
Type |
Description |
1 |
struct AuthInfo |
client authentication information |
2 |
string |
number of a key to which a note should be added |
3 |
string |
note text |
Returns
Field |
Type |
Description |
resultCode |
int |
code for command execution result (see below) |
resultDesc |
string |
textual description of command execution result (see below) |
Result Codes
resultCode |
resultDesc |
|---|---|
100 |
Note has been added successfully |
200 |
Client authorization failed |
201 |
Access to this method is denied |
202 |
Access to this object is denied |
220 |
Key <key number> is not found |
283 |
Text of note is too long |
300 |
Internal error, please try after some time |
400 |
Incorrect authorization info format |
410 |
Incorrect key number format: "<key number>" |
XML Examples
Request message
<?xml version='1.0'?>
<methodCall>
<methodName>partner10.addNoteToKey</methodName>
<params>
<param>
<value>
<struct>
<member>
<name>login</name>
<value>
<string>API_LOGIN</string>
</value>
</member>
<member>
<name>password</name>
<value>
<string>API_PASSWORD</string>
</value>
</member>
</struct>
</value>
</param>
<param>
<value>
<string>4PSA.00123456.0000</string>
</value>
</param>
<param>
<value>
<string>*</string>
</value>
</param>
</params>
</methodCall>
Response message
<?xml version="1.0"?>
<methodResponse>
<params>
<param>
<value>
<struct>
<member>
<name>resultCode</name>
<value>
<int>100</int>
</value>
</member>
<member>
<name>resultDesc</name>
<value>Note has been added successfully</value>
</member>
</struct>
</value>
</param>
</params>
</methodResponse>