Lookup
GET
/trestle/odata/Lookup
GET
/trestle/rets/search?SearchType=Lookup&Class=Lookup
LookupKey is the primary key and uniquely identifies records in the Lookup resource.
The following fields are considered InKeyIndex fields and may be queried in batches up to 300,000 at a time:
FieldKey, LookupKey, ModelKey, ModificationTimestamp.
Fields
| Field | Type | Size | Description |
|---|---|---|---|
| Definition | String | 8000 | Definition |
| FieldKey InKey | String | 20 | FieldKey |
| FieldName | String | 100 | FieldName |
| LegacyODataValue | String | 100 | The name of the resource the field belongs to. This will be a RESO Standard Name, such as "Property", but may also be a non-standard local resource name. |
| LookupKey Key InKey | String | 20 | The key used to uniquely identify the lookup entry. |
| LookupName | String | 100 | The name of the group of enumerations comprising the given lookup (aka picklist). It is called a "LookupName" in this proposal because more than one field can have a given lookup, so it refers to the name of the lookup rather than a given field. For example, Listing with CountyOrParish and Office with OfficeCountyOrParish having the same CountyOrParish LookupName. This MUST match the Data Dictionary definition for cases where the lookup is defined. Vendors MAY add their own enumerations otherwise. The LookupName that a given field uses is required to be annotated at the field level in the OData XML Metadata. |
| LookupValue | String | 100 | The human-friendly display name the data consumer receives in the payload and uses in queries. This may be a local name or synonym for a given RESO Data Dictionary lookup item. |
| ModelKey InKey | String | 20 | ModelKey |
| ModificationTimestamp InKey | DateTimeOffset | The timestamp for when the enumeration value was last modified. The timestamp for when the enumeration value was last modified. | |
| OdataOverride | String | OdataOverride | |
| RESOStandardYN | Boolean | RESOStandardYN | |
| ResourceName | String | 100 | ResourceName |
| StandardLookupValue | String | 100 | The Data Dictionary StandardLookupValue of the enumerated value. This field is required when the LookupValue for a given item corresponds to a RESO standard value, meaning a standard lookup display name, known synonym, local name, or translation of that value. Local lookups MAY omit this value if they don't correspond to an existing RESO standard lookup value. |
| SystemReferenceCount | Int64 | 10 | SystemReferenceCount |
| SystemReferences | String | 8000 | SystemReferences |