Office
Get a list of offices
get/odata/v1/Office
Query parameters
$selectstring
Selects which properties to include in the response.
$countboolean
Return, along with the results, the total number of records in the dataset. NOTE: There is a performance cost with this query option.
$filterstring
Filters the results, based on a Boolean condition.
$topstring
Returns only the first n results.
$skipstring
Skips the first n results.
$orderbystring
Sorts the results.
Response
OK
Example response
{
"@odata.context": "https://localhost:7051/odata/v1/$metadata#DDF.Core.Entities.Office",
"value": [
{
"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"
}
],
"@odata.nextLink": "https://localhost:7051/odata/v1/DDF.Core.Entities.Office?skip=1"
}