You can get information about a group by sending the GET request to the following URL: /group/<group_id>.
Permission to run the request: Account Owner, Administrator, Organization Administrator, Publisher.
Parameter | Description |
---|
X-Auth-Account-Url (required) | Base URL of the account, e.g. http://myaccount.ispringlearn.com |
X-Auth-Email (required) | Administrator e-mail address. |
X-Auth-Password (required) | Administrator password. |
After the request has been completed, the system returns the response with Code 200. The body of the response contains an xml file with group info.
Possible Response Codes
Code | Text | Description |
---|
404 | Unknown group | The group was not found. For Organization Admins, the group is not within their organization. |
200 | Ok | The request has been processed successfully. |
Sample Request
GET /group/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"?>
<group>
<groupId>1</groupId>
<name>group name</name>
<description>description</description>
<users>
<id>1</id>
<id>2</id>
</users>
</group>
XML