Broker Distributions

The Broker Distributions Metadata service allows retrieval of distribution options available within an MLS and allows us to filter a subset of those which are available within an office.
  1. Supported Roles
  2. Available Services
    1. MLS Broker Distributions
    2. MLS broker distributions filtered by agent or broker
    3. Individual Broker Distributions
  3. Broker Distribution Description
  4. Expansions
  5. API Explorer

Supported Roles

Role Reads Writes Notes
IDX Yes No
Public Yes No
VOW Yes No
Portal Yes No
Private Yes No
More information about roles may be found here.

Available Services

MLS broker distributions

/<API Version>/brokerdistributions

HTTP Method Description Conditional Notes
GET Returns a list of distributions available for the MLS. This is a full list of available options in the MLS, to get options for the listing agent or broker filter this with their Account Id. 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": [
              {
                  "Id": "20171114172142952062000000",
                  "ResourceUri": "/v1/brokerdistributions/20171114172142952062000000",
                  "MlsId": "20000426143505724628000000",
                  "OwnerId": "20000426143505724628000000",
                  "Name": "Example",
                  "ExclusionDefault": false,
                  "ExclusionEditable": true,
                  "PropertyTypeRestrictions": [
                      "A",
                      "B",
                      "C",
                      "D",
                      "E",
                      "G",
                      "I"
                  ]
              }
          ],
          "Success": true
      }
  }

MLS broker distributions filtered by agent or broker

/<API Version>/brokerdistributions/accounts/<ListingAgent.Id>

HTTP Method Description Conditional Notes
GET Returns distributions for the listing agent or broker. 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": [
              {
                  "Id": "20171114172142952062000000",
                  "ResourceUri": "/v1/brokerdistributions/20171114172142952062000000",
                  "MlsId": "20000426143505724628000000",
                  "OwnerId": "20000426143505724628000000",
                  "Name": "Example",
                  "ExclusionDefault": false,
                  "ExclusionEditable": true,
                  "PropertyTypeRestrictions": [
                      "A",
                      "B",
                      "C",
                      "D",
                      "E",
                      "G",
                      "I"
                  ]
              }
          ],
          "Success": true
      }
  }

Individual distribution

/<API Version>/brokerdistributions/<BrokerDistribution.Id>

HTTP Method Description Conditional Notes
GET Returns individual distribution 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": [
              {
                  "Id": "20171114172142952062000000",
                  "ResourceUri": "/v1/brokerdistributions/20171114172142952062000000",
                  "MlsId": "20000426143505724628000000",
                  "OwnerId": "20000426143505724628000000",
                  "Name": "Example",
                  "ExclusionDefault": false,
                  "ExclusionEditable": true,
                  "PropertyTypeRestrictions": [
                      "A",
                      "B",
                      "C",
                      "D",
                      "E",
                      "G",
                      "I"
                  ]
              }
          ],
          "Success": true
      }
  }

Expansions

  • None

Broker Distributions Description

Attribute Data Type Description
Id Character The distribution id.
MlsId Character The ID of the MLS that owns the distribution.
OwnerId Character The Id of the MLS or Broker who owns the distribution.
Name Character Name of the distribution
ExclusionDefault Boolean True if the distribution should be excluded by default.
ExclusionEditable Boolean True if the listing agent has a choice whether or not to choose this option on input.
PropertyTypeRestrictions Character List A list of property type codes which this distribution is restricted to. null signifies no restrictions.

API Explorer

Interact with this service using the API Explorer.