@realestate/types/RESODataDictionaryV1_7/TeamMembers.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 { TeamMemberType } from './TeamMemberType';
import { TeamImpersonationLevel } from './TeamImpersonationLevel';
import { OUID } from './OUID';
import { Member } from './Member';
import { HistoryTransactional } from './HistoryTransactional';
export interface TeamMembers {
  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MemberKey+%28TeamMembers%29+Field}
   *
   * A system unique identifier. Specifically, the foreign key relating to the Member resource's MemberKey.
   */
  MemberKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MemberKeyNumeric+%28TeamMembers%29+Field}
   *
   * A system unique identifier. Specifically, the foreign key relating to the Member resource's MemberKey.
   * This is the numeric only key and used as an alternative to the MemberKey field.
   */
  MemberKeyNumeric?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MemberLoginId+%28TeamMembers%29+Field}
   *
   * The ID used to logon to the MLS system.
   */
  MemberLoginId?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MemberMlsId+%28TeamMembers%29+Field}
   *
   * The local, well-known identifier for the member. This value may not be unique, specifically in the case
   * of aggregation systems, this value should be the identifier from the original system.
   */
  MemberMlsId?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/ModificationTimestamp+%28TeamMembers%29+Field}
   *
   * Date/time the roster (member or office) record was last modified.
   */
  ModificationTimestamp?: Date;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OriginalEntryTimestamp+%28TeamMembers%29+Field}
   *
   * Date/time the roster (member or office) record was originally input into the source system.
   */
  OriginalEntryTimestamp?: Date;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OriginatingSystemID+%28TeamMembers%29+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 Team
   * Member was input. In cases where the Originating system was not where the record originated (the
   * authoritative system), see the Originating System fields.
   */
  OriginatingSystemID?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OriginatingSystemKey+%28TeamMembers%29+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
   * Team 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.
   */
  OriginatingSystemKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OriginatingSystemName+%28TeamMembers%29+Field}
   *
   * The name of the Originating record provider. Most commonly the name of the MLS. The place where the Team
   * Member is originally input. The legal name of the company.
   */
  OriginatingSystemName?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/SourceSystemID+%28TeamMembers%29+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.
   */
  SourceSystemID?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/SourceSystemKey+%28TeamMembers%29+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.
   */
  SourceSystemKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/SourceSystemName+%28TeamMembers%29+Field}
   *
   * The name of the Team Member record provider. The system from which the record was directly received.
   * The legal name of the company.
   */
  SourceSystemName?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/TeamImpersonationLevel+Field}
   *
   * The level of impersonation the member is allowed within the team. i.e. Impersonate (to work as the
   * team), On Behalf (to show the team name, but also show the member's info, None (don't allow this member
   * to appear as part of team).
   */
  TeamImpersonationLevel?: TeamImpersonationLevel;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/TeamKey+%28TeamMembers%29+Field}
   *
   * A system unique identifier. Specifically, a foreign key referencing the Teams resource's primary key.
   */
  TeamKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/TeamKeyNumeric+%28TeamMembers%29+Field}
   *
   * A system unique identifier. Specifically, a foreign key referencing the Teams resource's primary key.
   * This is the numeric only key and used as an alternative to the TeamKey field.
   */
  TeamKeyNumeric?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/TeamMemberKey+Field}
   *
   * A system unique identifier. Specifically, the local key to the TeamMembers resource.
   */
  TeamMemberKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/TeamMemberKeyNumeric+Field}
   *
   * A system unique identifier. Specifically, the local key to the TeamMembers resource. This is the numeric
   * only key and used as an alternative to the TeamKey field.
   */
  TeamMemberKeyNumeric?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/TeamMemberNationalAssociationId+Field}
   *
   * The national association ID of the member. i.e. in the U.S. is the NRDS number.
   */
  TeamMemberNationalAssociationId?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/TeamMemberStateLicense+Field}
   *
   * The license of the member. Separate multiple licenses with a comma and space.
   */
  TeamMemberStateLicense?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/TeamMemberType+Field}
   *
   * The role of the member within the team. i.e. team lead, principle, associate, assistant, etc.
   */
  TeamMemberType?: TeamMemberType;

  Member?: Member;
  OriginatingSystem?: OUID;
  SourceSystem?: OUID;
  HistoryTransactional?: HistoryTransactional[];
}