Documentation Center

UserRole ObjectList XML Structure

The XML structure containing a list of user roles.

XML structure

<xs:schema id="ISHObjects-UserRole" elementFormDefault="qualified"  xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="ishobjects">
    <xs:complexType>
      <xs:sequence minOccurs="0" maxOccurs="unbounded">
        <xs:element ref="ishobject"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="ishobject">
    <xs:complexType>
      <xs:choice>
        <xs:element ref="ishfields" minOccurs="1" maxOccurs="1"/>
      </xs:choice>
      <xs:attribute name="ishref" use="required">
        <!-- The element name of the user role -->
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:maxLength value="255"/>
          </xs:restriction>
        </xs:simpleType>
      </xs:attribute>
      <xs:attribute name="ishuserroleref" use="required">
        <!-- Unique identifier of the user role -->
        <xs:simpleType>
          <xs:restriction base="xs:long">
            <xs:minInclusive value="0"/>
            <xs:maxInclusive value="9999999999"/>
          </xs:restriction>
        </xs:simpleType>
      </xs:attribute>
      <xs:attribute name="ishtype" use="required">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:enumeration value="ISHUserRole"/>
          </xs:restriction>
        </xs:simpleType>
      </xs:attribute>
    </xs:complexType>
  </xs:element>
  <xs:element name="ishfields">
    <xs:complexType>
      <xs:sequence minOccurs="0" maxOccurs="unbounded">
        <xs:element ref="ishfield"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="ishfield">
    <xs:complexType>
      <xs:simpleContent>
        <xs:extension base="xs:string">
          <xs:attribute name="name" use="required">
            <xs:simpleType>
              <xs:restriction base="xs:string">
                <xs:maxLength value="255"/>
              </xs:restriction>
            </xs:simpleType>
          </xs:attribute>
          <xs:attribute name="level" use="required">
            <xs:simpleType>
              <xs:restriction base="xs:string">
                <xs:enumeration value="none"/>
              </xs:restriction>
            </xs:simpleType>
          </xs:attribute>
          <xs:attribute name="ishvaluetype" use="optional">
          	<xs:simpleType>
              <xs:restriction base="xs:string">
                <xs:enumeration value=""/>
                <xs:enumeration value="value"/>
                <xs:enumeration value="element"/>
	                <xs:enumeration value="id"/>
              </xs:restriction>
            </xs:simpleType>
        </xs:extension>
      </xs:simpleContent>
    </xs:complexType>
  </xs:element> 
</xs:schema>

Remarks:

  • Currently the ishtype can only contain 'ISHUserRole'.
  • The level attribute on the ishfield element is always 'none' for a user role.

Example


<ishobjects>
  <ishobject ishref="VUSERROLEADMINISTRATOR" ishtype="ISHUserRole" ishuserroleref="359933">
    <ishfields>
      <ishfield name="FISHUSERROLENAME" level="none">Administrator</ishfield>
      <ishfield name="FISHUSERROLENAME" level="none" ishvaluetype="element">VUSERROLEADMINISTRATOR</ishfield>
      <ishfield name="NAME" level="none">Administrator</ishfield>
      <ishfield name="CREATED-ON" level="none">20/04/2011 09:24:02</ishfield>
      <ishfield name="MODIFIED-ON" level="none"></ishfield>
      <ishfield name="FDESCRIPTION" level="none"></ishfield>
      <ishfield name="FISHOBJECTACTIVE" level="none">Yes</ishfield>
      <ishfield name="FISHOBJECTACTIVE" level="none" ishvaluetype="element">TRUE</ishfield>
    </ishfields>
  </ishobject>
  <ishobject ishref="VUSERROLEAUTHOR" ishtype="ISHUserRole" ishuserroleref="359934">
    <ishfields>
      <ishfield name="FISHUSERROLENAME" level="none">Author</ishfield>
      <ishfield name="FISHUSERROLENAME" level="none" ishvaluetype="element">VUSERROLEAUTHOR</ishfield>
      <ishfield name="NAME" level="none">Author</ishfield>
      <ishfield name="CREATED-ON" level="none">20/04/2011 09:24:02</ishfield>
      <ishfield name="MODIFIED-ON" level="none"></ishfield>
      <ishfield name="FDESCRIPTION" level="none"></ishfield>
      <ishfield name="FISHOBJECTACTIVE" level="none">Yes</ishfield>
      <ishfield name="FISHOBJECTACTIVE" level="none" ishvaluetype="element">TRUE</ishfield>
    </ishfields>
  </ishobject >
</ishobjects>