{"__v":1,"_id":"55b63be1f8105a2f00c34e26","category":{"__v":1,"_id":"55afb2a7902fd51700f5f8c7","pages":["55b63dcff8105a2f00c34e39"],"project":"559a61d2dbcfd20d00710b39","version":"559a61d2dbcfd20d00710b3c","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-07-22T15:11:35.945Z","from_sync":false,"order":16,"slug":"places","title":"Places"},"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_clean":"1.0.0","version":"1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-07-27T14:10:41.282Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":0,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"The Place 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    \"1-0\": \"placeId\",\n    \"1-1\": \"string\",\n    \"1-2\": \"Autogenerated\",\n    \"1-3\": \"Place identifier.\",\n    \"4-0\": \"config.name\",\n    \"4-1\": \"string\",\n    \"4-2\": \"Yes\",\n    \"4-3\": \"Name of the place.\",\n    \"5-0\": \"config.description\",\n    \"5-1\": \"string\",\n    \"5-2\": \"No\",\n    \"5-3\": \"Description of the place.\",\n    \"6-0\": \"config.geoFence\",\n    \"6-1\": \"GeoFence\",\n    \"6-2\": \"No\",\n    \"6-3\": \"GeoFence data of the place.\",\n    \"7-0\": \"floorPlan\",\n    \"7-1\": \"FloorPlan\",\n    \"7-2\": \"No\",\n    \"7-3\": \"Floor plan of the place.\",\n    \"8-0\": \"space\",\n    \"8-1\": \"Space\",\n    \"8-2\": \"No\",\n    \"8-3\": \"Space data of the place.\",\n    \"2-0\": \"accountId\",\n    \"2-1\": \"string\",\n    \"2-2\": \"Yes\",\n    \"2-3\": \"Account Id.\",\n    \"3-0\": \"zones\",\n    \"3-1\": \"Zone list\",\n    \"3-2\": \"Yes\",\n    \"3-3\": \"Zones contained in the place.\",\n    \"9-0\": \"placeUrl\",\n    \"9-1\": \"string\",\n    \"9-2\": \"No\",\n    \"9-3\": \"URL of the place.\"\n  },\n  \"cols\": 4,\n  \"rows\": 10\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\\\": 1425237156160,\\n    \\\"placeId\\\": \\\"bjG3KmuauO6E1EyQE2R7qA\\\",\\n    \\\"accountId\\\": \\\"AeZQ_Wm9iW2v7QgvdTtmx1\\\",\\n    \\\"zones\\\": [\\n      {\\n        \\\"createdAt\\\": 1425237168948,\\n        \\\"zoneId\\\": \\\"l1uHBkxUQyWqKtCEesepww\\\",\\n        \\\"placeId\\\": \\\"bjG3KmuauO6E1EyQE2R7qA\\\",\\n        \\\"config\\\": {\\n          \\\"name\\\": \\\"VIP Zone\\\",\\n          \\\"floorNumber\\\": 0,\\n          \\\"description\\\": \\\"\\\",\\n          \\\"category\\\": \\\"VIP Zone\\\",\\n          \\\"imageUrl\\\": null,\\n          \\\"url\\\": null,\\n          \\\"shapeJson\\\": null,\\n          \\\"enabled\\\": false,\\n          \\\"updatedAt\\\": 1425239849144\\n        }\\n      }\\n    ],\\n    \\\"config\\\": {\\n      \\\"name\\\": \\\"VIP Zone\\\",\\n      \\\"description\\\": \\\"VIP Zone\\\",\\n      \\\"geoFence\\\": {\\n        \\\"latitude\\\": 46.355351652955464,\\n        \\\"longitude\\\": -32.135888254928672,\\n        \\\"radius\\\": 504.504,\\n        \\\"type\\\": 0,\\n        \\\"geoTag\\\": {\\n          \\\"country\\\": \\\"ES\\\",\\n          \\\"region\\\": \\\"Catalunya\\\",\\n          \\\"county\\\": \\\"Barcelona\\\",\\n          \\\"locality\\\": \\\"Barcelona\\\",\\n          \\\"postCode\\\": \\\"12345\\\",\\n          \\\"streetName\\\": null,\\n          \\\"countryFID\\\": \\\"429f72bc-81ab-d2cc-438a-ace356bde631\\\",\\n          \\\"regionFID\\\": \\\"082a01de-81ab-d2cc-438a-ace356bde631\\\",\\n          \\\"countyFID\\\": \\\"082a09e0-81ab-d2cc-438a-ace356bde631\\\",\\n          \\\"localityFID\\\": \\\"0832922c-81ab-d2cc-438a-ace356bde631\\\",\\n          \\\"displayName\\\": \\\"Barcelona, 12345, ES\\\"\\n        }\\n      }\\n    },\\n    \\\"floorPlan\\\": null,\\n    \\\"space\\\": null,\\n    \\\"placeUrl\\\": \\\"http://mocaplatform.com\\\"\\n  }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"Represents a physical place. It is composed of Zones and Beacons.","slug":"places-3","type":"basic","title":"Places"}

Places

Represents a physical place. It is composed of Zones and Beacons.

[block:api-header] { "type": "basic", "title": "The Place 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).", "1-0": "placeId", "1-1": "string", "1-2": "Autogenerated", "1-3": "Place identifier.", "4-0": "config.name", "4-1": "string", "4-2": "Yes", "4-3": "Name of the place.", "5-0": "config.description", "5-1": "string", "5-2": "No", "5-3": "Description of the place.", "6-0": "config.geoFence", "6-1": "GeoFence", "6-2": "No", "6-3": "GeoFence data of the place.", "7-0": "floorPlan", "7-1": "FloorPlan", "7-2": "No", "7-3": "Floor plan of the place.", "8-0": "space", "8-1": "Space", "8-2": "No", "8-3": "Space data of the place.", "2-0": "accountId", "2-1": "string", "2-2": "Yes", "2-3": "Account Id.", "3-0": "zones", "3-1": "Zone list", "3-2": "Yes", "3-3": "Zones contained in the place.", "9-0": "placeUrl", "9-1": "string", "9-2": "No", "9-3": "URL of the place." }, "cols": 4, "rows": 10 } [/block] [block:api-header] { "type": "basic", "title": "Sample Place Object" } [/block] [block:code] { "codes": [ { "code": "{\n \"createdAt\": 1425237156160,\n \"placeId\": \"bjG3KmuauO6E1EyQE2R7qA\",\n \"accountId\": \"AeZQ_Wm9iW2v7QgvdTtmx1\",\n \"zones\": [\n {\n \"createdAt\": 1425237168948,\n \"zoneId\": \"l1uHBkxUQyWqKtCEesepww\",\n \"placeId\": \"bjG3KmuauO6E1EyQE2R7qA\",\n \"config\": {\n \"name\": \"VIP Zone\",\n \"floorNumber\": 0,\n \"description\": \"\",\n \"category\": \"VIP Zone\",\n \"imageUrl\": null,\n \"url\": null,\n \"shapeJson\": null,\n \"enabled\": false,\n \"updatedAt\": 1425239849144\n }\n }\n ],\n \"config\": {\n \"name\": \"VIP Zone\",\n \"description\": \"VIP Zone\",\n \"geoFence\": {\n \"latitude\": 46.355351652955464,\n \"longitude\": -32.135888254928672,\n \"radius\": 504.504,\n \"type\": 0,\n \"geoTag\": {\n \"country\": \"ES\",\n \"region\": \"Catalunya\",\n \"county\": \"Barcelona\",\n \"locality\": \"Barcelona\",\n \"postCode\": \"12345\",\n \"streetName\": null,\n \"countryFID\": \"429f72bc-81ab-d2cc-438a-ace356bde631\",\n \"regionFID\": \"082a01de-81ab-d2cc-438a-ace356bde631\",\n \"countyFID\": \"082a09e0-81ab-d2cc-438a-ace356bde631\",\n \"localityFID\": \"0832922c-81ab-d2cc-438a-ace356bde631\",\n \"displayName\": \"Barcelona, 12345, ES\"\n }\n }\n },\n \"floorPlan\": null,\n \"space\": null,\n \"placeUrl\": \"http://mocaplatform.com\"\n }", "language": "json" } ] } [/block]