{"_id":"560dab66961d492300d94b49","__v":2,"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"},"editedParams":true,"editedParams2":true,"project":"560d5ac71ec45619006069d6","category":{"_id":"560dabb698a6ae3700673f9f","project":"560d5ac71ec45619006069d6","version":"560d5ac71ec45619006069d9","pages":[],"__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-01T21:55:02.327Z","from_sync":false,"order":4,"slug":"search-components","title":"Search Components"},"githubsync":"","user":"560d5a4faf97231900938125","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-01T21:53:42.478Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"search_items\": [\n        {\n            \"id\": 266,\n            \"name\": \"Chick-Fil-A\",\n            \"favoriteable\": true,\n            \"display_amenities\": false,\n            \"background_color\": \"#FF3366\",\n            \"image_prefix\": \"FastFood\",\n            \"image_name\": \"cfa-fb-main.png\",\n            \"image_path\": \"https://s3.amazonaws.com/iexit/images/logos/000/000/796/small/\",\n            \"sponsored_banner_url\": \"\"\n        },\n        {\n            \"id\": 484,\n            \"name\": \"Chicken Express\",\n            \"favoriteable\": true,\n            \"display_amenities\": false,\n            \"background_color\": \"#FF3366\",\n            \"image_prefix\": \"FastFood\",\n            \"image_name\": \"\",\n            \"image_path\": \"\",\n            \"sponsored_banner_url\": \"\"\n        },\n        {\n            \"id\": 881,\n            \"name\": \"Chicken Salad Chick\",\n            \"favoriteable\": true,\n            \"display_amenities\": false,\n            \"background_color\": \"#CC3333\",\n            \"image_prefix\": \"Food\",\n            \"image_name\": \"\",\n            \"image_path\": \"\",\n            \"sponsored_banner_url\": \"\"\n        },\n        {\n            \"id\": 998,\n            \"name\": \"Chicken Shack\",\n            \"favoriteable\": true,\n            \"display_amenities\": false,\n            \"background_color\": \"#CC3333\",\n            \"image_prefix\": \"Food\",\n            \"image_name\": \"\",\n            \"image_path\": \"\",\n            \"sponsored_banner_url\": \"\"\n        },\n        {\n            \"id\": 1000,\n            \"name\": \"Chicken Coop\",\n            \"favoriteable\": true,\n            \"display_amenities\": false,\n            \"background_color\": \"#CC3333\",\n            \"image_prefix\": \"Food\",\n            \"image_name\": \"\",\n            \"image_path\": \"\",\n            \"sponsored_banner_url\": \"\"\n        },\n        {\n            \"id\": 1253,\n            \"name\": \"Chicago's Pizza\",\n            \"favoriteable\": true,\n            \"display_amenities\": false,\n            \"background_color\": \"#CC3333\",\n            \"image_prefix\": \"Food\",\n            \"image_name\": \"\",\n            \"image_path\": \"\",\n            \"sponsored_banner_url\": \"\"\n        },\n        {\n            \"id\": 1686,\n            \"name\": \"Chicken King\",\n            \"favoriteable\": true,\n            \"display_amenities\": false,\n            \"background_color\": \"#CC3333\",\n            \"image_prefix\": \"Food\",\n            \"image_name\": \"\",\n            \"image_path\": \"\",\n            \"sponsored_banner_url\": \"\"\n        },\n        {\n            \"id\": 1848,\n            \"name\": \"Chicken House\",\n            \"favoriteable\": true,\n            \"display_amenities\": false,\n            \"background_color\": \"#CC3333\",\n            \"image_prefix\": \"Food\",\n            \"image_name\": \"\",\n            \"image_path\": \"\",\n            \"sponsored_banner_url\": \"\"\n        },\n        {\n            \"id\": 2089,\n            \"name\": \"Chickie's & Pete's\",\n            \"favoriteable\": true,\n            \"display_amenities\": false,\n            \"background_color\": \"#CC3333\",\n            \"image_prefix\": \"Food\",\n            \"image_name\": \"\",\n            \"image_path\": \"\",\n            \"sponsored_banner_url\": \"\"\n        },\n        {\n            \"id\": 2151,\n            \"name\": \"Chicken Holiday\",\n            \"favoriteable\": true,\n            \"display_amenities\": false,\n            \"background_color\": \"#CC3333\",\n            \"image_prefix\": \"Food\",\n            \"image_name\": \"\",\n            \"image_path\": \"\",\n            \"sponsored_banner_url\": \"\"\n        },\n        {\n            \"id\": 2167,\n            \"name\": \"Chicken Kitchen\",\n            \"favoriteable\": true,\n            \"display_amenities\": false,\n            \"background_color\": \"#CC3333\",\n            \"image_prefix\": \"Food\",\n            \"image_name\": \"\",\n            \"image_path\": \"\",\n            \"sponsored_banner_url\": \"\"\n        }\n    ]\n}","name":"Results starting with \"chic\""}]},"settings":"","examples":{"codes":[]},"auth":"optional","params":[{"_id":"560eb66cdfdd5a2100e8f033","ref":"","in":"path","required":true,"desc":"User input for searching exits for a particular business or amenity.","default":"","type":"string","name":"input"}],"url":"/search/input/:input"},"isReference":false,"order":1,"body":"** JSON Response **\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Value\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`search_items`\",\n    \"0-1\": \"Array of [Search Item](doc:search-item)\",\n    \"0-2\": \"An array of [Search Item](doc:search-item) objects matching the user's input.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\nThis API allows your iExit client to build a keyword search engine. Results returned by this input-matching API are either business's (like Starbucks, Cracker Barrel, etc) or amenities (like WiFi, DEF, Truck Stop, etc). \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/a9e3c35-IMG_9587.PNG\",\n        \"IMG_9587.PNG\",\n        750,\n        1334,\n        \"#c7c9d0\"\n      ],\n      \"caption\": \"The `Keyword Search` API in use inside the iExit app.\"\n    }\n  ]\n}\n[/block]\n** Common Next API(s) **\n- [Upcoming Exits](doc:upcoming-exits) (assuming the Search Button was selected while viewing Upcoming Exits, supply it with `results[]`.`id`)\n- [Exits for Highway in State](doc:exits-for-highway-in-state) (assuming the Search Button was selected while viewing Exits For Highway In State, , supply it with `results[]`.`id`)","excerpt":"Create an auto-complete search engine for business/amenity keywords.","slug":"keyword-search","type":"endpoint","title":"Keyword Search"}

