{"_id":"560daa8461f78a2300660adc","__v":1,"category":{"_id":"560dacb26660a03700976de4","project":"560d5ac71ec45619006069d6","version":"560d5ac71ec45619006069d9","__v":2,"pages":["5611758fb177ce190073d70a","56128cc85b4fb72300748549"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-01T21:59:14.130Z","from_sync":false,"order":1,"slug":"data-hierarchy","title":"Data Hierarchy"},"project":"560d5ac71ec45619006069d6","user":"560d5a4faf97231900938125","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"},"editedParams2":true,"githubsync":"","editedParams":true,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-01T21:49:56.412Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"name":"","code":"{\n  \"exit\": {\n    \"id\": 14634,\n    \"exit_latitude\": \"30.793841\",\n    \"exit_longitude\": \"-88.102556\",\n    \"destination_latitude\": \"30.802167\",\n    \"destination_longitude\": \"-88.103663\",\n    \"city\": \"Saraland\",\n    \"state\": \"Alabama\",\n    \"postal_code\": \"36571\",\n    \"exit_description\": \"SR-158 / SR-213 – Eight Mile, Saraland\",\n    \"sign_label_line_one\": \"EXIT\",\n    \"sign_label_line_two\": \"13\",\n    \"sign_number\": \"13\",\n    \"formatted_sign_name\": \"Exit 13\",\n    \"highway_exit_type_id\": 1,\n    \"highway_exit_type\": \"Exit\",\n    \"highway_exit_sign_background_color\": \"#67B964\",\n    \"highway_exit_sign_text_color\": \"#ffffff\",\n    \"highway_in_state\": {\n      \"id\": 123,\n      \"highway\": {\n        \"id\": 42,\n        \"display_name\": \"I-65\",\n        \"sign_name\": \"65\",\n        \"sign_web_background_image\": \"interstate-bg.svg\",\n        \"sign_background_image_small\": \"interstatesign_small.png\",\n        \"sign_background_image_large\": \"interstatesign_large.png\",\n        \"sign_text_color\": \"#FFFFFF\",\n        \"highway_sign_class\": \"interstate-bg\",\n        \"highway_type_id\": 1,\n        \"highway_type\": \"Interstate\",\n        \"positive_direction\": \"North\",\n        \"negative_direction\": \"South\",\n        \"direction_suffix\": \"bound\"\n      },\n      \"state\": {\n        \"id\": 1,\n        \"short_name\": \"AL\",\n        \"long_name\": \"Alabama\"\n      },\n      \"direction\": {\n        \"current_direction\": \"North\",\n        \"reverse_direction\": \"South\",\n        \"direction_suffix\": \"bound\"\n      }\n    }\n  },\n  \"reverse_exit\": {\n    \"id\": 15159,\n    \"exit_latitude\": \"30.806677\",\n    \"exit_longitude\": \"-88.104175\",\n    \"destination_latitude\": \"30.802225\",\n    \"destination_longitude\": \"-88.106968\",\n    \"city\": \"Saraland\",\n    \"state\": \"Alabama\",\n    \"postal_code\": \"36571\",\n    \"exit_description\": \"SR-158 / SR-213 – Eight Mile, Saraland\",\n    \"sign_label_line_one\": \"EXIT\",\n    \"sign_label_line_two\": \"13\",\n    \"sign_number\": \"13\",\n    \"formatted_sign_name\": \"Exit 13\",\n    \"highway_exit_type_id\": 1,\n    \"highway_exit_type\": \"Exit\",\n    \"highway_exit_sign_background_color\": \"#67B964\",\n    \"highway_exit_sign_text_color\": \"#ffffff\"\n  },\n  \"previous_exit\": {\n    \"id\": 14633,\n    \"exit_latitude\": \"30.763576\",\n    \"exit_longitude\": \"-88.092626\",\n    \"destination_latitude\": \"30.767141\",\n    \"destination_longitude\": \"-88.092707\",\n    \"city\": \"Mobile\",\n    \"state\": \"Alabama\",\n    \"postal_code\": \"36611\",\n    \"exit_description\": \"West Lee Street\",\n    \"sign_label_line_one\": \"EXIT\",\n    \"sign_label_line_two\": \"10\",\n    \"sign_number\": \"10\",\n    \"formatted_sign_name\": \"Exit 10\",\n    \"highway_exit_type_id\": 1,\n    \"highway_exit_type\": \"Exit\",\n    \"highway_exit_sign_background_color\": \"#67B964\",\n    \"highway_exit_sign_text_color\": \"#ffffff\"\n  },\n  \"next_exit\": {\n    \"id\": 14635,\n    \"exit_latitude\": \"30.826564\",\n    \"exit_longitude\": \"-88.091289\",\n    \"destination_latitude\": \"30.829727\",\n    \"destination_longitude\": \"-88.087909\",\n    \"city\": \"Saraland\",\n    \"state\": \"Alabama\",\n    \"postal_code\": \"36571\",\n    \"exit_description\": \"Saraland, Citronelle\",\n    \"sign_label_line_one\": \"EXIT\",\n    \"sign_label_line_two\": \"15\",\n    \"sign_number\": \"15\",\n    \"formatted_sign_name\": \"Exit 15\",\n    \"highway_exit_type_id\": 1,\n    \"highway_exit_type\": \"Exit\",\n    \"highway_exit_sign_background_color\": \"#67B964\",\n    \"highway_exit_sign_text_color\": \"#ffffff\"\n  },\n  \"categories\": [\n    {\n      \"id\": 1,\n      \"name\": \"Fuel\",\n      \"background_color\": \"#0033CC\",\n      \"image_prefix\": \"Gas\",\n      \"businesses\": [\n        {\n          \"id\": 237165,\n          \"establishment_id\": 478,\n          \"phone\": \"1-251-679-7067\",\n          \"latitude\": \"30.8021\",\n          \"longitude\": \"-88.1015\",\n          \"name\": \"Murphy USA\",\n          \"brand_name\": \"Murphy USA\",\n          \"formatted_address\": \"1091 Industrial Parkway, Saraland, AL 36571\",\n          \"website\": \"http://www.murphyusa.com\",\n          \"claimed\": 0,\n          \"exit_mapping\": {\n            \"exit_id\": 14634,\n            \"distance\": \"0.13\",\n            \"cardinal_direction_short\": \"E\",\n            \"cardinal_direction_long\": \"East\",\n            \"turn_direction_short\": \"R\",\n            \"turn_direction_long\": \"Right\"\n          },\n          \"amenities\": [\n            {\n              \"id\": 1,\n              \"name\": \"Unleaded\",\n              \"background_color\": \"#0099FF\",\n              \"image_prefix\": \"Gas\",\n              \"priority\": 1\n            },\n            {\n              \"id\": 2,\n              \"name\": \"Diesel\",\n              \"background_color\": \"#006600\",\n              \"image_prefix\": \"Diesel\",\n              \"priority\": 1\n            }\n          ],\n          \"top_priority_amenity\": {\n            \"id\": 2,\n            \"name\": \"Diesel\",\n            \"background_color\": \"#006600\",\n            \"image_prefix\": \"Diesel\",\n            \"priority\": 1\n          }\n        },\n        {\n          \"id\": 150699,\n          \"establishment_id\": 114,\n          \"phone\": \"1-251-679-1159\",\n          \"latitude\": \"30.8017\",\n          \"longitude\": \"-88.10017\",\n          \"name\": \"Shell\",\n          \"brand_name\": \"Shell\",\n          \"formatted_address\": \"1121 Industrial Parkway, Saraland, AL 36571-3721\",\n          \"website\": \"http://www.shell.com\",\n          \"claimed\": 0,\n          \"exit_mapping\": {\n            \"exit_id\": 14634,\n            \"distance\": \"0.21\",\n            \"cardinal_direction_short\": \"E\",\n            \"cardinal_direction_long\": \"East\",\n            \"turn_direction_short\": \"R\",\n            \"turn_direction_long\": \"Right\"\n          },\n          \"amenities\": [\n            {\n              \"id\": 1,\n              \"name\": \"Unleaded\",\n              \"background_color\": \"#0099FF\",\n              \"image_prefix\": \"Gas\",\n              \"priority\": 1\n            }\n          ],\n          \"top_priority_amenity\": {\n            \"id\": 1,\n            \"name\": \"Unleaded\",\n            \"background_color\": \"#0099FF\",\n            \"image_prefix\": \"Gas\",\n            \"priority\": 1\n          }\n        },\n        {\n          \"id\": 172849,\n          \"establishment_id\": 107,\n          \"phone\": \"1-251-679-5898\",\n          \"latitude\": \"30.80271\",\n          \"longitude\": \"-88.109\",\n          \"name\": \"Exxon\",\n          \"brand_name\": \"Exxon\",\n          \"formatted_address\": \"1380 Industrial Pkwy, Saraland, AL 36571-3900\",\n          \"website\": \"http://www.exxonmobilstations.com/13892-clarks-exxon-20-saraland\",\n          \"claimed\": 0,\n          \"exit_mapping\": {\n            \"exit_id\": 14634,\n            \"distance\": \"0.32\",\n            \"cardinal_direction_short\": \"W\",\n            \"cardinal_direction_long\": \"West\",\n            \"turn_direction_short\": \"L\",\n            \"turn_direction_long\": \"Left\"\n          },\n          \"amenities\": [\n            {\n              \"id\": 1,\n              \"name\": \"Unleaded\",\n              \"background_color\": \"#0099FF\",\n              \"image_prefix\": \"Gas\",\n              \"priority\": 1\n            },\n            {\n              \"id\": 5,\n              \"name\": \"Restaurant\",\n              \"background_color\": \"#CC3333\",\n              \"image_prefix\": \"Food\",\n              \"priority\": 1\n            },\n            {\n              \"id\": 6,\n              \"name\": \"Coffee\",\n              \"background_color\": \"#814000\",\n              \"image_prefix\": \"Coffee\",\n              \"priority\": 1\n            },\n            {\n              \"id\": 2,\n              \"name\": \"Diesel\",\n              \"background_color\": \"#006600\",\n              \"image_prefix\": \"Diesel\",\n              \"priority\": 1\n            },\n            {\n              \"id\": 4,\n              \"name\": \"Fast Food\",\n              \"background_color\": \"#FF3366\",\n              \"image_prefix\": \"FastFood\",\n              \"priority\": 1\n            }\n          ],\n          \"top_priority_amenity\": {\n            \"id\": 2,\n            \"name\": \"Diesel\",\n            \"background_color\": \"#006600\",\n            \"image_prefix\": \"Diesel\",\n            \"priority\": 1\n          }\n        },\n        {\n          \"id\": 265966,\n          \"establishment_id\": 105,\n          \"phone\": \"\",\n          \"latitude\": \"30.8065\",\n          \"longitude\": \"-88.09942\",\n          \"name\": \"BP\",\n          \"brand_name\": \"BP\",\n          \"formatted_address\": \"1028 Shelton Beach R, Saraland, AL 36571\",\n          \"website\": \"\",\n          \"claimed\": 0,\n          \"exit_mapping\": {\n            \"exit_id\": 14634,\n            \"distance\": \"0.39\",\n            \"cardinal_direction_short\": \"NE\",\n            \"cardinal_direction_long\": \"Northeast\",\n            \"turn_direction_short\": \"R\",\n            \"turn_direction_long\": \"Right\"\n          },\n          \"amenities\": [\n            {\n              \"id\": 1,\n              \"name\": \"Unleaded\",\n              \"background_color\": \"#0099FF\",\n              \"image_prefix\": \"Gas\",\n              \"priority\": 1\n            },\n            {\n              \"id\": 2,\n              \"name\": \"Diesel\",\n              \"background_color\": \"#006600\",\n              \"image_prefix\": \"Diesel\",\n              \"priority\": 1\n            }\n          ],\n          \"top_priority_amenity\": {\n            \"id\": 2,\n            \"name\": \"Diesel\",\n            \"background_color\": \"#006600\",\n            \"image_prefix\": \"Diesel\",\n            \"priority\": 1\n          }\n        },\n        {\n          \"id\": 405472,\n          \"establishment_id\": 397,\n          \"phone\": \"1-251-675-5011\",\n          \"latitude\": \"30.8065\",\n          \"longitude\": \"-88.09942\",\n          \"name\": \"Citgo\",\n          \"brand_name\": \"Citgo\",\n          \"formatted_address\": \"1028 Shelton Beach Rd, Saraland, AL 36571\",\n          \"website\": \"http://citgo.mycstore.com/30617006\",\n          \"claimed\": 0,\n          \"exit_mapping\": {\n            \"exit_id\": 14634,\n            \"distance\": \"0.39\",\n            \"cardinal_direction_short\": \"NE\",\n            \"cardinal_direction_long\": \"Northeast\",\n            \"turn_direction_short\": \"R\",\n            \"turn_direction_long\": \"Right\"\n          },\n          \"amenities\": [\n            {\n              \"id\": 1,\n              \"name\": \"Unleaded\",\n              \"background_color\": \"#0099FF\",\n              \"image_prefix\": \"Gas\",\n              \"priority\": 1\n            }\n          ],\n          \"top_priority_amenity\": {\n            \"id\": 1,\n            \"name\": \"Unleaded\",\n            \"background_color\": \"#0099FF\",\n            \"image_prefix\": \"Gas\",\n            \"priority\": 1\n          }\n        }\n      ]\n    },\n    {\n      \"id\": 2,\n      \"name\": \"Food\",\n      \"background_color\": \"#CC3333\",\n      \"image_prefix\": \"Food\",\n      \"businesses\": [\n        {\n          \"id\": 128061,\n          \"establishment_id\": 172,\n          \"phone\": \"1-251-675-7009\",\n          \"latitude\": \"30.80229\",\n          \"longitude\": \"-88.1025\",\n          \"name\": \"Waffle House\",\n          \"brand_name\": \"Waffle House\",\n          \"formatted_address\": \"1204 Industrial Pkwy, I-65, Exit 13, Saraland, AL 36571\",\n          \"website\": \"http://wafflehouse.com\",\n          \"claimed\": 0,\n          \"exit_mapping\": {\n            \"exit_id\": 14634,\n            \"distance\": \"0.07\",\n            \"cardinal_direction_short\": \"E\",\n            \"cardinal_direction_long\": \"East\",\n            \"turn_direction_short\": \"R\",\n            \"turn_direction_long\": \"Right\"\n          },\n          \"amenities\": [\n            {\n              \"id\": 5,\n              \"name\": \"Restaurant\",\n              \"background_color\": \"#CC3333\",\n              \"image_prefix\": \"Food\",\n              \"priority\": 1\n            }\n          ],\n          \"top_priority_amenity\": {\n            \"id\": 5,\n            \"name\": \"Restaurant\",\n            \"background_color\": \"#CC3333\",\n            \"image_prefix\": \"Food\",\n            \"priority\": 1\n          }\n        } ...\n      ]\n    } ...\n  ]\n}","language":"json","status":200}]},"settings":"","auth":"optional","params":[{"_id":"560ea2cedfdd5a2100e8f00a","ref":"","in":"path","required":true,"desc":"[Exit](doc:exit) `id`","default":"","type":"int","name":"exit_id"},{"_id":"560ea2cedfdd5a2100e8f009","ref":"","in":"path","required":false,"desc":"0 to omit `categories` array, (where each [Category](doc:category) contains `businesses`. 1 to include.","default":"0","type":"int","name":"include_businesses"},{"_id":"560ea2cedfdd5a2100e8f008","ref":"","in":"path","required":false,"desc":"0 to omit `previous_exit`, `next_exit`, and `reverse_exit`, should they exist. 1 to include any of those that exist.","default":"0","type":"int","name":"include_adjacent_exits"}],"url":"/exit/:exit_id/:include_businesses/:include_adjacent_exits"},"isReference":false,"order":3,"body":"** JSON Response **\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Value\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`exit`\",\n    \"0-1\": \"[Exit](doc:exit)\",\n    \"0-2\": \"The [Exit](doc:exit) object defined by the supplied `exit_id`\",\n    \"1-0\": \"`reverse_exit`\",\n    \"1-1\": \"[Exit](doc:exit)\",\n    \"1-2\": \"[Optional] The [Exit](doc:exit) object for essentially the same exit, only that it's accessed from the other side of the highway. \\n\\nFor example, if the supplied `exit_id` is for Exit 13 on I-65 Northbound, the `reverse_exit` would be for Exit 13 on I-65 **Southbound**.  If Exit 13 is on accessible while traveling northbound, then `reverse_exit` would be omitted.\\n\\nWith `reverse_exit`, the `businesses` at the [Exit](doc:exit) should be the same, but their location relative to the end of the exit ramp will be different. And (except in rare cases) those businesses that are Left of the exit will now be Right of the exit.\",\n    \"2-0\": \"`previous_exit`\",\n    \"2-1\": \"[Exit](doc:exit)\",\n    \"2-2\": \"[Optional] The [Exit](doc:exit) object that comes immediately before this [Exit](doc:exit) for the given direction of travel. If this is the first exit on the highway, `previous_exit` will be omitted.\",\n    \"3-0\": \"`next_exit`\",\n    \"3-1\": \"[Exit](doc:exit)\",\n    \"3-2\": \"[Optional] The [Exit](doc:exit) object that comes immediately after this [Exit](doc:exit) for the given direction of travel. If this is the last exit on the highway, `next_exit` will be omitted.\",\n    \"4-0\": \"`categories`\",\n    \"4-1\": \"Array of [Category](doc:category)s\",\n    \"4-2\": \"Array of [Category](doc:category) objects. If a [Category](doc:category) is present for a given exit, that means there is at least one [Business / POI](doc:business-poi) at that exit that fits into that [Category](doc:category). The Category's [Business / POI](doc:business-poi)s can be retrieved with the `businesses` key.\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\nThe Exit Details allows the user to retrieve all information we have on a particular exit. \n\nThey can optionally choose to have related exits returned with the result, including the `previous_exit`, the `next exit`, and the `reverse_exit` as seen from the reverse direction of the [Highway](doc:highway). This allows for features such as quickly scrolling to the previous/next [Exit](doc:exit), or changing direction of travel.\n\nThe user can also retrieve all `businesses` found at this [Exit](doc:exit), ordered by [Category](doc:category) (Gas, Food, etc). Since an `exit_id` implies the direction of travel (Exit 13 Northbound has a different `exit_id` than Exit 13 Southbound), we can include relational directions like Right/Left and mileage from the off ramp.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/Ej786HIRNCbjKcGiWoKF_ExitDetails.png\",\n        \"ExitDetails.png\",\n        \"720\",\n        \"1280\",\n        \"#186a6a\",\n        \"\"\n      ],\n      \"caption\": \"The 'Exit Details' API in use inside the iExit Android app\"\n    }\n  ]\n}\n[/block]\n** Common Next API(s) **\n- [POI Details](doc:poi-details) (by using `categories[]`.`businesses[]`.`id`)\n- [Exit Details](doc:exit-details) (by using `reverse_exit`.`id`, `previous_exit`.`id`, or `next_exit`.`id`)","excerpt":"","slug":"exit-details","type":"endpoint","title":"Exit Details"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

