Page tree
Skip to end of metadata
Go to start of metadata

You can get information about a group in the account by sending the GET request to the following URL: /group/{group_id}.

Permissions to run the request: Account OwnerAdministratorsDepartment Administrators or users with a role with custom settings

Request Headers

Parameter

Description

X-Auth-Account-Url (required)The base URL of the account, e.g. http://myaccount.ispringlearn.com.
X-Auth-Email (required)The login of Account OwnerAdministratorDepartment Administrator or a user with a role with custom settings. 
X-Auth-Password (required)The login of Account OwnerAdministratorDepartment Administrator or a user with a role with custom settings. 
group_id (required)The ID of a group you would like to get info on.

After the request has been completed, the system returns the response with the 200 code. The response code contains XML info on the group.

Response Codes

Code

Text

Description

200Successful operation

The request was successfully processed.

400Bad RequestA request error.
401UnauthorizedAn authorization error.
403Permission Denied

The user doesn't have enough permissions to get information on the group.

Sample Request

GET /group/b1496214-acab-11e9-8db0-120a62f268a9 HTTP/1.1
Host: api-learn.ispringlearn.com
X-Auth-Account-Url: http://myaccount.ispringlearn.com
X-Auth-Email: email@email.com
X-Auth-Password: password

Sample Response

HTTP/1.1 200 Successful operation
Connection: close

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <group>
        <usersCount>1</usersCount>
        <userIds/>
        <groupId>6b2d3e10-e043-11e9-8511-0a580af40b37</groupId>
        <name>New Hire</name>
        <isSmart>0</isSmart>
    </group>
</response>


  • No labels