Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The following are the columns used in the data dictionary used to These items define the MLS data delivered in this dictionaryversion of the RESO Data Dictionary.

Meta Name

Description

AnchorDDVersionAddedDDVersionAdded

Added in Version

The Data Dictionary version (i.e., 1.6, 1.7, 1.8) where the field or lookup was added.
Anchor

BEDES

BEDESBEDES(Also referred to as 'BEDES Mapping') BEDES,
Building Energy Data Exchange Specification
,
(BEDES) is a dictionary sponsored by the
US
U.S. 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 efficiency policies and programs.
AnchorCertificationLevelCertificationLevel
Also referred to as BEDES Mapping.

Certification Level

A Data Dictionary
Certificate
certificate can be awarded to applicants achieving
the pre-defined
predefined compliance levels. If a field/enumeration is part of the certification process, then the
Certification Level
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. AnchorCollectionCollection

Collection

As of Data Dictionary 1.7, the metallic levels – Bronze, Silver, Gold, Platinum – have been retired in favor of a newly established Core level.

Collection

A complex data type that references a collection or container of data items that have a shared relevance.
 Collections
Collections can be lists, sets, queues, dictionaries, etc.
 The
The common use in the RESO Data Dictionary is to show the relationship from a parent table
,
(the location of the collection field
,
) to a sub-table (child resource).
AnchorFieldNameFieldNameField Name

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.
AnchorElementStatusElementStatus

Element Status

Used for both fields and lookup values (e.g., enumerations)

which describes

that describe the state within the RESO Data Dictionary. The different values are listed directly below.

Active

The field or enumeration is available for use. The Element Status Change Date must reflect the date the field or enumeration became active.
Deprecated
This gives notice that the
The field or enumeration in question is scheduled for deletion.
  The
 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 planned 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
 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
 The Element Status Change Date must reflect the date the field or enumeration was originally proposed.
Anchor

Group

GroupGroup
A single designation identifying what category of fields to which the given field belongs.
  For
 For example
'
, "ListingKey Field
' Property
" will have the value
:
 Property Resource, Listing Group.
AnchorLookup

Lookup

Lookup
The name of the collection of
Lookup Values
lookup values (enumerations) applied to the given field. An empty value implies no lookup items have been defined for this field.
AnchorLookupFieldIDLookupFieldID

Lookup FieldID

Lookup Field (Enumeration) Identifier.
 An
An integer used as a unique identifier for a given set of
Lookup Values
lookup values.
Anchor

LookupID

LookupIDLookupID
Lookup Identifier.
  An
 An integer used as a unique identifier for a lookup value in the RESO Data Dictionary.
AnchorEnumerationStatusEnumerationStatus

Lookup Status

Lookups pertains

Pertains to a list of acceptable values

and are also referred to as 'Enumerations'

(enumerations). Lookups (

Enumerations

enumerations) may not exceed 128 characters in length.

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



Lookup Value

A single unique lookup item (value can be any alpha-numeric character set) within a set of lookup values within a lookup field.
AnchorLookupValuesLookupValues
Lookup Field or ValuesA list of lookup values (also known as enumerated values) that apply to a given lookup field. For example, State is a lookup field that has lookup value entries for each state.
AnchorOriginalEntryTimestampOriginalEntryTimestamp
Original Entry DateThe 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
Data Dictionary. The change will receive 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
RESO Board of Directors or Data Dictionary Workgroup, but rather the action of applying that decision into the dictionary.
Anchor

Payloads

PayloadsPayloads
Any number of fields representing the payloads found in RESO transports.
  The
 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.
AnchorPropertyTypesPropertyTypes

Property Type

The

This field will only apply to items within the

'

Property

' resource

Resource. Possible values are listed below.

RESI
The
Residential property type.
 
This class is used to represent dwellings that are for sale.
  Some examples are Single Family Residence
Examples include Single-Family Residential, Condominium, Townhome, etc.
RLSE
The
Residential Lease
, aka
(Rental
,
) property type.
  This
 This class is used to represent dwellings that are for lease.
  Some examples are Single Family Residence, Apartments
