SOAP API - UpgradeUserPackage

UpgradeUserPackage( userPackageID, targetPackageID, chargeCreditCard ) : void

Since: EngageIP v25.2

Upgrades one User Package to a valid upgrade Package.

This method can optionally charge the user's credit card at the time of the upgrade for the amount of the upgrade (i.e. the charge will not include the user's existing balance, if any). If the payment fails the upgrade will not be performed.

Parameters:

userPackageID (Integer) - The ID of the user package to upgrade. An exception will be thrown if the package id cannot be found.
targetPackageID (Integer) - The ID of the upgraded user target package to be assigned. An exception will be thrown if the package id cannot be found.
chargeCreditCard (Boolean) - Whether or not to charge the user's credit card for the amount of the upgrade.

Possible Exceptions:

INVALID PACKAGE ID
INVALID TARGET PACKAGE ID

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /adminportal/webservice.asmx HTTP/1.1
Host: demo.logisense.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <AuthHeader xmlns="Logisense_EngageIP">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap12:Header>
  <soap12:Body>
    <UpgradeUserPackage xmlns="Logisense_EngageIP">
      <userPackageID>int</userPackageID>
      <targetPackageID>int</targetPackageID>
      <chargeCreditCard>boolean</chargeCreditCard>
    </UpgradeUserPackage>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <UpgradeUserPackageResponse xmlns="Logisense_EngageIP" />
  </soap12:Body>
</soap12:Envelope>

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /adminportal/webservice.asmx HTTP/1.1
Host: demo.logisense.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Logisense_EngageIP/UpgradeUserPackage"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthHeader xmlns="Logisense_EngageIP">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap:Header>
  <soap:Body>
    <UpgradeUserPackage xmlns="Logisense_EngageIP">
      <userPackageID>int</userPackageID>
      <targetPackageID>int</targetPackageID>
      <chargeCreditCard>boolean</chargeCreditCard>
    </UpgradeUserPackage>
  </soap:Body>
</soap:Envelope>