RESO: Lookup

The Lookup service lists all possible values for fields which have a discrete list of defined values.

Supported Roles
Available Services
1. Lookup field values
Lookup Description
Usage Notes
Expansions

Supported Roles

Role	Reads	Writes
IDX	Yes	No
Public	Yes	No
VOW	Yes	No
Portal	Yes	No
Private	Yes	No

More information about roles may be found here.

Available Services

Lookup field values

`/Reso/OData/Lookup`

HTTP Method	Description	Conditional	Notes
GET	Returns the list of possible values for a given field.	No
POST	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
PUT	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
DELETE	Returns HTTP 405 (Method Not Allowed)	No	Not implemented

GET Request

Parameters:

Parameter	Required	Notes
Attribute selection parameters	No
Pagination parameters	No
Searching parameters	No
Sorting parameters	No

GET Response

{
    "@odata.context": "https://sparkapi.com/Reso/OData/$metadata#Lookup",
    "@odata.nextLink": "https://sparkapi.com/Reso/OData/Lookup?%24skip=2",
    "value": [
        {
            "LookupName": "MemberLanguages",
            "LookupValue": "Irish (Gaelic)",
            "StandardLookupValue": "Irish (Gaelic)",
            "LegacyODataValue": "Irish",
            "ModificationTimestamp": "2021-06-03T17:43:35Z",
            "LookupKey": "2027-2027-2614-97",
            "@odata.id": "https://sparkapi.com/Reso/OData/Lookup('2027-2027-2614-97')"
        },
        {
            "LookupName": "MemberType",
            "LookupValue": "Association Staff",
            "StandardLookupValue": "Association Staff",
            "LegacyODataValue": "b__3h43te5sge4whybhaatcaa",
            "ModificationTimestamp": "2021-06-07T17:30:11Z",
            "LookupKey": "2051-2051-2743-98",
            "@odata.id": "https://sparkapi.com/Reso/OData/Lookup('2051-2051-2743-98')"
        }
    ]
}

Lookup Description

Attribute	Data Type	Searchable	Description
`LookupName`	Character	Yes	The name of the RESO Web API field to which the lookup value belongs.
`LookupValue`	Character	Yes	The field value that will appear in the RESO Web API payload. This will replace the `LegacyODataValue`.
`StandardLookupValue`	Character	Yes	The corresponding RESO Data Dictionary term, when applicable.
`LegacyODataValue`	Character	Yes	The value currently delivered in the RESO Web API payload, including encoded `b__` lookup values.
`ModificationTimestamp`	Datetime	Yes	The time and date when the field value was last modified.
`LookupKey`	Character	No	The unique system key for the field value.

Usage Notes

To look up the possible values for any given field, use a filter on LookupName:

https://sparkapi.com/Reso/OData/Lookup?$filter=LookupName eq 'AssociationAmenities'

This service does not return all possible values at once by default. It will only return the first 10 matching field value records unless otherwise specified with the $top parameter:
```
https://sparkapi.com/Reso/OData/Lookup?$top=25
```

Expansions

None.