Cloud Fax and Notifications Account API 2.6 Documentation
GroupList
Cloud Fax and Notifications API Forums Home  
    prev  next        Table of Contents  GroupList  

15.3 GroupListResult

GroupList Overview   GroupListRequest

Tag Name
& type
#Description
GroupListResult   Namespace of this element is http://ws.easylink.com/GroupList/2015/05
   Status
StatusType
1Status of processing. See StatusType.
   SubmitId
xs:string
0-1Echoes the SubmitId in the request, if one was provided, and if possible.
   Entity
EntityType
0-1Entity information.
   EntityId
EntityIdType
1Entity Id.
   @type
EntityLevel
1May be "customer", "group" or "user".
   EntityName
EncodableStringType
0-1Entity name. See EncodableStringType.
If this Entity is a user (type="user"), then this will be the userid (for XDDS users), or the name associated with the user account (for F2M users).
   ParentEntityId
xs:long
0-1This will be the parent of the entity.
   GroupExtensions
ExtensionType
0-1These are the group extensions. See ExtensionType.
Currently, GroupExtensions are only returned for F2M user entities, and the properties returned may include:
  • faxNumber - the F2M fax number
  • emailAddress - the forwarding email address (usually the internet address alias)
  • groupName - usually empty for users
  • coverSheet - property element returned, but with no value
  • subjectLine - property element returned, but with no value
  • bodyText - property element returned, but with no value
  • faxFileName - property element returned, but with no value
  • userId - shows the User ID for the user entity
For user entities, the GroupExtensions may also contain an "Aliases" segment that shows the various aliases for that user. The alias type appears as the Property name attribute's value.

If the request specified UniqueMembers as true, then the faxNumber and emailAddress will not appear for a user entity, and the fax number and email addresses can be found as INBOUND_FAX and INTERNET values in the Aliases segment. Other Property values will only be returned if they have non-empty values.
   ChildEntity
EntityType
0-Child entity of this entity. Each ChildEntity will have the same structure as the Entity element. This means that the hierarchy is represented as nested elements.
 
    prev  next        Table of Contents  GroupList  
© Copyright 2020 OpenText Corp. All Rights Reserved.
Privacy Policy | Cookie Policy
This information is subject to change. Please check frequently for updates.
Modified October 06, 2020