Sign in

v1

latestOpenAPI 3.0.4MIT2026-08-0417157271.9 KB
OpenHouse

Gets a single open house by OpenHouseKey

Both methods are valid and return the same result: a single OpenHouse entity identified by its unique OpenHouseKey. The path-style is more intuitive and commonly used in RESTful APIs. The function-style follows OData conventions and may be required in certain query contexts (e.g., when the key contains special characters or is not a simple numeric ID).

<b>Path-style access: </b>/odata/v1/OpenHouse/{OpenHouseKey}

<b>Example: </b>/odata/v1/OpenHouse/1000

<b>Function-style access: </b>/odata/v1/OpenHouse('{OpenHouseKey}')

<b>Example: </b>/odata/v1/OpenHouse('1000')

get/odata/v1/OpenHouse/{OpenHouseKey}

Path parameters

OpenHouseKeystring required

A unique identifier for this record from the immediate source

Query parameters

$selectstring

Selects which properties to include in the response.

Response

OK (DDF.Core.Entities.OpenHouse object)

@odata.contextstring nullable
OpenHouseKeystring nullable

A unique identifier for this record from the immediate source.

ListingKeystring nullable

A unique identifier for the listing record related to this Open House.

ListingIdstring nullable

The well known identifier for the listing related to this Open House.

OpenHouseDatestring date-time nullable

The date on which the open house will occur.

OpenHouseStartTimestring nullable

The time the open house begins (in local time).

OpenHouseEndTimestring nullable

The time the open house ends (in local time).

OpenHouseRemarksstring nullable

Comments, instructions or information about the open house.

OpenHouseTypestring Enum: OpenHouseType nullable

The type of open house. i.e. Public, Broker, Office, Association, Private (invitation or targeted publication).

OpenHouseStatusstring Enum: OpenHouseStatus nullable

Status of the open house, i.e. Active, Cancelled, Ended.

LivestreamOpenHouseURLstring nullable

A link to an open house livestream event

Example response

{
  "@odata.context": "https://localhost:7051/odata/v1/$metadata#DDF.Core.Entities.OpenHouse",
  "OpenHouseKey": "12345",
  "ListingKey": "12345",
  "ListingId": "1",
  "OpenHouseDate": "2021-01-01",
  "OpenHouseStartTime": "12:00:00.00",
  "OpenHouseEndTime": "12:00:00.00",
  "OpenHouseRemarks": "OpenHouseRemarks",
  "OpenHouseType": "Public",
  "OpenHouseStatus": "Active",
  "LivestreamOpenHouseURL": "\"https://www.youtube.com/watch?v=i-09UtAH10A\""
}