SOAP API - AddOptionalService

AddOptionalService( username, userpackageID, packageAttributeQuantityID, optionalServiceStartDate, transactionDate, billNow ) : Integer

Since: EngageIP v25.2

Adds an optional service to the supplied user package. Optional services refer to services in a package that are not one service to one package. This is defined by the quantity component of the package. The customer can choose the quantity of the service they wish for that package.

Parameters:

username (String) - The username of the user in which to add an optional service. An exception will be thrown if the username does not exist.
userpackageID (Integer) - The ID of the User Package to which the optional service will be added.
packageAttributeQuantityID (Integer) -Package Attribute Quantity contains the definition of the quantity rules for the optional service on the package. This includes: minimum, maximum, default and threshold values for the service.
optionalServiceStartDate (DateTime) - The date you wish to begin billing the optional service.
transactionDate (DateTime) - The date of the transaction.
billNow (Boolean) - When set to true, the optional service will be invoiced, otherwise this will occur with the regular bill cycle of the user.

Returns:

The ID of the new User Service added.

Possible Exceptions:

INVALID USERNAME
INVALID COUNTRY

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>
    <AddOptionalService xmlns="Logisense_EngageIP">
      <username>string</username>
      <userpackageID>int</userpackageID>
      <packageAttributeQuantityID>int</packageAttributeQuantityID>
      <optionalServiceStartDate>dateTime</optionalServiceStartDate>
      <transactionDate>dateTime</transactionDate>
      <billNow>boolean</billNow>
    </AddOptionalService>
  </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>
    <AddOptionalServiceResponse xmlns="Logisense_EngageIP">
      <AddOptionalServiceResult>int</AddOptionalServiceResult>
    </AddOptionalServiceResponse>
  </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/AddOptionalService"

<?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>
    <AddOptionalService xmlns="Logisense_EngageIP">
      <username>string</username>
      <userpackageID>int</userpackageID>
      <packageAttributeQuantityID>int</packageAttributeQuantityID>
      <optionalServiceStartDate>dateTime</optionalServiceStartDate>
      <transactionDate>dateTime</transactionDate>
      <billNow>boolean</billNow>
    </AddOptionalService>
  </soap:Body>
</soap:Envelope>