@realestate/types/RESODataDictionaryV1_7/Office.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 { Media } from './Media';
import { AOR } from './AOR';
import { CountyOrParish } from './CountyOrParish';
import { SyndicateTo } from './SyndicateTo';
import { OUID } from './OUID';
import { Member } from './Member';
import { SyndicateAgentOption } from './SyndicateAgentOption';
import { OfficeBranchType } from './OfficeBranchType';
import { SocialMediaType } from './SocialMediaType';
import { StateOrProvince } from './StateOrProvince';
import { OfficeStatus } from './OfficeStatus';
import { OfficeType } from './OfficeType';
import { SocialMedia } from './SocialMedia';
import { HistoryTransactional } from './HistoryTransactional';
export interface Office {
  /**
   * {@link https://ddwiki.reso.org/display/DDW17/FranchiseAffiliation+Field}
   *
   * The name of the franchise to which the broker/office is contracted.
   */
  FranchiseAffiliation?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/IDXOfficeParticipationYN+Field}
   *
   * Does the Office/Broker participate in IDX.
   */
  IDXOfficeParticipationYN?: boolean;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MainOfficeKey+Field}
   *
   * OfficeKey of the Main Office in a firm/company of offices. This is a self referencing foreign key
   * relating to this resource's OfficeKey. This key may be the same value as the OfficeKey for a given
   * record if the given office is the Main Office.
   */
  MainOfficeKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MainOfficeKeyNumeric+Field}
   *
   * OfficeKey of the Main Office in a firm/company of offices. This is a self referencing foreign key
   * relating to this resource's OfficeKey. This key may be the same value as the OfficeKey for a given
   * record if the given office is the Main Office. This is the numeric only key and used as an alternative
   * to the MainOfficeKey field.
   */
  MainOfficeKeyNumeric?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/MainOfficeMlsId+Field}
   *
   * OfficeMlsId of the Main Office in a firm/company of offices.
   */
  MainOfficeMlsId?: string;

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficeAOR+Field}
   *
   * The Office's Board or Association of REALTORS.
   */
  OfficeAOR?: AOR;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficeAORMlsId+Field}
   *
   * The local, well-known identifier for the office's Association of REALTORS. This value may not be unique,
   * specifically in the case of aggregation systems, this value should be the identifier from the original
   * system.
   */
  OfficeAORMlsId?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficeAORkey+Field}
   *
   * A system unique identifier. Specifically, in aggregation systems, the OfficeAORkey 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 AOR's member management system in which the record was originated.
   */
  OfficeAORkey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficeAORkeyNumeric+Field}
   *
   * A system unique identifier. Specifically, in aggregation systems, the OfficeAORkey 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 AOR's member management system in which the record was originated.
   * This is the numeric only key and used as an alternative to the OfficeAORkey field.
   */
  OfficeAORkeyNumeric?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficeAddress1+Field}
   *
   * The street number, direction, name and suffix of the office.
   */
  OfficeAddress1?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficeAddress2+Field}
   *
   * The unit/suite number of the office.
   */
  OfficeAddress2?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficeAssociationComments+Field}
   *
   * Notes relating to the office.
   */
  OfficeAssociationComments?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficeBranchType+Field}
   *
   * The level of the office in the hierarchy of Main, Branch, Stand Alone, etc.,
   */
  OfficeBranchType?: OfficeBranchType;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficeBrokerKey+Field}
   *
   * The MemberKey of the responsible/owning broker. This is a foreign key relating to the Member resource's
   * MemberKey.
   */
  OfficeBrokerKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficeBrokerKeyNumeric+Field}
   *
   * The MemberKey of the responsible/owning broker. 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 OfficeBrokerKey field.
   */
  OfficeBrokerKeyNumeric?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficeBrokerMlsId+Field}
   *
   * The MemberMlsId of the responsible/owning broker.
   */
  OfficeBrokerMlsId?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficeCity+Field}
   *
   * The city of the office.
   */
  OfficeCity?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficeCorporateLicense+Field}
   *
   * When an office/firm is a corporation, an independent license number is issued.
   */
  OfficeCorporateLicense?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficeCountyOrParish+Field}
   *
   * The county or parish in which the offices is located.
   */
  OfficeCountyOrParish?: CountyOrParish;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficeEmail+Field}
   *
   * The email address of the office
   */
  OfficeEmail?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficeFax+Field}
   *
   * North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
   * Other conventions should use the common local standard. International numbers should be preceded by a
   * plus symbol.
   */
  OfficeFax?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficeKey+%28Office%29+Field}
   *
   * A system unique identifier. Specifically, in aggregation systems, the Key is the system unique identifier
   * from the system that the record was just retrieved. This may be identical to the related xxxId
   * identifier, but the key is guaranteed unique for this record set.
   */
  OfficeKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficeKeyNumeric+%28Office%29+Field}
   *
   * A unique identifier for this record from the immediate source. This is the numeric only key and used as
   * an alternative to the OfficeKey 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 SourceSystemOfficeKey and OriginatingSystemOfficeKey.
   */
  OfficeKeyNumeric?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficeManagerKey+Field}
   *
   * The lead Office Manager for the given office. This is a foreign key relating to the Member resource's
   * MemberKey.
   */
  OfficeManagerKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficeManagerKeyNumeric+Field}
   *
   * The lead Office Manager for the given office. 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 OfficeManagerKey field.
   */
  OfficeManagerKeyNumeric?: number;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficeManagerMlsId+Field}
   *
   * The lead Office Manager for the given office.
   */
  OfficeManagerMlsId?: string;

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficeName+%28Office%29+Field}
   *
   * The legal name of the brokerage.
   */
  OfficeName?: string;

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

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficePhone+Field}
   *
   * North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens).
   * Other conventions should use the common local standard. International numbers should be preceded by a
   * plus symbol.
   */
  OfficePhone?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficePhoneExt+Field}
   *
   * The extension of the given phone number (if applicable).
   */
  OfficePhoneExt?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficePostalCode+Field}
   *
   * The postal code of the office.
   */
  OfficePostalCode?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficePostalCodePlus4+Field}
   *
   * The extension of the postal/zip code. i.e. +4
   */
  OfficePostalCodePlus4?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficeStateOrProvince+Field}
   *
   * The state or province in which the office is located.
   */
  OfficeStateOrProvince?: StateOrProvince;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficeStatus+Field}
   *
   * Is the office active, inactive or under disciplinary action.
   */
  OfficeStatus?: OfficeStatus;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OfficeType+Field}
   *
   * The type of business conducted by the office. i.e. Real Estate, Appraiser, etc.
   */
  OfficeType?: OfficeType;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OriginalEntryTimestamp+%28Office%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+%28Office%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 office 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/OriginatingSystemName+%28Office%29+Field}
   *
   * The name of the Originating record provider. Most commonly the name of the MLS. The place where the
   * office is originally input by the member. The legal name of the company.
   */
  OriginatingSystemName?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/OriginatingSystemOfficeKey+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
   * office 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.
   */
  OriginatingSystemOfficeKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/SocialMediaType+%28Office%29+Field}
   *
   * A list of types of sites, blog, social media, the Office URL or ID is referring to. i.e. Website, Blog,
   * Facebook, Twitter, LinkedIn, Skype, etc., This list is used to populate the Type with repeating Social
   * Media URL or ID types.
   */
  SocialMediaType?: SocialMediaType;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/SourceSystemID+%28Office%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/SourceSystemName+%28Office%29+Field}
   *
   * The name of the immediate 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/SourceSystemOfficeKey+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.
   */
  SourceSystemOfficeKey?: string;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/SyndicateAgentOption+Field}
   *
   * A list of options allowing the broker to pass the decision of syndication choice down to the listing
   * agents. i.e. No Agent Choice, Allow Agent Choice, Restrict Agent Choice, etc.
   */
  SyndicateAgentOption?: SyndicateAgentOption;

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/SyndicateTo+%28Office%29+Field}
   *
   * The principal broker's choice on where they would like their listings syndicated. i.e. Zillow, Trulia,
   * Homes.com, etc.
   */
  SyndicateTo?: SyndicateTo[];

  MainOffice?: Office;
  OfficeBroker?: Member;
  OfficeManager?: Member;
  OriginatingSystem?: OUID;
  SourceSystem?: OUID;
  HistoryTransactional?: HistoryTransactional[];
  Media?: Media[];
  SocialMedia?: SocialMedia[];
}