{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","params":[],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"Business / POI","type":"basic","slug":"business-poi","excerpt":"","body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`id`\",\n    \"0-1\": \"Integer\",\n    \"0-2\": \"Referred to as `business_id` elsewhere throughout the API.\",\n    \"1-0\": \"`establishment_id`\",\n    \"1-1\": \"Integer\",\n    \"2-0\": \"`brand_name`\",\n    \"2-1\": \"String\",\n    \"4-0\": \"`phone`\",\n    \"4-1\": \"String\",\n    \"5-0\": \"`latitude`\",\n    \"5-1\": \"Double\",\n    \"6-0\": \"`longitude`\",\n    \"6-1\": \"Double\",\n    \"3-0\": \"`name`\",\n    \"3-1\": \"String\",\n    \"7-0\": \"`formatted_address`\",\n    \"7-1\": \"String\",\n    \"8-0\": \"`website`\",\n    \"8-1\": \"String\",\n    \"9-0\": \"`claimed`\",\n    \"9-1\": \"Integer\",\n    \"10-0\": \"`distance`\",\n    \"10-1\": \"Double\",\n    \"11-0\": \"`amenities`\",\n    \"11-1\": \"Array of [Amenity](doc:amenity)s\",\n    \"12-0\": \"`top_priority_amenity`\",\n    \"12-1\": \"[Amenity](doc:amenity)\",\n    \"13-0\": \"`promotion`\",\n    \"13-1\": \"[Promotion](doc:promotion)\",\n    \"14-0\": \"`logo`\",\n    \"14-1\": \"[Logo](doc:logo)\",\n    \"15-0\": \"`images`\",\n    \"15-1\": \"Array of [POI Image](doc:poi-image)s\",\n    \"16-0\": \"`exit_mapping`\",\n    \"16-1\": \"[Exit Mapping](doc:exit-mapping)\",\n    \"1-2\": \"The ID for the associated chain. \\n\\nNote: Chain, Brand, and Establishment are all synonyms.\\n\\nIf this is a POI belonging to McDonalds, then the `establishment_id` would be 153, which is the case for every McDonalds POI.\\n\\nFor POIs that are independently owned or not part of a larger chain, we have \\\"Independent\\\" Establishments. For an non-chain hotel, it would belong to the \\\"Independent Lodging\\\" Establishment.\",\n    \"2-2\": \"In the above example, \\\"McDonalds\\\" and \\\"Independent Lodging\\\" would be the `brand_name`\",\n    \"3-2\": \"Some POIs have specific names that differ from the `brand_name`. This is common for non-chain/independent POIs.\\n\\nFor example, a hotel that belongs to the \\\"Independent Lodging\\\" Establishment might be named \\\"American Classic Inn\\\".\",\n    \"4-2\": \"The phone number in the format 1-XXX-XXX-XXXX.\",\n    \"5-2\": \"The POI coordinate's latitude.\",\n    \"6-2\": \"The POI coordinate's longitude.\",\n    \"7-2\": \"A formatted string that contains the POI's address, city, state, and postal code.\",\n    \"8-2\": \"The POI's website URL. This might be empty if we do not have their website.\",\n    \"9-2\": \"0 or 1 depending on if the business owner has claimed this business on the iExit Business Dashboard website.\",\n    \"10-2\": \"[Optional] If this object is returned as part of the [Nearby POIs API](doc:nearby-pois), then this field will contain the number of miles away from the center coordinate. \\n\\nIf appearing in an API besides the [Nearby POIs API](doc:nearby-pois), this field will be omitted.\",\n    \"11-2\": \"[Optional] An array of every [Amenity](doc:amenity)s we have for this POI\",\n    \"12-2\": \"The most \\\"important\\\" [Amenity](doc:amenity) which will come with information on how to render its icon.\\n\\nWe might have 20 amenities for a gas station with diesel fuel, but the Diesel [Amenity](doc:amenity) is the most defining [Amenity](doc:amenity) of the 20, so it would go in this field.\",\n    \"13-2\": \"[Optional] If this POI is running a current [Promotion](doc:promotion), it will show up here.\",\n    \"14-2\": \"[Optional] If this POI has a custom [Logo](doc:logo), it will show up here.\",\n    \"16-2\": \"[Optional] If `exit_id` was supplied in the URL, an [Exit Mapping](doc:exit-mapping) object will show up as a child of `business`. This will contain information as to the relative location of the POI from the [Exit](doc:exit).\",\n    \"15-2\": \"[Optional] If this POI has any uploaded [POI Image](doc:poi-image)s, they will show up here as an array.\",\n    \"17-0\": \"`fuel_prices`\",\n    \"17-1\": \"Array of [Fuel Price](doc:fuel-price)s\",\n    \"17-2\": \"[Optional] If this business is a gas station, and if this gas station has integrated prices from GasBuddy/OPIS, then each type of fuel will appear in its own [Fuel Price](doc:fuel-price) object.\"\n  },\n  \"cols\": 3,\n  \"rows\": 18\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/zfLuKW3eRgiiziI1D5mH_Photo%20Oct%2005,%204%2031%2006%20PM.png\",\n        \"Photo Oct 05, 4 31 06 PM.png\",\n        \"750\",\n        \"1334\",\n        \"\",\n        \"\"\n      ],\n      \"caption\": \"Top half of a sample POI Details page inside the iExit iOS app. This page hopefully helps demonstrate how the above data can be used in an iExit client UI.\"\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/2gQ2vgEQHiJYdXsMEyOm_Photo%20Oct%2005,%204%2049%2018%20PM.png\",\n        \"Photo Oct 05, 4 49 18 PM.png\",\n        \"750\",\n        \"1334\",\n        \"#ce3452\",\n        \"\"\n      ],\n      \"caption\": \"The bottom half of a sample POI Details page inside the iExit iOS app. You can see all aspects of the above data used through this page.\"\n    }\n  ]\n}\n[/block]","updates":[],"order":6,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"560f04a352ef1a0d00c49cb5","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["560d5ac81ec45619006069da","560dabb698a6ae3700673f9f","560dabe1961d492300d94b4b","560dac2cd10a730d0081ac92","560dacb26660a03700976de4","560ebbffcac9dc0d007af87a"],"_id":"560d5ac71ec45619006069d9","releaseDate":"2015-10-01T16:09:43.711Z","__v":6,"createdAt":"2015-10-01T16:09:43.711Z","project":"560d5ac71ec45619006069d6"},"__v":7,"githubsync":"","project":"560d5ac71ec45619006069d6","user":"560d5a4faf97231900938125","category":{"sync":{"isSync":false,"url":""},"pages":["560ebc0e54af2b0d005bbf8a","560ebc22c4e4ae0d00b42f97","560ebc3059cb8d0d0015cd61","560efe33de15f60d0018d2ce","560f04a352ef1a0d00c49cb5","560f050552ef1a0d00c49cb7","560f051dde15f60d0018d2dc","560f053752ef1a0d00c49cb9","560f0541de15f60d0018d2de","560f054c9812c10d002729ee","560f055543ea130d00a3622e","560f055ca36c610d00e70154","560f05649812c10d002729f0","56127f8b09bdc51700696fe8","56127f9a436e0b0d00012a19","56a673332ec8310d007bc20f"],"title":"Object Reference","slug":"object-reference","order":9999,"from_sync":false,"reference":false,"_id":"560ebbffcac9dc0d007af87a","project":"560d5ac71ec45619006069d6","createdAt":"2015-10-02T17:16:47.793Z","version":"560d5ac71ec45619006069d9","__v":16},"createdAt":"2015-10-02T22:26:43.140Z","parentDoc":null}

Documentation

Data Hierarchy

On Highway Functionality

Radius-based Searching

Search Components

Object Reference

Business / POI

[block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-0": "`id`", "0-1": "Integer", "0-2": "Referred to as `business_id` elsewhere throughout the API.", "1-0": "`establishment_id`", "1-1": "Integer", "2-0": "`brand_name`", "2-1": "String", "4-0": "`phone`", "4-1": "String", "5-0": "`latitude`", "5-1": "Double", "6-0": "`longitude`", "6-1": "Double", "3-0": "`name`", "3-1": "String", "7-0": "`formatted_address`", "7-1": "String", "8-0": "`website`", "8-1": "String", "9-0": "`claimed`", "9-1": "Integer", "10-0": "`distance`", "10-1": "Double", "11-0": "`amenities`", "11-1": "Array of [Amenity](doc:amenity)s", "12-0": "`top_priority_amenity`", "12-1": "[Amenity](doc:amenity)", "13-0": "`promotion`", "13-1": "[Promotion](doc:promotion)", "14-0": "`logo`", "14-1": "[Logo](doc:logo)", "15-0": "`images`", "15-1": "Array of [POI Image](doc:poi-image)s", "16-0": "`exit_mapping`", "16-1": "[Exit Mapping](doc:exit-mapping)", "1-2": "The ID for the associated chain. \n\nNote: Chain, Brand, and Establishment are all synonyms.\n\nIf this is a POI belonging to McDonalds, then the `establishment_id` would be 153, which is the case for every McDonalds POI.\n\nFor POIs that are independently owned or not part of a larger chain, we have \"Independent\" Establishments. For an non-chain hotel, it would belong to the \"Independent Lodging\" Establishment.", "2-2": "In the above example, \"McDonalds\" and \"Independent Lodging\" would be the `brand_name`", "3-2": "Some POIs have specific names that differ from the `brand_name`. This is common for non-chain/independent POIs.\n\nFor example, a hotel that belongs to the \"Independent Lodging\" Establishment might be named \"American Classic Inn\".", "4-2": "The phone number in the format 1-XXX-XXX-XXXX.", "5-2": "The POI coordinate's latitude.", "6-2": "The POI coordinate's longitude.", "7-2": "A formatted string that contains the POI's address, city, state, and postal code.", "8-2": "The POI's website URL. This might be empty if we do not have their website.", "9-2": "0 or 1 depending on if the business owner has claimed this business on the iExit Business Dashboard website.", "10-2": "[Optional] If this object is returned as part of the [Nearby POIs API](doc:nearby-pois), then this field will contain the number of miles away from the center coordinate. \n\nIf appearing in an API besides the [Nearby POIs API](doc:nearby-pois), this field will be omitted.", "11-2": "[Optional] An array of every [Amenity](doc:amenity)s we have for this POI", "12-2": "The most \"important\" [Amenity](doc:amenity) which will come with information on how to render its icon.\n\nWe might have 20 amenities for a gas station with diesel fuel, but the Diesel [Amenity](doc:amenity) is the most defining [Amenity](doc:amenity) of the 20, so it would go in this field.", "13-2": "[Optional] If this POI is running a current [Promotion](doc:promotion), it will show up here.", "14-2": "[Optional] If this POI has a custom [Logo](doc:logo), it will show up here.", "16-2": "[Optional] If `exit_id` was supplied in the URL, an [Exit Mapping](doc:exit-mapping) object will show up as a child of `business`. This will contain information as to the relative location of the POI from the [Exit](doc:exit).", "15-2": "[Optional] If this POI has any uploaded [POI Image](doc:poi-image)s, they will show up here as an array.", "17-0": "`fuel_prices`", "17-1": "Array of [Fuel Price](doc:fuel-price)s", "17-2": "[Optional] If this business is a gas station, and if this gas station has integrated prices from GasBuddy/OPIS, then each type of fuel will appear in its own [Fuel Price](doc:fuel-price) object." }, "cols": 3, "rows": 18 } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/zfLuKW3eRgiiziI1D5mH_Photo%20Oct%2005,%204%2031%2006%20PM.png", "Photo Oct 05, 4 31 06 PM.png", "750", "1334", "", "" ], "caption": "Top half of a sample POI Details page inside the iExit iOS app. This page hopefully helps demonstrate how the above data can be used in an iExit client UI." } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/2gQ2vgEQHiJYdXsMEyOm_Photo%20Oct%2005,%204%2049%2018%20PM.png", "Photo Oct 05, 4 49 18 PM.png", "750", "1334", "#ce3452", "" ], "caption": "The bottom half of a sample POI Details page inside the iExit iOS app. You can see all aspects of the above data used through this page." } ] } [/block]