{"__v":0,"_id":"55b63dcff8105a2f00c34e39","category":{"__v":1,"_id":"55afb2ad902fd51700f5f8c8","pages":["55b6533b6127b125003643ea"],"project":"559a61d2dbcfd20d00710b39","version":"559a61d2dbcfd20d00710b3c","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-07-22T15:11:41.506Z","from_sync":false,"order":17,"slug":"zones","title":"Zones"},"parentDoc":null,"project":"559a61d2dbcfd20d00710b39","user":"55a54dde9c32760d00ca78a8","version":{"__v":23,"_id":"559a61d2dbcfd20d00710b3c","project":"559a61d2dbcfd20d00710b39","createdAt":"2015-07-06T11:09:06.510Z","releaseDate":"2015-07-06T11:09:06.510Z","categories":["559a61d3dbcfd20d00710b3d","55a589ddaaf9cf1900114dd0","55a589e30f354f0d00fd0312","55a589ea80c8a30d00b323cc","55a589f6aaf9cf1900114dd1","55a58d4e80c8a30d00b323e6","55a8e7a227a17d21005251a2","55a93098cf45e1390093f351","55afb085f202b12100cd9e83","55afb22e902fd51700f5f8bf","55afb260902fd51700f5f8c2","55afb28ec8a85321007a5462","55afb294f202b12100cd9e95","55afb29b902fd51700f5f8c5","55afb2a1c8a85321007a5463","55afb2a7902fd51700f5f8c7","55afb2ad902fd51700f5f8c8","55afb2b5902fd51700f5f8ca","55b74b2131bccb190081bedc","55bb441b54f9640d006e6cf2","565711085cb2420d00d70071","5681681330018c0d006bf7ff","588f38b5923d610f00c72dad"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"Version 1.0","version_clean":"1.0.0","version":"1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-07-27T14:18:55.450Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":true,"order":0,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"The Zone Object\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"createdAt\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Obligatory?\",\n    \"h-3\": \"Description\",\n    \"0-1\": \"long\",\n    \"0-2\": \"Autogenerated\",\n    \"0-3\": \"Creation date (timestamp UTC).\",\n    \"2-0\": \"placeId\",\n    \"2-1\": \"string\",\n    \"2-2\": \"Yes\",\n    \"2-3\": \"Place id of the zone.\",\n    \"3-0\": \"config.name\",\n    \"3-1\": \"string\",\n    \"3-2\": \"Yes\",\n    \"3-3\": \"Name of the zone.\",\n    \"5-0\": \"config.description\",\n    \"5-1\": \"string\",\n    \"5-2\": \"No\",\n    \"5-3\": \"Description of the zone.\",\n    \"6-0\": \"config.category\",\n    \"6-1\": \"string\",\n    \"6-2\": \"No\",\n    \"6-3\": \"Category of the zone.\",\n    \"7-0\": \"config.imageUrl\",\n    \"7-1\": \"string\",\n    \"7-2\": \"No\",\n    \"7-3\": \"URL of the zone's image.\",\n    \"8-0\": \"config.url\",\n    \"8-1\": \"string\",\n    \"8-2\": \"No\",\n    \"8-3\": \"URL of the zone.\",\n    \"9-0\": \"config.enabled\",\n    \"9-1\": \"boolean\",\n    \"9-2\": \"Yes\",\n    \"9-3\": \"Whether the zone is active or not.\",\n    \"1-0\": \"zoneId\",\n    \"1-1\": \"string\",\n    \"1-2\": \"Autogenerated\",\n    \"1-3\": \"Zone identifier.\",\n    \"4-0\": \"config.floorNumber\",\n    \"4-1\": \"integer\",\n    \"4-2\": \"Yes\",\n    \"4-3\": \"Floor number of the zone.\",\n    \"10-0\": \"config.updatedAt\",\n    \"10-1\": \"long\",\n    \"10-2\": \"Autogenerated\",\n    \"10-3\": \"Last updated date (timestamp UTC).\"\n  },\n  \"cols\": 4,\n  \"rows\": 11\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Sample Place Object\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"createdAt\\\": 1425237168948,\\n  \\\"zoneId\\\": \\\"l1uHBkxUQyWqKtCEesepww\\\",\\n  \\\"placeId\\\": \\\"bjG3KmuauO6E1EyQE2R7qA\\\",\\n  \\\"config\\\": {\\n    \\\"name\\\": \\\"VIP Zone 1\\\",\\n    \\\"floorNumber\\\": 0,\\n    \\\"description\\\": \\\"\\\",\\n    \\\"category\\\": \\\"VIP Zones\\\",\\n    \\\"imageUrl\\\": null,\\n    \\\"url\\\": null,\\n    \\\"enabled\\\": false,\\n    \\\"updatedAt\\\": 1425239849144\\n  }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"Represents a zone in a place.","slug":"zones-2","type":"basic","title":"Zones"}

Zones

Represents a zone in a place.

[block:api-header] { "type": "basic", "title": "The Zone Object" } [/block] [block:parameters] { "data": { "0-0": "createdAt", "h-0": "Name", "h-1": "Type", "h-2": "Obligatory?", "h-3": "Description", "0-1": "long", "0-2": "Autogenerated", "0-3": "Creation date (timestamp UTC).", "2-0": "placeId", "2-1": "string", "2-2": "Yes", "2-3": "Place id of the zone.", "3-0": "config.name", "3-1": "string", "3-2": "Yes", "3-3": "Name of the zone.", "5-0": "config.description", "5-1": "string", "5-2": "No", "5-3": "Description of the zone.", "6-0": "config.category", "6-1": "string", "6-2": "No", "6-3": "Category of the zone.", "7-0": "config.imageUrl", "7-1": "string", "7-2": "No", "7-3": "URL of the zone's image.", "8-0": "config.url", "8-1": "string", "8-2": "No", "8-3": "URL of the zone.", "9-0": "config.enabled", "9-1": "boolean", "9-2": "Yes", "9-3": "Whether the zone is active or not.", "1-0": "zoneId", "1-1": "string", "1-2": "Autogenerated", "1-3": "Zone identifier.", "4-0": "config.floorNumber", "4-1": "integer", "4-2": "Yes", "4-3": "Floor number of the zone.", "10-0": "config.updatedAt", "10-1": "long", "10-2": "Autogenerated", "10-3": "Last updated date (timestamp UTC)." }, "cols": 4, "rows": 11 } [/block] [block:api-header] { "type": "basic", "title": "Sample Place Object" } [/block] [block:code] { "codes": [ { "code": "{\n \"createdAt\": 1425237168948,\n \"zoneId\": \"l1uHBkxUQyWqKtCEesepww\",\n \"placeId\": \"bjG3KmuauO6E1EyQE2R7qA\",\n \"config\": {\n \"name\": \"VIP Zone 1\",\n \"floorNumber\": 0,\n \"description\": \"\",\n \"category\": \"VIP Zones\",\n \"imageUrl\": null,\n \"url\": null,\n \"enabled\": false,\n \"updatedAt\": 1425239849144\n }\n}", "language": "json" } ] } [/block]