exit_id:
required
integer
[Exit](doc:exit) `id`
include_businesses:
integer0
0 to omit `categories` array, (where each [Category](doc:category) contains `businesses`. 1 to include.
include_adjacent_exits:
integer0
0 to omit `previous_exit`, `next_exit`, and `reverse_exit`, should they exist. 1 to include any of those that exist.

Result Format


Documentation

** JSON Response ** [block:parameters] { "data": { "h-0": "Key", "h-1": "Value", "h-2": "Description", "0-0": "`exit`", "0-1": "[Exit](doc:exit)", "0-2": "The [Exit](doc:exit) object defined by the supplied `exit_id`", "1-0": "`reverse_exit`", "1-1": "[Exit](doc:exit)", "1-2": "[Optional] The [Exit](doc:exit) object for essentially the same exit, only that it's accessed from the other side of the highway. \n\nFor example, if the supplied `exit_id` is for Exit 13 on I-65 Northbound, the `reverse_exit` would be for Exit 13 on I-65 **Southbound**. If Exit 13 is on accessible while traveling northbound, then `reverse_exit` would be omitted.\n\nWith `reverse_exit`, the `businesses` at the [Exit](doc:exit) should be the same, but their location relative to the end of the exit ramp will be different. And (except in rare cases) those businesses that are Left of the exit will now be Right of the exit.", "2-0": "`previous_exit`", "2-1": "[Exit](doc:exit)", "2-2": "[Optional] The [Exit](doc:exit) object that comes immediately before this [Exit](doc:exit) for the given direction of travel. If this is the first exit on the highway, `previous_exit` will be omitted.", "3-0": "`next_exit`", "3-1": "[Exit](doc:exit)", "3-2": "[Optional] The [Exit](doc:exit) object that comes immediately after this [Exit](doc:exit) for the given direction of travel. If this is the last exit on the highway, `next_exit` will be omitted.", "4-0": "`categories`", "4-1": "Array of [Category](doc:category)s", "4-2": "Array of [Category](doc:category) objects. If a [Category](doc:category) is present for a given exit, that means there is at least one [Business / POI](doc:business-poi) at that exit that fits into that [Category](doc:category). The Category's [Business / POI](doc:business-poi)s can be retrieved with the `businesses` key." }, "cols": 3, "rows": 5 } [/block] The Exit Details allows the user to retrieve all information we have on a particular exit. They can optionally choose to have related exits returned with the result, including the `previous_exit`, the `next exit`, and the `reverse_exit` as seen from the reverse direction of the [Highway](doc:highway). This allows for features such as quickly scrolling to the previous/next [Exit](doc:exit), or changing direction of travel. The user can also retrieve all `businesses` found at this [Exit](doc:exit), ordered by [Category](doc:category) (Gas, Food, etc). Since an `exit_id` implies the direction of travel (Exit 13 Northbound has a different `exit_id` than Exit 13 Southbound), we can include relational directions like Right/Left and mileage from the off ramp. [block:image] { "images": [ { "image": [ "https://files.readme.io/Ej786HIRNCbjKcGiWoKF_ExitDetails.png", "ExitDetails.png", "720", "1280", "#186a6a", "" ], "caption": "The 'Exit Details' API in use inside the iExit Android app" } ] } [/block] ** Common Next API(s) ** - [POI Details](doc:poi-details) (by using `categories[]`.`businesses[]`.`id`) - [Exit Details](doc:exit-details) (by using `reverse_exit`.`id`, `previous_exit`.`id`, or `next_exit`.`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 }}