Getting Group List

You can get the list of groups with the getGroups method.

Parameters

Parameter Type Description
credentials (required) credentials Read the description of the Credentials object.

Return Value

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

Parameter Type Description
groups group[] An array of groups. The Group object has the same properties as in the getGroupInformation method.

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