{"_id":"593ff856b2f33c000fc141fb","project":"560d5ac71ec45619006069d6","version":{"_id":"560d5ac71ec45619006069d9","__v":6,"project":"560d5ac71ec45619006069d6","createdAt":"2015-10-01T16:09:43.711Z","releaseDate":"2015-10-01T16:09:43.711Z","categories":["560d5ac81ec45619006069da","560dabb698a6ae3700673f9f","560dabe1961d492300d94b4b","560dac2cd10a730d0081ac92","560dacb26660a03700976de4","560ebbffcac9dc0d007af87a"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"560ebbffcac9dc0d007af87a","project":"560d5ac71ec45619006069d6","pages":["560ebc0e54af2b0d005bbf8a","560ebc22c4e4ae0d00b42f97","560ebc3059cb8d0d0015cd61","560efe33de15f60d0018d2ce","560f04a352ef1a0d00c49cb5","560f050552ef1a0d00c49cb7","560f051dde15f60d0018d2dc","560f053752ef1a0d00c49cb9","560f0541de15f60d0018d2de","560f054c9812c10d002729ee","560f055543ea130d00a3622e","560f055ca36c610d00e70154","560f05649812c10d002729f0","56127f8b09bdc51700696fe8","56127f9a436e0b0d00012a19","56a673332ec8310d007bc20f"],"version":"560d5ac71ec45619006069d9","__v":16,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-02T17:16:47.793Z","from_sync":false,"order":9999,"slug":"object-reference","title":"Object Reference"},"user":"560d5a4faf97231900938125","githubsync":"","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-06-13T14:36:06.095Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":20,"body":"[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`id`\",\n    \"0-1\": \"Integer\",\n    \"0-2\": \"Referred to as `search_item_id` elsewhere\",\n    \"1-0\": \"`name`\",\n    \"1-1\": \"String\",\n    \"1-2\": \"Name of this search option\",\n    \"2-0\": \"`favoriteable`\",\n    \"2-1\": \"Boolean\",\n    \"2-2\": \"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.\",\n    \"3-0\": \"`display_amenities`\",\n    \"3-1\": \"Boolean\",\n    \"3-2\": \"As an API user, you can ignore this value. It is currently not used.\",\n    \"4-0\": \"`background_color`\",\n    \"4-1\": \"String\",\n    \"4-2\": \"A hex value that starts with '#'. Used as the background color with the icon described in `image_prefix`\",\n    \"5-0\": \"`image_prefix`\",\n    \"5-1\": \"String\",\n    \"5-2\": \"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`\",\n    \"6-0\": \"`image_name`\",\n    \"6-1\": \"String\",\n    \"6-2\": \"[optional]\\n\\nIf this value isn't empty, it should be concatenated with `image_path` to get the full image path.\\n\\nThis is the name of the image icon file to download to use with this search option.\",\n    \"7-1\": \"String\",\n    \"7-0\": \"`image_path`\",\n    \"7-2\": \"[optional]\\n\\nIf this value isn't empty, it should be concatenated with `image_name` to get the full image path.\\n\\nThis is the path to the image icon file to download to use with this search option.\",\n    \"8-0\": \"`sponsored_banner_url`\",\n    \"8-1\": \"String\",\n    \"8-2\": \"[optional]\\n\\nIf 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.\\n\\nThis value will almost always be empty as most Search Items are not sponsored.\"\n  },\n  \"cols\": 3,\n  \"rows\": 9\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/416f934-IMG_9588.PNG\",\n        \"IMG_9588.PNG\",\n        750,\n        1334,\n        \"#467b5f\"\n      ],\n      \"caption\": \"\\\"Gas\\\", \\\"Food\\\", \\\"Lodging\\\", and so on are all Search Items. Please note how the first Search Item in the \\\"Sponsored\\\" Search Section is a banner image. That is because it has a non-empty `sponsored_banner_url` value.\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"search-item","type":"basic","title":"Search Item"}
[block:parameters] { "data": { "0-0": "`id`", "0-1": "Integer", "0-2": "Referred to as `search_item_id` elsewhere", "1-0": "`name`", "1-1": "String", "1-2": "Name of this search option", "2-0": "`favoriteable`", "2-1": "Boolean", "2-2": "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.", "3-0": "`display_amenities`", "3-1": "Boolean", "3-2": "As an API user, you can ignore this value. It is currently not used.", "4-0": "`background_color`", "4-1": "String", "4-2": "A hex value that starts with '#'. Used as the background color with the icon described in `image_prefix`", "5-0": "`image_prefix`", "5-1": "String", "5-2": "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`", "6-0": "`image_name`", "6-1": "String", "6-2": "[optional]\n\nIf this value isn't empty, it should be concatenated with `image_path` to get the full image path.\n\nThis is the name of the image icon file to download to use with this search option.", "7-1": "String", "7-0": "`image_path`", "7-2": "[optional]\n\nIf this value isn't empty, it should be concatenated with `image_name` to get the full image path.\n\nThis is the path to the image icon file to download to use with this search option.", "8-0": "`sponsored_banner_url`", "8-1": "String", "8-2": "[optional]\n\nIf 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.\n\nThis value will almost always be empty as most Search Items are not sponsored." }, "cols": 3, "rows": 9 } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/416f934-IMG_9588.PNG", "IMG_9588.PNG", 750, 1334, "#467b5f" ], "caption": "\"Gas\", \"Food\", \"Lodging\", and so on are all Search Items. Please note how the first Search Item in the \"Sponsored\" Search Section is a banner image. That is because it has a non-empty `sponsored_banner_url` value." } ] } [/block]