Skip to end of metadata
Go to start of metadata

The following are the columns used in the data dictionary used to define the MLS data delivered in this dictionary.

Meta NameDescription
Added in Version
The Data Dictionary version (i.e. 1.4, 1.5, 1.6 etc.) where the field or lookup was added
BEDES
(Also referred to as 'BEDES Mapping') BEDES, Building Energy Data Exchange Specification, is a dictionary sponsored by the US Department of Energy to standardize information about high performing / efficient homes. It is intended to be used in tools and activities that help stakeholders make energy investment decisions, track building performance, and implement energy efficient policies and programs.

Certification Level

A Data Dictionary Certificate can be awarded to applicants achieving the pre-defined compliance levels. If a field/enumeration is part of the certification process then the Certification Level for which that field applies is so duly noted. More information on Certification Levels can be found on the Data Dictionary Certification section at reso.org.

Collection

A complex data type that references a collection or container of data items that have a shared relevance.  Collections can be lists, sets, queues, dictionaries, etc.  The common use in the RESO Dictionary is to show the relationship from a parent table, the location of the collection field, to a sub-table (child resource).
Field Name (Standard Name)
The only compliant name that represents the data point.
Field DefinitionThe written definition for the field.  May contain special rules that must be observed.
Field (Element) Status

Used for both fields and enumerations describes the state within the RESO Data Dictionary. The different values are listed directly below.

ActiveThe field or enumeration is available for use. The Element Status Change Date must reflect the date the field or enumeration became active.
DeprecatedThis gives notice that the field or enumeration in question is scheduled for deletion.  The Element Status Change Date must be in the future.  Once the date is reached, then this status is to be changed to Delete and the Element Status Change Date is unchanged.  The only exception is if the planed date of deletion changes, in which case this status remains unchanged and the Element Status Change Date is updated to reflect the new deletion date (in the future).
DeletedThe field or enumeration is no longer available for use.  The Element Status Change Date must reflect the date the field or enumeration's deletion was effective.
ProposedThe field or enumeration is under consideration and not available for use.  The Element Status Change Date must reflect the date the field or enumeration was originally proposed.
Group
A single designation identifying what category of fields to which the given field belongs.  For example 'ListingKey Field' will have the value: Property Resource, Listing Group.
Lookup
The name of the collection of Lookup Values (enumerations) applied to the given field. An empty value implies no lookup items have been defined for this field.
Lookup FieldID
Lookup Field (Enumeration) Identifier.  An integer used as a unique identifier for a given set of Lookup Values.
LookupID
Lookup Identifier.  An integer used as a unique identifier for a lookup value in the RESO Dictionary.
Lookup Status

Lookups pertains to a list of acceptable values and are also referred to as 'Enumerations'. Lookups (Enumerations) may not exceed 128 characters in length

Open with EnumerationsA Lookup (enumeration) list exists, but the list is still open and other values may be transmitted.  Additional items added must be reasonably relevant to the definition of the given field.
Locked with EnumerationsA Lookup (enumeration) exists and is finite.  No other values may be used.
OpenNo Lookup (enumeration) list exists and any relevant value may be transmitted. Lookups sent must be reasonably relevant to the definition of the given field.
Open (to be Locked)No Lookup (enumeration) list exists and any relevant value may be transmitted. It is expected that the list will be finalized and locked. Lookups sent must be reasonably relevant to the definition of the given field.  Lookups should also be sent to the RESO Dictionary workgroup to be included in the eventual locked list.


Lookup Value
A single unique lookup item (value can be any alpha-numeric character set) within a set of lookup values.
Lookup Field or Values
A list of lookup values (also known an enumerated values) that apply to a given field. State is a lookup field that has lookup value entries for each state.
Original Entry Date
The date the field or lookup was added to the Data Dictionary (not yet implemented)
Modification Timestamp (Page Revision Date)The modification timestamp is displayed on the footer of each page with a field header of 'Page Revision Date' and applies to any change to any column in the dictionary will received a date/time entry representing when the change was made in the dictionary.  This is not when the decision was made by the BOD or workgroup, but rather the action of applying that decision into the dictionary.
Payloads
Any number of fields representing the payloads found in RESO transports.  The listed payloads if used must be adhered to, but the list of payloads is extensible.  When a payload is called by the client, the client may also select additional fields to be included.
Property Type

