Share via

2.2.3.6 Roles

  • Article

The Roles element contains information about how to grant access permissions to users. This element is defined as follows:

 <xs:element name="Roles">
     <xs:complexType>
       <xs:sequence>
         <xs:choice>
           <xs:element ref="tns:Error"/>
           <xs:sequence>
             <xs:element name="Role" maxOccurs="unbounded">
               <xs:complexType>
                 <xs:attribute name="Name" type="xs:string"
                               use="required"/>
                 <xs:attribute name="Type" type="tns:RoleType"
                               use="required"/>
                 <xs:attribute name="Description" type="xs:string"
                               use="required"/>
               </xs:complexType>
             </xs:element>
           </xs:sequence>
         </xs:choice>
       </xs:sequence>
     </xs:complexType>
   </xs:element>

Error: Specifies that an error has occurred while accessing the Roles data. The error codes are described in the following table.

Error code

Description

NoAccess

Authenticated user does not have sufficient permissions to access role information for the Document Workspace.

ServerFailure

Protocol server encountered an unspecified error.

Role: Returns the information about a single role.

Name: Returns the friendly name of a role.

Type: Returns the type of role.

Description: Returns a general description of the role.