Purpose

Sends Key to the specified e-mail address or to the Key owner’s e-mail address. A Key can be sent in zip format.

Signature

Method name: partner10.sendKeyByEmail

Parameters

# Type Description
1 struct AuthInfo requesting party authentication information
2 string number of a key that is emailed
3 string email address to use while sending key
4 boolean should keys be sent in zipped format(optional)

Returns

Field Type Description
resultCode int code for command execution result (see below)
resultDesc string textual description of command execution result (see below)
emailAddress string email address the key has been sent to

Result Codes

resultCode resultDesc
100 Key <key number> has been successfully sent to <email>
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
221 License key <key number> is marked as problem
222 License key <key number> is terminated
223 License key <key number> is not activated
224 License key <key number> is not exportable
300 Internal error, please try after some time
400 Incorrect authorization info format
410 Incorrect key number format: “<key number>”
437 Incorrect email format

XML Examples

Request message

<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
  <methodName>partner10.sendKeyByEmail</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>PLSK.00123456.0000</string>
      </value>
    </param>
    <param>
      <value>
        <string>jdoe@example.com</string>
      </value>
    </param>
    <param>
      <value>
        <boolean>1</boolean>
      </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>Key PLSK.00123456.0000 has been successfully sent to jdoe@example.com</value>
          </member>
          <member>
            <name>emailAddress</name>
            <value>jdoe@example.com</value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>