id | Integer | Referred to as search_item_id elsewhere |
name | String | Name of this search option |
favoriteable | Boolean | As an API user, you can ignore this value. This is used in iExit to determine if this Search Item can be saved as a favorite. |
display_amenities | Boolean | As an API user, you can ignore this value. It is currently not used. |
background_color | String | A hex value that starts with '#'. Used as the background color with the icon described in image_prefix |
image_prefix | String | The title of the locally stored icon image to be displayed with this search option. You will need to retrieve these icon images from iExit if you want to use the values in image_prefix |
image_name | String | [optional] If this value isn't empty, it should be concatenated with image_path to get the full image path.This is the name of the image icon file to download to use with this search option. |
image_path | String | [optional] If this value isn't empty, it should be concatenated with image_name to get the full image path.This is the path to the image icon file to download to use with this search option. |
sponsored_banner_url | String | [optional] If present, this will be an image to be rendered over the entire row in the search table. See the image below with the Cracker Barrel image to see how this is used. This value will almost always be empty as most Search Items are not sponsored. |