Listings: Open Houses

The Open Houses sub-resource returns data about upcoming open houses scheduled for a listing.

Supported Roles
Available Services
Listings: Open Houses Description
Expansions
API Explorer

Supported Roles

Role	Reads	Writes
IDX	Yes	No
Public	Yes	No
VOW	Yes	No
Portal	Yes	No
Private	Yes	Yes

More information about roles may be found here.

Available Services

Open Houses

`/<API Version>/listings/<Listing.Id>/openhouses`

HTTP Method	Description	Conditional	Notes
GET	Returns upcoming in person open houses for a listing.	No
POST	Creates a new open house record, and may be used for any type of open house.	No
PUT	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
DELETE	Returns HTTP 405 (Method Not Allowed)	No	Not implemented

GET Request

Parameters:

None

GET Response

{
    "D": {
        "Success": true,
        "Results": [
            {
                "ResourceUri": "/vX/listings/20060412165917817933000000/openhouses/20101127153422574618000000",
                "Id": "20101127153422574618000000",
                "Date": "10/01/2010",
                "StartTime": "09:00 AM",
                "EndTime": "12:00 PM",
                "Comments": "Free chips!",
                "Livestream": false,
                "LivestreamUri": null,
                "LivestreamDescription": null,
                "LivestreamDate": null,
                "LivestreamStartTime": null,
                "LivestreamEndTime": null
            },
            {
                "ResourceUri": "/vX/listings/20060412165917817933000000/openhouses/20101127153422174618000000",
                "Id": "20101127153422174618000000",
                "Date": "10/08/2010",
                "StartTime": "09:00 AM",
                "EndTime": "12:00 PM",
                "Comments": null,
                "Livestream": false,
                "LivestreamUri": null,
                "LivestreamDescription": null,
                "LivestreamDate": null,
                "LivestreamStartTime": null,
                "LivestreamEndTime": null
            }
        ]
    }
}

POST Request

Request body:

{
   "D":{
     "Date": "10/01/2010",
     "StartTime": "09:00 AM",
     "EndTime": "12:00 PM",
     "Comments": "Free chips!"
   }
}

POST Response

The standard success/fail response is returned.

All Open Houses

`/<API Version>/listings/<Listing.Id>/openhouses/all`

HTTP Method	Description	Conditional	Notes
GET	Returns all upcoming open houses for a listing	No
POST	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
PUT	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
DELETE	Returns HTTP 405 (Method Not Allowed)	No	Not implemented

GET Request

Parameters:

None

GET Response

{
    "D": {
        "Success": true,
        "Results": [
            {
                "ResourceUri":"/v1/listings/20140603154202923655000000/openhouses/20200605174129179069000000",
                "Id":"20200605174129179069000000",
                "Date":"",
                "StartTime":"",
                "EndTime":"",
                "Comments":null,
                "Livestream":true,
                "LivestreamDate":"07/04/2020",
                "LivestreamStartTime":"8:00 am",
                "LivestreamEndTime":"12:00 pm",
                "LivestreamDescription":"This open house is available online!",
                "LivestreamUri":"https://zoom.us/my/livestream"
            },
            {
                "ResourceUri": "/vX/listings/20140603154202923655000000/openhouses/20200605153422574618000000",
                "Id": "20200605153422574618000000",
                "Date": "07/01/2020",
                "StartTime": "09:00 AM",
                "EndTime": "12:00 PM",
                "Comments": "See this house in person!",
                "Livestream": false,
                "LivestreamUri": null,
                "LivestreamDescription": null,
                "LivestreamDate": null,
                "LivestreamStartTime": null,
                "LivestreamEndTime": null
            }
        ]
    }
}

Livestream Open Houses

`/<API Version>/listings/<Listing.Id>/openhouses/livestream`

HTTP Method	Description	Conditional	Notes
GET	Returns upcoming Livestream open houses for a listing	No
POST	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
PUT	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
DELETE	Returns HTTP 405 (Method Not Allowed)	No	Not implemented

GET Request

Parameters:

None

GET Response

{
    "D":{
        "Results":[
            {
                "ResourceUri":"/v1/listings/20140603154202923655000000/openhouses/20200605174129179069000000",
                "Id":"20200605174129179069000000",
                "Date":"",
                "StartTime":"",
                "EndTime":"",
                "Comments":null,
                "Livestream":true,
                "LivestreamDate":"07/04/2020",
                "LivestreamStartTime":"8:00 am",
                "LivestreamEndTime":"12:00 pm",
                "LivestreamDescription":"This open house is available online!",
                "LivestreamUri":"https://zoom.us/my/livestream"
            }
        ],
        "Success":true
    }
}

