Search Templates: Views
Views provide a template for multiple listing reports, defining which standard fields the user has chosen to include.
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:
Parameter | Required | Notes |
---|---|---|
Standard search and paging syntax | No | |
Standard selection parameters | No | |
Standard expansion parameters | No |
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 | Searchable | Sortable | Description |
---|---|---|---|---|
ResourceUri |
Character | No | No | The resource URI to a particular view. |
Id |
Character | Yes | Yes | The unique id for the view. |
Name |
Character | Yes | Yes | The user specified name for the view. |
ReportName |
Character | Yes | Yes | The user specified name for the view, specifically for reports. |
OwnerId |
Character | Yes | Yes | The account Id for the user that created the template. |
MlsId |
Character | Yes | Yes | The account Id for the MLS the owner belongs to. |
Inheritable |
Boolean | Yes | Yes | If true , the view can be inherited by users under the current user's control. |
Inherited |
Boolean | Yes | No | If true , the view was inherited from another user. |
SortId |
Character | No | No | The associated sort record. |
ShowPrimaryPhoto |
Boolean | No | No | If true , the user expects to see the listing's primary photo when this view is used. |
CreatedTimestamp |
Timestamp | Yes | Yes | The creation time for the view. |
ModificationTimestamp |
Timestamp | Yes | Yes | The last modification time for the view. |
Fields |
Expansion | No | No | A list of standard or custom fields used by the listing view. |
Fields[n].Domain |
Character | No | No | The type of listing field. One of StandardFields , CustomFields , or CustomFieldGroups . |
Fields[n].GroupField |
Character | No | No | The CustomField group the Field resides under. null if Domain is StandardFields . |
Fields[n].Field |
Character | No | No | The standard or custom field, or, if the Domain is CustomFieldGroups , the name of the group. |
Fields[n].Label |
Character | No | No | 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.