SOAP API - GetPackages

GetPackages( username ) : Package[]

Since: EngageIP v25.2

Returns a list of packages that belong to the specified owner.

This method returns an array of Package objects which have the following properties:

ID (Integer) - The unique ID for the package
Name (String) - The name of the package
SKU (String) - The SKU for this user package
OwnerID (Integer) - The ID of the owner who defines the package
Frequency (Integer) - The numeric multiplier of the base time unit that determines the billing frequency for the package, for example every 3 months
BaseTimeUnitTypeID (Integer) -The ID referring to the period of time which interacts with the frequency to determine the billing period., for example every 2 Weeks, 1 Day, 1 Month, 12 Months etc.
Amount (Double) - The amount of the recurring charges of the package
CreatedDate (DateTime) - The date/time stamp of when the record was created
Description (String) - The text description of this package
OneTimeAmount (Double) - One time charge amount or non-recurring charges for the user package, for example a setup or installation fee
InactiveOverride (Boolean) - Override indicates the package can not be assigned
StartDate (DateTime) - The date the package becomes available for assignment
ExpiryDate (DateTime) - The date the package will not longer be assignable, otherwise null
InvoiceIdentifierID (Integer) - The ID of an alternate name for the package that is used for invoices
ShowToUserPortal (Boolean) - When set to true this package would be shown to your end customer as an available package.

Parameters:

username (String) - The username of the owner for whom the list of packages are to be retrieved. An exception will be thrown if the username cannot be found.

Returns:

An array of Package objects

Possible Exceptions:

INVALID USERNAME

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>
    <GetPackages xmlns="Logisense_EngageIP">
      <username>string</username>
    </GetPackages>
  </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>
    <GetPackagesResponse xmlns="Logisense_EngageIP">
      <GetPackagesResult>
        <Package>
          <Validate />
          <ID>int</ID>
          <Name>string</Name>
          <SKU>string</SKU>
          <OwnerID>int</OwnerID>
          <Frequency>int</Frequency>
          <BaseTimeUnitTypeID>int</BaseTimeUnitTypeID>
          <Amount>double</Amount>
          <CreatedDate>dateTime</CreatedDate>
          <Description>string</Description>
          <OneTimeAmount>double</OneTimeAmount>
          <InactiveOverride>boolean</InactiveOverride>
          <StartDate>dateTime</StartDate>
          <ExpiryDate>dateTime</ExpiryDate>
          <InvoiceIdentifierID>int</InvoiceIdentifierID>
          <ShowToUserPortal>boolean</ShowToUserPortal>
        </Package>
        <Package>
          <Validate />
          <ID>int</ID>
          <Name>string</Name>
          <SKU>string</SKU>
          <OwnerID>int</OwnerID>
          <Frequency>int</Frequency>
          <BaseTimeUnitTypeID>int</BaseTimeUnitTypeID>
          <Amount>double</Amount>
          <CreatedDate>dateTime</CreatedDate>
          <Description>string</Description>
          <OneTimeAmount>double</OneTimeAmount>
          <InactiveOverride>boolean</InactiveOverride>
          <StartDate>dateTime</StartDate>
          <ExpiryDate>dateTime</ExpiryDate>
          <InvoiceIdentifierID>int</InvoiceIdentifierID>
          <ShowToUserPortal>boolean</ShowToUserPortal>
        </Package>
      </GetPackagesResult>
    </GetPackagesResponse>
  </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/GetPackages"

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