GetChannelACL
Retrieves the ACL of the specified channel.
Request schema
<xsd:complexType name="GetChannelACL">
<xsd:sequence>
<xsd:choice>
<xsd:element name="ChannelName" type="xsd:string"/>
<xsd:element name="ChannelId" type="xsd:string"/>
</xsd:choice>
<xsd:choice minOccurs="0">
<xsd:element name="GrantedUserId" type="xsd:string"
minOccurs="0"/>
<xsd:element name="GrantedUserName" type="xsd:string"
minOccurs="0"/>
<xsd:element name="GrantedRoleId" type="xsd:string"
minOccurs="0"/>
<xsd:element name="GrantedRoleName" type="xsd:string"
minOccurs="0"/>
</xsd:choice>
<xsd:element name="FetchSize" type="xsd:int"
minOccurs="0"/>
<xsd:element name="FetchDirection" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="CountLimit" type="xsd:int"
minOccurs="0"/>
<xsd:element name="FetchHandle" type="xsd:string"
minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Request elements
ChannelName
The name of the channel for which to retrieve the ACL. Specify either ChannelName or ChannelId.
ChannelId
The ID of the channel for which to retrieve the ACL. Specify either ChannelId or ChannelName.
GrantedUserId
The user ID. Specify either GrantedUserId or GrantedUserName.
GrantedUserName
The user name. Specify either GrantedUserName or GrantedUserId.
GrantedRoleId
The role ID. Specify either GrantedRoleId or GrantedRoleName.
GrantedRoleName
The role name. Specify either GrantedRoleName or GrantedRoleId.
FetchSize
The maximum number of records to retrieve and return in a result set. The default value is 500.
FetchDirection
If True, records are retrieved forward. If False, records are retrieved backward. The default value is True.
CountLimit
The maximum number of records to count. By default, CountLimit is equal to FetchSize. To count all records, set CountLimit to ‑1.
FetchHandle
Retrieves more items from the result set. In the second and subsequent calls for data, specify the same search criteria as in the original call.
Response schema
<xsd:complexType name="GetChannelACLResponse">
<xsd:sequence>
<xsd:element name="ACL" type="typens:ArrayOfPermission"
minOccurs="0"/>
<xsd:element name="FetchHandle" type="xsd:string"
minOccurs="0"/>
<xsd:element name="TotalCount" type="xsd:int" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Response elements
ACL
The ACL of the channel.
FetchHandle
Indicates that the number of items in the result set exceeds the FetchSize limit.
TotalCount
The number of entries in the search result set.