You can obtain information about a user by sending the GET request to the following URL: /user/<user_id>.
Permission to run the request: Account Owner, Administrator, Organization Administrator.
Parameter | Description |
---|
X-Auth-Account-Url (required) | Base URL of the account, e.g. http://myaccount.ispringlearn.com |
X-Auth-Email (required) | Administrator/Organization Administrator e-mail address. |
X-Auth-Password (required) | Administrator/Organization Administrator password. |
After the request has been completed, the system returns the response with Code 200. The body of the response will contain xml data with user info.
Possible Response Codes
Code | Text | Description |
---|
404 | Unknown User | User with the specified ID was not found. |
403 | Permission denied | Authorized user does not have enough permissions to request user info. |
200 | Ok | The request has been processed successfully. |
Sample Request
GET /user/1 HTTP/1.1
Host: api.ispringonline.com
X-Auth-Account-Url: http://myaccount.ispringlearn.com
X-Auth-Email: email@email.com
X-Auth-Password: password
XML
Sample Response
HTTP/1.1 200 OK
Connection: close
<?xml version="1.0" encoding="UTF-8"?>
<userProfile>
<userId>1</userId>
<status>1</status>
<role>publisher</role>
<organizationId>2</organizationId>
<deactivationDate>2017-11-29</deactivationDate>
<groups>
<id>3</id>
...
</groups>
<fields>
<login>user</login>
<first_name>name</first_name>
<last_name>lastname<last_name/>
<email>user@email.com</email>
<country_id><country_id/>
<USER_COY>774</USER_COY>
<EMP_CODE>EMP009</EMP_CODE>
...
</fields>
</userProfile>
XML
The <deactivationDate/> value will be included in the response only if a deactivation date was previously set for a user.