{"_id":"5715f8cb893cbe0e002d74e2","githubsync":"","__v":37,"user":"56d548ba075dfa0b00be98d2","version":{"_id":"56d54a77075dfa0b00be98d8","__v":13,"project":"56d54a77075dfa0b00be98d5","createdAt":"2016-03-01T07:53:27.479Z","releaseDate":"2016-03-01T07:53:27.479Z","categories":["56d54a78075dfa0b00be98d9","56d6bbf046d19315000f8ea2","56d6bbfc46d19315000f8ea3","570cefd98da5b62b00d57e3c","571491a74007610e00c803ae","5714dcd837b7e00e00de5684","5715ea6ac016190e00f04272","5715f27fc016190e00f0429f","5715f7b9893cbe0e002d74da","5715f8c2c016190e00f042b8","5715fd49a9055c0e0015fbe7","57160c7e893cbe0e002d753a","5716136a893cbe0e002d7552"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5715f8c2c016190e00f042b8","__v":0,"project":"56d54a77075dfa0b00be98d5","version":"56d54a77075dfa0b00be98d8","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-04-19T09:22:10.402Z","from_sync":false,"order":6,"slug":"zone-map-area","title":"Zone (Map Area)"},"project":"56d54a77075dfa0b00be98d5","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-19T09:22:19.488Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:html]\n{\n  \"html\": \"<h3>GetZone</h3>\"\n}\n[/block]\nWill list parameters on a specified zone.\n[block:html]\n{\n  \"html\": \"<h4><b>Parameters</b></h4>\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`id` <span style=\\\"color:red\\\">*</span>\",\n    \"0-1\": \"String\",\n    \"0-2\": \"N/A\",\n    \"0-3\": \"Unique identifier.\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Unit of measurement\",\n    \"h-3\": \"Note\"\n  },\n  \"cols\": 4,\n  \"rows\": 1\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Columns</b></h4>\"\n}\n[/block]\nRefer to the following table for description of columns:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Unit of measurement\",\n    \"h-3\": \"Nullability\",\n    \"h-4\": \"Note\",\n    \"0-0\": \"`id`\",\n    \"0-1\": \"String\",\n    \"0-2\": \"N/A\",\n    \"0-3\": \"FALSE\",\n    \"0-4\": \"Unique identifier.\",\n    \"1-0\": \"`name`\",\n    \"1-1\": \"String\",\n    \"1-2\": \"N/A\",\n    \"1-3\": \"FALSE\",\n    \"2-0\": \"`note`\",\n    \"2-1\": \"String\",\n    \"2-2\": \"N/A\",\n    \"2-3\": \"TRUE\",\n    \"3-0\": \"`icon`\",\n    \"3-1\": \"String\",\n    \"3-2\": \"N/A\",\n    \"3-3\": \"TRUE\",\n    \"4-0\": \"`polygon`\",\n    \"4-1\": \"String\",\n    \"4-2\": \"N/A\",\n    \"4-3\": \"FALSE\",\n    \"4-4\": \"WKT format.\"\n  },\n  \"cols\": 5,\n  \"rows\": 5\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Request (example)</b></h4>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": \\\"6295\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Response</b></h4>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n         \\\"list\\\":[\\n            {\\n               \\\"id\\\": \\\"6295\\\",\\n               \\\"name\\\": \\\"Pauliström\\\",\\n               \\\"note\\\": \\\"Fabrik\\\",\\n               \\\"icon\\\": \\\"24x24/factory.png\\\",\\n               \\\"polygon\\\": \\\"POLYGON ((57.473227623291542 15.510871410369873, \\n               57.472777652023382 15.507717132568359, 57.47108155666789 \\n               15.507910251617432, 57.469593081600394 15.508832931518555, \\n               57.469443076874207 15.509905815124512, 57.468727661247641 \\n               15.510399341583252, 57.468554574717778 15.510399341583252, \\n               57.468681504919836 15.511257648468018, 57.46926999373273 \\n               15.511300563812256, 57.469673853121016 15.511257648468018, \\n               57.469258454827468 15.511600971221924, 57.469350765967427 \\n               15.512566566467285, 57.470343095995467 15.512416362762451, \\n               57.471912307086896 15.511794090270996, 57.473227623291542 \\n               15.510871410369873))\\\"\\n            }\\n         ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"&nbsp;\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h3>CreateZone</h3>\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Parameters</b></h4>\"\n}\n[/block]\nWill create a new zone.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Unit of measurement\",\n    \"h-3\": \"Note\",\n    \"0-0\": \"`name` <span style=\\\"color:red\\\">*</span>\",\n    \"0-1\": \"String\",\n    \"0-2\": \"N/A\",\n    \"0-3\": \"Name of zone.\",\n    \"1-0\": \"`note`\",\n    \"1-1\": \"String\",\n    \"1-2\": \"N/A\",\n    \"2-0\": \"`polygon` <span style=\\\"color:red\\\">*</span>\",\n    \"2-1\": \"String\",\n    \"2-2\": \"N/A\",\n    \"2-3\": \"WKT format.\"\n  },\n  \"cols\": 4,\n  \"rows\": 3\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Request (example)</b></h4>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \" {\\n        \\\"name\\\": \\\"Pauliström factory\\\",\\n        \\\"note\\\": \\\"Factory premises\\\",\\n        \\\"polygon\\\": \\\"POLYGON ((57.473227623291542 15.510871410369873, \\n                 57.472777652023382 15.507717132568359, 57.47108155666789 \\n                 15.507910251617432, 57.469593081600394 15.508832931518555, \\n                 57.469443076874207 15.509905815124512, 57.468727661247641 \\n                 15.510399341583252, 57.468554574717778 15.510399341583252, \\n                 57.468681504919836 15.511257648468018, 57.46926999373273 \\n                 15.511300563812256, 57.469673853121016 15.511257648468018, \\n                 57.469258454827468 15.511600971221924, 57.469350765967427 \\n                 15.512566566467285, 57.470343095995467 15.512416362762451, \\n                 57.471912307086896 15.511794090270996, 57.473227623291542 \\n                 15.510871410369873))\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Response</b></h4>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": \\\"6295\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"&nbsp;\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h3>UpdateZone</h3>\"\n}\n[/block]\nWill update parameters on an existing zone.\n[block:html]\n{\n  \"html\": \"<h4><b>Parameters</b></h4>\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Unit of measurement\",\n    \"h-3\": \"Note\",\n    \"0-0\": \"`id` <span style=\\\"color:red\\\">*</span>\",\n    \"0-1\": \"String\",\n    \"0-2\": \"N/A\",\n    \"0-3\": \"Unique identifier.\",\n    \"1-0\": \"`name`\",\n    \"1-1\": \"String\",\n    \"1-2\": \"N/A\",\n    \"1-3\": \"Name of zone.\",\n    \"2-0\": \"`note`\",\n    \"2-1\": \"String\",\n    \"2-2\": \"N/A\",\n    \"3-0\": \"`polygon`\",\n    \"3-1\": \"String\",\n    \"3-2\": \"N/A\",\n    \"3-3\": \"WKT format.\"\n  },\n  \"cols\": 4,\n  \"rows\": 4\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Request (example)</b></h4>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n     \\\"id\\\": \\\"6295\\\",\\n     \\\"name\\\": \\\"Pauliström factory\\\",\\n     \\\"note\\\": \\\"Factory premises\\\"\\n} \",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Response</b></h4>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"&nbsp;\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h3>DeleteZone</h3>\"\n}\n[/block]\nWill delete an existing zone.\n[block:html]\n{\n  \"html\": \"<h4><b>Parameters</b></h4>\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Unit of measurement\",\n    \"h-3\": \"Note\",\n    \"0-0\": \"`id` <span style=\\\"color:red\\\">*</span>\",\n    \"0-1\": \"String\",\n    \"0-2\": \"N/A\",\n    \"0-3\": \"Unique identifier.\"\n  },\n  \"cols\": 4,\n  \"rows\": 1\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Request (example)</b></h4>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": \\\"6294\\\"\\n} \",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Response</b></h4>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"A **Zone** corresponds to a user-defined “area” on the map, and is typically used in reporting summaries, or in the creation of alarms. A Zone can be scaled to cover for instance a building, or an entire country.\n\nURL Structure is:\n`https://api.trackunit.com/public/Zone`","slug":"zone","type":"basic","title":"Zone"}

Zone

A **Zone** corresponds to a user-defined “area” on the map, and is typically used in reporting summaries, or in the creation of alarms. A Zone can be scaled to cover for instance a building, or an entire country. URL Structure is: `https://api.trackunit.com/public/Zone`

[block:html] { "html": "<h3>GetZone</h3>" } [/block] Will list parameters on a specified zone. [block:html] { "html": "<h4><b>Parameters</b></h4>" } [/block] [block:parameters] { "data": { "0-0": "`id` <span style=\"color:red\">*</span>", "0-1": "String", "0-2": "N/A", "0-3": "Unique identifier.", "h-0": "Name", "h-1": "Data type", "h-2": "Unit of measurement", "h-3": "Note" }, "cols": 4, "rows": 1 } [/block] [block:html] { "html": "<h4><b>Columns</b></h4>" } [/block] Refer to the following table for description of columns: [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Unit of measurement", "h-3": "Nullability", "h-4": "Note", "0-0": "`id`", "0-1": "String", "0-2": "N/A", "0-3": "FALSE", "0-4": "Unique identifier.", "1-0": "`name`", "1-1": "String", "1-2": "N/A", "1-3": "FALSE", "2-0": "`note`", "2-1": "String", "2-2": "N/A", "2-3": "TRUE", "3-0": "`icon`", "3-1": "String", "3-2": "N/A", "3-3": "TRUE", "4-0": "`polygon`", "4-1": "String", "4-2": "N/A", "4-3": "FALSE", "4-4": "WKT format." }, "cols": 5, "rows": 5 } [/block] [block:html] { "html": "<h4><b>Request (example)</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"6295\"\n}", "language": "json" } ] } [/block] [block:html] { "html": "<h4><b>Response</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"list\":[\n {\n \"id\": \"6295\",\n \"name\": \"Pauliström\",\n \"note\": \"Fabrik\",\n \"icon\": \"24x24/factory.png\",\n \"polygon\": \"POLYGON ((57.473227623291542 15.510871410369873, \n 57.472777652023382 15.507717132568359, 57.47108155666789 \n 15.507910251617432, 57.469593081600394 15.508832931518555, \n 57.469443076874207 15.509905815124512, 57.468727661247641 \n 15.510399341583252, 57.468554574717778 15.510399341583252, \n 57.468681504919836 15.511257648468018, 57.46926999373273 \n 15.511300563812256, 57.469673853121016 15.511257648468018, \n 57.469258454827468 15.511600971221924, 57.469350765967427 \n 15.512566566467285, 57.470343095995467 15.512416362762451, \n 57.471912307086896 15.511794090270996, 57.473227623291542 \n 15.510871410369873))\"\n }\n ]\n}", "language": "json" } ] } [/block] [block:html] { "html": "&nbsp;" } [/block] [block:html] { "html": "<h3>CreateZone</h3>" } [/block] [block:html] { "html": "<h4><b>Parameters</b></h4>" } [/block] Will create a new zone. [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Unit of measurement", "h-3": "Note", "0-0": "`name` <span style=\"color:red\">*</span>", "0-1": "String", "0-2": "N/A", "0-3": "Name of zone.", "1-0": "`note`", "1-1": "String", "1-2": "N/A", "2-0": "`polygon` <span style=\"color:red\">*</span>", "2-1": "String", "2-2": "N/A", "2-3": "WKT format." }, "cols": 4, "rows": 3 } [/block] [block:html] { "html": "<h4><b>Request (example)</b></h4>" } [/block] [block:code] { "codes": [ { "code": " {\n \"name\": \"Pauliström factory\",\n \"note\": \"Factory premises\",\n \"polygon\": \"POLYGON ((57.473227623291542 15.510871410369873, \n 57.472777652023382 15.507717132568359, 57.47108155666789 \n 15.507910251617432, 57.469593081600394 15.508832931518555, \n 57.469443076874207 15.509905815124512, 57.468727661247641 \n 15.510399341583252, 57.468554574717778 15.510399341583252, \n 57.468681504919836 15.511257648468018, 57.46926999373273 \n 15.511300563812256, 57.469673853121016 15.511257648468018, \n 57.469258454827468 15.511600971221924, 57.469350765967427 \n 15.512566566467285, 57.470343095995467 15.512416362762451, \n 57.471912307086896 15.511794090270996, 57.473227623291542 \n 15.510871410369873))\"\n}", "language": "json" } ] } [/block] [block:html] { "html": "<h4><b>Response</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"6295\"\n}", "language": "json" } ] } [/block] [block:html] { "html": "&nbsp;" } [/block] [block:html] { "html": "<h3>UpdateZone</h3>" } [/block] Will update parameters on an existing zone. [block:html] { "html": "<h4><b>Parameters</b></h4>" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Unit of measurement", "h-3": "Note", "0-0": "`id` <span style=\"color:red\">*</span>", "0-1": "String", "0-2": "N/A", "0-3": "Unique identifier.", "1-0": "`name`", "1-1": "String", "1-2": "N/A", "1-3": "Name of zone.", "2-0": "`note`", "2-1": "String", "2-2": "N/A", "3-0": "`polygon`", "3-1": "String", "3-2": "N/A", "3-3": "WKT format." }, "cols": 4, "rows": 4 } [/block] [block:html] { "html": "<h4><b>Request (example)</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"6295\",\n \"name\": \"Pauliström factory\",\n \"note\": \"Factory premises\"\n} ", "language": "json" } ] } [/block] [block:html] { "html": "<h4><b>Response</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json" } ] } [/block] [block:html] { "html": "&nbsp;" } [/block] [block:html] { "html": "<h3>DeleteZone</h3>" } [/block] Will delete an existing zone. [block:html] { "html": "<h4><b>Parameters</b></h4>" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Unit of measurement", "h-3": "Note", "0-0": "`id` <span style=\"color:red\">*</span>", "0-1": "String", "0-2": "N/A", "0-3": "Unique identifier." }, "cols": 4, "rows": 1 } [/block] [block:html] { "html": "<h4><b>Request (example)</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"6294\"\n} ", "language": "json" } ] } [/block] [block:html] { "html": "<h4><b>Response</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json" } ] } [/block]