@realestate/types/RESODataDictionaryV1_7/Showing.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.
 */
import { Property } from './Property';
import { OUID } from './OUID';
import { Member } from './Member';
import { HistoryTransactional } from './HistoryTransactional';
import { SocialMedia } from './SocialMedia';
import { Media } from './Media';
export interface Showing {
  /**
   * {@link https://ddwiki.reso.org/display/DDW17/AgentOriginatingSystemID+Field}
   *
   * The RESO OUID's OrganizationUniqueId of the Originating record provider. The Originating system is the
   * system with authoritative control over the record. For example; the name of the MLS where the listing
   * was input. In cases where the Originating system was not where the record was retrieved, see the Source
   * System fields.
   */
  AgentOriginatingSystemID?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/AgentOriginatingSystemName+Field}
   *
   * The name of the Originating record provider. Most commonly the name of the MLS. The place where the
   * listing is originally input by the member. The legal name of the company. In cases where the Originating
   * system was not where the record was retrieved, see hte Source System fields.
   */
  AgentOriginatingSystemName?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/AgentSourceSystemID+Field}
   *
   * The RESO OUID's OrganizationUniqueId of the Source record provider. The source system is the system from
   * which the record was directly received. In cases where the source system was not where the record
   * originated (the authoritative system), see the Originating System fields.
   */
  AgentSourceSystemID?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/AgentSourceSystemName+Field}
   *
   * The name of the immediate record provider. The system from which the record was directly received. The
   * legal name of the company. In cases where the source system was not where the record originated (the
   * authoritative system), see the Originating System fields.
   */
  AgentSourceSystemName?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ListingId+%28Showing%29+Field}
   *
   * The well known identifier for the listing being shown. The value may be identical to that of the Listing
   * Key, but the Listing ID is intended to be the value used by a human to retrieve the information about a
   * specific listing. In a multiple originating system or a merged system, this value may not be unique and
   * may require the use of the provider system to create a synthetic unique value.
   */
  ListingId?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ListingKey+%28Showing%29+Field}
   *
   * A unique identifier for this record. This is a string that can include URI or other forms. Alternatively
   * use the ListingKeyNumeric for a numeric only key field. This is the local key of the system. When
   * records are received from other systems, a local key is commonly applied. If conveying the original keys
   * from the source or originating systems, see SourceSystemKey and OriginatingSystemKey.
   */
  ListingKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ListingKeyNumeric+%28Showing%29+Field}
   *
   * A unique identifier for this record. This is the numeric only key and used as an alternative to the
   * ListingKey fields. This is the local key of the system. When records are received from other systems, a
   * local key is commonly applied. If conveying the original keys from the source or originating systems,
   * see SourceSystemKey and OriginatingSystemKey.
   */
  ListingKeyNumeric?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ListingOriginatingSystemID+Field}
   *
   * The RESO OUID's OrganizationUniqueId of the Originating record provider. The Originating system is the
   * system with authoritative control over the record. For example; the name of the MLS where the listing
   * was input. In cases where the Originating system was not where the record was retrieved, see the Source
   * System fields.
   */
  ListingOriginatingSystemID?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ListingOriginatingSystemName+Field}
   *
   * The name of the Originating record provider. Most commonly the name of the MLS. The place where the
   * listing is originally input by the member. The legal name of the company. In cases where the Originating
   * system was not where the record was retrieved, see the Source System fields.
   */
  ListingOriginatingSystemName?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ListingSourceSystemID+Field}
   *
   * The RESO OUID's OrganizationUniqueId of the Source record provider. The source system is the system from
   * which the record was directly received. In cases where the source system was not where the record
   * originated (the authoritative system), see the Originating System fields.
   */
  ListingSourceSystemID?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ListingSourceSystemName+Field}
   *
   * The name of the immediate record provider. The system from which the record was directly received. The
   * legal name of the company. In cases where the source system was not where the record originated (the
   * authoritative system), see the Originating System fields
   */
  ListingSourceSystemName?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ModificationTimestamp+%28Showing%29+Field}
   *
   * The transactional timestamp automatically recorded by the system representing the date/time the Showing
   * record was last modified.
   */
  ModificationTimestamp?: Date;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OriginalEntryTimestamp+%28Showing%29+Field}
   *
   * The transactional timestamp automatically recorded by the system representing the date/time the Showing
   * record was entered and made visible to members of the system.
   */
  OriginalEntryTimestamp?: Date;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OriginatingSystemAgentKey+Field}
   *
   * The system key, a unique record identifier, from the Originating system. The Originating system is the
   * system with authoritative control over the record. For example, the Multiple Listing Service where the
   * member was input. There may be cases where the Source System (how you received the record) is not the
   * Originating System. See Source System Key for more information.
   */
  OriginatingSystemAgentKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OriginatingSystemListingKey+Field}
   *
   * The system key, a unique record identifier, from the Originating system. The Originating system is the
   * system with authoritative control over the record. For example, the Multiple Listing Service where the
   * member was input. There may be cases where the Source System (how you received the record) is not the
   * Originating System. See Source System Key for more information.
   */
  OriginatingSystemListingKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OriginatingSystemShowingKey+Field}
   *
   * The system key, a unique record identifier, from the Originating system. The Originating system is the
   * system with authoritative control over the record. For example, the Multiple Listing Service where the
   * member was input. There may be cases where the Source System (how you received the record) is not the
   * Originating System. See Source System Key for more information.
   */
  OriginatingSystemShowingKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ShowingAgentKey+%28Showing%29+Field}
   *
   * A system unique identifier of the member who has scheduled to access the property. Specifically, in
   * aggregation systems, the ListAgentKey is the system unique identifier from the system that the record was
   * retrieved. This may be identical to the related xxxId. This is a foreign key relating to the Member
   * resource's MemberKey.
   */
  ShowingAgentKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ShowingAgentKeyNumeric+%28Showing%29+Field}
   *
   * A system unique identifier of the member who has scheduled to access the property. Specifically, in
   * aggregation systems, the ListAgentKey is the system unique identifier from the system that the record was
   * retrieved. This may be identical to the related xxxId. This is a foreign key relating to the Member
   * resource's MemberKey. This is the numeric only key and used as an alternative to the ShowingAgentKey
   * field.
   */
  ShowingAgentKeyNumeric?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ShowingAgentMlsID+%28Showing%29+Field}
   *
   * The local, well-known identifier for the member who has scheduled to access the property, most commonly
   * representing a buyer. This value may not be unique, specifically in the case of aggregation systems, this
   * value should be the identifier from the original system.
   */
  ShowingAgentMlsID?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ShowingEndTimestamp+Field}
   *
   * The date and time the showing ends. Where other timestamps are typically stored in UTC, showing start and
   * end date/times are typically stored in the local time zone of the property being showed.
   */
  ShowingEndTimestamp?: Date;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ShowingId+Field}
   *
   * The well-known identifier for the showing record. The value may be identical to that of the ShowingKey,
   * but the ShowingID is intended to be the value used by a human to retrieve the information about a
   * specific showing. In a multiple originating system or a merged system, this value may not be unique and
   * may require the use of the provider system to create a synthetic unique value.
   */
  ShowingId?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ShowingKey+Field}
   *
   * A unique identifier for this record from the immediate source. This is a string that can include URI or
   * other forms. Alternatively use the ShowingKeyNumeric for a numeric only key field. This is the local
   * key of the system. When records are received from other systems, a local key is commonly applied. If
   * conveying the original keys from the source or originating systems, see SourceSystemKey and
   * OriginatingSystemKey.
   */
  ShowingKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ShowingKeyNumeric+Field}
   *
   * A unique identifier for this record from the immediate source. This is the numeric only key and used as
   * an alternative to the ShowingKey field. This is the local key of the system. When records are received
   * from other systems, a local key is commonly applied. If conveying the original keys from the source or
   * originating systems, see SourceSystemKey and OriginatingSystemKey.
   */
  ShowingKeyNumeric?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ShowingOriginatingSystemID+Field}
   *
   * The RESO OUID's OrganizationUniqueId of the Originating record provider. The Originating system is the
   * system with authoritative control over the record. For example; the name of the MLS where the listing
   * was input. In cases where the Originating system was not where the record originated (the authoritative
   * system), see the Originating System fields.
   */
  ShowingOriginatingSystemID?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ShowingOriginatingSystemName+Field}
   *
   * The name of the Originating record provider. Most commonly the name of the MLS. The place where the
   * listing is originally input by the member. The legal name of the company.
   */
  ShowingOriginatingSystemName?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ShowingRequestedTimestamp+Field}
   *
   * The date/time when the showing agent submitted their request to access the property. This is a system
   * timestamp normally generated by a showing system, which is commonly the Originating System for showing
   * records.
   */
  ShowingRequestedTimestamp?: Date;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ShowingSourceSystemID+Field}
   *
   * The RESO OUID's OrganizationUniqueId of the Source record provider. The source system is the system from
   * which the record was directly received. In cases where the source system was not where the record
   * originated (the authoritative system), see the Originating System fields.
   */
  ShowingSourceSystemID?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ShowingSourceSystemName+Field}
   *
   * The name of the immediate record provider. The system from which the record was directly received. The
   * legal name of the company.
   */
  ShowingSourceSystemName?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ShowingStartTimestamp+Field}
   *
   * The date and time the showing begins. Where other timestamps are typically stored in UTC, showing start
   * and end date/times are typically stored in the local time zone of the property being showed.
   */
  ShowingStartTimestamp?: Date;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/SourceSystemAgentKey+Field}
   *
   * The system key, a unique record identifier, from the Source System. The Source System is the system from
   * which the record was directly received. In cases where the Source System was not where the record
   * originated (the authoritative system), see the Originating System fields.
   */
  SourceSystemAgentKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/SourceSystemListingKey+Field}
   *
   * The system key, a unique record identifier, from the Source System. The Source System is the system from
   * which the record was directly received. In cases where the Source System was not where the record
   * originated (the authoritative system), see the Originating System fields.
   */
  SourceSystemListingKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/SourceSystemShowingKey+Field}
   *
   * The system key, a unique record identifier, from the Source System. The Source System is the system from
   * which the record was directly received. In cases where the Source System was not where the record
   * originated (the authoritative system), see the Originating System fields.
   */
  SourceSystemShowingKey?: string;

  AgentOriginatingSystem?: OUID;
  AgentSourceSystem?: OUID;
  ShowingAgent?: Member;
  Listing?: Property;
  ListingOriginatingSystem?: OUID;
  ListingSourceSystem?: OUID;
  ShowingOriginatingSystem?: OUID;
  ShowingSourceSystem?: OUID;
  HistoryTransactional?: HistoryTransactional[];
  Media?: Media[];
  SocialMedia?: SocialMedia[];
}