ListGroupsNH

Top  Previous  Next

SOAP

ListGroupsNH( &aGroupListXML, &aErrorMsg );

 

REST

/ListGroupsNH

returns GroupListXML, ErrorMsg

 

Description: ListGroupsNH() Returns a list of all the user groups in the system as an XML Document.  No login handle is required. The list includes the names of the groups, their logos and logo background colors.

 

&aGroupListXML The resulting list of group names in XML format.  A typical file snippet might look like this:

<Groups>

  <Group Name="IA@DOT">

    <LoginLogo>IADOT.JPG</LoginLogo>

    <LoginLogoBgColor>#CC00CC</LoginLogoBgColor>

  </Group>

  <Group Name="CO@Denver">

    <LoginLogo>DenverCO.JPG</LoginLogo>

    <LoginLogoBgColor>#AA00CC</LoginLogoBgColor>

  </Group>

</Groups>

 

&aErrorMsg is populated only if an error occurred that prevented the function from succeeding.  Otherwise, this parameter is empty.

 

Example: ListGroupsNH( lListOfGroups, lErrorMsg );