You can add a group with the createGroup method.
Parameters
| Parameter |
Type |
Description |
| credentials (required) |
credentials |
Read the description of the Credentials object. |
| name (required) |
string |
Name of the new group. |
| description (optional) |
string |
Description of the new group. |
Return Value
After the request has been completed, the system
returns an object with the following properties.
| Parameter |
Type |
Description |
| groupId |
string |
ID of the added group. |
Possible Errors
| Error |
Description |
| duplicated group name |
A group with a given name already exists. |
Sample Call
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<CreateGroupRequest xmlns="http://www.articulate-online.com/services/api/1.0/">
<Credentials>
<AccountUrl>http://myaccount.ispringonline.com</EmailAddress>
<Email>email@email.com</Password>
<Password>password</Password>
</Credentials>
<Name>group name</Name>
<Description>description</Description>
</CreateGroupRequest>
</soap:Body>
</soap:Envelope>
Sample Response
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<CreateGroupResult xmlns="http://www.articulate-online.com/services/api/1.0/">
<GroupId>string</GroupId>
</CreateGroupResult>
</soap:Body>
</soap:Envelope>