SOAP API - GetAvailableStatuses

GetAvailableStatuses( ownerID ) : UserStatusType[]

Since: EngageIP v25.2

Returns the list of user status types for the specified owner ID

When this method returns you will receive an array of UserStatusType. A UserStatusType has the following properties

ID (Integer) : The ID of the status type
Name (String) : Name of the status type
OwnerID (Integer) : The owner ID for which this status belongs
StatusTypeID (Integer) : Underlying type of status this status represents. There are a set of specific status types in Engage IP that have meaning. You are able to create new names of status types, but they all must be one of the root status types in the system. This field represents the root status type that this one is derrived from.
ImageURL (String) : A URL that can specify an image to display when a status is applied
ShowInAccountStatistics (Boolean) : Whether or not this status appears in the account side bar showing statistics

Parameters:

ownerID (Integer) - The ID of the owner to retrieve status types. An exception will be thrown if the owner ID does not exist.

Returns:

An array of UserStatusType objects.

Possible Exceptions:

INVALID OWNER

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>
    <GetAvailableStatuses xmlns="Logisense_EngageIP">
      <ownerID>int</ownerID>
    </GetAvailableStatuses>
  </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>
    <GetAvailableStatusesResponse xmlns="Logisense_EngageIP">
      <GetAvailableStatusesResult>
        <UserStatusType>
          <Validate />
          <ID>int</ID>
          <Name>string</Name>
          <OwnerID>int</OwnerID>
          <StatusTypeID>int</StatusTypeID>
          <ImageURL>string</ImageURL>
          <ShowInAccountStatistics>boolean</ShowInAccountStatistics>
        </UserStatusType>
        <UserStatusType>
          <Validate />
          <ID>int</ID>
          <Name>string</Name>
          <OwnerID>int</OwnerID>
          <StatusTypeID>int</StatusTypeID>
          <ImageURL>string</ImageURL>
          <ShowInAccountStatistics>boolean</ShowInAccountStatistics>
        </UserStatusType>
      </GetAvailableStatusesResult>
    </GetAvailableStatusesResponse>
  </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/GetAvailableStatuses"

<?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>
    <GetAvailableStatuses xmlns="Logisense_EngageIP">
      <ownerID>int</ownerID>
    </GetAvailableStatuses>
  </soap:Body>
</soap:Envelope>