SOAP API - UpdateUserPackageExtendedAttributes

UpdateUserPackageExtendedAttributes( userPackageID, extAttributesXML ) : void

Since: EngageIP v25.2

Updates the extended attributes of a user package, throws exception if the user package does not exist.

When providing updates to a user package's extended attributes (custom fields) you must supply a formatted XML string for the extAttributesXML parameter. This is an XML description of both the field name and the value to update for the specified field.

Example extAttributesXML value:

<?xml version='1.0' standalone='yes'?>
<Extended>
<Attribute Name='DeviceID' Value='12:A3:98'/>
</Extended>

Parameters:

userPackageID (Integer) - The ID of the package to retrieve its extended attributes. An exception will be thrown if the package does not exist
extAttributesXML (String) - Formatted XML text to update the extended attributes (custom fields) for the specified user package.

Possible Exceptions:

INVALID PACKAGE
INVALID ATTRIBUTES XML
INVALID EXTENDED FIELD 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>
    <UpdateUserPackageExtendedAttributes xmlns="Logisense_EngageIP">
      <userPackageID>int</userPackageID>
      <extAttributesXML>string</extAttributesXML>
    </UpdateUserPackageExtendedAttributes>
  </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>
    <UpdateUserPackageExtendedAttributesResponse xmlns="Logisense_EngageIP" />
  </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.