Deleting a Group

You can delete a group with the deleteGroup 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 delete.

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 deleted.

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>
    <DeleteGroupRequest 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>
    </DeleteGroupRequest>
  </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>
    <DeleteGroupResult xmlns="http://www.articulate-online.com/services/api/1.0/">
      <Success>True</Success>
    </DeleteGroupResult>
  </soap:Body>
</soap:Envelope>