SOAP API - UpdateUserStatusWithOption

UpdateUserStatusWithOption( username, userstatustypename, cancelopt, specificdate ) : void

Since: EngageIP v25.2

Changes a user's status or throws an exception if the user does not exist, or if the specific date is not supplied when CancelOption "SpecificDate" is supplied, or if the status type does not exist, or the user cannot have their status updated to the supplied value

Parameters:

username (String) - The username of the user to update. If the username does not exist an exception will be thrown.
userstatustypename (String) - Name of the status to be applied to the user. An exception will be thrown if the status cannot be found.
cancelopt (CancelOption) - An enumeration value representing cancel options of ImmediatelyWithFullTransaction or ImmediatelyWithProratedTransaction or ImmediatelyWithNoTransaction or PeriodEnd or SpecificDate
specificdate (DateTime) - The date when the User will be suspended. This must be supplied when CancelOption SpecificDate is selected

Possible Exceptions:

INVALID USERNAME
INVALID STATUS
INVALID DATE
CANNOT ASSIGN

Cancel Options:

ImmediatelyWithFullTransaction - cancel immediately but charge subscription fees for the full billing period
ImmediatelyWithProratedTransaction - cancel immediately and prorate any subscription fees
ImmediatelyWithNoTransaction - cancel immediately do not proate and do not charge fees
PeriodEnd - cancel at the end of the billing period
SpecificDate - cancel on the specified date

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>
    <UpdateUserStatusWithOption xmlns="Logisense_EngageIP">
      <username>string</username>
      <userstatustypename>string</userstatustypename>
      <cancelopt>ImmediatelyWithFullTransaction or ImmediatelyWithProratedTransaction or ImmediatelyWithNoTransaction or PeriodEnd or SpecificDate</cancelopt>
      <specificdate>dateTime</specificdate>
    </UpdateUserStatusWithOption>
  </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>
    <UpdateUserStatusWithOptionResponse 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/UpdateUserStatusWithOption"

<?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>
    <UpdateUserStatusWithOption xmlns="Logisense_EngageIP">
      <username>string</username>
      <userstatustypename>string</userstatustypename>
      <cancelopt>ImmediatelyWithFullTransaction or ImmediatelyWithProratedTransaction or ImmediatelyWithNoTransaction or PeriodEnd or SpecificDate</cancelopt>
      <specificdate>dateTime</specificdate>
    </UpdateUserStatusWithOption>
  </soap:Body>
</soap:Envelope>