Authorization token required | true |
Admin Authorization token required | true |
<GetDistributionListRequest [limit="{limit} (Integer)"] [offset="{starting-offset} (Integer)"]
[sortAscending="{sort-ascending} (0|1)"] [attrs="{request-attrs}"]> ## GetDistributionListRequest
<dl [by="{dl-selector-by} (id | name)"]>{key}</dl> ## DistributionListSelector
</GetDistributionListRequest>
elements and attributes you can define within a
<GetDistributionListRequest>
element:
XPath | Required / Optional | Description |
@limit | Optional (0 or 1) | Type: Integer The maximum number of accounts to return (0 is default and means all) |
@offset | Optional (0 or 1) | Type: Integer The starting offset (0, 25 etc) |
@sortAscending | Optional (0 or 1) | Type: 0|1 Flag whether to sort in ascending order 1 (true) is the default |
@attrs | Optional (0 or 1) | Type: String Comma separated list of attributes |
/dl | Optional (0 or 1) | Type: {key} Distribution List Description for element text content:The key used to identify the distribution list. Meaning determined by {dl-selector-by} |
/dl@by | Optional (0 or 1) | Type: id | name Select the meaning of {dl-selector-key} |
<GetDistributionListResponse [more="{more-flag} (0|1)"] [total="{total-members} (Integer)"]> ## GetDistributionListResponse
<dl [dynamic="{dl-is-dynamic} (0|1)"] name="{name}" id="{id}"> ## DistributionListInfo
(<dlm>{members} (String)</dlm>)*
<owners>
(<owner [type="{grantee-type} (usr | grp | egp | all | dom | edom | gst | key | pub | email)"]
id="{grantee-id}" name="{grantee-name}" /> ## GranteeInfo)*
</owners>
(<a n="{key}" /> ## Attr)*
</dl>
</GetDistributionListResponse>
elements and attributes you can define within a
<GetDistributionListResponse>
element:
XPath | Required / Optional | Description |
@more | Optional (0 or 1) | Type: 0|1 1 (true) if more mailboxes left to return Only present if the list of members is given |
@total | Optional (0 or 1) | Type: Integer Total number of members (not affected by limit/offset) Only present if the list of members is given |
/dl | Optional (0 or 1) | Information about distribution list |
/dl@dynamic | Optional (0 or 1) | Type: 0|1 Flags whether this is a dynamic distribution list 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) dl-members |
/dl/owners | Required (only 1) | |
/dl/owners/owner | Optional (0 or more) | |
/dl/owners/owner@type | Optional (0 or 1) | Type: usr | grp | egp | all | dom | edom | gst | key | pub | email Grantee type |
/dl/owners/owner@id | Required (only 1) | Type: String Grantee ID |
/dl/owners/owner@name | Required (only 1) | Type: String Grantee name |
/dl/a | Optional (0 or more) | Attributes |
/dl/a@n | Required (only 1) | Type: String Key |