Broker Distributions

The Broker Distributions Metadata service allows retrieval of distribution options available within an MLS and 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. Response 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 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
      }
  }

Available Services

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 office 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
      }
  }

Available Services

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

API Explorer

Interact with this service using the API Explorer.