You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

The information on this page refers to SOAP version 2. This function does not exist in SOAP version 1. 

The SendActivationKeysByEmail function is used to send an email that contains activation keys that are associated with the given email address.

This function requires a valid email address.

Return values

The following return values are possible for this function:

  • If the email address is correct, this function returns the result code 0. 
  • If the email address does not exist in the database, this function returns the result code 108, "Email address doesn't exist." 
  • If the email address format is incorrect, this function returns result code 108, "Invalid email address format."

Example request

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns="https://license.x-formation.com/soap/type/enduser/version/2">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:SendActivationKeysByEmail soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <email xsi:type="xsd:string">example@x-formation.com</email>
      </ns:SendActivationKeysByEmail>
   </soapenv:Body>
</soapenv:Envelope>

Example response

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="https://license.x-formation.com/soap/type/enduser/version/2"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body>
      <ns1:SendActivationKeysByEmailResponse>
         <return xsi:type="ns1:Soap_Response">
            <result_code xsi:type="xsd:int">0</result_code>
            <result_string xsi:nil="true"/>
         </return>
      </ns1:SendActivationKeysByEmailResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
  • No labels