SOAP API – AddPackageToUserWithNextBilldateWithBillNow

AddPackageToUserWithNextBilldateWithBillNow( username, packageID, chargeCreditCard, IsChildUser, NextBillDate, billNow) : Integer

Since: EngageIP v25.2

Assigns a package to a user, returns the ID of the User Package record or throws exception if the addition of the package fails or if the user or package does not exist.

Note: The User Package will not include any Optional Services that might be configured on the Package.

Parameters:

username (String) - The username of the user in which to add the package. An exception will be thrown if the username does not exist.
packageID (Integer) - The ID of the package to add to the user.
chargeCreditCard (Boolean) - Indicates if the credit card should be billed immediately.
IsChildUser (Boolean) - Indicates if the user is a child account.
NextBillDate (DateTime) - The next bill date for the package.
billNow (Boolean) - Indicates if the package should be invoiced immediately.

Returns:

The ID of the new User Package added.

Possible Exceptions:

INVALID USERNAME
INVALID PACKAGE

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>
    <AddPackageToUserWithNextBilldateWithBillNow xmlns="Logisense_EngageIP">
      <username>string</username>
      <packageID>int</packageID>
      <chargeCreditCard>boolean</chargeCreditCard>
      <IsChildUser>boolean</IsChildUser>
      <NextBillDate>dateTime</NextBillDate>
      <billNow>boolean</billNow>
    </AddPackageToUserWithNextBilldateWithBillNow>
  </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>
    <AddPackageToUserWithNextBilldateWithBillNowResponse xmlns="Logisense_EngageIP">
      <AddPackageToUserWithNextBilldateWithBillNowResult>int</AddPackageToUserWithNextBilldateWithBillNowResult>
    </AddPackageToUserWithNextBilldateWithBillNowResponse>
  </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 /BOSS/WebService.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Logisense_EngageIP/AddPackageToUserWithNextBilldateWithBillNow"

<?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>
    <AddPackageToUserWithNextBilldateWithBillNow xmlns="Logisense_EngageIP">
      <username>string</username>
      <packageID>int</packageID>
      <chargeCreditCard>boolean</chargeCreditCard>
      <IsChildUser>boolean</IsChildUser>
      <NextBillDate>dateTime</NextBillDate>
      <billNow>boolean</billNow>
    </AddPackageToUserWithNextBilldateWithBillNow>
  </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>
    <AddPackageToUserWithNextBilldateWithBillNowResponse xmlns="Logisense_EngageIP">
      <AddPackageToUserWithNextBilldateWithBillNowResult>int</AddPackageToUserWithNextBilldateWithBillNowResult>
    </AddPackageToUserWithNextBilldateWithBillNowResponse>
  </soap:Body>
</soap:Envelope>