Getting User List

You can obtain the list of users with the getUsers method.

Parameters

Parameter Type Description
credentials (required) credentials Read the description of the Credentials object.
groupId (optional) string When specified, this method selects users belonging to a given group.

Return Value

After the request has been completed, the system returns an object with the following properties:

Parameter Type Description
users UserProfile[] An array of user profiles. The UserProfile object has the same properties as in the getUserProfile method.

Possible Errors

Error Description
unknown group A group with a given ID cannot be found.

Sample Call

<?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:Body>
    <GetUsersRequest xmlns="http://www.articulate-online.com/services/api/1.0/">
      <Credentials>
        <AccountUrl>http://myaccount.ispringonline.com</EmailAddress>
        <Email>email@email.com</Password>
        <Password>password</Password>
      </Credentials>
    </GetUsersRequest>
    <GroupId>1</GroupId>
  </soap:Body>
</soap:Envelope>

Sample Response

<?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:Body>
    <GetUsersResult xmlns="http://www.articulate-online.com/services/api/1.0/">
      <UserProfile>
        <UserId>string</UserId>
        <Email>string</Email>
        …
      </UserProfile>
      <UserProfile>
        <UserId>string</UserId>
        <Email>string</Email>
        …
      </UserProfile>
    </GetUsersResult>
  </soap:Body>
</soap:Envelope>