website#askquestion

Message

website user asks a question

Payload Example(s) (generated)

{
  "topic": "realestate/website#askquestion",
  "data": {
    "type": "AskAction",
    "agent": {
      "type": "Person",
      "name": "string",
      "givenName": "string",
      "familyName": "string",
      "email": "user@example.com",
      "telephone": "string",
      "identifier": {
        "bhhsconsumerid": "12345"
      },
      "sameAs": {
        "amcecrmid": 1234567,
        "salesForceId": "parsing"
      },
      "contactPoint": {
        "type": "ContactPoint",
        "name": "Work",
        "telephone": "555-555-5555",
        "faxNumber": "555-555-5555",
        "email": "bob@example.com",
        "url": "https://www.facebook.com/hallandoates"
      },
      "additionalProperties": {
        "workingWithAgent": true
      }
    },
    "object": {
      "type": "Question",
      "text": "Populus debet control notitia sua"
    },
    "recipient": {
      "type": "RealEstateAgent",
      "name": "Randy Real Estate",
      "id": "https://8675309.example.com/profile/card#me"
    },
    "about": {
      "$ref": "../../example-propertylisting.yaml"
    }
  }
}

Payload

NameTypeDescription
(root)object-
topicstringconst ("realestate/website#askquestion")
dataobject-
data.typestringconst ("AskAction")
data.agentobjecta website user/visitor
data.agent.typestringallowed ("Person", "Contact")
data.agent.namestring-
data.agent.givenNamestring-
data.agent.familyNamestring-
data.agent.emailstringformat (email)
data.agent.telephonestring-
data.agent.identifierobject1 properties
data.agent.sameAsstringvendor specific identifier for the user can be shared with other vendors to identify the user format (uri)
data.agent.contactPointobjectA point of contact for the entity. By convention in the real estate domain, ContactPoints are preferred over telephone, email, and faxNumber so the ContactPoint.name property can be used to label values for example, Work Telephone, Home, as named contactPoint values. >= 3 properties
data.agent.contactPoint.typestringconst ("ContactPoint")
data.agent.contactPoint.namestringa label for the contactPoint, i.e. 'Work', or 'Home'
data.agent.contactPoint.telephonestring-
data.agent.contactPoint.faxNumberstring-
data.agent.contactPoint.emailstringan email address for the item. format (email)
data.agent.contactPoint.urlstringprimary URL for the item. format (uri)
data.agent.additionalPropertiesobjectadditional properties for the website user
data.agent.additionalProperties.workingWithAgentboolean-
data.objectobjectA specific question - e.g. from a user seeking answers online, or collected in a Frequently Asked Questions (FAQ) document.
data.object.typestringconst ("Question")
data.object.textstring-
data.recipientobjectthe agent being asked
data.aboutobjecta real estate property listed for sale
data.about.typestringallowed ("PropertyListing")
data.about.addressCountrystringallowed ("CA", "DE", "GR", "IN", "IT", "MX", "PE", "PT", "ES", "AE", "GB", "US") two-letter ISO 3166-1 alpha-2 country code
data.about.addressLocalitystringCity, Township. <= 50 characters
data.about.addressRegionstringabbreviated state or province
data.about.buyerAgentobjectthe buyer's RealEstateAgent
data.about.buyerOfficeobjectthe buyer's RealEstateOffice
data.about.closeDatestringWith for-sale listings, the date the purchase agreement was fulfilled. With lease listings, the date the requirements were fulfilled, such as contract and/or deposit. format (date-time)
data.about.imagetuple<object allOf, ...optional<any>>an ImageObject or URI reference to an image on the web.
data.about.image.0 (index)object allOf-
data.about.image.0.0 (allOf item)allOfan image, video or document availble for download
data.about.image.0.0.0 (allOf item)object-
data.about.image.0.0.0.typestringThe item type (Linked-Data @type) pattern (^[A-Z][a-zA-Z0-9]+$)
data.about.image.0.0.0.@idstringthe liked data uri for the Thing format (uri)
data.about.image.0.0.0 (property names)-pattern (^[a-z@$][a-zA-Z0-9-_]+$)
data.about.image.0.0.1 (allOf item)--
data.about.image.0.0.1.typestringallowed ("MediaObject", "ImageObject", "DigitalDocument")
data.about.image.0.0.1.idstringthe URL to access the item. format (uri)
data.about.image.0.0.1.namestringthe file name of the object.
data.about.image.0.0.1.encodingFormatstringMIME type
data.about.image.0.0.1.aboutstringURI to the subject of the image or logo format (uri)
data.about.image.0.0.1.urlstringURL of the image content format (uri)
data.about.image.0.1 (allOf item)--
data.about.image.0.1.typestringallowed ("ImageObject")
data.about.image.0.1.idany-
data.about.image.0.1.nameany-
data.about.image.0.1.encodingFormatany-
data.about.internetAddressDisplayYNstringallowed ("Y", "N")
data.about.latitudenumberThe latitude of a location.
data.about.listingAgentobjectthe agent/broker representing the seller in a real estate transaction
data.about.listingContractDatestringThe effective date of the agreement between the seller and the seller's broker. format (date-time)
data.about.listingIdstringthe local identifier for the listing
data.about.listingOfficeobjectthe listing office
data.about.listingOriginatingSystemobjectThe place where the item is originally input by the user.
data.about.listingPriceobject-
data.about.listingStatusstringallowed ("Active", "Pending", "Sold", "Canceled", "Prelisted", "OffMarket", "Private")
data.about.livingAreaobjectproperty indoor space
data.about.longitudenumberThe longitude of a location.
data.about.lotSizeobjectoutdoor space minValue, maxValue
data.about.numberOfBathroomsstringthe number of bathrooms
data.about.numberOfBedroomsstringthe number of bedrooms
data.about.numberOfRoomsstringthe total number of rooms in the building
data.about.originatingSystemKeystringthe listing identifier from the original MLS, aka MLSID.
data.about.originatingSystemNamestringthe name of the MLS where the listing was originally input
data.about.postalCodestringZip/Post Code <= 12 characters
data.about.propertySubTypestringallowed ("ApartmentPropertyType", "BoatSlipPropertyType", "CabinPropertyType", "CondominiumPropertyType", "DeededParkingPropertyType", "DuplexPropertyType", "FarmPropertyType", "ManufacturedHomePropertyType", "ManufacturedOnLandPropertyType", "MobileHomePropertyType", "OwnYourOwnPropertyType", "QuadruplexPropertyType", "RanchPropertyType", "SingleFamilyPropertyType", "StockCooperativePropertyType", "TimesharePropertyType", "TownhousePropertyType", "TriplexPropertyType", "AgriculturePropertyType", "BusinessPropertyType", "HotelMotelPropertyType", "IndustrialPropertyType", "MixedUsePropertyType", "MultiFamilyPropertyType", "OfficePropertyType", "RetailPropertyType", "UnimprovedLandPropertyType", "WarehousePropertyType") RESO property sub-type (see range for allowed values)
data.about.propertyTypestringallowed ("RESI", "RLSE", "RINC", "LAND", "MOBI", "FARM", "COMS", "COML", "BUSO") RESO property type (see range for allowed values) 4 characters
data.about.purchaseContractDatestringWith for-sale listings, the date an offer was accepted and the listing was no longer on market. With lease listings this may represent a meeting of the minds to lease, but some contractual requirements are yet to be fulfilled, such as contract signing or receipt of the deposit. format (date-time)
data.about.storiesnumberhe number of floors in the property
data.about.streetAddressstringthe street address <= 75 characters
data.about.universalPropertyIdstringThe Universal Property Identifier is a unique identifier for all real property in the US and Canada. It is based on country and local identification methods and is limited to real property. For cases such as shares of real property, units, and other more granular cases, please utilize the UniversalPropertySubId.
data.about.urlstringURL of the item. format (uri)
data.about.yearBuiltnumberthe year the structure was created

Headers

NameTypeDescription
(root)object-
timestringdate & time the event was produced format (date-time)
agentstringif you are a multi-tenant app, then the agent is the user associated with the event data. any future events related to this message will be sent to the same agent/recipient format (uri)
instrumentstringthe app or service that produced the event on behalf of the agent/user format (uri)
sourcestringa copy of the event was sent to the source(s). format (uri)
originalRecipientstringthe originalRecipient helps you determine the subscription that delivered the event to you. if the originalRecipient is the same as the agent, then the you are subscribed to the agent. if the originalRecipient is different from the agent, then you are subscribed to the event source format (uri)
idstringthe Event ID (aka "Publish ID") is the immutable canonical identifier for the event. it is a URI that is unique to the event and will not change. all subscribers will receive the same id for the same event. format (uri)
@idstringformat (uri)

Tools

Next
Getting started