Collapse Drawer
    Expand Drawer

    Office

    GET

    /trestle/odata/Office

    GET

    /trestle/rets/search?SearchType=Office&Class=Office

    info icon

    OfficeKey is the primary key and uniquely identifies records in the Office resource.

    info icon

    The following fields are considered InKeyIndex fields and may be queried in batches up to 300,000 at a time: ModificationTimestamp, OfficeKey, OfficeMlsId.

    Fields

    Field Type Size Description
    FranchiseAffiliation String 50 The name of the franchise to which the broker/office is contracted.
    HumanModifiedYN Boolean
    IDXOfficeParticipationYN Boolean Does the Office/Broker participate in IDX.
    MainOfficeKey String 255 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.
    MainOfficeKeyNumeric Int32 255 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.
    MainOfficeMlsId String 25 OfficeMlsId of the Main Office in a firm/company of offices.
    ModificationTimestamp InKey DateTimeOffset 27 Date/time the roster (member or office) record was last modified.
    OfficeAOR AOR Enum The Office's Board or Association of REALTORS.
    OfficeAORMlsId String 25 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.
    OfficeAORkey String 255 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.
    OfficeAORkeyNumeric Int32 255 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.
    OfficeAddress1 String 50 The street number, direction, name and suffix of the office.
    OfficeAddress2 String 50 The unit/suite number of the office.
    OfficeAssociationComments String 500 Notes relating to the office.
    OfficeBranchType OfficeBranchType Enum The level of the office in the hierarchy of Main, Branch, Stand Alone, etc.,
    OfficeBrokerKey String 255 The MemberKey of the responsible/owning broker. This is a foreign key relating to the Member resource's MemberKey.
    OfficeBrokerKeyNumeric Int32 255 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.
    OfficeBrokerMlsId String 25 The MemberMlsId of the responsible/owning broker.
    OfficeCity String 50 The city of the office.
    OfficeCorporateLicense String 50 When an office/firm is a corporation, an independent license number is issued.
    OfficeCountyOrParish String 50 The county or parish in which the offices is located.
    OfficeEmail String 80 The email address of the office
    OfficeFax String 16 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.
    OfficeKey Key InKey String 255 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.
    OfficeKeyNumeric Int32 255 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.
    OfficeManagerKey String 255 The lead Office Manager for the given office. This is a foreign key relating to the Member resource's MemberKey.
    OfficeManagerKeyNumeric Int32 255 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.
    OfficeManagerMlsId String 25 The lead Office Manager for the given office.
    OfficeMlsId InKey String 25 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.
    OfficeName String 255 The legal name of the brokerage.
    OfficeNationalAssociationId String 25 The national association ID of the office. i.e. in the U.S. is the NRDS number.
    OfficePhone String 16 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.
    OfficePhoneExt String 10 The extension of the given phone number (if applicable).
    OfficePostalCode String 10 The postal code of the office.
    OfficePostalCodePlus4 String 4 The extension of the postal/zip code. i.e. +4
    OfficeStateOrProvince StateOrProvince Enum The state or province in which the office is located.
    OfficeStatus OfficeStatus Enum Is the office active, inactive or under disciplinary action.
    OfficeType OfficeType Enum The type of business conducted by the office. i.e. Real Estate, Appraiser, etc.
    OriginalEntryTimestamp DateTimeOffset 27 Date/time the roster (member or office) record was originally input into the source system.
    OriginatingSystemID String 25 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.
    OriginatingSystemName String 255 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.
    OriginatingSystemOfficeKey String 255 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.
    OriginatingSystemSubName String 255
    Permission Permission Enum
    PermissionPrivate String 255
    SocialMediaType SocialMediaType Enum 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.
    SourceSystemID String 25 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.
    SourceSystemName String 255 The name of the immediate record provider. The system from which the record was directly received. The legal name of the company.
    SourceSystemOfficeKey String 255 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.
    SyndicateAgentOption SyndicateAgentOption Enum 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.
    SyndicateTo SyndicateTo Enum The principal broker's choice on where they would like their listings syndicated. i.e. Zillow, Trulia, Homes.com, etc.

    Expands

    Name Target Description
    BuyerOfficeProperties Property
    CoBuyerOfficeProperties Property
    CoListOfficeProperties Property
    ListOfficeProperties Property