Office

GET

/trestle/odata/Office

GET

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

Fields

Field Type Size Description
BillingOfficeKey String 300 The office that will be billed (e.g., corporate headquarters).
FranchiseAffiliation String 50 The name of the franchise to which the broker/office is contracted.
FranchiseNationalAssociationId String 30 The national association ID of the franchise (i.e., the NRDS number in the U.S.).
HumanModifiedYN Boolean
IDXOfficeParticipationYN Boolean Indicates whether or not the office/broker participates in IDX.
MainOfficeKey String 20 The 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 Int64 10
MainOfficeMlsId String 25 The OfficeMlsId of the main office in a firm/company of offices.
ModificationTimestamp InKey DateTimeOffset The date/time the roster (member or office) record was last modified.
NumberOfBranches Int32 4 The calculated value for the number of active branches. The count for multiple related offices.
NumberOfNonMemberSalespersons Int32 4 The total number of active salespersons that are not a member of the national association.
OfficeAddress1 String 50 The street number, direction, name and suffix of the office.
OfficeAddress2 String 50 The unit/suite number of the office.
OfficeAlternateId String 50 An alternate ID with no specific use.
OfficeAOR AOR Enum 100 The office's board or association of REALTORS®.
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 association of REALTORS® member management system in which the record was originated.
OfficeAORkeyNumeric Int64 10
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, and it should be the identifier from the original system.
OfficeAssociationComments String 500 Notes relating to the office.
OfficeBio String 1024 A text field containing biography information for the office record. This may be resume-like information, including experience and qualifications.
OfficeBranchType OfficeBranchType Enum 50 The level of the office in a hierarchy (i.e., Main, Branch, Stand-Alone, etc.).
OfficeBrokerKey String 20 The MemberKey of the responsible/owning broker. This is a foreign key relating to the Member resource's MemberKey.
OfficeBrokerKeyNumeric Int64 10
OfficeBrokerMlsId String 25 The MemberMlsId of the responsible/owning broker.
OfficeBrokerNationalAssociationId String 50 The national association ID of the broker (i.e., the NRDS number in the U.S.).
OfficeCity String 50 The city of the office.
OfficeCityRegion String 150
OfficeCorporateLicense String 50 An independent license number is issued when an office/firm is a corporation.
OfficeCountry Country Enum 50 The office's country code for the street address.
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 20 A system unique identifier. Specifically, in aggregation systems, the key is the system unique identifier from the system where 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 Int64 10
OfficeMailAddress1 String 50 The street number, direction, name and suffix of the office.
OfficeMailAddress2 String 50 The unit/suite number of the office.
OfficeMailCareOf String 50 The care of (c/o) for the office's mailing address.
OfficeMailCity String 50 The office's city for the mailing address.
OfficeMailCountry Country Enum 10 The office's country code for the mailing address.
OfficeMailCountyOrParish String 50 The office's county of the mailing address.
OfficeMailPostalCode String 10 The postal code of the office's mailing address.
OfficeMailPostalCodePlus4 String 10 The four-digit extension of the U.S. ZIP Code.
OfficeMailStateOrProvince StateOrProvince Enum 10 The office's state or province of the mailing address.
OfficeManagerKey String 20 The lead office manager for the given office. This is a foreign key relating to the Member Resource's MemberKey.
OfficeManagerKeyNumeric Int64 10
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, and it 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 (e.g., the NRDS number in the U.S.).
OfficeNationalAssociationIdInsertDate DateTime The date the office record was initially created in the national association's database (e.g., the date the record was added to NRDS in the U.S.).
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 four-digit extension of the U.S. ZIP Code.
OfficePreferredMedia PreferredMedia Enum 10 The method the office prefers to receive media.
OfficePrimaryAorId String 30 The primary association of REALTORS® (AOR) associated with the member. This may be another AOR where the member has their primary membership.
OfficePrimaryStateOrProvince StateOrProvince Enum 10 The office's primary state or province.
OfficeStateOrProvince StateOrProvince Enum 10 The state or province in which the office is located.
OfficeStatus OfficeStatus Enum 25 Indicates whether the office is active, inactive or under disciplinary action.
OfficeStreetAdditionalInfo String 50
OfficeType OfficeType Enum 50 The type of business conducted by the office (e.g., Appraisal, MLS, Mortgage).
OfficeUrl String 8000
OriginalEntryTimestamp DateTimeOffset The date/time the roster (member or office) record was originally input into the source system.
OriginatingSystemID String 25 The OUID Resource's OrganizationUniqueId of the originating record provider. The originating system is the system with authoritative control over the record (e.g., 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.
OriginatingSystemMainOfficeKey String 255
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.
OriginatingSystemOfficeBrokerKey String 50
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 (e.g., the MLS where the office was input). There may be cases where the source system (how the record was received) is not the originating system. See Source System Office Key for more information.
OriginatingSystemOfficeManagerKey String 50
OriginatingSystemSubName String 255
OtherPhone String 30 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.
Permission ListingPermission Enum 8000
RecordSignature Int32 4
SocialMediaType SocialMediaType Enum 25 A collection of the types of social media fields available for the office. The collection includes the type of system and other details pertinent to social media.
SourceSystemID String 25 The OUID Resource'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 50 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 5125 The principal broker's choice on where they would like their listings syndicated (i.e., Zillow, Trulia, Homes.com, etc.).
VirtualOfficeWebsiteYN Boolean Indicates whether or not this is a Virtual Office Website (VOW).

Expands

Name Target Description
BuyerOfficeProperties Property Office's BuyerOfficeProperties is a navigational property into resource Property
CoBuyerOfficeProperties Property Office's CoBuyerOfficeProperties is a navigational property into resource Property
CoListOfficeProperties Property Office's CoListOfficeProperties is a navigational property into resource Property
ListOfficeProperties Property Office's ListOfficeProperties is a navigational property into resource Property
Media Media Office's Media is a navigational property into resource Media