{"_id":"5715fd51c016190e00f042d6","githubsync":"","project":"56d54a77075dfa0b00be98d5","__v":39,"category":{"_id":"5715fd49a9055c0e0015fbe7","__v":0,"project":"56d54a77075dfa0b00be98d5","version":"56d54a77075dfa0b00be98d8","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-04-19T09:41:29.754Z","from_sync":false,"order":7,"slug":"point-map-point-of-interest","title":"Point (Map POI)"},"parentDoc":null,"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"},"user":"56d548ba075dfa0b00be98d2","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-19T09:41:37.809Z","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>GetPoint</h3>\"\n}\n[/block]\nWill list parameters on a specified point. \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>Errors</b></h4>\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Error Code\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`pointNotFound`\",\n    \"0-1\": \"Point with supplied “Id” was not found.\"\n  },\n  \"cols\": 2,\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    \"0-0\": \"`id`\",\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-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\": \"`location`\",\n    \"4-1\": \"Location\",\n    \"4-2\": \"N/A\",\n    \"4-3\": \"FALSE\",\n    \"5-0\": \"`address`\",\n    \"5-1\": \"Address\",\n    \"5-2\": \"N/A\",\n    \"5-3\": \"TRUE\"\n  },\n  \"cols\": 5,\n  \"rows\": 6\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\\\": \\\"71067\\\"\\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\\\": \\\"71067\\\",\\n      \\\"name\\\": \\\"Region West\\\",\\n      \\\"note\\\": \\\"Company headquarters\\\",\\n      \\\"icon\\\": \\\"16x16/about.png\\\",\\n      \\\"location\\\": {\\n        \\\"latitude\\\": 51.20118,\\n        \\\"longitude\\\": 6.777766\\n      },\\n      \\\"address\\\": {\\n        \\\"country\\\": \\\"DE\\\",\\n        \\\"zipCode\\\": \\\"40237\\\",\\n        \\\"city\\\": \\\"Düsseldorf\\\",\\n        \\\"streetAddress\\\": \\\"Sohnstr. 159\\\"\\n      }\\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>CreatePoint</h3>\"\n}\n[/block]\nWill create a new point.\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\": \"`name` <span style=\\\"color:red\\\">*</span>\",\n    \"0-1\": \"String\",\n    \"0-2\": \"N/A\",\n    \"0-3\": \"Name of point.\",\n    \"1-0\": \"`note`\",\n    \"1-1\": \"String\",\n    \"1-2\": \"N/A\",\n    \"2-0\": \"`location`<span style=\\\"color:red\\\">*</span>\",\n    \"2-1\": \"Location\",\n    \"2-2\": \"N/A\",\n    \"3-0\": \"`address`\",\n    \"3-1\": \"Address\",\n    \"3-2\": \"N/A\"\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   \\\"name\\\": \\\"Berlin depot\\\",\\n   \\\"location\\\":{\\n      \\\"latitude\\\":52.530112,\\n      \\\"longitude\\\":13.522968\\n \\t }\\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\\\": \\\"71094\\\"\\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>UpdatePoint</h3>\"\n}\n[/block]\nWill update parameters on an existing point.\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 point.\",\n    \"2-0\": \"`note`\",\n    \"2-1\": \"String\",\n    \"2-2\": \"N/A\",\n    \"3-0\": \"`location`\",\n    \"3-1\": \"Location\",\n    \"3-2\": \"N/A\",\n    \"4-0\": \"`address`\",\n    \"4-1\": \"Address\",\n    \"4-2\": \"N/A\"\n  },\n  \"cols\": 4,\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\\\": \\\"71067\\\",\\n      \\\"name\\\": \\\"Region North\\\"\\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>DeletePoint</h3>\"\n}\n[/block]\nWill delete an existing point.\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    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Unit of measurement\",\n    \"h-3\": \"Note\",\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\\\": \\\"71067\\\"\\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 **Point** corresponds to a user-defined “location” on the map, and is typically used in reporting summaries, or in the creation of alarms. Often referred to as POI.\n\nURL Structure is:\n`https://api.trackunit.com/public/Point`","slug":"point","type":"basic","title":"Point"}

