SOAP API – UpdateUserPackageContract

UpdateUserPackageContract( userPackageAttributeContractId, penalty, chargeRemainder, transactionPenaltyServiceName, startDate ) : void

Since: EngageIP v25.2

Update Contract Penalty amount, charge reminder flag, transaction penalty service name and start date on a user package by the supplied UserPackageAttributeContractID. If the contract does not exist an exception will be thrown.

Parameters:

userPackageAttributeContractId (Integer) - The ID of the contract to change. An exception will be thrown if the ID does not exist.
penalty (Double) - The penalty for cancellation
chargeRemainder (Boolean) - Indicates if any remaining recurring fees for the contract length should be charged for early cancellation
transactionPenaltyServiceName (String) - The name of the service to be used for any early termination fees. An exception will be thrown if the service name is invalid.
startDate (DateTime) - The date the contract begins

Possible Exceptions:

INVALID USER PACKAGE CONTRACT ID
INVALID SERVICE NAME

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: localhost
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>
    <UpdateUserPackageContract xmlns="Logisense_EngageIP">
      <userPackageAttributeContractId>int</userPackageAttributeContractId>
      <penalty>double</penalty>
      <chargeRemainder>boolean</chargeRemainder>
      <transactionPenaltyServiceName>string</transactionPenaltyServiceName>
      <startDate>dateTime</startDate>
    </UpdateUserPackageContract>
  </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>
    <UpdateUserPackageContractResponse 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: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Logisense_EngageIP/UpdateUserPackageContract"

<?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>
    <UpdateUserPackageContract xmlns="Logisense_EngageIP">
      <userPackageAttributeContractId>int</userPackageAttributeContractId>
      <penalty>double</penalty>
      <chargeRemainder>boolean</chargeRemainder>
      <transactionPenaltyServiceName>string</transactionPenaltyServiceName>
      <startDate>dateTime</startDate>
    </UpdateUserPackageContract>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?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:Body>
    <UpdateUserPackageContractResponse xmlns="Logisense_EngageIP" />
  </soap:Body>
</soap:Envelope>