SOAP API – CreatePackage

CreatePackage( ownerID, packageName, sku, description, startDate, expiryDate, frequency, baseUnitTypeName, inActiveOverride, showToUserPortal, invoiceIdentifier, serviceName) : Void

Since: EngageIP v25.2

Update an existing Service

If a field is identified as being mandatory, a value must be provided. If a field is identified as being optional, use null to indicate no value . If you do not wish to update a field, use the existing value when updating.
Parameters:

ownerID (Integer) - The mandatory unique ID of the owner for which this package belongs. An exception will be thrown if the owner does not exist.
packageName (String) - The mandatory unique name of the package to update. An exception will be thrown if the package name already exists.
sku (String) - The mandatory unique sku for the package. An exception will be thrown if the sku has been used.
description (String) - The mandatory description of the package. Use an empty string for no description.
startDate (DateTime) - The optional date the package becomes available.
expiryDate (DateTime) - The optional date the package becomes unavailable.
frequency (int) - The mandatory numeric part of the billing frequency, for example every 3 months.
baseUnitTypeName (String) - The mandatory time unit part of the billing frequency, for example every 3 months. An exception will be thrown if the base unit name does not exist.
inActiveOverride (Boolean) - Indicates the package is not available for assignment if set to true.
showToUserPortal (Boolean) - When set to true this package would be shown to your end customer as an available package
invoiceIdentifier (String) - An optional identifier that can be used to display on an invoice . An exception will be thrown if the invoice period type identifier does not exist.
serviceName (String[]) - The names of the services included in the package. An exception will be thrown if the service does not exist.

Returns:

Nothing

Possible Exceptions:

INVALID PACKAGE
INVALID SKU
INVALID DATETIME
INVALID BASE UNIT TYPE NAME
INVALID INVOICE IDENTIFIER

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 /BOSS/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>
    <CreatePackage xmlns="Logisense_EngageIP">
      <ownerID>int</ownerID>
      <packageName>string</packageName>
      <sku>string</sku>
      <description>string</description>
      <startDate>dateTime</startDate>
      <expiryDate>dateTime</expiryDate>
      <frequency>int</frequency>
      <baseTimeUnitTypeName>string</baseTimeUnitTypeName>
      <inActiveOverride>boolean</inActiveOverride>
      <showToUserPortal>boolean</showToUserPortal>
      <invoiceIdentifier>string</invoiceIdentifier>
      <serviceNames>
        <string>string</string>
        <string>string</string>
      </serviceNames>
    </CreatePackage>
  </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>
    <CreatePackageResponse xmlns="Logisense_EngageIP" />
  </soap12:Body>
</soap12:Envelope>

SOAP 1.1

POST /BOSS/WebService.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Logisense_EngageIP/CreatePackage"

<?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>
    <CreatePackage xmlns="Logisense_EngageIP">
      <ownerID>int</ownerID>
      <packageName>string</packageName>
      <sku>string</sku>
      <description>string</description>
      <startDate>dateTime</startDate>
      <expiryDate>dateTime</expiryDate>
      <frequency>int</frequency>
      <baseTimeUnitTypeName>string</baseTimeUnitTypeName>
      <inActiveOverride>boolean</inActiveOverride>
      <showToUserPortal>boolean</showToUserPortal>
      <invoiceIdentifier>string</invoiceIdentifier>
      <serviceNames>
        <string>string</string>
        <string>string</string>
      </serviceNames>
    </CreatePackage>
  </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>
    <CreatePackageResponse xmlns="Logisense_EngageIP" />
  </soap:Body>
</soap:Envelope>

v9 Documentation

SOAP API – CreatePackage

Related pages