Data Dictionary Terms and Meta Definitions

Added in Version

The Data Dictionary version (i.e., 1.6, 1.7, 2.0) in which 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.

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.

Definition

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

Display Name

The suggested name of a given field for display purposes. 

Field

Fields are contained within resources and are the descriptions of the listing components themselves. Examples of fields are ListPrice, Appliances and YearBuilt.

French-Canadian Lookup Value

The French-Canadian equivalent of Standard Lookup Value.

French-Canadian Display Name

The French-Canadian equivalent of Display Name.

Group

A single designation identifying what category of fields to which the given field belongs. For example, "ListingKey" field has the value of Property Resource, Listing Group.

Legacy OData Value

A single unique lookup item within a set of lookup values within a lookup field that can be any alpha-numeric character set. This is the OData-friendly value for those who use that method of transport should use. It will be deprecated in later versions of the Data Dictionary and Web API Core endorsements.

Lookup

Lookups are the options within certain fields. For example, within the Appliances field, there are lookups such as Dishwasher, Gas Oven and Dryer.

Lookup ID

A unique identifier for a singular lookup value.

Lookup Name

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

Lookup Name ID

A unique identifier for a given set of lookup values (aka enumerations).

Lookup Status

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

Open with Enumerations: A lookup 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 exists and is finite. No other values may be used.

Open: No lookup 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 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.

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 Types

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

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.

Resource

Resources are at the top level of the data structure in the Data Dictionary. They are high-level groupings of like concepts, such as property information, information related to a member of an organization and information related to a real estate office, which are labeled in the dictionary as Property Resource, Member Resource and Office Resource. Think of them as the categories of the items contained within it. Groups and lookups relate back to resources.

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

Spanish Lookup Value

The Spanish equivalent of Standard Lookup Value.

Spanish Display Name

The Spanish equivalent of Display Name.

Standard Lookup Value

The RESO-compliant name of a lookup value.

Standard Lookup Values
(View expandable list.)

A list of lookups that apply to a given Lookup Name. For example, StateOrProvince is a lookup field that has lookup value entries for each state. Note that when a value is a repeat name of another value, the name of the Lookup Name is included after the value in parentheses.

Standard Name

The RESO-compliant name of a field in any of RESO's resources.

Status Change Date

This is the date of the RESO Board of Directors or Data Dictionary Workgroup decision and not the modification timestamp in the dictionary.

Suggested Maximum Length

The suggested maximum length of a given field. This remains optional but is strongly recommended when a source MLS system is considering a metadata change.

Suggested Maximum Precision

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.

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.