Getting Group Info

You can get information about a group with the getGroupInformation method.

Parameters

Parameter Type Description
credentials (required) credentials Read the description of the Credentials object.
groupId (required) string ID of the group, which information you want to get.

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 group.
name string Name of the group.
description string Description of the group.
users string[] An array with IDs of those users, who belong to a given group.

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