@realestate/types/RESODataDictionaryV1_7/ObjectIdType.d.ts

Types for real estate

/**
 * Copyright (c) 2023 ListBird. All Rights Reserved.
 *
 * This software product includes software or other works developed by RESO,
 * subject to the RESO End User License published at www.reso.org.
 *
 * Any modifications, derivative works, or redistributions of this source must
 * maintain this copyright notice. See the RESO EULA for more information.
 */

export enum ObjectIdType {
  /**
   * The ObjectID is the MLS listing number
   */
  Listingid = 'Listingid',

  /**
   * The Object is a key field from an MLS system.
   */
  Listingkey = 'Listingkey',

  /**
   * The Object is a numeric key field from an MLS system.
   */
  Listingkeynumeric = 'Listingkeynumeric',

  /**
   * The ObjectID is an Open House ID
   */
  Openhouseid = 'Openhouseid',

  /**
   * The ObjectID is the key of an Open House record.
   */
  Openhousekey = 'Openhousekey',

  /**
   * The ObjectID is the numeric only key of an Open House record.
   */
  Openhousekeynumeric = 'Openhousekeynumeric',

  /**
   * When no listing exists or the tracking is property centric, the ObjectIdType of the property's Parcel
   * Number is used.
   */
  Parcelnumber = 'Parcelnumber',

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/PUID}
   *
   * When no listing exists and the tracking property centric, the RESO PUID is being used.
   */
  Puid = 'Puid',

  /**
   * When the event is the execution of a saved search, the ObjectID will be the SavedSearchKey or
   * SavedSearchKeyNumeric from the system that executed the search. Individual listings from the result set
   * or being viewed would be separate events for each record.
   */
  Savedsearchkey = 'Savedsearchkey',

  /**
   * When the event is the execution of a saved search, the ObjectID will be the SavedSearchKey or
   * SavedSearchKeyNumeric from the system that executed the search. Individual listings from the result set
   * or being viewed would be separate events for each record.
   */
  Savedsearchkeynumeric = 'Savedsearchkeynumeric',

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/Unique}
   *
   * The ObjectID is a unique ID supplied by the source and is not one of the other types…
   */
  Unique = 'Unique',
}