Struct reso_dd::SavedSearch

pub struct SavedSearch {
    pub class_name: Option<ClassName>,
    pub member_key: Option<String>,
    pub member_key_numeric: Option<f64>,
    pub member_mls_id: Option<String>,
    pub modification_timestamp: Option<DateTime<FixedOffset>>,
    pub original_entry_timestamp: Option<DateTime<FixedOffset>>,
    pub originating_system_id: Option<String>,
    pub originating_system_key: Option<String>,
    pub originating_system_member_key: Option<String>,
    pub originating_system_member_name: Option<String>,
    pub originating_system_name: Option<String>,
    pub resource_name: Option<ResourceName>,
    pub saved_search_description: Option<String>,
    pub saved_search_key: Option<String>,
    pub saved_search_key_numeric: Option<f64>,
    pub saved_search_name: Option<String>,
    pub saved_search_type: Option<String>,
    pub search_query: Option<String>,
    pub search_query_exception_details: Option<String>,
    pub search_query_exceptions: Option<String>,
    pub search_query_human_readable: Option<String>,
    pub search_query_type: Option<SearchQueryType>,
    pub source_system_id: Option<String>,
    pub source_system_key: Option<String>,
    pub source_system_name: Option<String>,
}

SavedSearch Resource

Fields

class_name: Option<ClassName>

The class or table to which the SearchQuery criteria refers. i.e. Residential, Residential Lease, Income, Mobile, etc.

ClassName

member_key: Option<String>

A system unique identifier. Specifically, in aggregation systems, the MemberKey is the system unique identifier from the system that the record was retrieved. This may be identical to the related xxxId. This is a foreign key relating to the Member resource's MemberKey.

MemberKey

member_key_numeric: Option<f64>

A system unique identifier. Specifically, in aggregation systems, the MemberKey is the system unique identifier from the system that the record was retrieved. This may be identical to the related xxxId. This is a foreign key relating to the Member resource's MemberKey. This is the numeric only key and used as an alternative to the MemberKey field.

MemberKeyNumeric

member_mls_id: Option<String>

The local, well-known identifier for the member. This value may not be unique, specifically in the case of aggregation systems, this value should be the identifier from the original system.

MemberMlsId

modification_timestamp: Option<DateTime<FixedOffset>>

The transactional timestamp automatically recorded by the MLS system representing the date/time the saved search was last modified.

ModificationTimestamp

original_entry_timestamp: Option<DateTime<FixedOffset>>

The transactional timestamp automatically recorded by the MLS system representing the date/time the saved search was entered.

OriginalEntryTimestamp

originating_system_id: Option<String>

The RESO OUID's OrganizationUniqueId of the Originating record provider. The Originating system is the system with authoritative control over the record. For example; the name of the MLS where the Saved Search was input. In cases where the Originating system was not where the record originated (the authoritative system), see the Originating System fields.

OriginatingSystemID

originating_system_key: Option<String>

The system key, a unique record identifier, from the Originating system. The Originating system is the system with authoritative control over the record. For example, the Multiple Listing Service where the Saved Search was input. There may be cases where the Source System (how you received the record) is not the Originating System. See Source System Key for more information.

OriginatingSystemKey

originating_system_member_key: Option<String>

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, this is the originating system key. This is a foreign key relating to the system where this record was originated.

OriginatingSystemMemberKey

originating_system_member_name: Option<String>

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 legal name of the company. To be used for display.

OriginatingSystemMemberName

originating_system_name: Option<String>

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 of the company.

OriginatingSystemName

resource_name: Option<ResourceName>

The resource to which the SearchQuery criteria refers. i.e. Property, Open House, Agent, Office, Contact, etc.

ResourceName

saved_search_description: Option<String>

A textual description of the saved search input by the member who created the saved search.

SavedSearchDescription

saved_search_key: Option<String>

A unique identifier for this record from the immediate source. This may be a number, or string that can include URI or other forms. This is the system you are connecting to and not necessarily the original source of the record.

SavedSearchKey

saved_search_key_numeric: Option<f64>

A unique identifier for this record from the immediate source. This may be a number, or string that can include URI or other forms. This is the system you are connecting to and not necessarily the original source of the record. This is the numeric only key and used as an alternative to the SavedSearchKey field.

SavedSearchKeyNumeric

saved_search_name: Option<String>

The name given to the search by the member inputting the saved search.

SavedSearchName

saved_search_type: Option<String>

Is the saved search used to pass criteria to be stored and executed by the client or is the saved search a key to be passed to the host for execution. i.e. Client Receives Criteria, Host Returns Listings. This may be described at the record level with this field, or at some other level of implementation to be determined by RESO R&D.

SavedSearchType

search_query: Option<String>

Textual representation of the search performed by the member that was saved. It is required to present in ODATA's $filter format. Additional formats are under review. See additional documentation for specific requirements for this field.

SearchQuery

search_query_exception_details: Option<String>

A free text description used to expand on the SearchQueryExceptions selections made by the host.

SearchQueryExceptionDetails

search_query_exceptions: Option<String>

A list of exceptions or errors with the given search query during it's creation by the host. Analogous to an error code this is the host's opportunity to describe an inability to fully express a saved search under the constraints of the given protocol. i.e. $filter. The client may use this information to bring attention to the user about a given saved search and a need to review or recreate the search.

SearchQueryExceptions

search_query_human_readable: Option<String>

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, use the SearchQuery field.

SearchQueryHumanReadable

search_query_type: Option<SearchQueryType>

A picklist of the type of query language used in the SearchQuery field. i.e. DMQL2, $filter, etc.

SearchQueryType

source_system_id: Option<String>

The RESO OUID's OrganizationUniqueId of the Source record provider. The source system is the system from which the record was directly received. In cases where the source system was not where the record originated (the authoritative system), see the Originating System fields.

SourceSystemID

source_system_key: Option<String>

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 cases where the Source System was not where the record originated (the authoritative system), see the Originating System fields.

SourceSystemKey

source_system_name: Option<String>

The name of the Saved Search record provider. The system from which the record was directly received. The legal name of the company.

SourceSystemName

Trait Implementations

impl Clone for SavedSearch

fn clone(&self) -> SavedSearch

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SavedSearch

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for SavedSearch

fn default() -> SavedSearch

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for SavedSearch

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for SavedSearch

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.