User ObjectList XML Structure
The XML structure containing a list of users.
XML structure
<xs:schema id="ISHObjects-User" 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 -->
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="255"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="ishuserref" use="required">
<!-- Unique identifier of the user -->
<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="ISHUser"/>
</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
ishtypecan only contain 'ISHUser'. - The
levelattribute on theishfieldelement is always 'none' for a user.
Example
<ishobjects>
<ishobject ishref="VUSERELEFEVER" ishtype="ISHUser" ishuserref="4484">
<ishfields>
<ishfield name="USERNAME" level="none">elefever</ishfield>
<ishfield name="USERNAME" level="none" ishvaluetype="element">VUSERELEFEVER</ishfield>
<ishfield name="FISHUSERDISPLAYNAME" level="none">Erwin Lefever (elefever)</ishfield>
<ishfield name="FISHEMAIL" level="none">elefever@sdl.com</ishfield>
<ishfield name="FUSERGROUP" level="none">Default Department, Project team, Sales Marketing, System management</ishfield>
<ishfield name="FISHUSERROLES" level="none">Administrator</ishfield>
<ishfield name="FISHUSERROLES" level="none" ishvaluetype="element">VUSERROLEADMINISTRATOR</ishfield>
<ishfield name="FISHEXTERNALID" level="none>GLOBAL\elefever, TRIBE\erwinl</ishfield>
<ishfield name="FISHOBJECTACTIVE" level="none" ishvaluetype="element">TRUE</ishfield>
</ishfields>
</ishobject>
</ishobjects>