System Info: Search

Provides MLS and user defined settings for default search configuration.

  1. Supported Roles
  2. Available Services
    1. Search Configuration
  3. System Info: Search 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

Search Configuration

URI: /<API Version>/system/search

HTTP Method Description Conditional Notes
GET Returns the MLS and user defined search configuration. 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": {
    "Success": true,
    "Results": [{
      "Filters": {
        "MyListings": "StatusChangeDate Ge days(-30) Or StandardStatus Ne 'Canceled','Closed','Expired','Withdrawn'"
      },
      "HotSheet": {
          "Fields": [
              {
                  "Domain": "StandardFields",
                  "GroupField": null,
                  "Field": "City"
              }
          ]
      },
      "DefaultMlsStatus": [
          "Active"
      ],
      "DefaultMlsId": [
          "20130117173750921178000000",
          "20130118742650987419000000"
      ]
      "MyListingsDefaultMlsStatus": [
          "Active"
      ],
      "NewSearchDefaultMlsStatus": [
          "Active"
      ],
      "OffMarketListingsRange": {
          "FromQuantity": 30,
          "FromUnit": "days"
      }
    }]
  }
}

System Info: Search Description

Attribute Data Type Description
DefaultMlsStatus Character List A list of MlsStatus values the user has requested by select by default on their search screen. See the MyListingsDefaultMlsStatus and NewSearchDefaultMlsStatus for settings that may override this value for specific workflows.
DefaultMlsId Character List A list of DefaultMlsId values the user has requested to be selected by default on their search screen.
MyListingsDefaultMlsStatus Character List A list of MlsStatus values the user has requested by select by default on their search screen when filtering by the current agent's listings.
NewSearchDefaultMlsStatus Character List A list of MlsStatus values the user has requested by select by default on their search screen when starting a new search from scratch.
Filters.MyListings Character The _filter the user has requested UIs use when viewing their own listings. Should be used in conjunction with the my listings service.
HotSheet.Fields Array of JSON Objects A list of standard or custom fields that should be used to further a hot sheet search. See the Quick Searches response description for more information.
OffMarketListingsRange JSON Object Listings that went off market past this time frame are requested to be excluded from the current user's search.
FromQuantity Integer The number of days, months or years back.
FromUnit Character days, months or years.

Expansions

None.

API Explorer

Interact with this service using the API Explorer.