SOAP API - DeleteOptionalUserService

DeleteOptionalUserService( userServiceID, deleteOption ) : void

Since: EngageIP v25.2

Cancels an optional service based on the supplied UserServiceID

Parameters:

userServiceID (Integer) - The ID of the service to be deleted. An exception will be thrown if the service does not exist.
deleteOption (DeleteOption) - Can be one of the following enumeration values: ImmediatelyWithFullTransaction, ImmediatelyWithProratedTransaction, ImmediatelyWithNoTransaction

Possible Exceptions:

INVALID SERVICE
INVALID DELETE OPTION

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>
    <DeleteOptionalUserService xmlns="Logisense_EngageIP">
      <userServiceID>int</userServiceID>
      <deleteOption>ImmediatelyWithFullTransaction or ImmediatelyWithProratedTransaction or ImmediatelyWithNoTransaction</deleteOption>
    </DeleteOptionalUserService>
  </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>
    <DeleteOptionalUserServiceResponse 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.

POST /adminportal/webservice.asmx HTTP/1.1
Host: demo.logisense.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Logisense_EngageIP/DeleteOptionalUserService"

<?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>
    <DeleteOptionalUserService xmlns="Logisense_EngageIP">
      <userServiceID>int</userServiceID>
      <deleteOption>ImmediatelyWithFullTransaction or ImmediatelyWithProratedTransaction or ImmediatelyWithNoTransaction</deleteOption>
    </DeleteOptionalUserService>
  </soap:Body>
</soap:Envelope>