Struct reso_dd::Rules

pub struct Rules {
    pub class_name: Option<ClassName>,
    pub field_key: Option<String>,
    pub field_key_numeric: Option<f64>,
    pub field_name: Option<String>,
    pub modification_timestamp: Option<DateTime<FixedOffset>>,
    pub original_entry_timestamp: Option<DateTime<FixedOffset>>,
    pub originating_system_id: Option<String>,
    pub originating_system_name: Option<String>,
    pub originating_system_rule_key: Option<String>,
    pub resource_name: Option<ResourceName>,
    pub rule_action: Option<String>,
    pub rule_description: Option<String>,
    pub rule_enabled_yn: Option<bool>,
    pub rule_error_text: Option<String>,
    pub rule_expression: Option<String>,
    pub rule_format: Option<RuleFormat>,
    pub rule_help_text: Option<String>,
    pub rule_key: Option<String>,
    pub rule_key_numeric: Option<f64>,
    pub rule_name: Option<String>,
    pub rule_order: Option<f64>,
    pub rule_type: Option<String>,
    pub rule_version: Option<String>,
    pub rule_warning_text: Option<String>,
    pub source_system_history_key: Option<String>,
    pub source_system_id: Option<String>,
    pub source_system_name: Option<String>,
}

Rules Resource

Fields

class_name: Option<ClassName>

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

ClassName

field_key: Option<String>

The unique identifier of the field to which the Rule applies. This is a foreign key relating to the field found in the resource per the ResourceName.

FieldKey

field_key_numeric: Option<f64>

The unique identifier of the field to which the Rule applies. This is a foreign key relating to the field found in the resource per the ResourceName. This is the numeric only key and used as an alternative to the FieldKey field.

FieldKeyNumeric

field_name: Option<String>

The name of the field to which the Rule applies.

FieldName

modification_timestamp: Option<DateTime<FixedOffset>>

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

ModificationTimestamp

original_entry_timestamp: Option<DateTime<FixedOffset>>

The transactional timestamp automatically recorded by the MLS system representing the date/time the rule was initially 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 Rule originated. In cases where the Originating system was not where the record originated (the authoritative system), see the Originating System fields.

OriginatingSystemID

originating_system_name: Option<String>

The name of the Originating record provider. Most commonly the name of the MLS. The place where the Rules is originally input. The legal name of the company.

OriginatingSystemName

originating_system_rule_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 Rule originated. 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.

OriginatingSystemRuleKey

resource_name: Option<ResourceName>

The resource to which the Rule refers. E.g. Property, Member, Office, Open House, etc.

ResourceName

rule_action: Option<String>

The action to be taken when processing the rule.

RuleAction

rule_description: Option<String>

A detailed textual description of the rule.

RuleDescription

rule_enabled_yn: Option<bool>

Is the rule currently enabled?

RuleEnabledYN

rule_error_text: Option<String>

Textual information conveyed when the given rule is in error or fails. (e.g. The listing price must be greater than 0.)

RuleErrorText

rule_expression: Option<String>

The expression or details of the rule.

RuleExpression

rule_format: Option<RuleFormat>

$filter, JavaScript, RETS1.8, REBR, etc.… ?

RuleFormat

rule_help_text: Option<String>

The text that might be displayed on a form that helps the user fix the rule (e.g. enter phone number in the 10 digit format ###-###-####.)

RuleHelpText

rule_key: Option<String>

<ac:structured-macro ac:name="tooltip" ac:schema-version="1" ac:macro-id="d9385e45-37c2-4bf8-9f64-6a4568d6b0b4"><ac:parameter ac:name="tip">A single designation identifying what category of fields to which the given field belongs.</ac:parameter><ac:parameter ac:name="text">Group</ac:parameter></ac:structured-macro><ac:link ac:anchor="Group"><ri:page ri:content-title="Data Dictionary Terms and Meta Definitions" />ac:plain-text-link-body</ac:plain-text-link-body></ac:link>: ac:link<ri:page ri:content-title="Rules Resource" />ac:link-bodyRules Resource</ac:link-body></ac:link>

RuleKey

rule_key_numeric: Option<f64>

<ac:structured-macro ac:name="tooltip" ac:schema-version="1" ac:macro-id="dddc1b50-f511-45b5-8c68-773cf136e7b5"><ac:parameter ac:name="tip">A single designation identifying what category of fields to which the given field belongs.</ac:parameter><ac:parameter ac:name="text">Group</ac:parameter></ac:structured-macro><ac:link ac:anchor="Group"><ri:page ri:content-title="Data Dictionary Terms and Meta Definitions" />ac:plain-text-link-body</ac:plain-text-link-body></ac:link>: ac:link<ri:page ri:content-title="Rules Resource" />ac:link-bodyRules Resource</ac:link-body></ac:link>

RuleKeyNumeric

rule_name: Option<String>

A descriptive name for the rule.

RuleName

rule_order: Option<f64>

When in use, execution of rules are to follow the order specified by this field. Any rule that references another field will need to be ordered.

RuleOrder

rule_type: Option<String>

Validation, Required, Warning, etc.

RuleType

rule_version: Option<String>

A semantically-versioned rule version. https://semver.org/

RuleVersion

rule_warning_text: Option<String>

Textual information conveyed when a given rule has met a condition that warrants a warning message. e.g. you've entered a sale price that is has a difference from the listing price greater than 25%.

RuleWarningText

source_system_history_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.

SourceSystemHistoryKey

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_name: Option<String>

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

SourceSystemName

Trait Implementations

impl Clone for Rules

fn clone(&self) -> Rules

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Rules

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

Formats the value using the given formatter.

impl Default for Rules

fn default() -> Rules

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Rules

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

Deserialize this value from the given Serde deserializer.

impl Serialize for Rules

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

Serialize this value into the given Serde serializer.