SOAP API - GetChildren

GetChildren( username ) : ViewChild[]

Since: EngageIP v25.2

Returns the list of a user's child accounts or throws an exception if the user does not exist.

The returned value from this method call is an array of ViewChild objects. A view child object consists of the following properties:

User (String) - The user name of the child account
UserID (Integer) - The ID of the user this object represents
Parent_UserID (Integer) - The ID of this user's parent account
ID (Integer) - The unique ID for this user's account
UserStatus (String) -The name of the user status type defined by your company's business logic each will have an underlying status type consistent with EngageIP's four base status types
CurrentStatus (String) - Account status as defined by EngageIP's four base status types of Active, Canceled, Prospect and Suspended

Parameters:

username (String) - The user for whom to retrieve a list of child users. An exception will be thrown if the username does not exist.

Returns:

An array of ViewChild objects representing the child accounts for the specified user name.

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>
    <GetChildren xmlns="Logisense_EngageIP">
      <username>string</username>
    </GetChildren>
  </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>
    <GetChildrenResponse xmlns="Logisense_EngageIP">
      <GetChildrenResult>
        <ViewChild>
          <User>string</User>
          <UserID>int</UserID>
          <Parent_UserID>int</Parent_UserID>
          <ID>int</ID>
          <UserStatus>string</UserStatus>
          <CurrentStatus>string</CurrentStatus>
        </ViewChild>
        <ViewChild>
          <User>string</User>
          <UserID>int</UserID>
          <Parent_UserID>int</Parent_UserID>
          <ID>int</ID>
          <UserStatus>string</UserStatus>
          <CurrentStatus>string</CurrentStatus>
        </ViewChild>
      </GetChildrenResult>
    </GetChildrenResponse>
  </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/GetChildren"

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