SOAP API – AddOrUpdateComponentToService

AddOrUpdateComponentToService( serviceName, componentName, componentPropertiesXML) : Void

Since: EngageIP v25.2

Add or Update Component to a Service

The componentPropertiesXML should contain a XML that maps the ServiceAttribute you are trying to add or update

Example for ServiceAttributeCost:

<?xml version="1.0" standalone="yes"?>
<Component>
<Property Name="Cost" Value="10"/>
</Component>

Parameters:

packageName (String) - The name of the service to add/update the component. An exception will be thrown if the service does not exist.
componentName (String) - The name of the attribute to add/update. An exception will be thrown if the attribute does not exist.
componentPropertiesXML (String) - XML string with name and value

Returns:

Nothing

Possible Exceptions:

INVALID PACKAGE
INVALID COMPONENT 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 /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>
    <AddOrUpdateComponentToService xmlns="Logisense_EngageIP">
      <serviceName>string</serviceName>
      <componentName>string</componentName>
      <componentPropertiesXML>string</componentPropertiesXML>
    </AddOrUpdateComponentToService>
  </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>
    <AddOrUpdateComponentToServiceResponse xmlns="Logisense_EngageIP" />
  </soap12:Body>
</soap12:Envelope>

SOAP 1.1

POST /BOSS/WebService.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Logisense_EngageIP/AddOrUpdateComponentToService"

<?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>
    <AddOrUpdateComponentToService xmlns="Logisense_EngageIP">
      <serviceName>string</serviceName>
      <componentName>string</componentName>
      <componentPropertiesXML>string</componentPropertiesXML>
    </AddOrUpdateComponentToService>
  </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>
    <AddOrUpdateComponentToServiceResponse xmlns="Logisense_EngageIP" />
  </soap:Body>
</soap:Envelope>