SelectRoles
Searches roles for specified information.
To search a single role, specify Name or Id. To search a list of roles, specify NameList or IdList. To search roles matching the specified conditions, specify Search.
Request schema
<xsd:complexType="SelectRoles">
<xsd:sequence>
<xsd:element name="ResultDef" type="typens:ArrayOfString"/>
<xsd:choice>
<xsd:element name="Search" type="typens:RoleSearch"/>
<xsd:element name="IdList" type="typens:ArrayOfString"/>
<xsd:element name="NameList" type="typens:ArrayOfString"/>
<xsd:element name="Id" type="xsd:string"/> <xsd:element name="Name" type="xsd:string"/>
</xsd:choice>
</xsd:sequence>
</xsd:complexType>
Request elements
ResultDef
The properties to retrieve.
Search
The search conditions. If conditions apply to multiple fields, use ConditionArray. When using RSSE external registration, SelectRoles allows only one search condition within the Search element.
In the following example, <Condition> and <AssignedToUserName> are search conditions:
<Search>
<Condition>
<Field>Name</Field>
<Match>roleA</Match>
</Condition>
<ConditionArray xsi:nil="true"/>
<ParentRoleName xsi:nil="true"/>
<ChildRoleName xsi:nil="true"/>
<WithRightsToChannelName xsi:nil="true"/>
<AssignedToUserName>Administrator</AssignedToUserName>
<ParentRoleId xsi:nil="true"/>
<ChildRoleId xsi:nil="true"/>
<WithRightsToChannelId xsi:nil="true"/>
<AssignedToUserId xsi:nil="true"/>
</Search>
When using RSSE external registration, the previous search pattern is invalid, generating the following response:
<Description>
<Message>The search pattern is too long or is incorrect.
</Message>
<Parameter1>More than one search condition is invalid under
External Registration</Parameter1>
</Description>
IdList
The list of role IDs to search. Specify either IdList or NameList.
NameList
The list of role names to search. Specify either NameList or IdList.
Id
The ID of the single role to search. Specify either Id or Name.
Name
The name of the single role to search. Specify either Name or Id
Response schema
<xsd:complexType name="SelectRolesResponse">
<xsd:sequence>
<xsd:element name="Roles" type="typens:ArrayOfRole"/>
<xsd:element name="FetchHandle" type="xsd:string"
minOccurs="0"/>
<xsd:element name="TotalCount" type="xsd:long"
minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Response elements
Roles
The selected roles.
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.