{"_id":"56d84a0a3eb4dd0b00201b5b","__v":53,"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":"56d6bbfc46d19315000f8ea3","version":"56d54a77075dfa0b00be98d8","__v":13,"pages":["56d6e32c47f18a2d0088d684","56d7f2ceb20d260b00265620","56d7f4bf7a04df0b00ddefdb","56d84a0a3eb4dd0b00201b5b","56d97895337fd11300d6a2bd","56d978c97222d50b00701513","56d97914dd90610b0027087f","56d9793e337fd11300d6a2c0","56d97977337fd11300d6a2c2","56d9799d54ee631300116644","56d979e6337fd11300d6a2c5","56d97a0e7222d50b00701516","56d9a5fbf0c80c1b007e16b8"],"project":"56d54a77075dfa0b00be98d5","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-02T10:10:04.831Z","from_sync":false,"order":2,"slug":"reference","title":"Group"},"githubsync":"","parentDoc":null,"project":"56d54a77075dfa0b00be98d5","user":"56cf3e935267d70b00494c47","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-03T14:28:26.266Z","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>GetGroup</h3>\"\n}\n[/block]\nWill list parameters on a specified group.\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`\",\n    \"0-1\": \"String\",\n    \"0-2\": \"N/A\",\n    \"0-3\": \"If supplied, only the specific group is returned.\",\n    \"1-0\": \"`unitId`\",\n    \"1-1\": \"String\",\n    \"1-2\": \"N/A\",\n    \"1-3\": \"If supplied, only groups which this unit belongs to are returned.\"\n  },\n  \"cols\": 4,\n  \"rows\": 2\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\": \"`groupNotFound`\",\n    \"0-1\": \"Group 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    \"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    \"1-4\": \"Name of the group.\"\n  },\n  \"cols\": 5,\n  \"rows\": 2\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\\\": \\\"8818\\\"\\n }\",\n      \"language\": \"json\",\n      \"name\": null\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 \\t\\t{\\n    \\t\\\"id\\\": \\\"8818\\\",\\n      \\\"name\\\": \\\"Kramer maskiner\\\"\\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>CreateGroup</h3>\"\n}\n[/block]\nWill create a new group. \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`\",\n    \"0-1\": \"String\",\n    \"0-2\": \"N/A\",\n    \"0-3\": \"Name of group.\",\n    \"1-0\": \"`units`\",\n    \"1-1\": \"String[]\",\n    \"1-2\": \"N/A\",\n    \"1-3\": \"List of units to add to group.\"\n  },\n  \"cols\": 4,\n  \"rows\": 2\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 \\t\\t\\\"name\\\": \\\"Vehicles, GE\\\",\\n    \\\"units\\\": \\\"87282,87283\\\"\\n } \",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\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  \"sidebar\": true\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"&nbsp;\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h3>UpdateGroup</h3>\"\n}\n[/block]\nWill update parameters on any of the existing groups. \n[block:html]\n{\n  \"html\": \"<h4><b>Parameters</b></h4>\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Naame\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Unit of measurement\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"`id` <span style=\\\"color:red\\\">*</span>\",\n    \"0-1\": \"String\",\n    \"0-3\": \"Unique identifier.\",\n    \"1-0\": \"`name`\",\n    \"1-1\": \"String\",\n    \"1-3\": \"Name of the group.\",\n    \"2-0\": \"`addUnits`\",\n    \"2-1\": \"String[]\",\n    \"2-3\": \"Units to add to group.\",\n    \"3-0\": \"`removeUnits`\",\n    \"3-1\": \"String[]\",\n    \"3-3\": \"Units to remove from group. Only allowed when Clear is “false” (or omitted).\",\n    \"4-0\": \"`clear`\",\n    \"4-1\": \"Bool\",\n    \"4-3\": \"If specified (and equal to “true”), all units from the group will be removed. Units from “AddUnits” are then added.\"\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\\\": \\\"8819\\\",\\n   \\\"name\\\": \\\"Vehicles, SE\\\",\\n   \\\"removeUnits\\\": \\\"72916\\\"\\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>DeleteGroup</h3>\"\n}\n[/block]\nWill delete an existing group.\n[block:html]\n{\n  \"html\": \"<h4><b>Parameters</b></h4>\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Note\",\n    \"0-0\": \"`id` <span style=\\\"color:red\\\">*</span>\",\n    \"0-1\": \"String\",\n    \"0-2\": \"Id of the group\"\n  },\n  \"cols\": 3,\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\\\": \\\"8819\\\"\\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 **Group ** is essentially a collection of units.\n\nURL Structure is:\n`https://api.trackunit.com/public/Group`","slug":"group","type":"basic","title":"Group"}

