28 fields · Last revised 5/12/2018
5/12/2018| Field | Definition | Type | Usage |
|---|
| Field | Definition | Type | Usage |
|---|---|---|---|
| Class Name ClassName | The class or table to which the rule refers (i.e., Residential, Residential Lease, Income, Mobile, etc.). | String List, Single | — |
| Field Key FieldKey | 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... more | String | — |
| Field Name FieldName | The name of the field to which the rule applies. | String | — |
| History Transactional HistoryTransactional | The history of the Rules record. | Collection | — |
| Modification Timestamp ModificationTimestamp | The transactional timestamp automatically recorded by the MLS system representing the date/time the rule was last modified. | Timestamp | — |
| Original Entry Timestamp OriginalEntryTimestamp | The transactional timestamp automatically recorded by the MLS system representing the date/time the rule was initially entered. | Timestamp | — |
| Originating System OriginatingSystem | The originating system of the Rules 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 Name OriginatingSystemName | The name of the originating record provider where the rule is originally input, which is the legal name of the company and most commonly the name of... more | String | — |
| Originating System Rule Key OriginatingSystemRuleKey | The system key, a unique record identifier, from the originating system. The originating system is the system with authoritative control over the... more | String | — |
| Resource Name ResourceName | The resource to which the rule refers (e.g., Property, Member, Office, Open House, etc.). | String List, Single | — |
| Rule Action RuleAction | The action to be taken when processing the rule. | String | — |
| Rule Description RuleDescription | A detailed textual description of the rule. | String | — |
| Rule Enabled Yes/No RuleEnabledYN | Is the rule currently enabled? | Boolean | — |
| Rule Error Text RuleErrorText | Textual information conveyed when the given rule is in error or fails (e.g., the listing price must be greater than 0). | String | — |
| Rule Expression RuleExpression | The expression or details of the rule. | String | — |
| Rule Format RuleFormat | The format of the rule (e.g., $filter, JavaScript, REBR). | String List, Single | — |
| Rule Help Text RuleHelpText | The text that might be displayed on a form that helps the user fix the rule (e.g., enter phone number in the following 10-digit format: ###-###-####). | String | — |
| Rule Key RuleKey | The primary key of the individual Rule record. | String | — |
| Rule Name RuleName | A descriptive name for the rule. | String | — |
| Rule Order RuleOrder | 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. | Number | — |
| Rule Type RuleType | The type of rule (e.g., Validation, Required, Warning, etc.). | String List, Single | — |
| Rule Version RuleVersion | A rule version that uses semantic versioning. See https://semver.org/. | String | — |
| Rule Warning Text RuleWarningText | Textual information conveyed when a given rule has met a condition that warrants a warning message (e.g., sale price entered differs from listing... more | String | — |
| Source System SourceSystem | The source system of the Rules record. | Resource | — |
| Source System History Key SourceSystemHistoryKey | 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 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 Name SourceSystemName | The name of the rule record provider, that being the system from which the record was directly received and the legal name of the company. | String | — |