v1

latestOpenAPI 3.0.4MIT2026-08-0417157271.9 KB

Office

Gets a single office by OfficeKey

Both methods are valid and return the same result: a single Office entity identified by its unique OfficeKey. 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).

Path-style access: /odata/v1/Office/{OfficeKey}

Example: /odata/v1/Office/49

Function-style access: /odata/v1/Office('{OfficeKey}')

Example: /odata/v1/Office('49')

get/odata/v1/Office/{OfficeKey}

Path parameters

OfficeKeystring 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.Office object)

@odata.contextstring nullable

OfficeKeystring nullable

A unique identifier for this record from the immediate source. This is the string only key and used as an alternative to the OfficeKeyNumeric fields.

OfficeMlsIdstring nullable

The local, well-known identifier. This value may not be unique, specifically in the case of aggregation systems, this value should be the identifier from the original system.

OfficeAORKeystring nullable

A system unique identifier. This is the Board ID of the Office's Primary Board or Association of REALTORS.

OfficeNationalAssociationIdstring nullable

The national association ID of the office. i.e. In Canada, this is the CREA Organization ID of the Office.

FranchiseNationalAssociationIdstring nullable

The national association ID of the Franchisor. In Canada this would be the CREAID

OfficeBrokerNationalAssociationIdstring nullable

The national association Id of the Brokerage Owner. In Canada this would be the CREAID

OfficeAddress1string nullable

The street number, direction, name and suffix of the office.

OfficeAddress2string nullable

The unit/suite number of the office.

OfficeCitystring nullable

The city of the office.

OfficeFaxstring nullable

North American 10 digit fax 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.

OfficeNamestring nullable

The legal name of the brokerage.

OfficePhonestring nullable

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.

OfficePhoneExtstring nullable

The extension of the given phone number (if applicable).

OfficePostalCodestring nullable

The postal code of the office.

ModificationTimestampstring Enum: DateTime nullable

Date/time the roster (member or office) record was last modified (in Zulu time (UTC)).

OriginalEntryTimestampstring Enum: DateTime nullable

Date/time the office record was originally input into the source system (in Zulu time (UTC)).

OfficeTypestring Enum: OfficeType nullable

The type of business conducted by the office. i.e. Real Estate, Appraiser, etc.

OfficeStateOrProvincestring Enum: StateOrProvince nullable

The state or province in which the office is located.

OfficeAORstring Enum: AOR nullable

The Office's Board or Association of REALTORS.

OfficeStatusstring Enum: OfficeStatus nullable

Is the office active, inactive or under disciplinary action.

OfficeCountrystring Enum: Country nullable

The country in a postal address.

Example response

{
  "@odata.context": "https://localhost:7051/odata/v1/$metadata#DDF.Core.Entities.Office",
  "OfficeKey": "OfficeKey",
  "OfficeMlsId": "OfficeMlsId",
  "OfficeAORKey": "OfficeAORKey",
  "OfficeNationalAssociationId": "OfficeNationalAssociationId",
  "FranchiseNationalAssociationId": "0",
  "OfficeBrokerNationalAssociationId": "OfficeBrokerNationalAssociationId",
  "OfficeAddress1": "OfficeAddress1",
  "OfficeAddress2": "OfficeAddress2",
  "OfficeCity": "OfficeCity",
  "OfficeFax": "OfficeFax",
  "OfficeName": "OfficeName",
  "OfficePhone": "OfficePhone",
  "OfficePhoneExt": "OfficePhoneExt",
  "OfficePostalCode": "OfficePostalCode",
  "Media": [
    {
      "MediaKey": "MediaKey",
      "LongDescription": "REALTOR.ca Logo",
      "MediaURL": "https:///ddfcdn.realtor.ca/realtorlogo.png",
      "ModificationTimestamp": "2019-08-24T14:15:22Z",
      "Order": 1,
      "PreferredPhotoYN": true,
      "ResourceRecordId": "RealtorLogo.png",
      "ResourceRecordKey": "1234",
      "ResourceName": "Member",
      "MediaCategory": "Photo"
    }
  ],
  "OfficeSocialMedia": [
    {
      "SocialMediaKey": "SocialMediaKey",
      "ResourceRecordKey": "12345",
      "SocialMediaType": "FaceBook",
      "ModificationTimestamp": "\"2021-01-01T00:00:00.000Z\"",
      "SocialMediaUrlOrId": "\"SocialMediaUrlOrId\""
    }
  ],
  "ModificationTimestamp": "\"2021-01-01T12:00:00.000Z\"",
  "OriginalEntryTimestamp": "\"2021-01-01T12:00:00.000Z\"",
  "OfficeType": "Real Estate",
  "OfficeStateOrProvince": "Ontario",
  "OfficeAOR": "Affiliate",
  "OfficeStatus": "Active",
  "OfficeCountry": "Canada"
}