SOAP API - GetPackageServices

GetPackageServices( packageName ) : Service[]

Since: EngageIP v25.2

Returns the list of services for the specified package name. An exception will be thrown if the package does not exist.

This method returns an array of Service objects. A service object has the following properties:

ID (Integer) - Unique ID for this service
ServiceTypeID (Integer) - ID of associated service type
Name (String) - The name of the service
OwnerID (Integer) - ID of the owner user
BaseTimeUnitTypeID (Integer) -The ID referring to the period of time which interacts with the base time unit to determine the billing period., for example every 2 Weeks, 1 Day, 1 Month, 12 Months etc.
BaseTimeUnit (Integer) -The numeric multiplier of the base time unit that determines the billing frequency, for example every 3 months
CreatedDate (DateTime) - The date time stamp for when this record was created
BaseFee (Double) - The charge for the service
Description (String) - Text description of this service
InvoiceIdentifierID (Integer) - The ID that refers to alternate identifier for the service that can be used to display on an invoice in lieu of the actual service name
Inactive (Boolean) - Indicates that the service is no longer assignable
BillingPeriodTypeID (Integer) - ID of the associated billing period type
ShowOnTicketTransaction (Boolean) - Indicates that the service may be used for billing via ticketing module

Parameters:

packageName (String) - The name of the package for which the list of services are to be retrieved. An exception will be thown if the package does not exist.

Returns:

An array of Service objects.

Possible Exceptions:

INVALID PACKAGE 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: 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>
    <GetPackageServices xmlns="Logisense_EngageIP">
      <packageName>string</packageName>
      <ownerUsername>string</ownerUsername>
    </GetPackageServices>
  </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>
    <GetPackageServicesResponse xmlns="Logisense_EngageIP">
      <GetPackageServicesResult>
        <Service>
          <Validate />
          <ID>int</ID>
          <ServiceTypeID>int</ServiceTypeID>
          <Name>string</Name>
          <OwnerID>int</OwnerID>
          <BaseTimeUnitTypeID>int</BaseTimeUnitTypeID>
          <BaseTimeUnit>int</BaseTimeUnit>
          <CreatedDate>dateTime</CreatedDate>
          <BaseFee>double</BaseFee>
          <Description>string</Description>
          <InvoiceIdentifierID>int</InvoiceIdentifierID>
          <Inactive>boolean</Inactive>
          <BillingPeriodTypeID>int</BillingPeriodTypeID>
          <ShowOnTicketTransaction>boolean</ShowOnTicketTransaction>
          <SKU>string</SKU>
        </Service>
        <Service>
          <Validate />
          <ID>int</ID>
          <ServiceTypeID>int</ServiceTypeID>
          <Name>string</Name>
          <OwnerID>int</OwnerID>
          <BaseTimeUnitTypeID>int</BaseTimeUnitTypeID>
          <BaseTimeUnit>int</BaseTimeUnit>
          <CreatedDate>dateTime</CreatedDate>
          <BaseFee>double</BaseFee>
          <Description>string</Description>
          <InvoiceIdentifierID>int</InvoiceIdentifierID>
          <Inactive>boolean</Inactive>
          <BillingPeriodTypeID>int</BillingPeriodTypeID>
          <ShowOnTicketTransaction>boolean</ShowOnTicketTransaction>
          <SKU>string</SKU>
        </Service>
      </GetPackageServicesResult>
    </GetPackageServicesResponse>
  </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/GetPackageServices"

<?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>
    <GetPackageServices xmlns="Logisense_EngageIP">
      <packageName>string</packageName>
      <ownerUsername>string</ownerUsername>
    </GetPackageServices>
  </soap:Body>
</soap:Envelope>