Examples include Single-Family Residential, Apartment, etc.
RINC
The
Residential Income
, a.k.a. Multi-Family,
(Multifamily) property type.
 
This class is used to represent
multi-family
multifamily dwellings that are for sale.
  Some examples are duplex, triplex, fourplex, and apartments. Legally
 Examples include Duplex, Triplex, Fourplex and Apartment. Legally, this property type represents 2- to 4-unit properties, but some MLSs allow more than 4 units.
LAND
The
Land property type.
  This
 This class is used to represent
Lots
lots and
Land
land that are for sale.
MOBI
The
Mobile property type.
 
This class is used to represent mobile homes.
FARM
The
Farm property type.
  This
 This class
s
is used to represent either commercial or residential farms.
COMS
The
Commercial Sale Property Type.
  This
 This class represents commercial and industrial properties that are for sale.
COML
The
Commercial Lease Property Type.
  This
 This class represents commercial and industrial properties that are for lease.
BUSO
The
Business Opportunity property type.
  This
 This class represents businesses that are for sale and may not include real property.
Anchor

RecordID

RecordIDRecordID
Record Identifier.
 
An integer used as a unique identifier for the fields in the RESO Data Dictionary.
Anchor

References

ReferencesReferences
A reference to another resource/field related to the current page where the field or lookup value is utilized.
AnchorRepeatingElementRepeatingElement

Repeating Element?

A
'
"Yes
'
" value
will mean
means 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
such that Room[type]Features becomes RoomKitchenFeatures and refers to the
Features
features of the
Kitchen
kitchen.
AnchorRevisedDateRevisedDate

Revised Date

The date a substantive change was made to the field or enumeration.
 This
This is the date the change was decided upon by the
BOD or workgroup
RESO Board of Directors or Data Dictionary Workgroup and not the modification timestamp representing when the change was applied to the dictionary. 
AnchorSimpleDataTypeSimpleDataType

Simple Data Type

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

BooleanA logical true/false indicator
which is
expressed per the given RESO transport specification in use.
 
This field may be nulled.
CollectionA 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 Data Dictionary is to show the relationship from a parent table
,
(the location of the collection field
,
) to a sub-table (child resource).
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
, RESO Web API) and should follow common date standards as summarized
by
by W3C Date and Time Formats.
NumberA number may be an integer or decimal
which is
defined in the data length.
 Check
Check Suggested Max Length to differentiate
Integer
integer from
Decimal
decimal.
StringA free text or string 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
transport currently in use.
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
, RESO Web API) and should follow common date standards as summarized
by
 
.
AnchorSpanishLookupValuesSpanishLookupValues

Spanish Lookup Fields and Values

The Spanish equivalent
to the columns
of Lookup Field or
Lookup
Values. See above.
AnchorSpanishStdNameSpanishStdName

Spanish


(Standard Name)

The Spanish equivalent to the
column
column Field Name (Standard Name). See above.
AnchorSugMaxLengthSugMaxLength

Sug. Max Length

The suggested maximum length of
the
a given field.
 Suggested maximum lengths are optional
Optional at this time
,
but
are
strongly recommended when a source MLS system is considering a metadata change.
 This
This field also determines integer from decimal.
 For
For example, "2" is
an
an integer
with
 with a length of two places
.
; 6.2 is
a
decimal
with
 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.
AnchorSugMaxPrecisionSugMaxPrecisionSug. 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.  AnchorStatusChangeDateStatusChangeDate

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
 or Lookup Status).
 See
See those definitions for specific instruction on the population of this field.
 This
This is the date of the
workgroup or BOD decision
RESO Board of Directors or Data Dictionary Workgroup decision and not the modification timestamp in the
Dictionary. AnchorSynonymsSynonyms
dictionary. Also known as Element Status Change Date.

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 data mapping and general understanding.


Page Revision Date: Oct 29 2018 AnchorBottomAnchorBottomAnchorNovember 19, 2020.