Point

A **Point** corresponds to a user-defined “location” on the map, and is typically used in reporting summaries, or in the creation of alarms. Often referred to as POI. URL Structure is: `https://api.trackunit.com/public/Point`

[block:html] { "html": "<h3>GetPoint</h3>" } [/block] Will list parameters on a specified point. [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>Errors</b></h4>" } [/block] [block:parameters] { "data": { "h-0": "Error Code", "h-1": "Description", "0-0": "`pointNotFound`", "0-1": "Point with supplied “Id” was not found." }, "cols": 2, "rows": 1 } [/block] [block:html] { "html": "<h4><b>Columns</b></h4>" } [/block] Refer to the following table for description of columns: [block:parameters] { "data": { "0-0": "`id`", "h-0": "Name", "h-1": "Data type", "h-2": "Unit of measurement", "h-3": "Nullability", "h-4": "Note", "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": "`location`", "4-1": "Location", "4-2": "N/A", "4-3": "FALSE", "5-0": "`address`", "5-1": "Address", "5-2": "N/A", "5-3": "TRUE" }, "cols": 5, "rows": 6 } [/block] [block:html] { "html": "<h4><b>Request (example)</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"71067\"\n}", "language": "json" } ] } [/block] [block:html] { "html": "<h4><b>Response</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"list\": [\n {\n \"id\": \"71067\",\n \"name\": \"Region West\",\n \"note\": \"Company headquarters\",\n \"icon\": \"16x16/about.png\",\n \"location\": {\n \"latitude\": 51.20118,\n \"longitude\": 6.777766\n },\n \"address\": {\n \"country\": \"DE\",\n \"zipCode\": \"40237\",\n \"city\": \"Düsseldorf\",\n \"streetAddress\": \"Sohnstr. 159\"\n }\n }\n ]\n}", "language": "json" } ] } [/block] [block:html] { "html": "&nbsp;" } [/block] [block:html] { "html": "<h3>CreatePoint</h3>" } [/block] Will create a new point. [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": "`name` <span style=\"color:red\">*</span>", "0-1": "String", "0-2": "N/A", "0-3": "Name of point.", "1-0": "`note`", "1-1": "String", "1-2": "N/A", "2-0": "`location`<span style=\"color:red\">*</span>", "2-1": "Location", "2-2": "N/A", "3-0": "`address`", "3-1": "Address", "3-2": "N/A" }, "cols": 4, "rows": 4 } [/block] [block:html] { "html": "<h4><b>Request (example)</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"Berlin depot\",\n \"location\":{\n \"latitude\":52.530112,\n \"longitude\":13.522968\n \t }\n}", "language": "json" } ] } [/block] [block:html] { "html": "<h4><b>Response</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"71094\"\n}", "language": "json" } ] } [/block] [block:html] { "html": "&nbsp;" } [/block] [block:html] { "html": "<h3>UpdatePoint</h3>" } [/block] Will update parameters on an existing point. [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 point.", "2-0": "`note`", "2-1": "String", "2-2": "N/A", "3-0": "`location`", "3-1": "Location", "3-2": "N/A", "4-0": "`address`", "4-1": "Address", "4-2": "N/A" }, "cols": 4, "rows": 5 } [/block] [block:html] { "html": "<h4><b>Request (example)</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"71067\",\n \"name\": \"Region North\"\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>DeletePoint</h3>" } [/block] Will delete an existing point. [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", "h-0": "Name", "h-1": "Data type", "h-2": "Unit of measurement", "h-3": "Note", "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\": \"71067\"\n} ", "language": "json" } ] } [/block] [block:html] { "html": "<h4><b>Response</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json" } ] } [/block]