Types

BHHSTerms

Example

{
  "contactPoint.name": "BHHSWebsiteURL",
  "additionalProperty": {
    "Status": "Active",
    "UserType": "string",
    "AffiliateID": "string",
    "BrokerID": "string",
    "OfficeID": "string",
    "OfficeDBA": "string",
    "AffiliateStatus": "string",
    "OfficeStatus": "string",
    "EmployeeType": "Full Time Sales Professional",
    "IsCompanyQueue": true,
    "agentWebsiteType": "Agent Profile",
    "RoqLogicTCVersion": "TC-00035",
    "bhhsLeadNotificationPreference": {
      "timeZone": [
        "GMT+12:00 Fiji Time (Pacific/Fiji)"
      ],
      "emailNotification": true,
      "textNotification": true,
      "email": "string",
      "telephone": "string",
      "leadNotificationSchedule": [
        {
          "type": "string",
          "byDay": [
            "Monday",
            "Wednesday",
            "Friday"
          ],
          "byMonth": [
            1
          ],
          "byMonthDay": [
            0
          ]
        }
      ]
    },
    "IsDisplayed": true,
    "OfficeType": "Administrative Office",
    "FullTimeCount": 0,
    "PartTimeCount": 0,
    "franchiseCommitmentNotes": "string",
    "franchiseCommitment": "string",
    "listingLeadsToListingAgent": true,
    "HSoACompany": true,
    "unassignedLeadOwner": null,
    "companyContactLastName": "string",
    "companyContactFirstName": "string",
    "companyCFO": "string",
    "primaryOffice": null,
    "transactionReportingMethod": "Batch File Upload",
    "databridgeVersion": "DB4.0",
    "systemDeactivationDate": "2019-08-24T14:15:22Z",
    "inactiveDate": "2019-08-24T14:15:22Z",
    "goLiveDate": "2019-08-24T14:15:22Z",
    "originalAffiliationDate": "2019-08-24T14:15:22Z",
    "numberOfSubOrganizations": 0,
    "PublicOffice": "string",
    "OfficeContact": null,
    "IsRelocationOffice": true,
    "PrimaryHomeStoryContact": null,
    "PrimaryHomeStoryContactEmail": "string",
    "PrimaryRelocationContact": null,
    "PrimaryRelocationContactEmail": "string",
    "PrimaryReferralContact": null,
    "PrimaryReferralContactEmail": "string",
    "PrimaryREOContact": null,
    "PrimaryREOContactEmail": "string",
    "transactionSequence": "string",
    "unimprovedLandFlag": "string",
    "workingWithAgent": true
  }
}

Schema

