Search Templates: Quick Searches

Quick search templates are user-defined field layouts for user interfaces. They present standard and custom fields the user expects to see in the order the user expects to see them.

  1. Supported Roles
  2. Available Services
    1. All Quick Searches
    2. Individual Quick Search
    3. Default Quick Search
    4. Global Default Quick Search
  3. Quick Searches 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 Yes
More information about roles may be found here.

Available Services

All Quick Searches

URI: /<API Version>/searchtemplates/quicksearches

All quick searches belonging to or inheritable by the current user.

HTTP Method Description Conditional Notes
GET Returns all quick searches the user has access to, ordered by name. 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": [
            {
                "ResourceUri": "/v1/searchtemplates/quicksearches/20120717212004874996000000",
                "Id": "20130717212004874996000000",
                "Name": "My Quick Search",
                "OwnerId": "20000426173054342350000000",
                "MlsId": "20000426143505724628000000",
                "Inheritable": true,
                "Inherited": false,
                "ViewId": "20130717211827902622000000",
                "PropertyTypes": [
                    "A"
                ],
                "Fields": [
                    {
                        "Domain": "StandardFields",
                        "GroupField": null,
                        "Field": "ListPrice"
                    },
                    {
                        "Domain": "CustomFields",
                        "GroupField": "Amenities",
                        "Field": "# Ceiling Fans"
                    }
                ],
                "SavedSearch": null,
                "ModificationTimestamp": "2013-07-09T15:31:47Z"
            }
        ],
        "Success": true
    }
}

Individual Quick Search

URI: /<API Version>/searchtemplates/quicksearches/<Id>

HTTP Method Description Conditional Notes
GET Returns a specified quick search. 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
Standard expansion parameters No

GET Response

See the GET request section for for the quick searches service.

Default Quick Search

URI: /<API Version>/searchtemplates/quicksearches/default

When there is no human-entered search template specified as the default, a system-generated template will be provided. This template will not include data for fields such as Name or DisplayName, but will include a list of PropertyTypes and Fields.

HTTP Method Description Conditional Notes
GET Returns the default quick search for the current user 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
Standard expansion parameters No

GET Response

See the GET request section for for the quick searches service.

Default Global Quick Search

URI: /<API Version>/searchtemplates/quicksearches/default/global

The Global Default Quick Search is a generic template that is identical for all users across all MLSs. It use returned from the default quick search service when no custom quick search can be determined as the default for the current user.

HTTP Method Description Conditional Notes
GET Returns the default quick search for the current user 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
Standard expansion parameters No

GET Response

See the GET request section for for the quick searches service.

Quick Searches Description

Attribute Data Type Description
ResourceId Character The resource URI to a particular quick search.
Id Character The unique id for the quick search template.
Name Character The user specified name for the quick search template.
OwnerId Character The account Id for the user that created the template.
MlsId Character The account Id for the MLS the owner belongs to.
Inheritable Boolean If true, the quick search template can be inherited by users under the current user's control.
Inherited Boolean If true, the quick search template was inherited from another user.
ViewId Character The associated view record.
PropertyTypes Character List An array of property types the quick search can be used under.
SavedSearch JSON Object If present, the saved search data whose filter should populate the search template.
Fields Expansion A list of standard or custom fields used by the template.
Domain Character The type of listing field. Either StandardFields or CustomFields.
GroupField Character The CustomField group the Field resides under. null if Domain is StandardFields.
Field Character The standard or custom field.

Expansions

Expansion Roles Single Record Only? Selection Support? Description
DisplayName All Yes No For non-private roles, if a quick search is associated with an IDX link, the name of that link will provided as the display name.
Fields All Yes No A list of fields associated with the search template.

API Explorer

Interact with this service using the API Explorer.