| Authorization token required | true |
| Admin Authorization token required | false |
<GetDistributionListRequest [needOwners="(0|1)"] [needRights="..."]> ## GetDistributionListRequest
<dl by="{dl-selector-by} (id | name)">{key}</dl> ## DistributionListSelector
(<a name="{attr-name}" [pd="{attr-perm-denied} (0|1)"]>{value}</a> ## Attr)*
</GetDistributionListRequest>
elements and attributes you can define within a
<GetDistributionListRequest> element:
| XPath | Required / Optional | Description |
| @needOwners | Optional (0 or 1) | Type: 0|1 Whether to return owners, default is 0 (i.e. Don't return owners) |
| @needRights | Optional (0 or 1) | Type: String return grants for the specified (comma-seperated) rights. e.g. needRights="sendToDistList,viewDistList" |
| /dl | Required (only 1) | Type: {key} Specify the distribution list Description for element text content:The key used to identify the account. Meaning determined by {dl-selector-by} |
| /dl@by | Required (only 1) | Type: id | name Select the meaning of {dl-selector-key} |
| /a | Optional (0 or more) | Type: {value} Attributes Description for element text content:Value of attribute |
| /a@name | Required (only 1) | Type: String Name of attribute |
| /a@pd | Optional (0 or 1) | Type: 0|1 Flags whether permission has been denied (optional). If 1 (true), flags that the real value of this attribute has not been provided. The value is set to "" |
<GetDistributionListResponse> ## GetDistributionListResponse
<dl [isOwner="{isOwner} (0|1)"] [isMember="{isMember} (0|1)"] [dynamic="{dl-is-dynamic} (0|1)"]
name="{object-name}" id="{object-id}"> ## DistributionListInfo
(<dlm>{members} (String)</dlm>)*
<owners>
(<owner type="{dl-grantee-type} (usr | grp | egp | all | dom | edom | gst | key | pub | email)"
id="{dl-owner-or-grantee-id}" name="{dl-owner-or-grantee-name}" /> ## DistributionListGranteeInfo)*
</owners>
<rights>
(<right right="..."> ## DistributionListRightInfo
(<grantee ... /> ## See /dl/owners/owner [ ## DistributionListGranteeInfo])*
</right>)*
</rights>
(<a n="{key}">{value}</a> ## KeyValuePair)*
</dl>
</GetDistributionListResponse>
elements and attributes you can define within a
<GetDistributionListResponse> element:
| XPath | Required / Optional | Description | ||||||||
| /dl | Optional (0 or 1) | Distribution list | ||||||||
| /dl@isOwner | Optional (0 or 1) | Type: 0|1 Flags whether user is the owner of the group. Only returned if ownerOf on the request is 1 (true) |
||||||||
| /dl@isMember | Optional (0 or 1) | Type: 0|1 Flags whether user is a member of the group. Only returned if memberOf on the request is 1 (true) |
||||||||
| /dl@dynamic | Optional (0 or 1) | Type: 0|1 Flags whether the group is dynamic or not |
||||||||
| /dl@name | Required (only 1) | Type: String Name |
||||||||
| /dl@id | Required (only 1) | Type: String ID |
||||||||
| /dl/dlm | Optional (0 or more) | Type: {members} (String) Group members |
||||||||
| /dl/owners | Required (only 1) | |||||||||
| /dl/owners/owner | Optional (0 or more) | |||||||||
| /dl/owners/owner@type | Required (only 1) | Type: usr | grp | egp | all | dom | edom | gst | key | pub | email Grantee Type.
|
||||||||
| /dl/owners/owner@id | Required (only 1) | Type: String ID of owner of grantee |
||||||||
| /dl/owners/owner@name | Required (only 1) | Type: String Name of owner of grantee |
||||||||
| /dl/rights | Required (only 1) | |||||||||
| /dl/rights/right | Optional (0 or more) | |||||||||
| /dl/rights/right@right | Required (only 1) | Type: String Right |
||||||||
| /dl/rights/right/grantee | Optional (0 or more) | Grantees
See /dl/owners/owner for more details. |
||||||||
| /dl/a | Optional (0 or more) | Type: {value} Attributes Description for element text content:Value |
||||||||
| /dl/a@n | Required (only 1) | Type: String Key |