NameTypeDescription
(root)objectadditional properties for BHHS.
contactPoint.namestringallowed ("BHHSWebsiteURL", "BHHSWebsiteVanityURL")
additionalPropertyobject-
additionalProperty.Statusstringallowed ("Active", "Inactive", "Pre-Active")
additionalProperty.UserTypestringemployee type. For backward compatibility
additionalProperty.AffiliateIDstringBHHS affiliate identifier
additionalProperty.BrokerIDstringBHHS affiliate identifier. For backward compatibility
additionalProperty.OfficeIDstringBHHS office identifier. For backward compatibility
additionalProperty.OfficeDBAstringname of office. For backward compatibility
additionalProperty.AffiliateStatusstringstatus of affiliate. For backward compatibility
additionalProperty.OfficeStatusstringstatus of office. For backward compatibility
additionalProperty.EmployeeTypestringallowed ("Full Time Sales Professional", "Part Time Sales Professional", "Non-Agent", "Marketing Team", "In-House Admin. Profile") type of employee
additionalProperty.IsCompanyQueuebooleanif the real estate agent accepts company's lead
additionalProperty.agentWebsiteTypestringallowed ("Agent Profile", "Agent Page with IDX Search") agent's website type
additionalProperty.RoqLogicTCVersionstringversion of RoqLogic terms and conditions agent accepted.
additionalProperty.bhhsLeadNotificationPreferenceobjectlead notification preference
additionalProperty.bhhsLeadNotificationPreference.timeZonestring-
additionalProperty.bhhsLeadNotificationPreference.emailNotificationbooleanif notification will be sent to sepcified email address
additionalProperty.bhhsLeadNotificationPreference.textNotificationbooleanif notification will be sent to sepcified phone number
additionalProperty.bhhsLeadNotificationPreference.emailstringemail address that notification will be sent to
additionalProperty.bhhsLeadNotificationPreference.telephonestringphone number that notification will be sent to
additionalProperty.bhhsLeadNotificationPreference.leadNotificationSchedulearray<object>-
additionalProperty.bhhsLeadNotificationPreference.leadNotificationSchedule.typestringThe item type (Linked-Data @type)
additionalProperty.bhhsLeadNotificationPreference.leadNotificationSchedule.byDayarray<string>Defines the day(s) of the week on which a recurring Event takes place
additionalProperty.bhhsLeadNotificationPreference.leadNotificationSchedule.byDay (single item)stringallowed ("Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday")
additionalProperty.bhhsLeadNotificationPreference.leadNotificationSchedule.byMontharray<number>Defines the month(s) of the year on which a recurring Event takes place. Specified as an Integer between 1-12. January is 1.
additionalProperty.bhhsLeadNotificationPreference.leadNotificationSchedule.byMonth (single item)numberallowed (1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12)
additionalProperty.bhhsLeadNotificationPreference.leadNotificationSchedule.byMonthDayarray<number>Defines the day(s) of the month on which a recurring Event takes place. Specified as an Integer between 1-31.
additionalProperty.bhhsLeadNotificationPreference.leadNotificationSchedule.byMonthDay (single item)number-
additionalProperty.IsDisplayedbooleanif an affiliate/office/agent is listed in company/office/agent finder.
additionalProperty.OfficeTypestringallowed ("Administrative Office", "Branch Office", "Kiosk", "Primary Office", "Srvice Center", "Subdivision Sales Office") type of office
additionalProperty.FullTimeCountintegerthe number of full time sales professional
additionalProperty.PartTimeCountintegerthe number of part time sales professional
additionalProperty.franchiseCommitmentNotesstring-
additionalProperty.franchiseCommitmentstring-
additionalProperty.listingLeadsToListingAgentboolean-
additionalProperty.HSoACompanybooleanif company is owned by HSoA
additionalProperty.unassignedLeadOwneranyagent whom affiliate leads are assigned to
additionalProperty.companyContactLastNamestringlast name of company contact
additionalProperty.companyContactFirstNamestringfirst name of company contact
additionalProperty.companyCFOstringfull name of company CFO
additionalProperty.primaryOfficeanyprimay office of company
additionalProperty.transactionReportingMethodstringallowed ("Batch File Upload", "Direct Data Entry", "Summary Reporting") method of reporting transaction
additionalProperty.databridgeVersionstringallowed ("DB4.0", "DB3.0") version of data bridge
additionalProperty.systemDeactivationDatestringformat (date-time)
additionalProperty.inactiveDatestringformat (date-time)
additionalProperty.goLiveDatestringformat (date-time)
additionalProperty.originalAffiliationDatestringformat (date-time)
additionalProperty.numberOfSubOrganizationsinteger-
additionalProperty.PublicOfficestringoffice's public name
additionalProperty.OfficeContactanyoffice contact
additionalProperty.IsRelocationOfficebooleanif office is relocation office
additionalProperty.PrimaryHomeStoryContactanyoffice primary Home Story contact
additionalProperty.PrimaryHomeStoryContactEmailstringprimary Home Story contact email
additionalProperty.PrimaryRelocationContactanyoffice primary relocation contact
additionalProperty.PrimaryRelocationContactEmailstringprimary relocation contact email
additionalProperty.PrimaryReferralContactanyoffice primary referral contact
additionalProperty.PrimaryReferralContactEmailstringprimary referral contact email
additionalProperty.PrimaryREOContactanyoffice primary REO contact
additionalProperty.PrimaryREOContactEmailstringprimary REO contact email
additionalProperty.transactionSequencestringThe adjustment sequence number. Must be zeros if STR is closed but not an adjustment or if STR is open or canceled. If adjusting a closed transaction, the first adjustment must have 001 in the adjustment sequence, the second must have 002, the third, 003, etc. Sequence number cannot be equal or less than the last adjustment sequence number reported for the transaction if the Status has not changed.
additionalProperty.unimprovedLandFlagstringA Yes/No flag identifying where or not the property involved in the transaction is considered unimproved land. Valid codes are Y = unimproved land N= not an unimproved land
additionalProperty.workingWithAgentbooleanis consumer already working with an Agent?
Previous
UnsubscribeAction
Next
Mock Data Generator API