{"_id":"5714dd5612b19c0e00ec1722","githubsync":"","user":"56d548ba075dfa0b00be98d2","__v":33,"category":{"_id":"5714dcd837b7e00e00de5684","project":"56d54a77075dfa0b00be98d5","version":"56d54a77075dfa0b00be98d8","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-04-18T13:10:48.898Z","from_sync":false,"order":3,"slug":"category","title":"Category"},"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"},"parentDoc":null,"project":"56d54a77075dfa0b00be98d5","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-18T13:12:54.949Z","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>GetCategory</h3>\"\n}\n[/block]\nWill list parameters on a specified category. \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\": \"The id of the category.\"\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\": \"`categoryNotFound`\",\n    \"0-1\": \"Category 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]\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\": \"`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\": \"TRUE\",\n    \"1-4\": \"Name of category.\"\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\\\": \\\"30559\\\"\\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   \\t\\t\\\"id\\\": \\\"30559\\\",\\n      \\\"name\\\": \\\"CADDY\\\"\\n\\t\\t}\\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>CreateCategory</h3>\"\n}\n[/block]\nWill create a new category. \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 the category.\"\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  \\\"name\\\": \\\"CATEPILLAR\\\"\\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  \\\"id\\\": \\\"30819\\\"\\n}\",\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>UpdateCategory</h3>\"\n}\n[/block]\nWill update parameters on any of the existing categories. \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 category.\"\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  \\\"id\\\": \\\"30818\\\",\\n  \\\"name\\\": \\\"BENFORD\\\"\\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>DeleteCategory</h3>\"\n}\n[/block]\nWill delete an existing category.\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 category.\"\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\\\": \\\"30818\\\"\\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 **Category** is a simple description, which can be appended to any unit. \nWhen appended, the category can be used to identify a set of units which share similar characteristics, ie. make, model/year etc.\n\nURL Structure is:\n`https://api.trackunit.com/public/Category`","slug":"categoryn","type":"basic","title":"Category"}

Category

A **Category** is a simple description, which can be appended to any unit. When appended, the category can be used to identify a set of units which share similar characteristics, ie. make, model/year etc. URL Structure is: `https://api.trackunit.com/public/Category`

[block:html] { "html": "<h3>GetCategory</h3>" } [/block] Will list parameters on a specified category. [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": "The id of the category." }, "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": "`categoryNotFound`", "0-1": "Category with supplied “Id” was not found" }, "cols": 2, "rows": 1 } [/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": "`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": "TRUE", "1-4": "Name of category." }, "cols": 5, "rows": 2 } [/block] [block:html] { "html": "<h4><b>Request (example)</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"30559\"\n}", "language": "json" } ] } [/block] [block:html] { "html": "<h4><b>Response</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"list\":[\n {\n \t\t\"id\": \"30559\",\n \"name\": \"CADDY\"\n\t\t}\n ]\n}", "language": "json" } ] } [/block] [block:html] { "html": "&nbsp;" } [/block] [block:html] { "html": "<h3>CreateCategory</h3>" } [/block] Will create a new category. [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 the category." }, "cols": 4, "rows": 1 } [/block] [block:html] { "html": "<h4><b>Request (example)</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"CATEPILLAR\"\n}", "language": "json" } ], "sidebar": true } [/block] [block:html] { "html": "<h4><b>Response</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"30819\"\n}", "language": "json" } ], "sidebar": true } [/block] [block:html] { "html": "&nbsp;" } [/block] [block:html] { "html": "<h3>UpdateCategory</h3>" } [/block] Will update parameters on any of the existing categories. [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 category." }, "cols": 4, "rows": 2 } [/block] [block:html] { "html": "<h4><b>Request (example)</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"30818\",\n \"name\": \"BENFORD\"\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>DeleteCategory</h3>" } [/block] Will delete an existing category. [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 category." }, "cols": 3, "rows": 1 } [/block] [block:html] { "html": "<h4><b>Request (example)</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"30818\"\n} ", "language": "json" } ] } [/block] [block:html] { "html": "<h4><b>Response</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json" } ] } [/block]