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

You can add a group by sending the POST 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.
X-Name (required)A name of the new group.
X-Description (optional)A description of the new group.

After the request has been completed, the system returns the response with Code 201. The body of the response contains ID of the added group.

Possible Response Codes

CodeTextDescription
400Bad RequestThe system failed to process the request, because it did not contain all necessary parameters.
403Duplicated group nameA group with the specified name already exists.
201CreatedA new group has been added.

 

Sample Request

POST /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
X
-Name: New group
X
-Description: description

Sample Response

HTTP/1.1 201 Created
Server: nginx
Connection: close

<group_id>
  •