Definition Type: Element
Name: Fields
Namespace: http://rets.org/xsd/RETSSystem/2007-08
Containing Schema: DataDictionary.xsd
MinOccurs (1)
MaxOccurs (1)
Abstract
Collapse XSD Schema Diagram:
Drilldown into Field in schema datadictionary_xsd Drilldown into modificationTimestamp in schema datadictionary_xsd Drilldown into version in schema datadictionary_xsd Drilldown into isgSecurityClass in schema primitives_xsdXSD Diagram of Fields in schema datadictionary_xsd (Real Estate Transaction Standard (RETS))
Collapse XSD Schema Code:
<xs:element name="Fields">
    <xs:complexType>
        <xs:sequence>
            <xs:element name="Field" minOccurs="0" maxOccurs="unbounded">
                <xs:complexType>
                    <xs:sequence>
                        <xs:element name="MetaEntryId" type="xs:string">
                            <xs:annotation>
                                <xs:documentation>
												A value that never changes as long
												as the semantic definition of this
												field remains unchanged. In
												particular, it should be managed
												to allow the client to detect
												changes to the name.
											</xs:documentation>
                                <xs:appinfo>
												uid789987979
											</xs:appinfo>
                            </xs:annotation>
                        </xs:element>
                        <xs:element name="LongName" type="xs:string" minOccurs="1">
                            <xs:annotation>
                                <xs:documentation>
												The name of this field as it is
												known to the user. This is a
												localized, human-readable string.
												Use of this element is
												implementation defined; it is
												expected that clients will use
												this value as the title for this
												datum when it appears on a report.
											</xs:documentation>
                                <xs:appinfo>
												Listing Price
											</xs:appinfo>
                            </xs:annotation>
                        </xs:element>
                        <xs:element name="ShortName" type="xs:string" minOccurs="1">
                            <xs:annotation>
                                <xs:documentation>
												An abbreviated field name that is
												also localized and human-readable.
												Use of this field is
												implementation defined. It is
												expected that clients will use
												this field in human-interface
												elements such as field labels and
												pick lists.
											</xs:documentation>
                                <xs:appinfo>
												ListPrice
											</xs:appinfo>
                            </xs:annotation>
                        </xs:element>
                        <xs:element name="Description" type="xs:string" minOccurs="0" />
                        <xs:element name="MaximumLength" type="xs:long" minOccurs="0">
                            <xs:annotation>
                                <xs:documentation>
												The maximum length of the field,
												in characters. For numeric fields,
												this is the display length rather
												than the storage length and
												includes all formatting such as
												the sign, decimal point, commas or
												other information. Numeric fields
												include Currency, Number,
												UnsignedNumber and Decimal.
											</xs:documentation>
                                <xs:appinfo>
												24
											</xs:appinfo>
                            </xs:annotation>
                        </xs:element>
                        <xs:element name="DataType" type="sys:DataTypeList">
                            <xs:annotation>
                                <xs:documentation>
												A value defined in the
												DataTypeList above
											</xs:documentation>
                                <xs:appinfo>
												Decimal
											</xs:appinfo>
                            </xs:annotation>
                        </xs:element>
                        <xs:element name="Precision" type="xs:decimal" minOccurs="0">
                            <xs:annotation>
                                <xs:documentation>
												The number of digits to the right
												of the decimal mark when
												formatted.
											</xs:documentation>
                                <xs:appinfo>
												3
											</xs:appinfo>
                            </xs:annotation>
                        </xs:element>
                        <xs:element name="Alignment" type="sys:Alignment" minOccurs="0">
                            <xs:annotation>
                                <xs:documentation>
												A display hint that MAY be used to
												provide text justification in
												applications.
											</xs:documentation>
                                <xs:appinfo>
												Left
											</xs:appinfo>
                            </xs:annotation>
                        </xs:element>
                        <xs:element name="UseSeparator" type="xs:boolean" minOccurs="0">
                            <xs:annotation>
                                <xs:documentation>
												A boolean value that indicates
												that the numeric value MAY be
												displayed with a thousands
												separator.
											</xs:documentation>
                                <xs:appinfo>
												true
											</xs:appinfo>
                            </xs:annotation>
                        </xs:element>
                        <xs:element name="Units" type="xs:boolean" minOccurs="0">
                            <xs:annotation>
                                <!-- +++ PS this appears to be
											defined wrong. -->
                                <xs:documentation>
												+++
											</xs:documentation>
                                <xs:appinfo>
                                </xs:appinfo>
                            </xs:annotation>
                        </xs:element>
                        <xs:element name="IsSearchable" type="xs:boolean" minOccurs="0">
                            <xs:annotation>
                                <xs:documentation>
												A boolean indicator that this
												field is searchable. If absent,
												applications should assume true.
											</xs:documentation>
                                <xs:appinfo>
												true
											</xs:appinfo>
                            </xs:annotation>
                        </xs:element>
                        <xs:element name="IsUnique" type="xs:boolean" minOccurs="0">
                            <xs:annotation>
                                <xs:documentation>
												A boolean indicator that indicates
												that this field is a unique
												identifier for the record in which
												it appears.	If absent,
												applications should assume true.
											</xs:documentation>
                                <xs:appinfo>
												false
											</xs:appinfo>
                            </xs:annotation>
                        </xs:element>
                        <xs:element name="LookupName" type="xs:string" minOccurs="0">
                            <xs:annotation>
                                <xs:documentation>
												The name of the METADATA-LOOKUP
												containing the lookup data for
												this field. This element is
												required when the data
												type is either "Lookup" or
												"LookupMulti".
											</xs:documentation>
                                <xs:appinfo>
                                </xs:appinfo>
                            </xs:annotation>
                        </xs:element>
                        <xs:element name="Charset" type="xs:string" minOccurs="0">
                            <xs:annotation>
                                <xs:documentation>
												The native character set for
												representing the datum.
												See the IANA Character set
												registry.

												Most systems will respond with
												either
												US-ASCII
												or
												ANSI_X3.4-1986
											</xs:documentation>
                                <xs:appinfo>
												US-ASCII
											</xs:appinfo>
                            </xs:annotation>
                        </xs:element>
                        <xs:element name="Locale" type="xs:string" minOccurs="0">
                            <xs:annotation>
                                <xs:documentation>
												The locale that the datum is
												represented. This may result in
												different display formats for
												numbers, decimal separators,
												thousands separators, date
												formating and time formating.

												Most systems will respond with
												en-US
											</xs:documentation>
                                <xs:appinfo>
												en-US
											</xs:appinfo>
                            </xs:annotation>
                        </xs:element>
                        <xs:any namespace="##other" minOccurs="0" maxOccurs="unbounded" />
                    </xs:sequence>
                    <xs:attribute name="modificationTimestamp" type="xs:dateTime" use="required">
                    </xs:attribute>
                </xs:complexType>
            </xs:element>
        </xs:sequence>
        <xs:attribute ref="commons:isgSecurityClass" use="required">
            <xs:annotation>
                <xs:documentation>
								The security class of this field, from the NAR
								information security guidelines security
								class, defined in Primitives.xsd
							</xs:documentation>
                <xs:appinfo>
								Public
							</xs:appinfo>
            </xs:annotation>
        </xs:attribute>
        <xs:attribute name="version" type="xs:anyURI" use="required">
            <xs:annotation>
                <xs:documentation>
								The URI changes when the data dictionary is
								not backwards compatible to the previous
								version. 
							</xs:documentation>
                <xs:appinfo>
								http://rets.org/xsd/DataDictionary/2007-08
							</xs:appinfo>
            </xs:annotation>
        </xs:attribute>
        <xs:attribute name="modificationTimestamp" type="xs:dateTime" use="required">
            <xs:annotation>
                <xs:documentation>
								The modificationTimestamp changes anytime the
								data dictionary has been modified. 
								Must match the modificationTimestamp for the
								most recently changed Field.
							</xs:documentation>
                <xs:appinfo>
								2007-04-01T03:00:23Z
							</xs:appinfo>
            </xs:annotation>
        </xs:attribute>
    </xs:complexType>
</xs:element>
Collapse Child Elements:
Name Type Min Occurs Max Occurs
Field sys:Field 0 unbounded
Collapse Child Attributes:
Name Type Default Value Use
isgSecurityClass commons:isgSecurityClass Required
version sys:version Required
modificationTimestamp sys:modificationTimestamp Required