The field will only apply to items within the 'Property' resource. Possible values are listed below.

RESIThe Residential property type.  This class is used to represent dwellings that are for sale.  Some examples are Single Family Residence, Condominium, etc.
RLSEThe Residential Lease, aka Rental, property type.  This class is used to represent dwellings that are for lease.  Some examples are Single Family Residence, Apartments, etc.
RINCThe Residential Income, a.k.a. Multi-Family, property type.  This class is used to represent multi-family dwellings that are for sale.  Some examples are duplex, triplex, fourplex and apartments. Legally this property type represents 2 to 4 unit properties, but some MLSs allow more than 4 units.
LANDThe Land property type.  This class is used to represent Lots and Land that are for sale.
MOBIThe Mobile property type.  This class is used to represent mobile homes.
FARMThe Farm property type.  This class s used to represent either commercial or residential farms.
COMSThe Commercial Sale property Type.  This class represents commercial and industrial properties that are for sale.
COMLThe Commercial Lease property Type.  This class represents commercial and industrial properties that are for lease.
BUSOThe Business Opportunity property type.  This class represents businesses that are for sale and may not include real property.
RecordID
Record Identifier.  An integer used as a unique identifier for the fields in the RESO Dictionary.
References
A reference to another resource/field related to the current page where the field or lookup value is utilized.
Repeating Element?
A 'Yes' value will mean the corresponding Field Name includes "[type]" indicating this may be repeated and will include a defining string that indicates the instance of the repeated element. Such that Room[type]Features becomes RoomKitchenFeatures and refers to the Features of the Kitchen.
Revised Date
The date a substantive change was made to the field or enumeration.  This is the date the change was decided upon by the BOD or workgroup and not the modification timestamp representing when the change was applied to the dictionary. 
Simple Data Type

A particular kind of data item, as defined by the values it can take

StringA free text or sting field.
String List, SingleA fixed list of values where only one value may be transmitted.
String List, MultiA fixed list of values where multiple values may be transmitted in a fashion dictated by the RESO Transport currently in use.
DateA date field that is typically input by a member reflecting a date something occurred in the process of business, rather than when the change was made in the MLS system. Specific date formats will be defined by the utilized transport (i.e. RETS 1x, Web API) and should follow common date standards as summarized by W3C Date and Time Formats.
TimestampA date and time field that is typically the date and time when a change was made in the MLS system. Specific timestamp formats will be defined by the utilized transport (i.e. RETS 1x, Web API) and should follow common date standards as summarized by W3C Date and Time Formats .
NumberA number, may be an integer or decimal which is defined in the data length.  Check Suggested Max Length to differentiate Integer from Decimal.
BooleanA logical true/false indicator which is expressed per the given RESO transport specification in use.  This field may be nulled.


Sug. Max Length
The suggested maximum length of the given field.  Suggested maximum lengths are optional at this time, but are strongly recommended when a source MLS system is considering a metadata change.  This field also determines integer from decimal.  For example, "2" is an integer with a length of two places.  6.2 is a decimal with two places to the right of the decimal and 4 places to the left of the decimal. Integers are allowed one extra character to allow for a plus or minus "+/-" character.
Sug. Max Precision
(DD 1.5) The suggested maximum precision is the optional maximum number of decimal places allowed on a number.  This field determines integer from decimal.  For example, "2" is an integer with a length of two places.  The suggested maximum precision length is from a "business rules" perspective.  Given that RETS 1.x conveys everything as a string, decimals are allowed have two additional characters beyond the stated suggested maximum length.  This is to allow for the decimal character, ".", and a plus or minus, "+/-" character that may be present in a RETS 1.x transmission. 
Status Change Date
(Also referred to as 'Element Status Change Date'). The date as dictated by the rules of the Element Status field (Field Status or Lookup Status).  See those definitions for specific instruction on the population of this field.  This is the date of the workgroup or BOD decision and not the modification timestamp in the Dictionary.
Synonym(s)
Another name for the given field having the same meaning. Synonyms are for reference only and must not be used in any RETS 1x implementation.  It is only a reference as an aid to mapping and understanding.


Page Revision Date: May 08 2017

  • No labels