{"_id":"560f05649812c10d002729f0","__v":8,"githubsync":"","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"},"project":"560d5ac71ec45619006069d6","user":"560d5a4faf97231900938125","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"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-02T22:29:56.453Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":7,"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    \"1-0\": \"`name`\",\n    \"1-1\": \"String\",\n    \"2-0\": \"`background_color`\",\n    \"2-1\": \"String\",\n    \"3-0\": \"`image_prefix`\",\n    \"3-1\": \"String\",\n    \"5-0\": \"`amenity_value`\",\n    \"5-1\": \"String\",\n    \"6-0\": \"`amenity_number`\",\n    \"6-1\": \"Integer\",\n    \"2-2\": \"[optional]\\n\\nThe background color for displaying this Amenity as an icon, should the client want to do that. This is an empty string for most Amenities as most are not important enough to be turned into an icon.\\n\\nThis field is not currently used in the iExit iOS or Android apps.\",\n    \"3-2\": \"[optional]\\n\\nThe image prefix string for displaying this Amenity as an icon, should the client want to do that. This is an empty string for most Amenities as most are not important enough to be turned into an icon.\\n\\nThis field is not currently used in the iExit iOS or Android apps.\",\n    \"5-2\": \"[optional] \\n\\nSome amenities have additional information that further describes the Amenity in the form of a string. \\n\\nFor instance, for the Amenity \\\"Breakfast\\\", we might have additional information that it is \\\"Free\\\". So in this case, \\\"Free\\\" would be the `amenity_value` string.\\n\\nUsually this field is omitted from the response.\",\n    \"6-2\": \"[optional] \\n\\nSome amenities have additional information that further describes the Amenity in the form of a number. \\n\\nFor instance, for the amenity \\\"Truck Parking Spots\\\", we might also know that there are 150 spots. So this number would be added as the `amenity_number` for the parent Amenity. \\n\\nUsually this field is omitted from the response.\",\n    \"0-2\": \"Referred to as `amenity_id` elsewhere.\",\n    \"1-2\": \"The name of the Amenity. For example, \\\"WiFi\\\" or \\\"Truck Friendly\\\".\",\n    \"4-0\": \"`priority`\",\n    \"4-1\": \"Integer\",\n    \"4-2\": \"Either 0 or 1.\\n\\nIf 1, that means `background_color` and `image_prefix` will not be NULL or empty. Priority amenities are the most defining amenities for a business, and can be denoted with an icon created the `background_color` and `image_prefix` values.\\n\\nExamples of Priority amenities: Unleaded Fuel, Grocery Store, Restaurant...\\n\\nExamples of non-Priority amenities: Refrigerator in room, WiFi, American Express accepted...\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/b9gSLPu0QPWESLfTH0Qb_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\": \"At the bottom of this image, you will see a list of Amenities that belong to this POI. Each of these amenities are ways this POI can be searched for and found.\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"amenity","type":"basic","title":"Amenity"}
[block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-0": "`id`", "0-1": "Integer", "1-0": "`name`", "1-1": "String", "2-0": "`background_color`", "2-1": "String", "3-0": "`image_prefix`", "3-1": "String", "5-0": "`amenity_value`", "5-1": "String", "6-0": "`amenity_number`", "6-1": "Integer", "2-2": "[optional]\n\nThe background color for displaying this Amenity as an icon, should the client want to do that. This is an empty string for most Amenities as most are not important enough to be turned into an icon.\n\nThis field is not currently used in the iExit iOS or Android apps.", "3-2": "[optional]\n\nThe image prefix string for displaying this Amenity as an icon, should the client want to do that. This is an empty string for most Amenities as most are not important enough to be turned into an icon.\n\nThis field is not currently used in the iExit iOS or Android apps.", "5-2": "[optional] \n\nSome amenities have additional information that further describes the Amenity in the form of a string. \n\nFor instance, for the Amenity \"Breakfast\", we might have additional information that it is \"Free\". So in this case, \"Free\" would be the `amenity_value` string.\n\nUsually this field is omitted from the response.", "6-2": "[optional] \n\nSome amenities have additional information that further describes the Amenity in the form of a number. \n\nFor instance, for the amenity \"Truck Parking Spots\", we might also know that there are 150 spots. So this number would be added as the `amenity_number` for the parent Amenity. \n\nUsually this field is omitted from the response.", "0-2": "Referred to as `amenity_id` elsewhere.", "1-2": "The name of the Amenity. For example, \"WiFi\" or \"Truck Friendly\".", "4-0": "`priority`", "4-1": "Integer", "4-2": "Either 0 or 1.\n\nIf 1, that means `background_color` and `image_prefix` will not be NULL or empty. Priority amenities are the most defining amenities for a business, and can be denoted with an icon created the `background_color` and `image_prefix` values.\n\nExamples of Priority amenities: Unleaded Fuel, Grocery Store, Restaurant...\n\nExamples of non-Priority amenities: Refrigerator in room, WiFi, American Express accepted..." }, "cols": 3, "rows": 7 } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/b9gSLPu0QPWESLfTH0Qb_Photo%20Oct%2005,%204%2049%2018%20PM.png", "Photo Oct 05, 4 49 18 PM.png", "750", "1334", "#ce3452", "" ], "caption": "At the bottom of this image, you will see a list of Amenities that belong to this POI. Each of these amenities are ways this POI can be searched for and found." } ] } [/block]