Broker Tours

Broker Tours represent a tour of homes grouped together on the same date. Not all MLSs and property types have this feature enabled. See the BrokerTours flag in the property types service to see if this feature is enabled for the current MLS.

  1. Supported Roles
  2. Available Services
    1. Broker Tours
    2. Individual Broker Tour
    3. Listings in a Broker Tour
    4. Updating Listing in a Broker Tour
    5. Broker Tours for a Listing
  3. Broker Tours Description
  4. Expansions
  5. API Explorer

Supported Roles

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

Available Services

Broker Tours

URI: /<API Version>/brokertours

HTTP Method Description Conditional Notes
GET All broker tours in the current MLS No
POST Create a new broker tour No
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:
Parameter Required Notes
Pagination No

GET Response

{
    "D": {
        "Success": true,
        "Results": [
            {
                "ResourceUri": "/vX/brokertours/20101127153422574618000000",
                "Id": "20101127153422574618000000",
                "MlsId: "20060412165917817933000000",
                "Date": "10/01/2010",
                "StartTime": "09:00 AM",
                "EndTime": "12:00 PM",
                "Description": null,
                "AdditionalInfo": null,
                "City": "Fargo",
                "StartLocation": "Fargo Dome",
                "MaxListings": 250,
                "Completed": false, 
                "ListingCount": 10
            }
        ]
    }
}

POST Request

Request body:
{
    "D": {
        "Date": "10/01/2010",
        "StartTime": "09:00 AM",
        "EndTime": "12:00 PM",
        "City": "Fargo",
        "StartLocation": "Fargo Dome",
        "MaxListings": 50,
        "Completed": false
    }
}

POST Response

The standard success/fail response is returned.

Individual Broker Tour

URI: /<API Version>/brokertours/<BrokerTour.Id>

HTTP Method Description Conditional Notes
GET Returns an individual broker tour record No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Updates a broker tour No
DELETE Removes a broker tour No

GET Request

Parameters:
Parameter Required Notes
Standard expansion parameters No

GET Response

See the GET request section for for the broker tours service.

PUT Request

Request body:
{
    "D": {
        "City": "Moorhead"
    }
}

PUT Response

The standard success/fail response is returned.

DELETE Request

Parameters:
  • None

DELETE Response

The standard success/fail response is returned.

Listings in a Broker Tour

URI: /<API Version>/brokertours/<BrokerTour.Id>/listings

HTTP Method Description Conditional Notes
GET Returns HTTP 405 (Method Not Allowed) No Not implemented
POST Adds a listing to a broker tour No
PUT Reorders listings in a tour No All listings must be specified in this request
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

POST Request

Request body:
{
    "D": [
        {"Id": "20141127153422274613000000"},
        {"Id": "20131127153322574213900000",
         "Comments": "Great backyard!"}
    ]
}

POST Response

The standard success/fail response is returned.

PUT Request

Request body:
{
    "D": [
        {"Id": "20131127153322574213900000"},
        {"Id": "20141127153422274613000000"}
    ]
}

PUT Response

The standard success/fail response is returned.

Updating Listing in a Broker Tour

URI: /<API Version>/brokertours/<BrokerTour.Id>/listings/<Listing.Id>

HTTP Method Description Conditional Notes
GET Returns HTTP 405 (Method Not Allowed) No Not implemented
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Updates comments for a listing No
DELETE Removes a listing from the tour No

PUT Request

Request body:
{
    "D": {
        "Comments": "New pool!"
    }
}

PUT Response

The standard success/fail response is returned.

DELETE Request

Parameters:
  • None

DELETE Response

The standard success/fail response is returned.

Broker Tours for a Listing

URI: /<API Version>/listings/<Listing.Id>/brokertours

HTTP Method Description Conditional Notes
GET Returns all broker tours which the listing is part of 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:
Parameter Required Notes
Pagination No

GET Response

See the GET request section for for the listing carts service.

Broker Tours Description

Attribute Data Type Writeable Required Description
Id Character No No The unique id for the broker tour.
ResourceUri Character No No The URI to the individual broker tour resource.
AdditionalInfo Character Yes No Additional information about the broker tour. 100 character max.
City Character Yes No The city the broker tour is in. 100 character max.
Completed Boolean Yes No (Defaults to false) If true, the tour has completed and no more listings can be added.
Description Character Yes No A description of the broker tour. 100 character max.
ListingCount Integer No No The number of listings on the tour.
MaxListings Integer Yes Yes The maximum number of listings allowed on the tour.
MlsId Character No No The ID of the MLS that owns the Broker Tour.
Name Character Yes No The name of the broker tour. 100 character max.
StartLocation Character Yes No The location where the broker tour of homes will begin. 100 character max.
Date Character Yes Yes The human readable date the broker tour is scheduled for.
Note: For writes, we accept this field either as presented by this service (i.e. in the format "MM/DD/YYYY"), or as a typical Date type
StartTime Character Yes Yes The human readable starting time for the broker tour event.
Note: For writes, we accept this field either as presented by this service (i.e. in the format "9:00 am"), or as a typical Timestamp type
EndTime Character Yes Yes The human readable ending time for the broker tour event.
Note: For writes, we accept this field either as presented by this service (i.e. in the format "9:00 am"), or as a typical Timestamp type

Expansions

Expansion Roles Single Record Only? Selection Support? Description
Listings All Yes No This expansion will provide listing details for the listings in the tour. This will include the Comments for the listing specific to the tour.