SOAP API - GetUserStatus

GetUserStatus( username ) : Object

Since: EngageIP v25.2

Returns a user's status, or throws an exception if the user does not exist.

This method returns an object representing the Status of the user. The status object has the following properties:

ID (Integer) - Unique ID for the status
Name (String) - The name of the status
OwnerID (Integer) - ID of the user who owns this status
StatusTypeID (Integer) - ID of the associated status type
ImageURL (String) - URL to an image that represents this status
ShowInAccountStatistics (Boolean) - Indicates if the user is included in calculation indicating active, cancelled and recent accounts found on the left side-bar of Admin Portal.

Parameters:

username (String) - The username for whom to retrieve the status. If the username does not exist an exception will be thrown.

Returns:

An Object representing the status of the user

Possible Exceptions:

INVALID USERNAME

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>
    <GetUserStatus xmlns="Logisense_EngageIP">
      <username>string</username>
    </GetUserStatus>
  </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>
    <GetUserStatusResponse xmlns="Logisense_EngageIP">
      <GetUserStatusResult>
        <Validate />
        <ID>int</ID>
        <Name>string</Name>
        <OwnerID>int</OwnerID>
        <StatusTypeID>int</StatusTypeID>
        <ImageURL>string</ImageURL>
        <ShowInAccountStatistics>boolean</ShowInAccountStatistics>
      </GetUserStatusResult>
    </GetUserStatusResponse>
  </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/GetUserStatus"

<?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>
    <GetUserStatus xmlns="Logisense_EngageIP">
      <username>string</username>
    </GetUserStatus>
  </soap:Body>
</soap:Envelope>