The information on this page refers to SOAP version 2, which added this function. SOAP version 1 does not include this function.

The LicenseRemovalRequested function makes a request to check if removal of a license from a host was requested. This function requires an activation key and a HostID. Examples of a request and response for LicenseRemovalRequested are given below

If successful, the response for LicenseRemovalRequested will contain the following:

  • SUCCESS if the license removal was requested
  • LICENSE_REMOVAL_NOT_REQUESTED if the license removal was not requested
  • LICENSE_GENERATION_WAS_NOT_REQUESTED if there is no generated license for the specified license order

The response will contain an error message if unsuccessful. See Return Codes for more information about error messages. See Removing license files using the API to learn about using the removal flag to program your software to remove license files.

Example request for LicenseRemovalRequested

<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:LicenseRemovalRequested soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <activationKey xsi:type="xsd:string">GTVU3-J6W0U-030QX-5IM19</activationKey>
         <hostid xsi:type="xsd:string">ETHERNET=213434</hostid>
      </ns:LicenseRemovalRequested>
   </soapenv:Body>
</soapenv:Envelope>

Example response from LicenseRemovalRequested

<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:LicenseRemovalRequestedResponse>
         <return xsi:type="ns1:Soap_Response">
            <result_code xsi:type="xsd:int">0</result_code>
            <result_string xsi:nil="true"/>
         </return>
      </ns1:LicenseRemovalRequestedResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
  • No labels