Updating a Group

You can update a group with the updateGroup method.

Parameters

Parameter Type Description
credentials (required) credentials Read the description of the Credentials object.
groupId (required) string ID of the group that you want to update.
name (required) string A name of the specified group.
description (required) string A description of the specified group.
users (optional) string[] An array of user IDs to be added to the group.

Return Value

After the request has been completed, the system returns an object with the following properties.

Parameter Type Description
success bool True, if the group has been updated.
excessUsers string An array of IDs of users, who haven't been added to the group.

Possible Errors

Error Description
duplicated group name A group with this name already exists.
unknown group A group with this name hasn't been found.

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>
    <UpdateGroupRequest 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>
      <GroupID>string</GroupID>
      <Name>string</Name>
      <Description>string</Description>
      <Users>
        <id>1</id>
        <id>2</id>
      </Users>
    </UpdateGroupRequest>
  </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>
    <UpdateGroupResult xmlns="http://www.articulate-online.com/services/api/1.0/">
      <success>true</success>
      <excessUsers />
    </UpdateGroupResult>
  </soap:Body>
</soap:Envelope>