Data Dictionary Terms and Meta Definitions

Added in Version

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

BEDES

Building Energy Data Exchange Specification (BEDES) is a dictionary sponsored by the 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. Also referred to as BEDES Mapping.

Certification Level

A Data Dictionary certificate can be awarded to applicants achieving predefined compliance levels. If a field/enumeration is part of the certification process, then the certification level for which that field applies is noted. 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 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).

Field Name (Standard Name)

The only compliant name that represents the data point.

Field Definition

The written definition for the field. May contain special rules that must be observed.

Element Status

Used for both fields and lookup values (e.g., enumerations) 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: 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 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).

Deleted: The 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.

Proposed: The 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 Field ID

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 Data Dictionary.

Lookup Status

Pertains to a list of acceptable values (enumerations). Lookups (enumerations) may not exceed 128 characters in length.

Open with Enumerations: A lookup (enumeration) list exists, but the list is still open and other values may be transmitted. Added items must be reasonably relevant to the definition of the given field.

Locked with Enumerations: A lookup (enumeration) exists and is finite. No other values may be used.

Open: No lookup (enumeration) list exists, and any relevant value may be transmitted. Sent Lookups 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. Sent Lookups must be reasonably relevant to the definition of the given field. Lookups should also be sent to the RESO Data 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 within a lookup field.

Lookup Field or Values

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

Original Entry Date

The date the field or lookup was added to the Data Dictionary (not yet implemented).

Modification Timestamp

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 Data Dictionary. The change will receive a date/time entry representing when the change was made. This is not when the decision was made by the RESO Board of Directors or Data Dictionary 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

This field will only apply to items within the Property Resource. Possible values are listed below.

RESI: Residential property type. This class is used to represent dwellings that are for sale. Examples include Single-Family Residential, Condominium, Townhome, etc.

RLSE: Residential Lease (Rental) property type. This class is used to represent dwellings that are for lease. Examples include Single-Family Residential, Apartment, etc.

RINC: Residential Income (Multifamily) property type. This class is used to represent multifamily dwellings that are for sale. 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: Land property type. This class is used to represent lots and land that are for sale.

MOBI: Mobile property type. This class is used to represent mobile homes.

FARM: Farm property type. This class is used to represent either commercial or residential farms.

COMS: Commercial Sale property type. This class represents commercial and industrial properties that are for sale.

COML: Commercial Lease property type. This class represents commercial and industrial properties that are for lease.

BUSO: Business Opportunity property type. This class represents businesses that are for sale and may not include real property.

Record ID

An integer used as a unique identifier for the fields in the RESO Data 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 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 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 RESO Board of Directors or Data Dictionary 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.

Boolean: A logical true/false indicator expressed per the given RESO transport specification in use. This field may be nulled.

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 Data Dictionary is to show the relationship from a parent table (the location of the collection field) to a sub-table (child resource).

Date: A 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., RESO Web API) and should follow common date standards as summarized by W3C Date and Time Formats.

Number: A number may be an integer or decimal defined in the data length. Check Suggested Max Length to differentiate integer from decimal.

String: A free text or string field.

String List, Single: A fixed list of values where only one value may be transmitted.

String List, Multi: A fixed list of values where multiple values may be transmitted in a fashion dictated by the transport currently in use.

Timestamp: A 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., RESO Web API) and should follow common date standards as summarized by W3C Date and Time Formats.

Spanish Lookup Fields and Values

The Spanish equivalent of Lookup Field or Values. See above.

Spanish (Standard Name)

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

Sug. Max Length

The suggested maximum length of a given field. Optional at this time but 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.

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 RESO Board of Directors or Data Dictionary Workgroup decision and not the modification timestamp in the 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 as an aid to data mapping and general understanding.