SOAP API - CancelUserPackageWithEffectiveCancelDate

CancelUserPackageWithEffectiveCancelDate( username, userPackageID, cancelOpt, specificDate, effectiveCancelDate ) : void

Since: EngageIP v25.2

Cancels a user's package with an effective date

Parameters:

username (String) - The name of the user in which to cancel a package. An exception will be thrown if the username does not exist.
userPackageID (Integer) - The ID of the user package to cancel. An exception will be thrown if the ID does not exist or the user package does not belong to the supplied user.
cancelOpt (DisableOption) - Value can be one of: ImmediatelyWithFullTransaction or ImmediatelyWithProratedTransaction or ImmediatelyWithNoTransaction or PeriodEnd or SpecificDate
specificDate (DateTime) - When using the disable option of SpecificDate this parameter must be set to a valid date time. An exception will be thrown if specific date is not supplied when DisableOption SpecificDate is selected
effectiveCancelDate (DateTime) - This is the date, when the user package will be cancelled and effective

Possible Exceptions:

INVALID USERNAME
INVALID USER PACKAGE ID
DATE NOT SUPPLIED WHEN REQUIRED
USER PACKAGE NOT ACTIVE

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>
    <CancelUserPackageWithEffectiveCancelDate xmlns="Logisense_EngageIP">
      <username>string</username>
      <userpackageid>int</userpackageid>
      <cancelopt>ImmediatelyWithFullTransaction or ImmediatelyWithProratedTransaction or ImmediatelyWithNoTransaction or PeriodEnd or SpecificDate</cancelopt>
      <specificdate>dateTime</specificdate>
      <effectiveCancelDate>dateTime</effectiveCancelDate>
    </CancelUserPackageWithEffectiveCancelDate>
  </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>
    <CancelUserPackageWithEffectiveCancelDateResponse 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/CancelUserPackageWithEffectiveCancelDate"

<?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>
    <CancelUserPackageWithEffectiveCancelDate xmlns="Logisense_EngageIP">
      <username>string</username>
      <userpackageid>int</userpackageid>
      <cancelopt>ImmediatelyWithFullTransaction or ImmediatelyWithProratedTransaction or ImmediatelyWithNoTransaction or PeriodEnd or SpecificDate</cancelopt>
      <specificdate>dateTime</specificdate>
      <effectiveCancelDate>dateTime</effectiveCancelDate>
    </CancelUserPackageWithEffectiveCancelDate>
  </soap:Body>
</soap:Envelope>