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

You can get the list of groups by sending the GET request to the following URL: /group.

Request Headers

ParameterDescription
X-Auth-Account-Url (required)Base URL of the account, e.g. http://myaccount.ispringlearn.com
X-Auth-Email (required)Administrator/Publisher e-mail address.
X-Auth-Password (required)Administrator/Publisher 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 information about the groups.

Possible Response Codes

CodeTextDescription
200OkThe request has been processed successfully.

 

Sample Request

GET /group HTTP/1.1
Host: api.ispringonline.com
X
-Auth-Account-Url: http://myaccount.ispringonline.com
X
-Auth-Email: email@email.com
X
-Auth-Password: password

Sample Response

HTTP/1.1 200 OK
Server: nginx
Connection: close

<?xml version="1.0" encoding="utf-8"?>
<groups>
 
<group>
   
<groupId>1</groupId>
    <name>group name</
name>
   
<description>description</description>
    <users>
      <id>1</
id>
     
<id>2</id>
    </
users>
 
</group>
  <group>
    …
  </
group>
</groups>
  •