27 fields · Last revised 8/28/2019
8/28/2019| Field | Definition | Type | Usage |
|---|
| Field | Definition | Type | Usage |
|---|---|---|---|
| Class Name ClassName | The class or table to which the SearchQuery criteria refers (e.g., Residential, Residential Lease, Residential Income, Commercial Sale). | String List, Single | — |
| History Transactional HistoryTransactional | The collection history items related to the SavedSearch record. | Collection | — |
| Member Member | The member associated with the saved search. | Resource | — |
| Member Key MemberKey | A system unique identifier. Specifically, in aggregation systems, the MemberKey is the system unique identifier from the system that the record was... more | String | — |
| Member MLS ID MemberMlsId | The local, well-known identifier for the member. This value may not be unique, specifically in the case of aggregation systems, and it should be the... more | String | — |
| Modification Timestamp ModificationTimestamp | The transactional timestamp automatically recorded by the MLS system representing the date/time that the saved search was last modified. | Timestamp | < 1% |
| Original Entry Timestamp OriginalEntryTimestamp | The transactional timestamp automatically recorded by the MLS system representing the date/time that the saved search was entered. | Timestamp | — |
| Originating System OriginatingSystem | The originating system of the SavedSearch record. | Resource | — |
| Originating System ID OriginatingSystemID | The RESO Unique Organization Identifier (UOI) OrganizationUniqueId of the originating record provider. The originating system is the system with... more | String | — |
| Originating System Key OriginatingSystemKey | The system key, a unique record identifier, from the originating system. The originating system is the system with authoritative control over the... more | String | — |
| Originating System Member Key OriginatingSystemMemberKey | Unique identifier from the originating system, which is commonly a key to that system. In the case where data is passed through more than one system,... more | String | — |
| Originating System Member Name OriginatingSystemMemberName | The name of the originating record provider, most commonly the name of the MLS. The place where the listing is originally input by the member. The... more | String | — |
| Originating System Name OriginatingSystemName | The name of the originating record provider, most commonly the name of the MLS. The place where the saved search is originally input. The legal name... more | String | — |
| Resource Name ResourceName | The resource to which the SearchQuery criteria refers (e.g., Property, OpenHouse, Agent, Office, Contacts). | String List, Single | — |
| Saved Search Description SavedSearchDescription | A textual description of the saved search input by the member who created the saved search. | String | — |
| Saved Search Key SavedSearchKey | A unique identifier for this record from the immediate source. This may be a number or string that can include a Uniform Resource Identifier (URI) or... more | String | < 1% |
| Saved Search Name SavedSearchName | The name given to the search by the member inputting the saved search. | String | — |
| Saved Search Type SavedSearchType | Determines if the saved search used to pass criteria is to be stored and executed by the client or if it is a key to be passed to the host for... more | String List, Single | — |
| Search Query SearchQuery | The textual representation of the search performed by the member that was saved. It is required to present in the OData $filter format. Additional... more | String | — |
| Search Query Exception Details SearchQueryExceptionDetails | A free-text description used to expand on the SearchQueryExceptions selections made by the host. | String | — |
| Search Query Exceptions SearchQueryExceptions | A list of exceptions or errors with the given search query during its creation by the host. Analogous to an error code, this is the host's... more | String List, Single | — |
| Search Query Human Readable SearchQueryHumanReadable | A human readable version of the search query that is commonly used for display and may not contain all actual criteria. For actual search criteria,... more | String | — |
| Search Query Type SearchQueryType | A pick list of the type of query language used in the SearchQuery field (e.g., DMQL2, $filter). | String List, Single | — |
| Source System SourceSystem | The source system of the SavedSearch record. | Resource | — |
| Source System ID SourceSystemID | The RESO Unique Organization Identifier (UOI) OrganizationUniqueId of the source record provider. The source system is the system from which the... more | String | — |
| Source System Key SourceSystemKey | The system key, a unique record identifier, from the source system. The source system is the system from which the record was directly received. In... more | String | — |
| Source System Name SourceSystemName | The name of the record provider of the saved search. The system from which the record was directly received. The legal name of the company. | String | — |