SOAP API - CreateUserPackageContract

CreateUserPackageContract( userPackageID, term, baseTimeUnitType, penalty, chargeRemainder, startDate, transactionPenaltyService ) : void

Since: EngageIP v25.2

Creates a Contract on the specified UserPackage. If a contract already exists an exception will be thrown.

Parameters:

userPackageID (Integer) - The ID of the user package in which to create a contract.. An exception will be thrown if the ID does not exist.
term (Integer) - Numeric portion of contract length, for example 3 months.
baseTimeUnitType (String) - Time measurement unit of contract length, for example 3 months.
penalty (Double) - Optional penalty charged to transactionPenaltyService if contract is broken.
chargeRemainder ( Boolean) - Indicates if the user should be charged remainder of the contract's recurring charges for breaking the contract.
startDate (DateTime) - The start date for the contract.
transactionPenaltyService (String) - Service to be used for billing any fees associated with breaking the contract.

Possible Exceptions:

INVALID PACKAGE ID
CONTACT ALREADY EXISTS

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>
    <CreateUserPackageContract xmlns="Logisense_EngageIP">
      <userPackageID>int</userPackageID>
      <term>int</term>
      <baseTimeUnitType>string</baseTimeUnitType>
      <penalty>double</penalty>
      <chargeRemainder>boolean</chargeRemainder>
      <startDate>dateTime</startDate>
      <transactionPenaltyService>string</transactionPenaltyService>
    </CreateUserPackageContract>
  </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>
    <CreateUserPackageContractResponse 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/CreateUserPackageContract"

<?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>
    <CreateUserPackageContract xmlns="Logisense_EngageIP">
      <userPackageID>int</userPackageID>
      <term>int</term>
      <baseTimeUnitType>string</baseTimeUnitType>
      <penalty>double</penalty>
      <chargeRemainder>boolean</chargeRemainder>
      <startDate>dateTime</startDate>
      <transactionPenaltyService>string</transactionPenaltyService>
    </CreateUserPackageContract>
  </soap:Body>
</soap:Envelope>

v9 Documentation

SOAP API - CreateUserPackageContract

Related pages