Developer Documentation
Platform Overview
Authentication
API Services
Overview Accounts Accounts: Associations Accounts: Metadata Accounts: Profile Appstore: Users Broker Distributions Broker Tours Consumers Consumers: Linked Agents Contacts Contacts: Activity Contacts: Export Contacts: Tags Contacts: Portal Accounts Developers: Identities Developers: Keys Developers: Authorizations Developers: Billing Summary Developers: Change History Developers: Domains Developers: News Feed Webhooks Developers: Roles Developers: Syndications Developers: Templates Developers: Usage Detail Developers: Usage Summary Devices Flexmls: Email Links Flexmls: Listing Meta Origins Flexmls: Listing Meta Translations Flexmls: Listing Meta Field List Translations Flexmls: Listing Reports Flexmls: Listing Updates IDX IDX Links Listing Carts Listing Carts: Portal/VOW Carts Incomplete Listings Incomplete Listings: Documents Incomplete Listings: Documents Metadata Incomplete Listings: Document Uploads Incomplete Listings: FloPlans Incomplete Listings: Photos Incomplete Listings: Photos Metadata Incomplete Listings: Photo Uploads Incomplete Listings: Rooms Incomplete Listings: Tickets Incomplete Listings: Units Incomplete Listings: Videos Incomplete Listings: Videos Metadata Incomplete Listings: Virtual Tours Incomplete Listings: Virtual Tours Metadata Listings Listings: Clusters Listings: Documents Listings: Documents Metadata Listings: FloPlans Listings: Historical Listings: History Listings: Hot Sheet Parameters Listings: Notes Listings: Search Parameters Listings: Open Houses Listings: Photos Listings: Photos Metadata Listings: Photo Uploads Listings: Document Uploads Listings: Rental Calendar Listings: Rooms Listings: Rules Listings: Tour of Homes Listings: Tickets Listings: Units Listings: Validation Listings: Videos Listings: Videos Metadata Listings: Virtual Tours Listings: Virtual Tours Metadata Listing Meta: Custom Fields Listing Meta: Custom Field Groups Listing Meta: Field Order Listing Meta: Field Relations Listing Meta: Property Types Listing Meta: Rooms Listing Meta: Standard Fields Listing Meta: Units Registered Listings Market Statistics Messages News Feed News Feed: Curation News Feed: Events News Feed: Groups News Feed: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Notifications Open Houses Portals Portal Groups Portal Groups: Current Portal Groups: Tags Portals: Listing Categories Portals: Metadata Preferences Properties Properties: Clusters Properties Meta: Standard Fields Saved Searches Saved Searches: Provided Saved Searches: Restrictions Saved Searches: Tags Search Templates: Quick Searches Search Templates: Views Search Templates: Sorts Shared Links System Info System Info: Languages System Info: Search Templates
API Explorer
Supporting Documentation
Examples
RESO Web API
RETS
Terms of Use

Search Templates: Views

Views provide a template for multiple listing reports, defining which standard fields the user has chosen to include.

 
  1. Supported Roles
  2. Available Services
    1. All Views
    2. Individual View
  3. Views 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 Views

/<API Version>/searchtemplates/views

All views belonging to or inheritable by the current user.

HTTP Method Description Conditional Notes
GET Returns all views 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:

 

GET Response

{
    "D": {
        "Results": [
            {
                "ResourceUri": "/v1/searchtemplates/views/20120717212004874996000000",
                "Id": "20130717212004874996000000",
                "Name": "My Listing Grid View",
                "ReportName": "My Listing Grid View",
                "OwnerId": "20000426173054342350000000",
                "MlsId": "20000426143505724628000000",
                "Inheritable": true,
                "Inherited": false,
                "SortId": "20130717211827902622000000",
                "ShowPrimaryPhoto": true,
                "Fields": [
                    {
                        "Domain": "StandardFields",
                        "GroupField": null,
                        "Field": "ListPrice",
                        "Label": "Listing Price"
                    },
                    {
                        "Domain": "StandardFields",
                        "GroupField": null,
                        "Field": "MlsStatus",
                        "Label": null
                    }
                ],
                "ModificationTimestamp": "2013-07-09T15:31:47Z"
            }
        ],
        "Success": true
    }
}
 
 

Individual View

/<API Version>/searchtemplates/views/<Id>

HTTP Method Description Conditional Notes
GET Returns a specified view. 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 views service.

 

Views Description

Attribute Data Type Description
ResourceId Character The resource URI to a particular view.
Id Character The unique id for the view.
Name Character The user specified name for the view.
ReportName Character The user specified name for the view, specifically for reports.
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 view can be inherited by users under the current user's control.
Inherited Boolean If true, the view was inherited from another user.
SortId Character The associated sort record.
ShowPrimaryPhoto Boolean If true, the user expects to see the listing's primary photo when this view is used.
Fields Expansion A list of standard or custom fields used by the listing view.
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.
Label Character An optional user-defined label to override the MLS defined label.
 

Expansions

Expansion Roles Single Record Only? Selection Support? Description
Fields All Yes No A list of fields associated with the view.
 

API Explorer

Interact with this service using the API Explorer.