{"_id":"5714d15c9eb7280e008d1e07","category":{"_id":"571491a74007610e00c803ae","project":"56d54a77075dfa0b00be98d5","version":"56d54a77075dfa0b00be98d8","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-04-18T07:49:59.276Z","from_sync":false,"order":10,"slug":"reporting","title":"Reporting"},"project":"56d54a77075dfa0b00be98d5","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"},"__v":14,"githubsync":"","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-18T12:21:48.664Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"[block:html]\n{\n  \"html\": \"<h3>GetUnitSummary</h3>\"\n}\n[/block]\n\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\": \"`unitId`\",\n    \"0-1\": \"String\",\n    \"0-2\": \"N/A\",\n    \"0-3\": \"Unit Id to request summary for (is optional). If this is omitted, a summary is presented for all units available to the 'requester'.\",\n    \"1-0\": \"`date`<span style=\\\"color:red\\\">*</span>\",\n    \"1-1\": \"DateTime\",\n    \"1-2\": \"UTC\",\n    \"1-3\": \"Date that we request summary for.\"\n  },\n  \"cols\": 4,\n  \"rows\": 2\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Columns</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\": \"Nullability\",\n    \"h-4\": \"Note\",\n    \"0-0\": \"`unitId`\",\n    \"0-1\": \"String\",\n    \"0-2\": \"N/A\",\n    \"0-3\": \"FALSE\",\n    \"0-4\": \"Unique identifier.\",\n    \"1-0\": \"`startTime`\",\n    \"1-1\": \"DateTime\",\n    \"1-2\": \"N/A\",\n    \"1-3\": \"TRUE\",\n    \"1-4\": \"Local time (of unit's end-customer).\",\n    \"2-0\": \"`startLocation`\",\n    \"2-1\": \"Location\",\n    \"2-2\": \"N/A\",\n    \"2-3\": \"TRUE\",\n    \"3-0\": \"`startAddress`\",\n    \"3-1\": \"Address\",\n    \"3-2\": \"N/A\",\n    \"3-3\": \"TRUE\",\n    \"4-0\": \"`stopTime`\",\n    \"4-1\": \"DateTime\",\n    \"4-2\": \"N/A\",\n    \"4-3\": \"TRUE\",\n    \"4-4\": \"Local time (of unit's end-customer).\",\n    \"5-0\": \"`stopLocation`\",\n    \"5-1\": \"Location\",\n    \"5-2\": \"N/A\",\n    \"5-3\": \"TRUE\",\n    \"6-0\": \"`stopAddress`\",\n    \"6-1\": \"Address\",\n    \"6-2\": \"N/A\",\n    \"6-3\": \"TRUE\",\n    \"7-0\": \"`input1ChangeCounter`\",\n    \"7-1\": \"INT\",\n    \"7-2\": \"#\",\n    \"7-3\": \"FALSE\",\n    \"8-0\": \"`run1`\",\n    \"8-1\": \"Double\",\n    \"8-2\": \"Second\",\n    \"8-3\": \"FALSE\",\n    \"9-0\": \"`run2`\",\n    \"9-1\": \"Double\",\n    \"9-2\": \"Second\",\n    \"9-3\": \"FALSE\",\n    \"10-0\": \"`run3`\",\n    \"10-1\": \"Double\",\n    \"10-2\": \"Second\",\n    \"10-3\": \"FALSE\",\n    \"10-4\": \"Outputs 0 for ME201 and ME301 unit types.\",\n    \"11-0\": \"`run4`\",\n    \"11-1\": \"Double\",\n    \"11-2\": \"Second\",\n    \"11-3\": \"FALSE\",\n    \"11-4\": \"Outputs 0 for ME201 and ME301 unit types.\",\n    \"12-0\": \"`runOdo`\",\n    \"12-1\": \"Double\",\n    \"12-2\": \"Second\",\n    \"13-0\": \"`km`\",\n    \"13-1\": \"Double\",\n    \"13-2\": \"Km\",\n    \"13-3\": \"FALSE\"\n  },\n  \"cols\": 5,\n  \"rows\": 14\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   \\\"unitId\\\": \\\"46209\\\",\\n   \\\"date\\\": \\\"2013-08-20T07:00:00.0000000\\\"\\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                 \\\"unitId\\\": \\\"46209\\\",\\n                 \\\"startTime\\\": \\\"2013-08-20T07:28:58.0000000\\\",\\n                 \\\"startLocation\\\":{\\n                    \\\"latitude\\\": 56.0371733333333,\\n                    \\\"longitude\\\": 12.5807916666667\\n                 },\\n                 \\\"startAddress\\\":{\\n                    \\\"country\\\": \\\"DK\\\",\\n                    \\\"zipCode\\\": \\\"3000\\\",\\n                    \\\"city\\\": \\\"Helsingør\\\",\\n                    \\\"streetAddress\\\": \\\"Blichersvej 35\\\"\\n                 },\\n                 \\\"stopTime\\\": \\\"2013-08-20T12:15:48.0000000\\\",\\n                 \\\"stopLocation\\\":{\\n                    \\\"latitude\\\": 56.037065,\\n                    \\\"longitude\\\": 12.580745\\n                 },\\n                 \\\"stopAddress\\\":{\\n                    \\\"country\\\": \\\"DK\\\",\\n                    \\\"zipCode\\\": \\\"3000\\\",\\n                    \\\"city\\\": \\\"Helsingør\\\",\\n                    \\\"streetAddress\\\": \\\"Blichersvej 35\\\"\\n                 },\\n                 \\\"input1ChangeCounter\\\": 0,\\n                 \\\"input2ChangeCounter\\\": 14,\\n                 \\\"run1\\\": 0,\\n                 \\\"run2\\\": 4680,\\n                 \\\"run3\\\": 0,\\n                 \\\"run4\\\": 0,\\n                 \\\"runOdo\\\": 4140,\\n                 \\\"km\\\": 40\\n              }\\n           ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"Will provide a brief summary of unit activity, start/stop location, date and time etc. This summary may be requested for a single unit, or all units present on the account.\n\nURL Structure is:\n`https://api.trackunit.com/public/Report/UnitSummary`","slug":"unitsummary","type":"basic","title":"Unit Summary"}

Unit Summary

Will provide a brief summary of unit activity, start/stop location, date and time etc. This summary may be requested for a single unit, or all units present on the account. URL Structure is: `https://api.trackunit.com/public/Report/UnitSummary`

[block:html] { "html": "<h3>GetUnitSummary</h3>" } [/block] [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": "`unitId`", "0-1": "String", "0-2": "N/A", "0-3": "Unit Id to request summary for (is optional). If this is omitted, a summary is presented for all units available to the 'requester'.", "1-0": "`date`<span style=\"color:red\">*</span>", "1-1": "DateTime", "1-2": "UTC", "1-3": "Date that we request summary for." }, "cols": 4, "rows": 2 } [/block] [block:html] { "html": "<h4><b>Columns</b></h4>" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Unit of measurement", "h-3": "Nullability", "h-4": "Note", "0-0": "`unitId`", "0-1": "String", "0-2": "N/A", "0-3": "FALSE", "0-4": "Unique identifier.", "1-0": "`startTime`", "1-1": "DateTime", "1-2": "N/A", "1-3": "TRUE", "1-4": "Local time (of unit's end-customer).", "2-0": "`startLocation`", "2-1": "Location", "2-2": "N/A", "2-3": "TRUE", "3-0": "`startAddress`", "3-1": "Address", "3-2": "N/A", "3-3": "TRUE", "4-0": "`stopTime`", "4-1": "DateTime", "4-2": "N/A", "4-3": "TRUE", "4-4": "Local time (of unit's end-customer).", "5-0": "`stopLocation`", "5-1": "Location", "5-2": "N/A", "5-3": "TRUE", "6-0": "`stopAddress`", "6-1": "Address", "6-2": "N/A", "6-3": "TRUE", "7-0": "`input1ChangeCounter`", "7-1": "INT", "7-2": "#", "7-3": "FALSE", "8-0": "`run1`", "8-1": "Double", "8-2": "Second", "8-3": "FALSE", "9-0": "`run2`", "9-1": "Double", "9-2": "Second", "9-3": "FALSE", "10-0": "`run3`", "10-1": "Double", "10-2": "Second", "10-3": "FALSE", "10-4": "Outputs 0 for ME201 and ME301 unit types.", "11-0": "`run4`", "11-1": "Double", "11-2": "Second", "11-3": "FALSE", "11-4": "Outputs 0 for ME201 and ME301 unit types.", "12-0": "`runOdo`", "12-1": "Double", "12-2": "Second", "13-0": "`km`", "13-1": "Double", "13-2": "Km", "13-3": "FALSE" }, "cols": 5, "rows": 14 } [/block] [block:html] { "html": "<h4><b>Request (example)</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"unitId\": \"46209\",\n \"date\": \"2013-08-20T07:00:00.0000000\"\n}", "language": "json" } ] } [/block] [block:html] { "html": "<h4><b>Response</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"list\":[\n {\n \"unitId\": \"46209\",\n \"startTime\": \"2013-08-20T07:28:58.0000000\",\n \"startLocation\":{\n \"latitude\": 56.0371733333333,\n \"longitude\": 12.5807916666667\n },\n \"startAddress\":{\n \"country\": \"DK\",\n \"zipCode\": \"3000\",\n \"city\": \"Helsingør\",\n \"streetAddress\": \"Blichersvej 35\"\n },\n \"stopTime\": \"2013-08-20T12:15:48.0000000\",\n \"stopLocation\":{\n \"latitude\": 56.037065,\n \"longitude\": 12.580745\n },\n \"stopAddress\":{\n \"country\": \"DK\",\n \"zipCode\": \"3000\",\n \"city\": \"Helsingør\",\n \"streetAddress\": \"Blichersvej 35\"\n },\n \"input1ChangeCounter\": 0,\n \"input2ChangeCounter\": 14,\n \"run1\": 0,\n \"run2\": 4680,\n \"run3\": 0,\n \"run4\": 0,\n \"runOdo\": 4140,\n \"km\": 40\n }\n ]\n}", "language": "json" } ] } [/block]