Getting User Info

You can obtain information about a user with the getUserProfile method.

Parameters

Parameter Type Description
credentials (required) credentials Read the description of the Credentials object.
userId (required) string ID of a user, whose information you want to get.

Return Value

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

Parameter Type Description
userId string ID of the specified user.
email string E-mail address of the specified user.
name string Name of the specified user.
country string Country of the specified user.
postalCode string Postal Code of the specified user.
city string City of the specified user.
state string State of the specified user.
cellPhone string Cell phone number of the specified user.
phone string Phone number of the specified user.
fax string Fax number of the specified user.
address1 string First address line of the specified user.
address2 string Second address line of the specified user.
groups string[] An array of group IDs, to which a given user belongs.

Possible Errors

Error Description
unknown user a user 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>
    <GetUserProfileRequest 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>
      <UserID>1</UserID>
    </GetUserProfileRequest>
  </soap:Body>
</soap:Envelope>

Sample Response

<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>
    <GetUserProfileResult xmlns="http://www.articulate-online.com/services/api/1.0/">
      <UserProfile>
        <UserId>string</UserId>
        <Email>string</Email>
        <Name>string</Name>
        <Country>string</Country>
        <PostalCode>string</PostalCode>
        <City>string</City>
        <State>string</State>
        <Phone>string</Phone>
        <Fax>string</Fax>
        <Cell>string</Cell>
        <AddressLine1>string</AddressLine1>
        <AddressLine2>string</AddressLine2>
        <Groups>
          <id>1</id>
          <id>2</id>
        </Groups>
      </UserProfile>
    </GetUserProfileResult>
  </soap:Body>
</soap:Envelope>