getKeyword Search

Create an auto-complete search engine for business/amenity keywords.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

input:
required
string
User input for searching exits for a particular business or amenity.

Result Format


Documentation

** JSON Response ** [block:parameters] { "data": { "h-0": "Key", "h-1": "Value", "h-2": "Description", "0-0": "`search_items`", "0-1": "Array of [Search Item](doc:search-item)", "0-2": "An array of [Search Item](doc:search-item) objects matching the user's input." }, "cols": 3, "rows": 1 } [/block] This API allows your iExit client to build a keyword search engine. Results returned by this input-matching API are either business's (like Starbucks, Cracker Barrel, etc) or amenities (like WiFi, DEF, Truck Stop, etc). [block:image] { "images": [ { "image": [ "https://files.readme.io/a9e3c35-IMG_9587.PNG", "IMG_9587.PNG", 750, 1334, "#c7c9d0" ], "caption": "The `Keyword Search` API in use inside the iExit app." } ] } [/block] ** Common Next API(s) ** - [Upcoming Exits](doc:upcoming-exits) (assuming the Search Button was selected while viewing Upcoming Exits, supply it with `results[]`.`id`) - [Exits for Highway in State](doc:exits-for-highway-in-state) (assuming the Search Button was selected while viewing Exits For Highway In State, , supply it with `results[]`.`id`)

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}