Open Houses

`/<API Version>/listings/<Listing.Id>/openhouses/<OpenHouse.Id>`

HTTP Method	Description	Conditional	Notes
GET	Returns a specified open house record	No
POST	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
PUT	Updates an existing open house record	No
DELETE	Deletes an open house record	No

GET Request

Parameters:

None

GET Response

See the GET request section for for the Open Houses serivice.

PUT Request

Request body:

{
   "D":{
     "Comments": "Bring your own chips."
   }
}

PUT Response

The standard success/fail response is returned.

DELETE Request

Parameters:

None

DELETE Response

The standard success/fail response is returned.

Open House Metadata

`/<API Version>/listings/openhouses/meta`

HTTP Method	Description	Conditional	Notes
GET	Returns meta data for fields not consistent across all MLSs	No
POST	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
PUT	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
DELETE	Returns HTTP 405 (Method Not Allowed)	No	Not implemented

GET Request

Parameters:

None

GET Response

{
    "D": {
        "Success": true,
        "Results": [{
          "AdditionalInfo": [{
                  "Hosted By": {
                          "Type": "Character"
                  }
              },
              {
                  "Hosted Phone": {
                          "Type": "Character"
                  }
              },
              {
                  "Area": {
                          "Type": "Character"
                  }
              }
          ]
        }]
    }
}

Open House Validation

`/<API Version>/listings/<Listing.Id>/openhouses/validation`

HTTP Method	Description	Conditional	Notes
GET	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
POST	Validates open house data to be created, but does not perform the actual creation.	No
PUT	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
DELETE	Returns HTTP 405 (Method Not Allowed)	No	Not implemented

POST Request

Request body:

{
    "D": {
        "Comments": "This is a valid open house.",
        "Livestream":true,
        "LivestreamDate":"07/04/2020",
        "LivestreamStartTime":"8:00 am",
        "LivestreamEndTime":"12:00 pm",
        "LivestreamDescription":"This open house is available online!",
        "LivestreamUri":"https://zoom.us/my/livestream"
    }
}

POST Response

The standard success/fail response is returned.

Listings: Open Houses Description

Attribute	Data Type	Writeable	Required	Description
`Id`	Character	No	No	The unique id for the open house.
`ResourceUri`	Character	No	No	The URI to the particular open house.
`Date`	Character	Yes	Yes	The human readable starting date the open house is scheduled for. Note: For writes, we accept this field either as presented by this service (i.e. in the format "MM/DD/YYYY"), or as a typical Date type
`StartTime`	Character	Yes	Yes	The human readable starting time for the open house event. Note: For writes, we accept this field either as presented by this service (i.e. in the format "9:00 am"), or as a typical Timestamp type
`EndTime`	Character	Yes	Yes	The human readable ending time for the open house event. Note: For writes, we accept this field either as presented by this service (i.e. in the format "9:00 am"), or as a typical Timestamp type
`Comments`	Character	Yes	Yes	Additional information regarding the open house event.
`Livestream`	Boolean	No	No	If `true`, this is a livestream open house. For these types of events, `LivestreamDate`, `LivestreamStartTime`, and `LivestreamEndTime` will be used instead of `Date`, `StartTime`, and `EndTime`.
`LivestreamUri`	Character	No	No	The URI where the livestream open house will take place.
`LivestreamDescription`	Character	No	No	The description of the livestream event.
`LivestreamDate`	Character	No	No	The human readable starting date the livestream open house is scheduled for. Used instead of `Date` when `Livestream` is `true`.
`LivestreamStartTime`	Character	No	No	The human readable starting time for the livestream open house event. Used instead of `StartTime` when `Livestream` is `true`.
`LivestreamEndTime`	Character	No	No	The human readable ending time for the livestream open house event. Used instead of `EndTime` when `Livestream` is `true`.
`AdditionalInfo`	JSON Object	Yes	No	(Private Only) Additional information custom to the MLS for the open house, in the order of desired presentation. See the metadata service for details.

Expansions

None.

API Explorer

The API Explorer does not currently support this service.