Group

A **Group ** is essentially a collection of units. URL Structure is: `https://api.trackunit.com/public/Group`

[block:html] { "html": "<h3>GetGroup</h3>" } [/block] Will list parameters on a specified group. [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`", "0-1": "String", "0-2": "N/A", "0-3": "If supplied, only the specific group is returned.", "1-0": "`unitId`", "1-1": "String", "1-2": "N/A", "1-3": "If supplied, only groups which this unit belongs to are returned." }, "cols": 4, "rows": 2 } [/block] [block:html] { "html": "<h4><b>Errors</b></h4>" } [/block] [block:parameters] { "data": { "h-0": "Error Code", "h-1": "Description", "0-0": "`groupNotFound`", "0-1": "Group 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": { "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", "1-4": "Name of the group." }, "cols": 5, "rows": 2 } [/block] [block:html] { "html": "<h4><b>Request (example)</b></h4>" } [/block] [block:code] { "codes": [ { "code": " {\n \"id\": \"8818\"\n }", "language": "json", "name": null } ] } [/block] [block:html] { "html": "<h4><b>Response</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"list\":[\n \t\t{\n \t\"id\": \"8818\",\n \"name\": \"Kramer maskiner\"\n }\n ]\n}", "language": "json" } ] } [/block] [block:html] { "html": "&nbsp;" } [/block] [block:html] { "html": "<h3>CreateGroup</h3>" } [/block] Will create a new group. [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`", "0-1": "String", "0-2": "N/A", "0-3": "Name of group.", "1-0": "`units`", "1-1": "String[]", "1-2": "N/A", "1-3": "List of units to add to group." }, "cols": 4, "rows": 2 } [/block] [block:html] { "html": "<h4><b>Request (example)</b></h4>" } [/block] [block:code] { "codes": [ { "code": " {\n \t\t\"name\": \"Vehicles, GE\",\n \"units\": \"87282,87283\"\n } ", "language": "json" } ], "sidebar": true } [/block] [block:html] { "html": "<h4><b>Response</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json" } ], "sidebar": true } [/block] [block:html] { "html": "&nbsp;" } [/block] [block:html] { "html": "<h3>UpdateGroup</h3>" } [/block] Will update parameters on any of the existing groups. [block:html] { "html": "<h4><b>Parameters</b></h4>" } [/block] [block:parameters] { "data": { "h-0": "Naame", "h-1": "Data type", "h-2": "Unit of measurement", "h-3": "Description", "0-0": "`id` <span style=\"color:red\">*</span>", "0-1": "String", "0-3": "Unique identifier.", "1-0": "`name`", "1-1": "String", "1-3": "Name of the group.", "2-0": "`addUnits`", "2-1": "String[]", "2-3": "Units to add to group.", "3-0": "`removeUnits`", "3-1": "String[]", "3-3": "Units to remove from group. Only allowed when Clear is “false” (or omitted).", "4-0": "`clear`", "4-1": "Bool", "4-3": "If specified (and equal to “true”), all units from the group will be removed. Units from “AddUnits” are then added." }, "cols": 4, "rows": 5 } [/block] [block:html] { "html": "<h4><b>Request (example)</b></h4>" } [/block] [block:code] { "codes": [ { "code": " {\n \"id\": \"8819\",\n \"name\": \"Vehicles, SE\",\n \"removeUnits\": \"72916\"\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>DeleteGroup</h3>" } [/block] Will delete an existing group. [block:html] { "html": "<h4><b>Parameters</b></h4>" } [/block] [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Data type", "h-2": "Note", "0-0": "`id` <span style=\"color:red\">*</span>", "0-1": "String", "0-2": "Id of the group" }, "cols": 3, "rows": 1 } [/block] [block:html] { "html": "<h4><b>Request (example)</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"8819\"\n} ", "language": "json" } ] } [/block] [block:html] { "html": "<h4><b>Response</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json" } ] } [/block]